{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Introduction","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":2,"id":"introduction","__idx":0},"children":["Introduction"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["DrillPlan's ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/drillplan/apis/drillplan-ddi-api"},"children":["Dynamic Display Items API"]}," provides access to DrillPlan dynamic display items."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-to-request-key-parameters-content","__idx":1},"children":["How to request key parameters content"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An asynchronous task for requesting key parameters content can be created via executing a POST using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/drillplan/ddis/v1/projects/{projectId}/key-parameters/content/requests"]}," end-point and providing the following payload:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{  \n   \"plan_id\": \"131231231\",  // The plan ID \n   \"language\": \"en-EN\", // Optional, project language is used if it is not specified. \n   \"unit_system\": \"English\", // Optional, Project unit system is used if it is not specified. \n   \"key_parameters\": [ \n       { \n          \"key_parameter_id\": \"well-name\", \n          \"level_id\": \"d973c00e4d64f5ddb1231\" // The content level ID specified as a plan node ID of the plan referenced in the request. \n       } \n    ],\n   \"callback\": {\n        \"uri\": \"https://example.com/callback\",\n        \"headers\": {\n           \"Authorization\": \"Bearer your_token_here\",\n           \"Custom-Header\": \"custom_header_value\"\n        }\n    }   \n}  \n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Available key parameters could be obtained via executing a GET request using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/drillplan/ddis/v1/key-parameters"]}," end-point."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once the content generation is complete, the DrillPlan Reporting subsystem will send a POST request to the specified callback endpoint with the following payload:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"395849cf9bbf440d91\", // ID of the task the callback is related to.\n  \"status\": \"Succeeded\", // The task execution status.\n  \"artifacts\": {\n     \"content_id\": \"ac5ed2e4e05976\"\n  }\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can also retrieve the tasks created in step 1 by sending a GET request to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/drillplan/ddis/v2/projects/{projectId}/tasks/{taskId}"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After obtaining the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["content_id"]},", the result of the content generation operation can be received by issuing a GET request to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/drillplan/ddis/v1/projects/{projectId}/key-parameters/content/{contentId}"]},"."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-to-request-display-items-content","__idx":2},"children":["How to request display items content"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An asynchronous task for requesting display items content can be created via executing a POST using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/drillplan/ddis/v1/projects/{projectId}/display-tems/content/requests"]}," end-point and providing the following payload:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{  \n   \"plan_id\": \"131231231\",  // The plan ID \n   \"language\": \"en-EN\", // Optional, project language is used if it is not specified. \n   \"unit_system\": \"English\", // Optional, Project unit system is used if it is not specified. \n   \"display_items\": [ \n       { \n          \"display_item_id\": \"pressure-aea-card-results\", \n          \"level_id\": \"d973c00e4d64f5ddb1231\" // The content level ID specified as a plan node ID of the plan referenced in the request. \n       } \n    ],\n    \"callback\": {\n        \"uri\": \"https://example.com/callback\",\n        \"headers\": {\n           \"Authorization\": \"Bearer your_token_here\",\n           \"Custom-Header\": \"custom_header_value\"\n        }\n     }          \n}  \n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Available display items could be obtained via executing a GET request using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/drillplan/ddis/v1/display-items"]}," end-point."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once the content generation is complete, the DrillPlan Reporting subsystem will send a POST request to the specified callback endpoint with the following payload:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"395849cf9bbf440d91\", // ID of the task the callback is related to.\n  \"status\": \"Succeeded\", // The task execution status.\n  \"artifacts\": {\n     \"content_id\": \"ac5ed2e4e05976\"\n  }\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can also retrieve the tasks created in step 1 by sending a GET request to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/drillplan/ddis/v2/projects/{projectId}/tasks/{taskId}"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After obtaining the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["content_id"]},", the result of the content generation operation can be received by issuing a GET request to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/drillplan/ddis/v1/projects/{projectId}/display-items/content/{contentId}"]},". The response should contains the following content:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{  \n   \"display_items\": [ \n       { \n          \"display_item_id\": \"pressure-aea-card-results\", \n          \"level_id\": \"d973c00e4d64f5ddb1231\", // The content level ID specified as a plan node ID of the plan referenced in the request. \n          \"content_parts\": [\n              {\n                  \"content_part_id\": \"d1231c00e4d45461231\", // The content part ID which could be used to retrieve part's content.\n                  \"title\": \"AEA Result\" // The title of the content part.\n              }\n          ]\n       } \n    ] \n}  \n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using the content part IDs from the previous response, the actual content can be retrieved by issuing a GET request to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/drillplan/ddis/v1/projects/{projectId}/display-items/content-parts/{contentPartId}"]},". The response may contain content of different types, including ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["image/jpeg"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["image/png"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/pdf"]},"."]}]}]}]},"headings":[{"value":"Introduction","id":"introduction","depth":2},{"value":"How to request key parameters content","id":"how-to-request-key-parameters-content","depth":2},{"value":"How to request display items content","id":"how-to-request-display-items-content","depth":2}],"frontmatter":{"seo":{"title":"Introduction"}},"lastModified":"2025-04-14T21:53:33.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/drillplan/docs/tutorials/api-consumption-guide/ddis-api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}