{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Consumption Hub APIs","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":"consumption-hub-apis","__idx":0},"children":["Consumption Hub APIs"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"introduction","__idx":1},"children":["Introduction"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"publish-source-data-to-consumption-hub","__idx":2},"children":["Publish Source Data to Consumption Hub"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Published data needs to follow a unified schema defined by the consumption hub, please reference API documentation for details."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To consume the API, first a ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["data source"]}," needs to be defined and will be used for all the APIs."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["data source:"]}," data source stands for the external data source/system."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Then objects data can be published to the consumption hub under the data source. The current objects types are supported:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"supported data object"},"children":["supported data object"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["wells"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["wellbores"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["trajectories"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["wellbore-geometries"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["targets"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["formation-tops"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["pressure-windows"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["temperatures"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cement-programs"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["units"]}," for the data published to consumption hub should be ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["SI"]}," ","For each object, the property ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["timestamp"]}," is important"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["timestamp:"]}," timestamp is a important property defined in each data object schema, this property indicate the data object ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["last modified time"]},", and will be compared by DrillPlan to decide if the source data is newer than DrillPlan."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"integration-workflow-example","__idx":3},"children":["Integration workflow (Example)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Different workflow could be selected to do the integration. Here is an example for creating DrillPlan project with data published to Consumption Hub."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["By calling create project API with data source information, DrillPlan will tracking data change on consumption hub."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/consumption-hub-workflow-example-1.1aa30217e2e63c5caecc11859e1d4e28c3b1ea1bf375bd0738f588a91c2fe920.c0faf1fc.png","alt":"create-project-workflow-example.png"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/consumption-hub-workflow-example-2.186d38a710ea7be604482b56aafe65f649c8da427bf1461d891f4d850351047c.c0faf1fc.png","alt":"Update-workflow-example.png"},"children":[]}]}]},"headings":[{"value":"Consumption Hub APIs","id":"consumption-hub-apis","depth":1},{"value":"Introduction","id":"introduction","depth":2},{"value":"Publish Source Data to Consumption Hub","id":"publish-source-data-to-consumption-hub","depth":2},{"value":"Integration workflow (Example)","id":"integration-workflow-example","depth":2}],"frontmatter":{"seo":{"title":"Consumption Hub APIs"}},"lastModified":"2025-04-14T21:53:33.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/drillplan/docs/tutorials/consumption-hub/consumption-hub-tutorial","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}