Skip to content
Cloud APIs
/
FDPlan
/
/CloudEvents

CloudEvents

Getting cloud events.

Operations

Get a list of events

Request

Returns a list of events using CloudEvents. Due to paging this does not follow the standard 'batch' format, see attributes

Security
bearer and appkey
Query
planningtagsArray of strings

An optional list of tags to filter events e.g. ["StudyId:01ED4CMJ4N9N504E3QJT1A68JY", "ScenarioId:01ED4CNEQDGBEWAK107ZFNT61S"]. The planning tags are typically of the form "tag name":"identifier". For example to query all events for the study with identifier "01ED4CMJ4N9N504E3QJT1A68JY" use ["StudyId:01ED4CMJ4N9N504E3QJT1A68JY"].

studyIdstring

Study identifier to filter results. (Marked for deprecation in favour of planningtags)

fromstring, (date-time)

First date from which events will be returned. Must be after 1979 and before 'to' filter, defaults to exactly 10 days ago.

Example:from=2021-01-01T00:00:00.000Z
tostring, (date-time)

Last date to which events will be returned. Must be either current time or after 'from', defaults to the current time.

Example:to=2021-01-10T00:00:00.000Z
typestring

Event type to filter results. 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.

Example:type=com.slb.cloud.fdplan.evaluation.computation_required_ix_v1.v1
pageSizeinteger, <= 3600

Paging - number of events to return in the current page.

Default:50
pageNumberinteger

Paging - the current zero based index page.

Default:0
Headers
slb-partition-idstringrequired

Data partition id.

curl -i -X GET \
  'https://api.delfi.slb.com/fdplan/events/v1/cloud-events?planningtags=string&studyId=string&from=2021-01-01T00%3A00%3A00.000Z&to=2021-01-10T00%3A00%3A00.000Z&type=com.slb.cloud.fdplan.evaluation.computation_required_ix_v1.v1&pageSize=50&pageNumber=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'appkey: YOUR_API_KEY_HERE' \
  -H 'slb-partition-id: string'

Responses

Retrieved cloud events successfully.

Bodyapplication/json
totalintegerrequired

The total unpaged results for the filters given.

Example:5
eventsArray of objects(CloudEvent)required

List of CloudEvents

Example:
[
  {
    "id": "01EHSM2HYX79AV6RRFSCYDR2YF",
    "specversion": "0.3",
    "type": "com.slb.cloud.fdplan.evaluation.computation_required_ix_v1.v1",
    "source": "/services/internal/01EHSM2HYXM3MM99SH749MF53C",
    "time": "2021-01-04T14:24:52.189Z",
    "datacontenttype": "application/json",
    "studyId": "01ED4CMJ4N9N504E3QJT1A68JY",
    "planningtags": [ … ],
    "data": { … }
  },
  {
    "id": "01EHSM2HYX79AV6RRFSCYSDFSD",
    "specversion": "0.3",
    "type": "com.slb.cloud.fdplan.evaluation.computation_required_ix_v1.v1",
    "source": "/services/internal/01EHSM2HYXM3MM99SH749MF53C",
    "time": "2021-01-09T14:24:52.189Z",
    "datacontenttype": "application/json",
    "studyId": "01ED4CMJ4N9N504E3QJT1A68JY",
    "planningtags": [ … ],
    "data": { … }
  }
]
Response
{
  "events": [
    { … },
    { … }
  ],
  "total": 2
}