The 'Consumption Hub' is a staging area for external systems to publish planned or actual well data to DrillPlan. Once a DrillPlan project has been associated to a data-source-record, data can be fetched into the user's draft space and any discrepancies between the current plan objects and the data-source-record are highlighted.
Published data needs to follow a unified schema defined by the consumption hub, please reference API documentation for details.
To consume the API, first a data source needs to be defined and will be used for all the APIs.
data source: data source stands for the external data source/system.
Then objects data can be published to the consumption hub under the data source. The current objects types are supported:
| supported data object |
|---|
| wells |
| wellbores |
| trajectories |
| wellbore-geometries |
| targets |
| formation-tops |
| pressure-windows |
| temperatures |
| cement-programs |
the units for the data published to consumption hub should be SI For each object, the property timestamp is important
timestamp: timestamp is a important property defined in each data object schema, this property indicate the data object last modified time, and will be compared by DrillPlan to decide if the source data is newer than DrillPlan.
Different workflow could be selected to do the integration. Here is an example for creating DrillPlan project with data published to Consumption Hub.
By calling create project API with data source information, DrillPlan will tracking data change on consumption hub.
