{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Data Sources","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":false}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"data-sources","__idx":0},"children":["Data Sources"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The data sources API is responsible for managing data sources in FDPlan."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["data source"]}," is a versioned input bundle consumed by scenario evaluations. It pairs a"," ","user-facing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["source"]}," (a registered data type and its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["store"]},") with one ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["target"]}," data type"," ","understood by computations, and is discovered and reused across scenarios through ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]}," ","(usually ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["StudyId:id"]},")."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Data sources are never created directly. Every data source is produced by an asynchronous"," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["data source job"]},": the caller posts the inputs (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["source"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["target"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dataProviders"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]},")"," ","and the platform runs the transformation declared on the matching ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["data source type"]}," in the"," ","background. A data source type is the reusable conversion contract between a domain-native input"," ","format and one or more evaluation-ready data types, and also declares the editors, viewers, and"," ","transformation/copy providers used to author and process the data."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Key resources:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-source-types"]}," - register and manage the conversion contracts (source/target, editors,"," ","viewers, providers)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-source-jobs"]}," - create, reprocess, poll, and complete the asynchronous work that builds"," ","a data source. External transformers report completion via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".../{id}/state"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflow-input-data-source-jobs"]}," - build all workflow input data sources of a study at once"," ","to create virtual scenarios."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-sources"]}," - read a given ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["version"]},", list by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]},", and delete."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"client-id","__idx":1},"children":["Client ID"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["prod-nam-services-fdplan.slbservice.com"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["prod-eu-services-fdplan.slbservice.com"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["prod-au-services-fdplan.slbservice.com"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["prod-id-services-fdplan.slbservice.com"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["production-services-fdplan.slbservice.com"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"table-of-contents","__idx":2},"children":["Table of contents",{"$$mdtype":"Tag","name":"a","attributes":{"name":"toc"},"children":[]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#create-a-new-data-source-job"},"children":["Create a new data source job"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get-a-data-source-job"},"children":["Get a data source job."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#patch-a-data-source-job"},"children":["Patch a data source job."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#create-a-new-data-source-reprocess-job"},"children":["Create a new data source reprocess job"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#set-state-of-data-source-job"},"children":["Set state of data source job."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#create-a-new-workflow-input-data-source-job"},"children":["Create a new workflow input data source job"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get-list-of-data-sources"},"children":["Get list of data sources"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get-a-data-source"},"children":["Get a data source"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#delete-a-data-source"},"children":["Delete a data source."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get-list-of-data-source-types-for-a-given-target"},"children":["Get list of data source types for a given target."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#create-new-data-source-type"},"children":["Create new data source type."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get-a-data-source-type-by-id"},"children":["Get a data source type by ID."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#update-a-data-source-type"},"children":["Update a data source type."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"create-a-new-data-source-job","__idx":3},"children":["Create a new data source job ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"create-a-new-data-source-job"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a new data source job to trigger the processing of a set of data provider sources"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["dataSourceJob"]}," The data source processing job that needs to be triggered."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request POST ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/data-sources/v2/data-source-jobs' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-partition-id: header' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--data '{"," ","\"source\": {"," ","\"type\": \"demo:data-types:planning-assumption-reference\","," ","\"store\": \"comm-store\""," ","},"," ","\"target\": {"," ","\"type\": \"price-forecast\""," ","},"," ","\"tags\": ["," ","\"StudyId:01JY6FMJMY0F6AJFV05V831SB4\""," ","],"," ","\"description\": \"Example of transformation\","," ","\"name\": \"Forecast Q2\","," ","\"dataProviders\": {"," ","\"items\": ["," ","{"," ","\"name\": \"Base\","," ","\"description\": \"Base price forecast deck\","," ","\"sources\": ["," ","\"https://corp.commercials.data-agent.com/reference/2fbcc17c7700258b/base\""," ","]"," ","},"," ","{"," ","\"name\": \"Stress\","," ","\"description\": \"Stress price forecast deck\","," ","\"sources\": ["," ","\"https://corp.commercials.data-agent.com/reference/2fbcc17c7700258b/stress\""," ","]"," ","}"," ","]"," ","}"," ","}'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 202"," ","{"," ","\"id\": \"01JY6YFQ5F7MYPDM3TXCGG02N2\","," ","\"dataSourceId\": \"01JY6YVV4QPRH7W4TY64BXEDB6\","," ","\"dataSourceType\": \"price-forecast\","," ","\"dataSourceJobType\": \"Reprocess\","," ","\"dataSourceJobState\": \"Failed\","," ","\"dataSourceJobErrors\": ["," ","\"scenario 01EFY17N9ED84BV4CHPTDAXZK1 of study 01JY6FMJMY0F6AJFV05V831SB4 does not have any attached choices\","," ","\"scenario 1 of study 2 does not have any attached choices\""," ","]"," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"get-a-data-source-job","__idx":4},"children":["Get a data source job. ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"get-a-data-source-job"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get a data source job."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["dataSourceJobId"]}," The data source job to get."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request GET ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/data-sources/v2/data-source-jobs/{dataSourceJobId}' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-partition-id: header'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"," ","{"," ","\"id\": \"01JY6YFQ5F7MYPDM3TXCGG02N2\","," ","\"dataSourceId\": \"01JY6YVV4QPRH7W4TY64BXEDB6\","," ","\"dataSourceType\": \"price-forecast\","," ","\"dataSourceJobType\": \"Reprocess\","," ","\"dataSourceJobState\": \"Failed\","," ","\"dataSourceJobErrors\": ["," ","\"scenario 01EFY17N9ED84BV4CHPTDAXZK1 of study 01JY6FMJMY0F6AJFV05V831SB4 does not have any attached choices\","," ","\"scenario 1 of study 2 does not have any attached choices\""," ","]"," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"patch-a-data-source-job","__idx":5},"children":["Patch a data source job. ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"patch-a-data-source-job"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Apply a JSON Patch to a data source job. This is used by an external worker during a custom"," ","copy flow to replace the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dataProviders"]}," of a copy job before writing the target containers,"," ","so the new data source can use different sources in the context of its study. The job is"," ","identified by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dataSourceJobId"]}," (for example the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.id"]}," from a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["copy_transformation_required"]}," ","event)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["dataSourceJobId"]}," The data source job to patch."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["patches"]}," The JSON Patch operations to apply to the data source job, for example replacing its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dataProviders"]},"."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request PATCH ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/data-sources/v2/data-source-jobs/{dataSourceJobId}' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-partition-id: header' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--data '["," ","{"," ","\"op\": \"replace\","," ","\"path\": \"dataProviders\","," ","\"value\": {"," ","\"items\": ["," ","{"," ","\"name\": \"Base\","," ","\"sources\": ["," ","\"https://corp.commercials.data-agent.com/reference/01K0F086K8HD3SBMHQ1N0W6J2P/Base\""," ","]"," ","}"," ","]"," ","}"," ","}"," ","]'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"," ","{"," ","\"id\": \"01JY6YFQ5F7MYPDM3TXCGG02N2\","," ","\"dataSourceId\": \"01JY6YVV4QPRH7W4TY64BXEDB6\","," ","\"dataSourceType\": \"price-forecast\","," ","\"dataSourceJobType\": \"Reprocess\","," ","\"dataSourceJobState\": \"Failed\","," ","\"dataSourceJobErrors\": ["," ","\"scenario 01EFY17N9ED84BV4CHPTDAXZK1 of study 01JY6FMJMY0F6AJFV05V831SB4 does not have any attached choices\","," ","\"scenario 1 of study 2 does not have any attached choices\""," ","]"," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"create-a-new-data-source-reprocess-job","__idx":6},"children":["Create a new data source reprocess job ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"create-a-new-data-source-reprocess-job"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a new data source reprocess job to trigger the reprocessing of an existing data source."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["dataSourceReprocessJob"]}," The data source reprocessing job that needs to be triggered."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request POST ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/data-sources/v2/data-source-reprocess-jobs' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-partition-id: header' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--data '{"," ","\"id\": \"01JY6YVV4QPRH7W4TY64BXEDB6\","," ","\"version\": 1,"," ","\"dataProviders\": {"," ","\"items\": ["," ","{"," ","\"name\": \"Base\","," ","\"description\": \"Base price forecast deck\","," ","\"sources\": ["," ","\"https://corp.commercials.data-agent.com/reference/2fbcc17c7700258b/base\""," ","]"," ","},"," ","{"," ","\"name\": \"Stress\","," ","\"description\": \"Stress price forecast deck\","," ","\"sources\": ["," ","\"https://corp.commercials.data-agent.com/reference/2fbcc17c7700258b/stress\""," ","]"," ","}"," ","]"," ","}"," ","}'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 202"," ","{"," ","\"id\": \"01JY6YFQ5F7MYPDM3TXCGG02N2\""," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"set-state-of-data-source-job","__idx":7},"children":["Set state of data source job. ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"set-state-of-data-source-job"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set state of data source job given the data source job ID."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["dataSourceJobId"]}," The data source job id to set state."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["state"]}," The details of the data source job state to be set."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request POST ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/data-sources/v2/data-source-jobs/{dataSourceJobId}/state' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-partition-id: header' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--data '{"," ","\"state\": \"Failed\","," ","\"transformationErrors\": {"," ","\"items\": ["," ","{"," ","\"message\": \"scenario 01EFY17N9ED84BV4CHPTDAXZK1 of study 01JY6FMJMY0F6AJFV05V831SB4 does not have any attached choices\""," ","},"," ","{"," ","\"message\": \"scenario 1 of study 2 does not have any attached choices\""," ","}"," ","]"," ","}"," ","}'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"," ","{"," ","\"id\": \"01JY6YFQ5F7MYPDM3TXCGG02N2\","," ","\"dataSourceId\": \"01JY6YVV4QPRH7W4TY64BXEDB6\","," ","\"dataSourceType\": \"price-forecast\","," ","\"dataSourceJobType\": \"Reprocess\","," ","\"dataSourceJobState\": \"Failed\","," ","\"dataSourceJobErrors\": ["," ","\"scenario 01EFY17N9ED84BV4CHPTDAXZK1 of study 01JY6FMJMY0F6AJFV05V831SB4 does not have any attached choices\","," ","\"scenario 1 of study 2 does not have any attached choices\""," ","]"," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"create-a-new-workflow-input-data-source-job","__idx":8},"children":["Create a new workflow input data source job ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"create-a-new-workflow-input-data-source-job"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a new workflow input data source job to trigger the processing of a set of data provider sources"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["workflowInputDataSourceJob"]}," The workflow input data source processing job that needs to be triggered."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request POST ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/data-sources/v2/workflow-input-data-source-jobs' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-partition-id: header' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--data '{"," ","\"dataProviders\": {"," ","\"items\": ["," ","{"," ","\"name\": \"Base\","," ","\"nodeAddress\": \"0:2:0\","," ","\"sources\": ["," ","\"01JY6FMJMY0F6AJFV05V831SB4/files/production-forecast/01JE9MRE22QJH38W0QKF8VZ2DK/Field_Profile_Upside_Base.xlsx\""," ","],"," ","\"processAs\": {"," ","\"type\": \"ReferenceDataSource\","," ","\"value\": \"01JY6YVV4QPRH7W4TY64BXEDB6:v1\""," ","},"," ","\"description\": \"Production forecast deck\""," ","},"," ","{"," ","\"name\": \"Low\","," ","\"nodeAddress\": \"0:2:2\","," ","\"sources\": ["," ","\"https://corp.commercials.data-agent.com/reference/e92276ec41f84dfb/low\""," ","],"," ","\"description\": \"Low price forecast deck\""," ","},"," ","{"," ","\"name\": \"Base\","," ","\"nodeAddress\": \"0:2:2\","," ","\"sources\": ["," ","\"https://corp.commercials.data-agent.com/reference/e92276ec41f84dfb/base\""," ","],"," ","\"description\": \"Base price forecast deck\""," ","}"," ","]"," ","},"," ","\"tags\": ["," ","\"StudyId:01JY6FMJMY0F6AJFV05V831SB4\","," ","\"Iteration:Iteration1\","," ","\"Case:case1\""," ","],"," ","\"description\": \"Standalone economics sensitivity\","," ","\"name\": \"VS_price_sensitivity\""," ","}'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 202"," ","{"," ","\"id\": \"01JY6YFQ5F7MYPDM3TXCGG02N2\","," ","\"dataSourceId\": \"01JY6YVV4QPRH7W4TY64BXEDB6\","," ","\"dataSourceType\": \"price-forecast\","," ","\"dataSourceJobType\": \"Reprocess\","," ","\"dataSourceJobState\": \"Failed\","," ","\"dataSourceJobErrors\": ["," ","\"scenario 01EFY17N9ED84BV4CHPTDAXZK1 of study 01JY6FMJMY0F6AJFV05V831SB4 does not have any attached choices\","," ","\"scenario 1 of study 2 does not have any attached choices\""," ","]"," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"get-list-of-data-sources","__idx":9},"children":["Get list of data sources ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"get-list-of-data-sources"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get list of data sources."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["tags"]}," The tag(s) for data sources v2 to get, e.g. StudyId:ID. Multiple tags can be queried for by using a comma separated list of tags, e.g. StudyId:ID,SourceType:source-type. Only data sources whose tags match every one of the provided tags (AND logic) will be returned. StudyId (or VirtualScenarioStudyId) tag is required. A maximum of 5 tags is allowed."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request GET ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/data-sources/v2/data-sources?tags=value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-partition-id: header'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"," ","{"," ","\"items\": ["," ","{"," ","\"id\": \"01JY6YVV4QPRH7W4TY64BXEDB6\","," ","\"name\": \"Forecast Q2\","," ","\"description\": \"Example of transformation\","," ","\"tags\": ["," ","\"StudyId:01JY6FMJMY0F6AJFV05V831SB4\""," ","],"," ","\"version\": 1,"," ","\"source\": {"," ","\"type\": \"demo:data-types:planning-assumption-reference\","," ","\"store\": \"comm-store\""," ","},"," ","\"target\": {"," ","\"type\": \"price-forecast\""," ","},"," ","\"details\": {"," ","\"dataProviders\": {"," ","\"items\": ["," ","{"," ","\"name\": \"Base\","," ","\"description\": \"Base price forecast deck\","," ","\"sources\": ["," ","\"https://corp.commercials.data-agent.com/reference/2fbcc17c7700258b/base\""," ","]"," ","},"," ","{"," ","\"name\": \"Stress\","," ","\"description\": \"Stress price forecast deck\","," ","\"sources\": ["," ","\"https://corp.commercials.data-agent.com/reference/2fbcc17c7700258b/stress\""," ","]"," ","}"," ","]"," ","},"," ","\"containers\": ["," ","{"," ","\"path\": \"01JY6FMJMY0F6AJFV05V831SB4/containers/price-forecast/01JY6YFRF2QEVQYNGB3N31SWD5\","," ","\"type\": \"price-forecast\","," ","\"version\": 1,"," ","\"store\": \"fdplan\","," ","\"description\": \"Price forecast for Robin field\","," ","\"labels\": {"," ","\"name\": \"Base\""," ","}"," ","},"," ","{"," ","\"path\": \"01JY6FMJMY0F6AJFV05V831SB4/containers/price-forecast/01JY6YFRF2TN0YKRF3NQYZJBVF\","," ","\"type\": \"price-forecast\","," ","\"version\": 1,"," ","\"store\": \"fdplan\","," ","\"description\": \"Price forecast for Robin field\","," ","\"labels\": {"," ","\"name\": \"Stress\""," ","}"," ","}"," ","]"," ","},"," ","\"lastUpdated\": {"," ","\"atDate\": \"2025-06-20T15:21:09.000Z\","," ","\"byEvent\": \"9510b57e-835e-9eb0-b544-407aa857226a\","," ","\"byUser\": \"user@example.com\""," ","}"," ","}"," ","]"," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"get-a-data-source","__idx":10},"children":["Get a data source ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"get-a-data-source"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get a data source given a data source ID."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["dataSourceId"]}," The data source v2 to get."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["version"]}," The version of data source v2 to get."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request GET ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/data-sources/v2/data-sources/{dataSourceId}' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-partition-id: header'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"," ","{"," ","\"id\": \"01JY6YVV4QPRH7W4TY64BXEDB6\","," ","\"name\": \"Forecast Q2\","," ","\"description\": \"Example of transformation\","," ","\"tags\": ["," ","\"StudyId:01JY6FMJMY0F6AJFV05V831SB4\""," ","],"," ","\"version\": 1,"," ","\"source\": {"," ","\"type\": \"demo:data-types:planning-assumption-reference\","," ","\"store\": \"comm-store\""," ","},"," ","\"target\": {"," ","\"type\": \"price-forecast\""," ","},"," ","\"details\": {"," ","\"dataProviders\": {"," ","\"items\": ["," ","{"," ","\"name\": \"Base\","," ","\"description\": \"Base price forecast deck\","," ","\"sources\": ["," ","\"https://corp.commercials.data-agent.com/reference/2fbcc17c7700258b/base\""," ","]"," ","},"," ","{"," ","\"name\": \"Stress\","," ","\"description\": \"Stress price forecast deck\","," ","\"sources\": ["," ","\"https://corp.commercials.data-agent.com/reference/2fbcc17c7700258b/stress\""," ","]"," ","}"," ","]"," ","},"," ","\"containers\": ["," ","{"," ","\"path\": \"01JY6FMJMY0F6AJFV05V831SB4/containers/price-forecast/01JY6YFRF2QEVQYNGB3N31SWD5\","," ","\"type\": \"price-forecast\","," ","\"version\": 1,"," ","\"store\": \"fdplan\","," ","\"description\": \"Price forecast for Robin field\","," ","\"labels\": {"," ","\"name\": \"Base\""," ","}"," ","},"," ","{"," ","\"path\": \"01JY6FMJMY0F6AJFV05V831SB4/containers/price-forecast/01JY6YFRF2TN0YKRF3NQYZJBVF\","," ","\"type\": \"price-forecast\","," ","\"version\": 1,"," ","\"store\": \"fdplan\","," ","\"description\": \"Price forecast for Robin field\","," ","\"labels\": {"," ","\"name\": \"Stress\""," ","}"," ","}"," ","]"," ","},"," ","\"lastUpdated\": {"," ","\"atDate\": \"2025-06-20T15:21:09.000Z\","," ","\"byEvent\": \"9510b57e-835e-9eb0-b544-407aa857226a\","," ","\"byUser\": \"user@example.com\""," ","}"," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"delete-a-data-source","__idx":11},"children":["Delete a data source. ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"delete-a-data-source"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Delete a data source."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["dataSourceId"]}," The data source to delete."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request DELETE ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/data-sources/v2/data-sources/{dataSourceId}' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-partition-id: header'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 204"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"get-list-of-data-source-types-for-a-given-target","__idx":12},"children":["Get list of data source types for a given target. ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"get-list-of-data-source-types-for-a-given-target"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get list of data source types for a given target."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["target"]}," The data type (target) to get data source types."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request GET ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/data-sources/v2/data-source-types' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-partition-id: header'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"," ","{"," ","\"items\": ["," ","{"," ","\"id\": \"production-forecast-fdplan-workbook:fdplan\","," ","\"editors\": ["," ","{"," ","\"editorURL\": \"\","," ","\"name\": \"fdplan-file-selector\","," ","\"type\": \"Both\""," ","}"," ","],"," ","\"isSystem\": true,"," ","\"source\": {"," ","\"store\": \"fdplan\","," ","\"type\": \"production-forecast-fdplan-workbook\""," ","},"," ","\"targets\": ["," ","\"production-forecast\""," ","],"," ","\"copyProvider\": {"," ","\"name\": \"system\""," ","},"," ","\"transformationProvider\": {"," ","\"name\": \"system\""," ","},"," ","\"viewers\": ["," ","]"," ","}"," ","]"," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"create-new-data-source-type","__idx":13},"children":["Create new data source type. ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"create-new-data-source-type"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create new data source type."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["createDataSourceType"]}," The data source type that needs to be created."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request POST ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/data-sources/v2/data-source-types' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-partition-id: header' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--data '{"," ","\"source\": {"," ","\"store\": \"fdplan\","," ","\"type\": \"production-forecast-fdplan-workbook\""," ","},"," ","\"targets\": ["," ","\"production-forecast\""," ","]"," ","}'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"," ","{"," ","\"id\": \"production-forecast-fdplan-workbook:fdplan\","," ","\"editors\": ["," ","{"," ","\"editorURL\": \"\","," ","\"name\": \"fdplan-file-selector\","," ","\"type\": \"Both\""," ","}"," ","],"," ","\"isSystem\": true,"," ","\"source\": {"," ","\"store\": \"fdplan\","," ","\"type\": \"production-forecast-fdplan-workbook\""," ","},"," ","\"targets\": ["," ","\"production-forecast\""," ","],"," ","\"copyProvider\": {"," ","\"name\": \"system\""," ","},"," ","\"transformationProvider\": {"," ","\"name\": \"system\""," ","},"," ","\"viewers\": ["," ","]"," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"get-a-data-source-type-by-id","__idx":14},"children":["Get a data source type by ID. ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"get-a-data-source-type-by-id"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get a data source type by ID."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["dataSourceTypeId"]}," The data source type id to get."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request GET ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/data-sources/v2/data-source-types/{dataSourceTypeId}' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-partition-id: header'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"," ","{"," ","\"id\": \"production-forecast-fdplan-workbook:fdplan\","," ","\"editors\": ["," ","{"," ","\"editorURL\": \"\","," ","\"name\": \"fdplan-file-selector\","," ","\"type\": \"Both\""," ","}"," ","],"," ","\"isSystem\": true,"," ","\"source\": {"," ","\"store\": \"fdplan\","," ","\"type\": \"production-forecast-fdplan-workbook\""," ","},"," ","\"targets\": ["," ","\"production-forecast\""," ","],"," ","\"copyProvider\": {"," ","\"name\": \"system\""," ","},"," ","\"transformationProvider\": {"," ","\"name\": \"system\""," ","},"," ","\"viewers\": ["," ","]"," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"update-a-data-source-type","__idx":15},"children":["Update a data source type. ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"update-a-data-source-type"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Update a data source type."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["dataSourceTypeId"]}," The data source type id to update."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["patch"]}," The update to apply to the given data source type id."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request PATCH ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/data-sources/v2/data-source-types/{dataSourceTypeId}' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-partition-id: header' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--data '{"," ","\"targets\": ["," ","\"production-forecast\""," ","]"," ","}'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"," ","{"," ","\"id\": \"production-forecast-fdplan-workbook:fdplan\","," ","\"editors\": ["," ","{"," ","\"editorURL\": \"\","," ","\"name\": \"fdplan-file-selector\","," ","\"type\": \"Both\""," ","}"," ","],"," ","\"isSystem\": true,"," ","\"source\": {"," ","\"store\": \"fdplan\","," ","\"type\": \"production-forecast-fdplan-workbook\""," ","},"," ","\"targets\": ["," ","\"production-forecast\""," ","],"," ","\"copyProvider\": {"," ","\"name\": \"system\""," ","},"," ","\"transformationProvider\": {"," ","\"name\": \"system\""," ","},"," ","\"viewers\": ["," ","]"," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]}]},"headings":[{"value":"Data Sources","id":"data-sources","depth":1},{"value":"Client ID","id":"client-id","depth":2},{"value":"Table of contents","id":"table-of-contents","depth":1},{"value":"Create a new data source job","id":"create-a-new-data-source-job","depth":1},{"value":"Get a data source job.","id":"get-a-data-source-job","depth":1},{"value":"Patch a data source job.","id":"patch-a-data-source-job","depth":1},{"value":"Create a new data source reprocess job","id":"create-a-new-data-source-reprocess-job","depth":1},{"value":"Set state of data source job.","id":"set-state-of-data-source-job","depth":1},{"value":"Create a new workflow input data source job","id":"create-a-new-workflow-input-data-source-job","depth":1},{"value":"Get list of data sources","id":"get-list-of-data-sources","depth":1},{"value":"Get a data source","id":"get-a-data-source","depth":1},{"value":"Delete a data source.","id":"delete-a-data-source","depth":1},{"value":"Get list of data source types for a given target.","id":"get-list-of-data-source-types-for-a-given-target","depth":1},{"value":"Create new data source type.","id":"create-new-data-source-type","depth":1},{"value":"Get a data source type by ID.","id":"get-a-data-source-type-by-id","depth":1},{"value":"Update a data source type.","id":"update-a-data-source-type","depth":1}],"frontmatter":{"seo":{"title":"Data Sources"}},"lastModified":"2026-09-28T14:56:40.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/fdplan/tutorial/data-sources-openapi_nam","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}