The events API can be used to discover events which have occurred within FDPlan. The events follow the cloud events specification for describing events. For more information on the cloud event specification.
- prod-nam-services-fdplan.slbservice.com
- prod-eu-services-fdplan.slbservice.com
- prod-au-services-fdplan.slbservice.com
- prod-id-services-fdplan.slbservice.com
- production-services-fdplan.slbservice.com
Returns a list of events using CloudEvents. Due to paging this does not follow the standard 'batch' format, see attributes
Parameters
slb-partition-id Data partition id.
planningtags 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"].
studyId Study identifier to filter results. (Marked for deprecation in favour of planningtags)
from First date from which events will be returned. Must be after 1979 and before 'to' filter, defaults to exactly 10 days ago.
to Last date to which events will be returned. Must be either current time or after 'from', defaults to the current time.
type 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.
pageSize Paging - number of events to return in the current page.
pageNumber Paging - the current zero based index page.
Example
curl -request GET
--url 'https://api.delfi.slb.com/fdplan/events/v1/cloud-events?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'
--header 'Authorization: value'
--header 'appkey: value'
--header 'content-type: application/json'
--header 'slb-partition-id: header'
Response: 200 { "events": [ { "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": [ "StudyId:01ED4CMJ4N9N504E3QJT1A68JY", "ScenarioId:01ED4CNEQDGBEWAK107ZFNT61S" ], "data": { "computationID": "1cc5d4b52ce9f3e4851024fdbba1bd028c0a25af1f140e6b92d27408e274403b", "specID": "ix", "specName": "name", "specVersion": 1 } }, { "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": [ "StudyId:01ED4CMJ4N9N504E3QJT1A68JY", "ScenarioId:01ED4CNEQDGBEWAK107ZFNT61S" ], "data": { "computationID": "543jk5hlk435hjlk435hk345hkhfkdjh55kjh5kjhsekjahklj60098092838098", "specID": "ix", "specName": "name", "specVersion": 1 } } ], "total": 2 }