CloudEvent

Cloud APIs

CloudEvent

idstringrequired

The identifier of the event. See id.

Example:"01EHSM2HYX79AV6RRFSCYDR2YF"

specversionstringrequired

The cloudevents spec version. See version.

Example:"0.3"

typestringrequired

The type of event being raised. The event type is a reverse DNS name of the form com.slb.cloud.fdplan.{domain}.{event-type}.{event-version}. where "domain" is the FDPlan domain which generated the results (e.g. studies, evaluation), "event-type" is the name of the event and "event-version" is the event version. For example, events are raised from the FDPlan evaluation system when computations are required and completed. The events have the form com.slb.cloud.fdplan.evaluation.computation_required_{spec_id}_{spec_version}.{event-version}, where "spec_id" and "spec_version" are the evaluation computation specification identifier and version respectively. See FDPlan evaluation API for more details. See type.

Example:"com.slb.cloud.fdplan.evaluation.computation_completed_peep_economics_v1.v1"

sourcestringrequired

URI describing the origin of the event. See source.

Example:"/services/internal/01EHSM2HYXM3MM99SH749MF53C"

timestring, (date-time)required

The time the event occurred (in memory) - note do not use an entity persistence time or any time which may lag the actual event. See time.

Example:"2020-09-09T14:24:52.189Z"

studyIdstringrequired

The study identifier. (Marked for deprecation in favour of planningtags)

Example:"01ED4CMJ4N9N504E3QJT1A68JY"

datacontenttypestringrequired

The MIME content type of the 'data' field below. See datacontenttype.

Example:"application/json"

planningtagsArray of strings

List of tags which will provide user context for logged events. Planning tags are typically of the form "tag name":"identifier".

Example:

[
  "StudyId:01ED4CMJ4N9N504E3QJT1A68JY",
  "ScenarioId:01ED4CNEQDGBEWAK107ZFNT61S"
]

dataobjectrequired

The JSON body of the event. See data.

Example:

{
  "computationID": "1cc5d4b52ce9f3e4851024fdbba1bd028c0a25af1f140e6b92d27408e274403b",
  "specID": "peep-economics",
  "specName": "economics",
  "specVersion": 1
}

{
  "id": "01EHSM2HYX79AV6RRFSCYDR2YF",
  "specversion": "0.3",
  "type": "com.slb.cloud.fdplan.evaluation.computation_completed_peep_economics_v1.v1",
  "source": "/services/internal/01EHSM2HYXM3MM99SH749MF53C",
  "time": "2020-09-09T14:24:52.189Z",
  "studyId": "01ED4CMJ4N9N504E3QJT1A68JY",
  "datacontenttype": "application/json",
  "planningtags": [
    "StudyId:01ED4CMJ4N9N504E3QJT1A68JY",
    "ScenarioId:01ED4CNEQDGBEWAK107ZFNT61S"
  ],
  "data": {
    "computationID": "1cc5d4b52ce9f3e4851024fdbba1bd028c0a25af1f140e6b92d27408e274403b",
    "specID": "peep-economics",
    "specName": "economics",
    "specVersion": 1
  }
}