{"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 Wellbarrier API allows external applications to get well barrier diagrams and their associated activities from DrillPlan."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Today a user creates well barrier diagrams in Wellbarrier® (a separate application to DrillPlan) and fetches them into DrillPlan's Wellbarrier object editor. Here, the barrier diagrams are initially grouped under their respective ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["wellbore"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["section"]},", and users are able to further associate them with a collection of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["L6_activities"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-barrier-illustrations","__idx":1},"children":["Get Barrier Illustrations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The first endpoint returns the list of well barrier illustrations by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["planId"]}," and their corresponding ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["L6_activity"]}," assignments. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["planId"]}," can be retrieved using the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/drillplan/apis/projectplanapi"},"children":["Project Plan API"]},". Please see corresponding tutorial for additional details."]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Example Get Request: well barrier illustrations and associated activities ",{"$$mdtype":"Tag","name":"small","attributes":{},"children":["(click to open)"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"curl","header":{"controls":{"copy":{}}},"source":"curl -L -X GET '{baseURL}/drillplan/wellbarrier/v1/activity-associations/by-plan/{plan_id}'\n-H 'accept: application/json'\n-H 'slb-partition-id: {SlbPartitionId}'\n-H 'appkey: {appKey}'\n-H 'Authorization: Bearer {token}'\n","lang":"curl"},"children":[]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Example Response Body ",{"$$mdtype":"Tag","name":"small","attributes":{},"children":["(click to open)"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"planId\": \"0ed19f23f6754ecea60c129ed38d6fbb\",\n \"wellBarrierId\": \"e8fa8892a08c46949d1d86554545b1ba\",\n \"activityAssociations\": [\n  {\n   \"l3ActivityId\": \"\",\n   \"l6ActivityId\": \"e7813a86-9d07-41fd-a099-6288fcc8623b\",\n   \"illustrationName\": \"SC.V 1.2-a2 rev. 1 - Drilling run\",\n   \"illustrationId\": \"72ce518f-3b41-4c07-8388-bf70748f247c\"\n  },\n  {\n   \"l3ActivityId\": \"\",\n   \"l6ActivityId\": \"1807ecab-0aec-464b-8249-4f85c0180933\",\n   \"illustrationName\": \"SC.V 1.2-a2 rev. 1 - Drilling run\",\n   \"illustrationId\": \"72ce518f-3b41-4c07-8388-bf70748f247c\"\n  }\n ]\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note: See ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Activity notes"]}," below for further information about ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["L6_activities"]}," and where to retrieve them."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-illustration","__idx":2},"children":["Get Illustration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The second endpoint is used to extract a specific barrier illustration. This will be a PDF file."]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Example Get Request: well barrier illustration ",{"$$mdtype":"Tag","name":"small","attributes":{},"children":["(click to open)"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"curl","header":{"controls":{"copy":{}}},"source":"curl -L -X GET '{baseURL}/drillplan/wellbarrier/v1/<<TBD>>'\n-H 'accept: application/json'\n-H 'slb-partition-id: {SlbPartitionId}'\n-H 'appkey: {appKey}'\n-H 'Authorization: Bearer {token}'\n","lang":"curl"},"children":[]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Example Response Body ",{"$$mdtype":"Tag","name":"small","attributes":{},"children":["(click to open)"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"pdf","header":{"controls":{"copy":{}}},"source":"PDF\n","lang":"pdf"},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"activity-notes","__idx":3},"children":["Activity Notes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/drillplan/apis/projectplanapi"},"children":["Project Plan API"]}," can be used to get the list of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["projects"]}," and their corresponding ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plans"]},". The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["planId"]}," is then used to get the list of plan ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["artifacts"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["More details can be found in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/drillplan/docs/tutorials/api-consumption-guide/project-plan-api"},"children":["Project Plan API Tutorial"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The comphrensive list of planned activities can be found inside the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ActivityPlan_public_vXX"]}," plan artifact."]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Example snippet from a `ActivityPlan_public_vXX` artifact ",{"$$mdtype":"Tag","name":"small","attributes":{},"children":["(click to open)"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"xml","header":{"controls":{"copy":{}}},"source":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<ActivityPlan\n xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\n xmlns=\"http://www.slb.com/schema/activityplan\">\n <name>Activity Plan</name>\n <activities>\n  <activity xsi:type=\"L3\" uid=\"79eeb1e7-8659-4887-812b-c8a0a7d9a9f4\">\n   <name>Construct section | 17.5 in</name>\n   ...\n   <level>L3</level>\n  </activity>\n  ...\n  <activity xsi:type=\"L6\" uid=\"e7813a86-9d07-41fd-a099-6288fcc8623b\">\n   <name>Trip in to depth | 0–65.62 ft</name>\n   ...\n   <level>L6</level>\n  </activity>\n  <activity xsi:type=\"L6\" uid=\"7c7a985a-ec0d-425b-bffd-2ffe0d799223\">\n      <name>Drill shoe track | 1328–1348 m</name>\n\t  ...\n      <level>L6</level>\n    </activity>\n  </activities>\n</ActivityPlan>\n","lang":"xml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Where:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uid"]}," corresponds to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["l3ActivityId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["l6ActivityId"]}," returned in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET Well barrier illustrations and associated activities"]}," endpoint"]}]}]},"headings":[{"value":"Introduction","id":"introduction","depth":2},{"value":"Get Barrier Illustrations","id":"get-barrier-illustrations","depth":3},{"value":"Get Illustration","id":"get-illustration","depth":3},{"value":"Activity Notes","id":"activity-notes","depth":4}],"frontmatter":{"seo":{"title":"Introduction"}},"lastModified":"2025-04-14T22:12:49.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/drillplan/docs/tutorials/well-barrier/well-barrier-tutorial","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}