{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Events","description":"Accelerate E&P application development and protect your innovation by consuming our Data and Domain APIs / Platform APIs.","lang":"en-US","meta":[{"name":"robots","content":"noindex"}],"llmstxt":{"hide":true,"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"events","__idx":0},"children":["Events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The events API can be used to discover events which have occurred"," ","within FDPlan. The events follow the cloud events specification for"," ","describing events (",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://cloudevents.io/"},"children":["https://cloudevents.io/"]},")."," ","For more information on the cloud event specification"," ","see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://github.com/cloudevents/spec"},"children":["https://github.com/cloudevents/spec"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"table-of-contents","__idx":1},"children":["Table of contents",{"$$mdtype":"Tag","name":"a","attributes":{"name":"toc"},"children":[]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get-a-list-of-events"},"children":["Get a list of events"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"get-a-list-of-events","__idx":2},"children":["Get a list of events ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"get-a-list-of-events"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns a list of events using CloudEvents. Due to paging this does not follow the standard 'batch' format, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://github.com/cloudevents/spec/blob/v0.3/json-format.md#2-attributes"},"children":["https://github.com/cloudevents/spec/blob/v0.3/json-format.md#2-attributes"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-data-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["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\"]."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["studyId"]}," Study identifier to filter results.  (Marked for deprecation in favour of planningtags)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["from"]}," First date from which events will be returned. Must be after 1979 and before 'to' filter, defaults to exactly 10 days ago."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["to"]}," Last date to which events will be returned. Must be either current time or after 'from', defaults to the current time."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["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."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["pageSize"]}," Paging - number of events to return in the current page."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["pageNumber"]}," Paging - the current zero based index page."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request GET ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--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' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-data-partition-id: header'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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\","," ","\"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\","," ","\"planningtags\": ["," ","\"StudyId:01ED4CMJ4N9N504E3QJT1A68JY\","," ","\"ScenarioId:01ED4CNEQDGBEWAK107ZFNT61S\""," ","],"," ","\"data\": {"," ","\"computationID\": \"543jk5hlk435hjlk435hk345hkhfkdjh55kjh5kjhsekjahklj60098092838098\","," ","\"specID\": \"ix\","," ","\"specName\": \"name\","," ","\"specVersion\": 1"," ","}"," ","}"," ","],"," ","\"total\": 2"," ","}"," ","]"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]}]},"headings":[{"value":"Events","id":"events","depth":1},{"value":"Table of contents","id":"table-of-contents","depth":1},{"value":"Get a list of events","id":"get-a-list-of-events","depth":1}],"frontmatter":{"seo":{"title":"Events"}},"lastModified":"2025-02-18T23:00:31.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/fdplan/tutorial/events-openapi_nam","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}