{"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":["The ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/drillplan/apis/customparametersapi"},"children":["Custom Parameter API"]}," enables administration of the Custom Parameter definition found in DrillPlan's Corporate Settings. Further details can be found in the DrillPlan section of ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://help.digital.slb.com/content/1003/help/index"},"children":["DELFI Help"]}," under the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://help.digital.slb.com/content/1003/help/Custom_Parameters_Definition_9248d5b4-6fae-42fe-a448-52d6ed0ef9e8"},"children":["Custom Parameters Definition"]}," topic."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For authentication and general guidance using DrillPlan's APIs, please visit the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/drillplan/docs/tutorials/api-consumption-guide/api-consumption-tutorial"},"children":["API Consumption Guide"]}," page."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Custom Parameters API allows the full range of standard C.R.U.D. actions."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"access-permissions","__idx":1},"children":["Access Permissions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API can be accessed via different authentication grant types (e.g. Authorization Code Flow (ACF) or Client Credentials etc.). Please find some considerations of each type below."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"authorization-code-flow-user-credentials","__idx":2},"children":["Authorization Code Flow (User Credentials)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Where possible, we recommend using ACF for interacting with DrillPlan, to ensure that no data entitlements or permissions are breached via a service account."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All users have ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["read"]}," access to the corporate settings and therefore can query the following endpoints:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"color":"#ffffff","backgroundColor":"#61AFFE","padding":"2px 5px","borderRadius":"3px"}},"children":["GET"]}," /v1/parameter-definitions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"color":"#ffffff","backgroundColor":"#61AFFE","padding":"2px 5px","borderRadius":"3px"}},"children":["GET"]}," /v1/parameter-definitions/{id}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["However ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["create"]},", ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["update"]}," and ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["delete"]}," actions:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"color":"#ffffff","backgroundColor":"#49CC90","padding":"2px 5px","borderRadius":"3px"}},"children":["POST"]}," /v1/parameter-definitions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"color":"#ffffff","backgroundColor":"#FCA130","padding":"2px 5px","borderRadius":"3px"}},"children":["PUT"]}," /v1/parameter-definitions/{id}"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"color":"#ffffff","backgroundColor":"#F93E3E","padding":"2px 5px","borderRadius":"3px"}},"children":["DELETE"]}," /v1/parameter-definitions/{id}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["require the additional ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Corporate Admin"]}," permission, granted in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Permission Management"]}," page (see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://help.digital.slb.com/content/1003/help/Permissions_Management_86401b3a-463e-4b2a-ad7f-823dabf4cda3"},"children":["help documentation"]}," for more information)"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"client-credentials-flow-service-account","__idx":3},"children":["Client Credentials Flow (Service Account)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Service accounts have unrestricted access and admin rights to DrillPlan's data and settings. They should therefore be used and issued with caution. Service accounts can be used to perform the full range of C.R.U.D. actions on the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/drillplan/apis/customparametersapi"},"children":["Custom Parameter API"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"read-all-custom-parameters","__idx":4},"children":["Read all Custom Parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The list of all custom parameters can be read as follows:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"CURL","header":{"controls":{"copy":{}}},"source":"curl -X GET '<baseURL>/drillplan/custom-parameters/v1/parameter-definitions' \\\n-H 'slb-data-partition-id: <slbPartitionId>' \\\n-H 'appkey: <appKey>' \\\n-H 'Authorization: Bearer <jwtoken>'\n","lang":"CURL"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the data schema and API details please visit the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/drillplan/apis/customparametersapi"},"children":["Custom Parameter API"]}," swagger documentation."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"read-a-custom-parameter","__idx":5},"children":["Read a Custom Parameter"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A single custom parameter can be read as follows:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"CURL","header":{"controls":{"copy":{}}},"source":"curl -X GET '<baseURL>/drillplan/custom-parameters/v1/parameter-definitions/{id}' \\\n-H 'slb-data-partition-id: <slbPartitionId>' \\\n-H 'appkey: <appKey>' \\\n-H 'Authorization: Bearer <jwtoken>'\n","lang":"CURL"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the data schema and API details please visit the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/drillplan/apis/customparametersapi"},"children":["Custom Parameter API"]}," swagger documentation."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"create-a-new-custom-parameter","__idx":6},"children":["Create a new Custom Parameter"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A new example custom parameter can be created as follows:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"CURL","header":{"controls":{"copy":{}}},"source":"curl -L -X POST '<baseURL>/drillplan/custom-parameters/v1/parameter-definitions' \\\n-H 'slb-data-partition-id: <slbPartitionId>' \\\n-H 'appkey: <appKey>' \\\n-H 'Authorization: Bearer <jwtoken>' \\\n-H 'Content-Type: application/json' \\\n-d '{\n  \"name\": \"Max Expected H2S %\",\n  \"type\": \"Number\",\n  \"level\": \"Section\",\n  \"description\": \"The maximum H2S % should be entered for each section\",\n  \"is_available_as_ddi\": true,\n  \"tags\": [\n    \"H2S\", \"Engine Parameters\"\n  ]\n}'\n","lang":"CURL"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the data schema and API details please visit the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/drillplan/apis/customparametersapi"},"children":["Custom Parameter API"]}," swagger documentation."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"update-a-custom-parameter","__idx":7},"children":["Update a Custom Parameter"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An example custom parameter can be updated as follows:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"CURL","header":{"controls":{"copy":{}}},"source":"curl -L -X PUT '<baseURL>/drillplan/custom-parameters/v1/parameter-definitions/{id}' \\\n-H 'slb-data-partition-id: <slbPartitionId>' \\\n-H 'appkey: <appKey>' \\\n-H 'Authorization: Bearer <jwtoken>' \\\n-H 'Content-Type: application/json' \\\n-d '{\n    \"id\": \"{id}\",\n    \"unique_id\": \"{id}\",\n    \"name\": \"Max Expected H2S %\",\n    \"type\": \"Number\",\n    \"level\": \"Section\",\n    \"description\": \"The maximum H2S % should be entered for each section\",\n    \"is_available_as_ddi\": true,\n    \"tags\": [\n        \"H2S\", \"Engine Parameters\", \"Extra Tag\"\n    ]\n}'\n","lang":"CURL"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the data schema and API details please visit the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/drillplan/apis/customparametersapi"},"children":["Custom Parameter API"]}," swagger documentation."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"delete-a-custom-parameter","__idx":8},"children":["Delete a Custom Parameter"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An example custom parameter can be deleted as follows:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"CURL","header":{"controls":{"copy":{}}},"source":"curl -L -X DELETE '<baseURL>/drillplan/custom-parameters/v1/parameter-definitions/{id}' \\\n-H 'slb-data-partition-id: <slbPartitionId>' \\\n-H 'appkey: <appKey>' \\\n-H 'Authorization: Bearer <jwtoken>' \\\n","lang":"CURL"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the data schema and API details please visit the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/drillplan/apis/customparametersapi"},"children":["Custom Parameter API"]}," swagger documentation."]}]}]},"headings":[{"value":"Introduction","id":"introduction","depth":2},{"value":"Access Permissions","id":"access-permissions","depth":2},{"value":"Authorization Code Flow (User Credentials)","id":"authorization-code-flow-user-credentials","depth":3},{"value":"Client Credentials Flow (Service Account)","id":"client-credentials-flow-service-account","depth":3},{"value":"Read all Custom Parameters","id":"read-all-custom-parameters","depth":2},{"value":"Read a Custom Parameter","id":"read-a-custom-parameter","depth":2},{"value":"Create a new Custom Parameter","id":"create-a-new-custom-parameter","depth":2},{"value":"Update a Custom Parameter","id":"update-a-custom-parameter","depth":2},{"value":"Delete a Custom Parameter","id":"delete-a-custom-parameter","depth":2}],"frontmatter":{"seo":{"title":"Introduction"}},"lastModified":"2025-04-14T21:53:33.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/drillplan/docs/tutorials/api-consumption-guide/custom-parameter-api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}