{"items":[{"type":"link","label":"Data Sources","link":"/solutions/fdplan/apis/fdplan-data-sources","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources","content":{"contentType":"overview","meta":{"name":"Data Sources"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"Data Sources Spec","url":"https://developer.slb.com/fdplan/FDPlan-Data-Sources.yaml"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://customersupport.digital.slb.com","url":"https://customersupport.digital.slb.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Data Sources (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"fence","attributes":{"content":"prod-nam-services-fdplan.slbservice.com\nprod-eu-services-fdplan.slbservice.com\nprod-au-services-fdplan.slbservice.com\nprod-id-services-fdplan.slbservice.com\nproduction-services-fdplan.slbservice.com\n","language":"plain","title":"Client ID"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"prod-nam-services-fdplan.slbservice.com\nprod-eu-services-fdplan.slbservice.com\nprod-au-services-fdplan.slbservice.com\nprod-id-services-fdplan.slbservice.com\nproduction-services-fdplan.slbservice.com\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data sources API is responsible for managing data sources in FDPlan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data source"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a versioned input bundle consumed by scenario evaluations. It pairs a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user-facing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (a registered data type and its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"store"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") with one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data type"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"understood by computations, and is discovered and reused across scenarios through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(usually "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StudyId:id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data sources are never created directly. Every data source is produced by an asynchronous"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data source job"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the caller posts the inputs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataProviders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the platform runs the transformation declared on the matching "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data source type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"background. A data source type is the reusable conversion contract between a domain-native input"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"format and one or more evaluation-ready data types, and also declares the editors, viewers, and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transformation/copy providers used to author and process the data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key resources:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data-source-types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - register and manage the conversion contracts (source/target, editors,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"viewers, providers)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data-source-jobs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - create, reprocess, poll, and complete the asynchronous work that builds"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a data source. External transformers report completion via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".../{id}/state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workflow-input-data-source-jobs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - build all workflow input data sources of a study at once"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to create virtual scenarios."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data-sources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - read a given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", list by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and delete."},"children":[]}]}]}]}]}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"group","label":"Data Source Job V2","link":"/solutions/fdplan/apis/fdplan-data-sources/data-source-job-v2","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/data-source-job-v2","items":[{"label":"Create a new data source job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-data-sources/data-source-job-v2/postdatasourcejobv2","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/data-source-job-v2/postdatasourcejobv2","metadata":{"seo":{"title":"Create a new data source job","description":"Create a new data source job to trigger the processing of a set of data provider sources"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postDataSourceJobV2","name":"Create a new data source job","isWebhook":false,"pointer":"/paths/~1v2~1data-source-jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new data source job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new data source job to trigger the processing of a set of data provider sources"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_0","description":"Data partition id.","required":true}],"pointer":"/paths/~1v2~1data-source-jobs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateDataSourceJobV2Params"}},"schemaId":"components/schemas/CreateDataSourceJobV2Params","pointer":"/paths/~1v2~1data-source-jobs/post/requestBody","description":"The data source processing job that needs to be triggered."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/data-source-jobs","servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateDataSourceJobV2Params"}},"responseCodes":["202","400","401","451","default"],"pointer":"/v2/data-source-jobs","href":"data-source-job-v2/postdatasourcejobv2","openApiOperationId":"postDataSourceJobV2","summary":"Create a new data source job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateDataSourceJobV2Params","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateDataSourceJobV2Params"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Data source job successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceJobV2"}},"schemaId":"components/schemas/DataSourceJobV2"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"Unavailable for legal reasons.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v2~1data-source-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/DataSourceJobV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceJobV2"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"451","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-source-job-v2/postdatasourcejobv2"}],"panels":[]}]},"httpPath":"/v2/data-source-jobs"},{"label":"Get a data source job.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-data-sources/data-source-job-v2/getdatasourcejobv2","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/data-source-job-v2/getdatasourcejobv2","metadata":{"seo":{"title":"Get a data source job.","description":"Get a data source job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDataSourceJobV2","name":"Get a data source job.","isWebhook":false,"pointer":"/paths/~1v2~1data-source-jobs~1{dataSourceJobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a data source job.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a data source job."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dataSourceJobId","in":"path","schemaId":"schema_0","description":"The data source job to get.","required":true}],"pointer":"/paths/~1v2~1data-source-jobs~1{dataSourceJobId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_0","description":"Data partition id.","required":true}],"pointer":"/paths/~1v2~1data-source-jobs~1{dataSourceJobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/data-source-jobs/{dataSourceJobId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"dataSourceJobId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","451","default"],"pointer":"/v2/data-source-jobs/{dataSourceJobId}","href":"data-source-job-v2/getdatasourcejobv2","openApiOperationId":"getDataSourceJobV2","summary":"Get a data source job."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceJobV2"}},"schemaId":"components/schemas/DataSourceJobV2"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The data source job was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"Unavailable for legal reasons","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v2~1data-source-jobs~1{dataSourceJobId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataSourceJobV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceJobV2"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"451","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-source-job-v2/getdatasourcejobv2"}],"panels":[]}]},"httpPath":"/v2/data-source-jobs/{dataSourceJobId}"},{"label":"Patch a data source job.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-data-sources/data-source-job-v2/patchdatasourcejobv2","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/data-source-job-v2/patchdatasourcejobv2","metadata":{"seo":{"title":"Patch a data source job.","description":"Apply a JSON Patch to a data source job. This is used by an external worker during a customcopy flow to replace the 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 isidentified by dataSourceJobId (for example the data.id from a copy_transformation_requiredevent)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchDataSourceJobV2","name":"Patch a data source job.","isWebhook":false,"pointer":"/paths/~1v2~1data-source-jobs~1{dataSourceJobId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch a data source job.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply a JSON Patch to a data source job. This is used by an external worker during a custom"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"copy flow to replace the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataProviders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a copy job before writing the target containers,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"so the new data source can use different sources in the context of its study. The job is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataSourceJobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"copy_transformation_required"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"event)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dataSourceJobId","in":"path","schemaId":"schema_0","description":"The data source job to patch.","required":true}],"pointer":"/paths/~1v2~1data-source-jobs~1{dataSourceJobId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_0","description":"Data partition id.","required":true}],"pointer":"/paths/~1v2~1data-source-jobs~1{dataSourceJobId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchReq"}},"schemaId":"components/schemas/PatchReq","pointer":"/paths/~1v2~1data-source-jobs~1{dataSourceJobId}/patch/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The JSON Patch operations to apply to the data source job, for example replacing its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataProviders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v2/data-source-jobs/{dataSourceJobId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"dataSourceJobId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchReq"}},"responseCodes":["200","400","401","404","451","503","default"],"pointer":"/v2/data-source-jobs/{dataSourceJobId}","href":"data-source-job-v2/patchdatasourcejobv2","openApiOperationId":"patchDataSourceJobV2","summary":"Patch a data source job."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/PatchReq","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchReq"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceJobV2"}},"schemaId":"components/schemas/DataSourceJobV2"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The data source job was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"Unavailable for legal reasons","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service Unavailable"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v2~1data-source-jobs~1{dataSourceJobId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataSourceJobV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceJobV2"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"451","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-source-job-v2/patchdatasourcejobv2"}],"panels":[]}]},"httpPath":"/v2/data-source-jobs/{dataSourceJobId}"},{"label":"Set state of data source job.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-data-sources/data-source-job-v2/postdatasourcejobstatev2","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/data-source-job-v2/postdatasourcejobstatev2","metadata":{"seo":{"title":"Set state of data source job.","description":"Set state of data source job given the data source job ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postDataSourceJobStateV2","name":"Set state of data source job.","isWebhook":false,"pointer":"/paths/~1v2~1data-source-jobs~1{dataSourceJobId}~1state/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set state of data source job.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Set state of data source job given the data source job ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dataSourceJobId","in":"path","schemaId":"schema_0","description":"The data source job id to set state.","required":true}],"pointer":"/paths/~1v2~1data-source-jobs~1{dataSourceJobId}~1state/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_0","description":"Data partition id.","required":true}],"pointer":"/paths/~1v2~1data-source-jobs~1{dataSourceJobId}~1state/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SetDataSourceJobState"}},"schemaId":"components/schemas/SetDataSourceJobState","pointer":"/paths/~1v2~1data-source-jobs~1{dataSourceJobId}~1state/post/requestBody","description":"The details of the data source job state to be set."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/data-source-jobs/{dataSourceJobId}/state","servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"dataSourceJobId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SetDataSourceJobState"}},"responseCodes":["200","400","401","404","451","default"],"pointer":"/v2/data-source-jobs/{dataSourceJobId}/state","href":"data-source-job-v2/postdatasourcejobstatev2","openApiOperationId":"postDataSourceJobStateV2","summary":"Set state of data source job."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/SetDataSourceJobState","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SetDataSourceJobState"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The data source job state was updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceJobV2"}},"schemaId":"components/schemas/DataSourceJobV2"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The data source job was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"Unavailable for legal reasons","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v2~1data-source-jobs~1{dataSourceJobId}~1state/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataSourceJobV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceJobV2"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"451","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-source-job-v2/postdatasourcejobstatev2"}],"panels":[]}]},"httpPath":"/v2/data-source-jobs/{dataSourceJobId}/state"},{"label":"Create a new workflow input data source job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-data-sources/data-source-job-v2/postworkflowinputdatasourcejobv2","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/data-source-job-v2/postworkflowinputdatasourcejobv2","metadata":{"seo":{"title":"Create a new workflow input data source job","description":"Create a new workflow input data source job to trigger the processing of a set of data provider sources"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postWorkflowInputDataSourceJobV2","name":"Create a new workflow input data source job","isWebhook":false,"pointer":"/paths/~1v2~1workflow-input-data-source-jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new workflow input data source job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new workflow input data source job to trigger the processing of a set of data provider sources"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_0","description":"Data partition id.","required":true}],"pointer":"/paths/~1v2~1workflow-input-data-source-jobs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWorkflowInputDataSourceJobV2Params"}},"schemaId":"components/schemas/CreateWorkflowInputDataSourceJobV2Params","pointer":"/paths/~1v2~1workflow-input-data-source-jobs/post/requestBody","description":"The workflow input data source processing job that needs to be triggered."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/workflow-input-data-source-jobs","servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateWorkflowInputDataSourceJobV2Params"}},"responseCodes":["202","400","401","451","default"],"pointer":"/v2/workflow-input-data-source-jobs","href":"data-source-job-v2/postworkflowinputdatasourcejobv2","openApiOperationId":"postWorkflowInputDataSourceJobV2","summary":"Create a new workflow input data source job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateWorkflowInputDataSourceJobV2Params","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWorkflowInputDataSourceJobV2Params"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Data source job successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceJobV2"}},"schemaId":"components/schemas/DataSourceJobV2"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"Unavailable for legal reasons.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v2~1workflow-input-data-source-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/DataSourceJobV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceJobV2"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"451","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-source-job-v2/postworkflowinputdatasourcejobv2"}],"panels":[]}]},"httpPath":"/v2/workflow-input-data-source-jobs"}],"content":{"contentType":"group","meta":{"name":"Data Source Job V2"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Source Job V2","showPageActions":true},{"nodeType":"markdoc","content":"Managing data source jobs."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/data-source-jobs","summary":"Create a new data source job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-source-job-v2/postdatasourcejobv2","deprecated":false},{"title":"/v2/data-source-jobs/{dataSourceJobId}","summary":"Get a data source job.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-source-job-v2/getdatasourcejobv2","deprecated":false},{"title":"/v2/data-source-jobs/{dataSourceJobId}","summary":"Patch a data source job.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/data-source-job-v2/patchdatasourcejobv2","deprecated":false},{"title":"/v2/data-source-jobs/{dataSourceJobId}/state","summary":"Set state of data source job.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-source-job-v2/postdatasourcejobstatev2","deprecated":false},{"title":"/v2/workflow-input-data-source-jobs","summary":"Create a new workflow input data source job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-source-job-v2/postworkflowinputdatasourcejobv2","deprecated":false}]}]}]}]}},{"type":"group","label":"Data Source Reprocess Job V2","link":"/solutions/fdplan/apis/fdplan-data-sources/data-source-reprocess-job-v2","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/data-source-reprocess-job-v2","items":[{"label":"Create a new data source reprocess job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-data-sources/data-source-reprocess-job-v2/postdatasourcereprocessjobsv2","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/data-source-reprocess-job-v2/postdatasourcereprocessjobsv2","metadata":{"seo":{"title":"Create a new data source reprocess job","description":"Create a new data source reprocess job to trigger the reprocessing of an existing data source."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postDataSourceReprocessJobsV2","name":"Create a new data source reprocess job","isWebhook":false,"pointer":"/paths/~1v2~1data-source-reprocess-jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new data source reprocess job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new data source reprocess job to trigger the reprocessing of an existing data source."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_0","description":"Data partition id.","required":true}],"pointer":"/paths/~1v2~1data-source-reprocess-jobs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReprocessDataSourceJobV2Params"}},"schemaId":"components/schemas/ReprocessDataSourceJobV2Params","pointer":"/paths/~1v2~1data-source-reprocess-jobs/post/requestBody","description":"The data source reprocessing job that needs to be triggered."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/data-source-reprocess-jobs","servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReprocessDataSourceJobV2Params"}},"responseCodes":["202","400","401","451","default"],"pointer":"/v2/data-source-reprocess-jobs","href":"data-source-reprocess-job-v2/postdatasourcereprocessjobsv2","openApiOperationId":"postDataSourceReprocessJobsV2","summary":"Create a new data source reprocess job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ReprocessDataSourceJobV2Params","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReprocessDataSourceJobV2Params"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Data source reprocessing job successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceReprocessJobV2"}},"schemaId":"components/schemas/DataSourceReprocessJobV2"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"Unavailable for legal reasons.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v2~1data-source-reprocess-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/DataSourceReprocessJobV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceReprocessJobV2"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"451","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-source-reprocess-job-v2/postdatasourcereprocessjobsv2"}],"panels":[]}]},"httpPath":"/v2/data-source-reprocess-jobs"}],"content":{"contentType":"group","meta":{"name":"Data Source Reprocess Job V2"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Source Reprocess Job V2","showPageActions":true},{"nodeType":"markdoc","content":"Managing data source reprocessing jobs."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/data-source-reprocess-jobs","summary":"Create a new data source reprocess job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-source-reprocess-job-v2/postdatasourcereprocessjobsv2","deprecated":false}]}]}]}]}},{"type":"group","label":"Data Source V2","link":"/solutions/fdplan/apis/fdplan-data-sources/data-source-v2","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/data-source-v2","items":[{"label":"Get list of data sources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-data-sources/data-source-v2/getdatasourcesv2","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/data-source-v2/getdatasourcesv2","metadata":{"seo":{"title":"Get list of data sources","description":"Get list of data sources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDataSourcesV2","name":"Get list of data sources","isWebhook":false,"pointer":"/paths/~1v2~1data-sources/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of data sources","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get list of data sources."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"tags","in":"query","schemaId":"schema_1","description":"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.","required":true}],"pointer":"/paths/~1v2~1data-sources/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_0","description":"Data partition id.","required":true}],"pointer":"/paths/~1v2~1data-sources/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/data-sources","servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"tags","in":"query","required":true,"schemaId":"schema_1"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","204","400","401","451","default"],"pointer":"/v2/data-sources","href":"data-source-v2/getdatasourcesv2","openApiOperationId":"getDataSourcesV2","summary":"Get list of data sources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Retrieved data sources v2 successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourcesV2"}},"schemaId":"components/schemas/DataSourcesV2"},{"code":"204","description":"No data source v2 found for supplied tags."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"Unavailable for legal reasons.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v2~1data-sources/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataSourcesV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourcesV2"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"451","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-source-v2/getdatasourcesv2"}],"panels":[]}]},"httpPath":"/v2/data-sources"},{"label":"Get a data source","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-data-sources/data-source-v2/getdatasourcev2","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/data-source-v2/getdatasourcev2","metadata":{"seo":{"title":"Get a data source","description":"Get a data source given a data source ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDataSourceV2","name":"Get a data source","isWebhook":false,"pointer":"/paths/~1v2~1data-sources~1{dataSourceId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a data source","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a data source given a data source ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dataSourceId","in":"path","schemaId":"schema_0","description":"The data source v2 to get.","required":true}],"pointer":"/paths/~1v2~1data-sources~1{dataSourceId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_2","description":"The version of data source v2 to get."}],"pointer":"/paths/~1v2~1data-sources~1{dataSourceId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_0","description":"Data partition id.","required":true}],"pointer":"/paths/~1v2~1data-sources~1{dataSourceId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/data-sources/{dataSourceId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"dataSourceId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"version","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","451","default"],"pointer":"/v2/data-sources/{dataSourceId}","href":"data-source-v2/getdatasourcev2","openApiOperationId":"getDataSourceV2","summary":"Get a data source"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Retrieved data source v2 successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceV2"}},"schemaId":"components/schemas/DataSourceV2"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The data source v2 was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"Unavailable for legal reasons.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v2~1data-sources~1{dataSourceId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataSourceV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceV2"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"451","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-source-v2/getdatasourcev2"}],"panels":[]}]},"httpPath":"/v2/data-sources/{dataSourceId}"},{"label":"Delete a data source.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-data-sources/data-source-v2/deletedatasourcev2","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/data-source-v2/deletedatasourcev2","metadata":{"seo":{"title":"Delete a data source.","description":"Delete a data source."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDataSourceV2","name":"Delete a data source.","isWebhook":false,"pointer":"/paths/~1v2~1data-sources~1{dataSourceId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a data source.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a data source."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dataSourceId","in":"path","schemaId":"schema_0","description":"The data source to delete.","required":true}],"pointer":"/paths/~1v2~1data-sources~1{dataSourceId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_0","description":"Data partition id.","required":true}],"pointer":"/paths/~1v2~1data-sources~1{dataSourceId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/data-sources/{dataSourceId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"dataSourceId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","404","451","default"],"pointer":"/v2/data-sources/{dataSourceId}","href":"data-source-v2/deletedatasourcev2","openApiOperationId":"deleteDataSourceV2","summary":"Delete a data source."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success."},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The data source was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"Unavailable for legal reasons","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v2~1data-sources~1{dataSourceId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"451","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-source-v2/deletedatasourcev2"}],"panels":[]}]},"httpPath":"/v2/data-sources/{dataSourceId}"}],"content":{"contentType":"group","meta":{"name":"Data Source V2"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Source V2","showPageActions":true},{"nodeType":"markdoc","content":"Managing data sources."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/data-sources","summary":"Get list of data sources","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-source-v2/getdatasourcesv2","deprecated":false},{"title":"/v2/data-sources/{dataSourceId}","summary":"Get a data source","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-source-v2/getdatasourcev2","deprecated":false},{"title":"/v2/data-sources/{dataSourceId}","summary":"Delete a data source.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/data-source-v2/deletedatasourcev2","deprecated":false}]}]}]}]}},{"type":"group","label":"Data Source Types V2","link":"/solutions/fdplan/apis/fdplan-data-sources/data-source-types-v2","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/data-source-types-v2","items":[{"label":"Get list of data source types for a given target.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-data-sources/data-source-types-v2/getdatasourcetypes","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/data-source-types-v2/getdatasourcetypes","metadata":{"seo":{"title":"Get list of data source types for a given target.","description":"Get list of data source types for a given target."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDataSourceTypes","name":"Get list of data source types for a given target.","isWebhook":false,"pointer":"/paths/~1v2~1data-source-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of data source types for a given target.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get list of data source types for a given target."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"target","in":"query","schemaId":"schema_0","description":"The data type (target) to get data source types."}],"pointer":"/paths/~1v2~1data-source-types/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_0","description":"Data partition id.","required":true}],"pointer":"/paths/~1v2~1data-source-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/data-source-types","servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"target","in":"query","schemaId":"schema_0"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","204","400","401","default"],"pointer":"/v2/data-source-types","href":"data-source-types-v2/getdatasourcetypes","openApiOperationId":"getDataSourceTypes","summary":"Get list of data source types for a given target."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceTypes"}},"schemaId":"components/schemas/DataSourceTypes"},{"code":"204","description":"No data source types for given target exist."},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v2~1data-source-types/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataSourceTypes","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceTypes"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-source-types-v2/getdatasourcetypes"}],"panels":[]}]},"httpPath":"/v2/data-source-types"},{"label":"Create new data source type.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-data-sources/data-source-types-v2/postdatasourcetype","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/data-source-types-v2/postdatasourcetype","metadata":{"seo":{"title":"Create new data source type.","description":"Create new data source type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postDataSourceType","name":"Create new data source type.","isWebhook":false,"pointer":"/paths/~1v2~1data-source-types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create new data source type.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create new data source type."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_0","description":"Data partition id.","required":true}],"pointer":"/paths/~1v2~1data-source-types/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateDataSourceType"}},"schemaId":"components/schemas/CreateDataSourceType","pointer":"/paths/~1v2~1data-source-types/post/requestBody","description":"The data source type that needs to be created."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/data-source-types","servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateDataSourceType"}},"responseCodes":["200","400","401","409","default"],"pointer":"/v2/data-source-types","href":"data-source-types-v2/postdatasourcetype","openApiOperationId":"postDataSourceType","summary":"Create new data source type."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateDataSourceType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateDataSourceType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Data source type created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceType"}},"schemaId":"components/schemas/DataSourceType"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v2~1data-source-types/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataSourceType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceType"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-source-types-v2/postdatasourcetype"}],"panels":[]}]},"httpPath":"/v2/data-source-types"},{"label":"Get a data source type by ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-data-sources/data-source-types-v2/getdatasourcetype","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/data-source-types-v2/getdatasourcetype","metadata":{"seo":{"title":"Get a data source type by ID.","description":"Get a data source type by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDataSourceType","name":"Get a data source type by ID.","isWebhook":false,"pointer":"/paths/~1v2~1data-source-types~1{dataSourceTypeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a data source type by ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a data source type by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dataSourceTypeId","in":"path","schemaId":"schema_0","description":"The data source type id to get.","required":true}],"pointer":"/paths/~1v2~1data-source-types~1{dataSourceTypeId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_0","description":"Data partition id.","required":true}],"pointer":"/paths/~1v2~1data-source-types~1{dataSourceTypeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/data-source-types/{dataSourceTypeId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"dataSourceTypeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","default"],"pointer":"/v2/data-source-types/{dataSourceTypeId}","href":"data-source-types-v2/getdatasourcetype","openApiOperationId":"getDataSourceType","summary":"Get a data source type by ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceType"}},"schemaId":"components/schemas/DataSourceType"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The data source type was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v2~1data-source-types~1{dataSourceTypeId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataSourceType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceType"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-source-types-v2/getdatasourcetype"}],"panels":[]}]},"httpPath":"/v2/data-source-types/{dataSourceTypeId}"},{"label":"Update a data source type.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-data-sources/data-source-types-v2/patchdatasourcetype","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/data-source-types-v2/patchdatasourcetype","metadata":{"seo":{"title":"Update a data source type.","description":"Update a data source type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchDataSourceType","name":"Update a data source type.","isWebhook":false,"pointer":"/paths/~1v2~1data-source-types~1{dataSourceTypeId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a data source type.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a data source type."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dataSourceTypeId","in":"path","schemaId":"schema_0","description":"The data source type id to update.","required":true}],"pointer":"/paths/~1v2~1data-source-types~1{dataSourceTypeId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_0","description":"Data partition id.","required":true}],"pointer":"/paths/~1v2~1data-source-types~1{dataSourceTypeId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateDataSourceType"}},"schemaId":"components/schemas/UpdateDataSourceType","pointer":"/paths/~1v2~1data-source-types~1{dataSourceTypeId}/patch/requestBody","description":"The update to apply to the given data source type id."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v2/data-source-types/{dataSourceTypeId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"dataSourceTypeId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateDataSourceType"}},"responseCodes":["200","400","401","404","default"],"pointer":"/v2/data-source-types/{dataSourceTypeId}","href":"data-source-types-v2/patchdatasourcetype","openApiOperationId":"patchDataSourceType","summary":"Update a data source type."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/UpdateDataSourceType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateDataSourceType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The data source type was updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceType"}},"schemaId":"components/schemas/DataSourceType"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The data source type was not updated, because not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v2~1data-source-types~1{dataSourceTypeId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataSourceType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceType"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-source-types-v2/patchdatasourcetype"}],"panels":[]}]},"httpPath":"/v2/data-source-types/{dataSourceTypeId}"}],"content":{"contentType":"group","meta":{"name":"Data Source Types V2"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Source Types V2","showPageActions":true},{"nodeType":"markdoc","content":"Managing data source types."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/data-source-types","summary":"Get list of data source types for a given target.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-source-types-v2/getdatasourcetypes","deprecated":false},{"title":"/v2/data-source-types","summary":"Create new data source type.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-source-types-v2/postdatasourcetype","deprecated":false},{"title":"/v2/data-source-types/{dataSourceTypeId}","summary":"Get a data source type by ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-source-types-v2/getdatasourcetype","deprecated":false},{"title":"/v2/data-source-types/{dataSourceTypeId}","summary":"Update a data source type.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/data-source-types-v2/patchdatasourcetype","deprecated":false}]}]}]}]}},{"type":"group","label":"Schema Definitions","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions","items":[{"type":"link","label":"Error","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/error","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/error","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Error"},"seo":{"title":"Error"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Error","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Error"},"children":[]}]}]}},{"type":"link","label":"Container","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/container","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/container","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Container"},"seo":{"title":"Container"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Container","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Container"},"children":[]}]}]}},{"type":"link","label":"LastUpdated","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/lastupdated","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/lastupdated","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"LastUpdated"},"seo":{"title":"LastUpdated"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"LastUpdated","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/LastUpdated"},"children":[]}]}]}},{"type":"link","label":"CorrelationId","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/correlationid","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/correlationid","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CorrelationId"},"seo":{"title":"CorrelationId"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CorrelationId","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CorrelationId"},"children":[]}]}]}},{"type":"link","label":"DataSourceType","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/datasourcetype","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/datasourcetype","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"DataSourceType"},"seo":{"title":"DataSourceType"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DataSourceType","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/DataSourceType"},"children":[]}]}]}},{"type":"link","label":"DataSourceTypes","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/datasourcetypes","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/datasourcetypes","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"DataSourceTypes"},"seo":{"title":"DataSourceTypes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DataSourceTypes","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/DataSourceTypes"},"children":[]}]}]}},{"type":"link","label":"CreateDataSourceType","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/createdatasourcetype","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/createdatasourcetype","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateDataSourceType"},"seo":{"title":"CreateDataSourceType"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateDataSourceType","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateDataSourceType"},"children":[]}]}]}},{"type":"link","label":"UpdateDataSourceType","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/updatedatasourcetype","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/updatedatasourcetype","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"UpdateDataSourceType"},"seo":{"title":"UpdateDataSourceType"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"UpdateDataSourceType","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/UpdateDataSourceType"},"children":[]}]}]}},{"type":"link","label":"DataSourceJobV2","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/datasourcejobv2","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/datasourcejobv2","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"DataSourceJobV2"},"seo":{"title":"DataSourceJobV2"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DataSourceJobV2","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/DataSourceJobV2"},"children":[]}]}]}},{"type":"link","label":"CreateDataSourceJobV2Params","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/createdatasourcejobv2params","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/createdatasourcejobv2params","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateDataSourceJobV2Params"},"seo":{"title":"CreateDataSourceJobV2Params"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateDataSourceJobV2Params","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateDataSourceJobV2Params"},"children":[]}]}]}},{"type":"link","label":"CreateWorkflowInputDataSourceJobV2Params","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/createworkflowinputdatasourcejobv2params","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/createworkflowinputdatasourcejobv2params","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateWorkflowInputDataSourceJobV2Params"},"seo":{"title":"CreateWorkflowInputDataSourceJobV2Params"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateWorkflowInputDataSourceJobV2Params","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateWorkflowInputDataSourceJobV2Params"},"children":[]}]}]}},{"type":"link","label":"DataSourceReprocessJobV2","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/datasourcereprocessjobv2","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/datasourcereprocessjobv2","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"DataSourceReprocessJobV2"},"seo":{"title":"DataSourceReprocessJobV2"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DataSourceReprocessJobV2","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/DataSourceReprocessJobV2"},"children":[]}]}]}},{"type":"link","label":"ReprocessDataSourceJobV2Params","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/reprocessdatasourcejobv2params","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/reprocessdatasourcejobv2params","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ReprocessDataSourceJobV2Params"},"seo":{"title":"ReprocessDataSourceJobV2Params"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ReprocessDataSourceJobV2Params","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ReprocessDataSourceJobV2Params"},"children":[]}]}]}},{"type":"link","label":"DataSourcesV2","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/datasourcesv2","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/datasourcesv2","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"DataSourcesV2"},"seo":{"title":"DataSourcesV2"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DataSourcesV2","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/DataSourcesV2"},"children":[]}]}]}},{"type":"link","label":"DataSourceV2","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/datasourcev2","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/datasourcev2","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"DataSourceV2"},"seo":{"title":"DataSourceV2"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DataSourceV2","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/DataSourceV2"},"children":[]}]}]}},{"type":"link","label":"DataSourceDetailV2","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/datasourcedetailv2","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/datasourcedetailv2","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"DataSourceDetailV2"},"seo":{"title":"DataSourceDetailV2"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DataSourceDetailV2","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/DataSourceDetailV2"},"children":[]}]}]}},{"type":"link","label":"TransformationProvider","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/transformationprovider","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/transformationprovider","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"TransformationProvider"},"seo":{"title":"TransformationProvider"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"TransformationProvider","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/TransformationProvider"},"children":[]}]}]}},{"type":"link","label":"CopyProvider","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/copyprovider","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/copyprovider","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CopyProvider"},"seo":{"title":"CopyProvider"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CopyProvider","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CopyProvider"},"children":[]}]}]}},{"type":"link","label":"Editor","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/editor","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/editor","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Editor"},"seo":{"title":"Editor"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Editor","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Editor"},"children":[]}]}]}},{"type":"link","label":"Viewer","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/viewer","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/viewer","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Viewer"},"seo":{"title":"Viewer"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Viewer","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Viewer"},"children":[]}]}]}},{"type":"link","label":"Source","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/source","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/source","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Source"},"seo":{"title":"Source"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Source","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Source"},"children":[]}]}]}},{"type":"link","label":"Target","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/target","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/target","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Target"},"seo":{"title":"Target"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Target","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Target"},"children":[]}]}]}},{"type":"link","label":"DataProviders","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/dataproviders","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/dataproviders","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"DataProviders"},"seo":{"title":"DataProviders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DataProviders","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/DataProviders"},"children":[]}]}]}},{"type":"link","label":"DataProvider","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/dataprovider","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/dataprovider","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"DataProvider"},"seo":{"title":"DataProvider"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DataProvider","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/DataProvider"},"children":[]}]}]}},{"type":"link","label":"WorkflowInputDataProviders","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/workflowinputdataproviders","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/workflowinputdataproviders","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WorkflowInputDataProviders"},"seo":{"title":"WorkflowInputDataProviders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WorkflowInputDataProviders","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WorkflowInputDataProviders"},"children":[]}]}]}},{"type":"link","label":"WorkflowInputDataProvider","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/workflowinputdataprovider","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/workflowinputdataprovider","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WorkflowInputDataProvider"},"seo":{"title":"WorkflowInputDataProvider"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WorkflowInputDataProvider","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WorkflowInputDataProvider"},"children":[]}]}]}},{"type":"link","label":"WorkflowInputProcessAs","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/workflowinputprocessas","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/workflowinputprocessas","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WorkflowInputProcessAs"},"seo":{"title":"WorkflowInputProcessAs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WorkflowInputProcessAs","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WorkflowInputProcessAs"},"children":[]}]}]}},{"type":"link","label":"SetDataSourceJobState","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/setdatasourcejobstate","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/setdatasourcejobstate","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"SetDataSourceJobState"},"seo":{"title":"SetDataSourceJobState"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SetDataSourceJobState","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/SetDataSourceJobState"},"children":[]}]}]}},{"type":"link","label":"TransformationErrors","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/transformationerrors","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/transformationerrors","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"TransformationErrors"},"seo":{"title":"TransformationErrors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"TransformationErrors","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/TransformationErrors"},"children":[]}]}]}},{"type":"link","label":"TransformationError","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/transformationerror","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/transformationerror","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"TransformationError"},"seo":{"title":"TransformationError"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"TransformationError","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/TransformationError"},"children":[]}]}]}},{"type":"link","label":"PatchReq","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/patchreq","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/patchreq","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"PatchReq"},"seo":{"title":"PatchReq"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PatchReq","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/PatchReq"},"children":[]}]}]}},{"type":"link","label":"PatchItem","link":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/patchitem","routeSlug":"/solutions/fdplan/apis/fdplan-data-sources/schema-definitions/patchitem","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"PatchItem"},"seo":{"title":"PatchItem"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PatchItem","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/PatchItem"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Schema Definitions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schema Definitions","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Error","link":"/schema-definitions/error","deprecated":false},{"title":"Container","link":"/schema-definitions/container","deprecated":false},{"title":"LastUpdated","link":"/schema-definitions/lastupdated","deprecated":false},{"title":"CorrelationId","link":"/schema-definitions/correlationid","deprecated":false},{"title":"DataSourceType","link":"/schema-definitions/datasourcetype","deprecated":false},{"title":"DataSourceTypes","link":"/schema-definitions/datasourcetypes","deprecated":false},{"title":"CreateDataSourceType","link":"/schema-definitions/createdatasourcetype","deprecated":false},{"title":"UpdateDataSourceType","link":"/schema-definitions/updatedatasourcetype","deprecated":false},{"title":"DataSourceJobV2","link":"/schema-definitions/datasourcejobv2","deprecated":false},{"title":"CreateDataSourceJobV2Params","link":"/schema-definitions/createdatasourcejobv2params","deprecated":false},{"title":"CreateWorkflowInputDataSourceJobV2Params","link":"/schema-definitions/createworkflowinputdatasourcejobv2params","deprecated":false},{"title":"DataSourceReprocessJobV2","link":"/schema-definitions/datasourcereprocessjobv2","deprecated":false},{"title":"ReprocessDataSourceJobV2Params","link":"/schema-definitions/reprocessdatasourcejobv2params","deprecated":false},{"title":"DataSourcesV2","link":"/schema-definitions/datasourcesv2","deprecated":false},{"title":"DataSourceV2","link":"/schema-definitions/datasourcev2","deprecated":false},{"title":"DataSourceDetailV2","link":"/schema-definitions/datasourcedetailv2","deprecated":false},{"title":"TransformationProvider","link":"/schema-definitions/transformationprovider","deprecated":false},{"title":"CopyProvider","link":"/schema-definitions/copyprovider","deprecated":false},{"title":"Editor","link":"/schema-definitions/editor","deprecated":false},{"title":"Viewer","link":"/schema-definitions/viewer","deprecated":false},{"title":"Source","link":"/schema-definitions/source","deprecated":false},{"title":"Target","link":"/schema-definitions/target","deprecated":false},{"title":"DataProviders","link":"/schema-definitions/dataproviders","deprecated":false},{"title":"DataProvider","link":"/schema-definitions/dataprovider","deprecated":false},{"title":"WorkflowInputDataProviders","link":"/schema-definitions/workflowinputdataproviders","deprecated":false},{"title":"WorkflowInputDataProvider","link":"/schema-definitions/workflowinputdataprovider","deprecated":false},{"title":"WorkflowInputProcessAs","link":"/schema-definitions/workflowinputprocessas","deprecated":false},{"title":"SetDataSourceJobState","link":"/schema-definitions/setdatasourcejobstate","deprecated":false},{"title":"TransformationErrors","link":"/schema-definitions/transformationerrors","deprecated":false},{"title":"TransformationError","link":"/schema-definitions/transformationerror","deprecated":false},{"title":"PatchReq","link":"/schema-definitions/patchreq","deprecated":false},{"title":"PatchItem","link":"/schema-definitions/patchitem","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"description":"Generic error response.","required":["data"],"type":"object","properties":{"data":{"required":["code"],"type":"object","properties":{"code":{"format":"int32","description":"The HTTP status code.","type":"integer","example":500},"message":{"description":"The error message.","type":"string","example":"internal server error"}}}},"example":{"data":{"code":500,"message":"internal server error"}}}},"components/schemas/Container":{"id":"components/schemas/Container","kind":"json-schema","title":"Container","data":{"description":"A container which holds data of a given type.","required":["type","version","path"],"type":"object","properties":{"type":{"description":"The type of the container.","type":"string","example":"price-forecast"},"version":{"description":"The version of the container.","type":"integer","example":1},"path":{"description":"The path of the container.","type":"string","example":"01JY6FMJMY0F6AJFV05V831SB4/containers/price-forecast/01JY6YFRF2QEVQYNGB3N31SWD5"},"description":{"description":"The description of the container.","type":"string","example":"Price forecast for Robin field"},"labels":{"description":"The labels of the container.","additionalProperties":{"type":"string"},"type":"object","example":{"name":"Base"}},"store":{"description":"Store is a file storage option.","type":"string","example":"fdplan"}},"example":{"path":"01JY6FMJMY0F6AJFV05V831SB4/containers/price-forecast/01JY6YFRF2QEVQYNGB3N31SWD5","type":"price-forecast","version":1,"description":"Price forecast for Robin field","labels":{"name":"Base"},"store":"fdplan"}}},"components/schemas/LastUpdated":{"id":"components/schemas/LastUpdated","kind":"json-schema","title":"LastUpdated","data":{"description":"Details of the last update to a resource.","required":["byUser","atDate","byEvent"],"type":"object","properties":{"byUser":{"description":"The ID of the user who made the last update.","type":"string","example":"user@slb.com"},"atDate":{"format":"date-time","description":"The date time of the last update.","type":"string","example":"2020-09-08T09:53:36.000Z"},"byEvent":{"$ref":"#/components/schemas/CorrelationId"}},"example":{"atDate":"2020-09-08T09:53:36.000Z","byEvent":"01EHPJ54HEA77K95T5KPH5JSW9","byUser":"user@slb.com"}}},"components/schemas/CorrelationId":{"id":"components/schemas/CorrelationId","kind":"json-schema","title":"CorrelationId","data":{"description":"The correlation ID for the request.","type":"string","example":"01EHPJ54HEA77K95T5KPH5JSW9"}},"components/schemas/DataSourceType":{"id":"components/schemas/DataSourceType","kind":"json-schema","title":"DataSourceType","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reusable conversion contract between a domain-native input format and one or more evaluation-ready data types. Every concrete data source references one of these through its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pair."},"children":[]}]}]}],"required":["source","targets"],"type":"object","properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deterministic identifier of the data source type, derived as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source.type:source.store"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","example":"demo:data-types:planning-assumption-reference:comm-store"},"source":{"$ref":"#/components/schemas/Source"},"targets":{"description":"List of evaluation data types that this source can be converted into.","type":"array","items":{"type":"string","example":"price-forecast"}},"editors":{"description":"List of editors defining how data source type is provided.","type":["array","null"],"items":{"$ref":"#/components/schemas/Editor"}},"viewers":{"description":"List of viewers defining how data source type is viewed.","type":["array","null"],"items":{"$ref":"#/components/schemas/Viewer"}},"transformationProvider":{"$ref":"#/components/schemas/TransformationProvider"},"copyProvider":{"$ref":"#/components/schemas/CopyProvider"},"isSystem":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for built-in types shipped with the platform."},"children":[]}]}]}],"type":"boolean"},"archived":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once the type is retired and should no longer be used to create new data sources."},"children":[]}]}]}],"type":"boolean"}},"example":{"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":[]}}},"components/schemas/DataSourceTypes":{"id":"components/schemas/DataSourceTypes","kind":"json-schema","title":"DataSourceTypes","data":{"description":"List of data source types.","required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DataSourceType"}}},"example":{"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":[]}]}}},"components/schemas/CreateDataSourceType":{"id":"components/schemas/CreateDataSourceType","kind":"json-schema","title":"CreateDataSourceType","data":{"description":"Object for creating a new DataSourceType.","required":["source","targets"],"type":"object","properties":{"source":{"$ref":"#/components/schemas/Source"},"targets":{"description":"List of Data Types.","type":"array","items":{"type":"string","example":"price-forecast"}},"editors":{"description":"List of editors defining how data source type is provided.","type":["array","null"],"items":{"$ref":"#/components/schemas/Editor"}},"viewers":{"description":"List of viewers defining how data source type is viewed.","type":["array","null"],"items":{"$ref":"#/components/schemas/Viewer"}},"transformationProvider":{"$ref":"#/components/schemas/TransformationProvider"},"copyProvider":{"$ref":"#/components/schemas/CopyProvider"}},"example":{"source":{"store":"fdplan","type":"production-forecast-fdplan-workbook"},"targets":["production-forecast"]}}},"components/schemas/UpdateDataSourceType":{"id":"components/schemas/UpdateDataSourceType","kind":"json-schema","title":"UpdateDataSourceType","data":{"description":"Object for updating an existing DataSourceType.","type":"object","properties":{"editors":{"description":"List of editors defining how data source type is provided.","type":["array","null"],"items":{"$ref":"#/components/schemas/Editor"}},"viewers":{"description":"List of viewers defining how data source type is viewed.","type":["array","null"],"items":{"$ref":"#/components/schemas/Viewer"}},"targets":{"description":"List of Data Types.","type":["array","null"],"items":{"type":"string","example":"price-forecast"}},"archived":{"description":"Defines if data source type is archived.","type":["boolean","null"]},"transformationProvider":{"$ref":"#/components/schemas/TransformationProvider"},"copyProvider":{"$ref":"#/components/schemas/CopyProvider"}},"example":{"targets":["production-forecast"]}}},"components/schemas/DataSourceJobV2":{"id":"components/schemas/DataSourceJobV2","kind":"json-schema","title":"DataSourceJobV2","data":{"description":"Data source job for creating a data source v2.","required":["id","dataSourceId","dataSourceType","dataSourceJobType","dataSourceJobState","dataSourceJobErrors"],"type":"object","properties":{"id":{"description":"The ULID of the data source job, used to poll the job status and, for external transformers, to set its final state.","type":"string","example":"01JY6YFQ5F7MYPDM3TXCGG02N2"},"dataSourceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the resulting data source. Empty string until "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataSourceJobState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reaches "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","example":"01JY6YVV4QPRH7W4TY64BXEDB6"},"dataSourceType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resolved data source type - the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the full data source type id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source.type:source.store"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") when source and target share a data type."},"children":[]}]}]}],"type":"string","example":"price-forecast"},"dataSourceJobType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data source job type. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Process"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when creating a new data source, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Reprocess"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when rebuilding an existing one."},"children":[]}]}]}],"enum":["Process","Reprocess"],"type":"string","example":"Reprocess"},"dataSourceJobState":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current lifecycle state of the data source job or reprocess job."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Running"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"                 : the platform is staging inputs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransformationPending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"   : a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transformation_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cloud event has been emitted to the external transformer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransformationCompleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" : the external transformer reported success."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"               : the platform has produced the data source (terminal)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"                  : the job failed (terminal)."},"children":[]}]}]}]}],"enum":["Succeeded","Failed","Running","TransformationPending","TransformationCompleted"],"type":"string","example":"Failed"},"dataSourceJobErrors":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-form platform-side error messages, kept distinct from the structured "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transformationErrors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" an external transformer may report when setting the job state."},"children":[]}]}]}],"type":"array","items":{"type":"string"},"example":["scenario 01EFY17N9ED84BV4CHPTDAXZK1 of study 01EEST49N94JA6YJYC2KCMMPJ8 does not have any attached choices","scenario 1 of study 2 does not have any attached choices"]}},"example":{"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"]}}},"components/schemas/CreateDataSourceJobV2Params":{"id":"components/schemas/CreateDataSourceJobV2Params","kind":"json-schema","title":"CreateDataSourceJobV2Params","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inputs for a job that creates a new data source. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pair selects the matching data source type and the transformation provider that runs in the background."},"children":[]}]}]}],"required":["target"],"type":"object","properties":{"source":{"$ref":"#/components/schemas/Source"},"target":{"$ref":"#/components/schemas/Target"},"tags":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of tags associated with the data source, used for later discovery. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StudyId:id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is normally required to associate the data source with a study."},"children":[]}]}]}],"type":"array","items":{"type":"string"},"example":["StudyId:01JY6FMJMY0F6AJFV05V831SB4"]},"description":{"description":"The description for data source to be created.","type":"string"},"name":{"description":"The name for data source.","type":"string","example":"Forecast Q2"},"dataProviders":{"$ref":"#/components/schemas/DataProviders"}},"example":{"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"]}]}}}},"components/schemas/CreateWorkflowInputDataSourceJobV2Params":{"id":"components/schemas/CreateWorkflowInputDataSourceJobV2Params","kind":"json-schema","title":"CreateWorkflowInputDataSourceJobV2Params","data":{"description":"Inputs for a single job that produces every workflow input data source of a study at once, in order to create virtual scenarios.","required":["dataProviders","tags"],"type":"object","properties":{"dataProviders":{"$ref":"#/components/schemas/WorkflowInputDataProviders"},"tags":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of tags associated with the data source. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StudyId:id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mandatory and defines which workflow inputs are expected in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataProviders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Add custom tags (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Iteration:Iteration1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Case:case1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to find virtual scenarios quickly; add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JobPriority:High"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to queue the evaluations with higher priority."},"children":[]}]}]}],"type":"array","items":{"type":"string"},"example":["StudyId:01JY6FMJMY0F6AJFV05V831SB4"]},"description":{"description":"The description for data source to be created.","type":"string"},"name":{"description":"The name for data source.","type":"string","example":"data-source-name"}},"example":{"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"}}},"components/schemas/DataSourceReprocessJobV2":{"id":"components/schemas/DataSourceReprocessJobV2","kind":"json-schema","title":"DataSourceReprocessJobV2","data":{"description":"Data source job for reprocessing a data source v2.","required":["id"],"type":"object","properties":{"id":{"description":"The id for data source reprocess job.","type":"string","example":"01JY6YFQ5F7MYPDM3TXCGG02N2"}},"example":{"id":"01JY6YFQ5F7MYPDM3TXCGG02N2"}}},"components/schemas/ReprocessDataSourceJobV2Params":{"id":"components/schemas/ReprocessDataSourceJobV2Params","kind":"json-schema","title":"ReprocessDataSourceJobV2Params","data":{"description":"Parameters for creating a data source v2 reprocessing job.","required":["id","version"],"type":"object","properties":{"id":{"description":"The id for data source.","type":"string","example":"01JY6YVV4QPRH7W4TY64BXEDB6"},"version":{"description":"The version for data source.","type":"integer","example":1},"dataProviders":{"$ref":"#/components/schemas/DataProviders"}},"example":{"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"]}]}}}},"components/schemas/DataSourcesV2":{"id":"components/schemas/DataSourcesV2","kind":"json-schema","title":"DataSourcesV2","data":{"description":"List of data sources","required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DataSourceV2"}}},"example":{"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"}}]}}},"components/schemas/DataSourceV2":{"id":"components/schemas/DataSourceV2","kind":"json-schema","title":"DataSourceV2","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A versioned input bundle that feeds scenario evaluations, produced by a data source job. Reads always specify a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["id","source","target","description","version"],"type":"object","properties":{"id":{"description":"The immutable id of the data source.","type":"string","example":"01JY6YVV4QPRH7W4TY64BXEDB6"},"source":{"$ref":"#/components/schemas/Source"},"target":{"$ref":"#/components/schemas/Target"},"tags":{"description":"List of tags associated with data source.","type":"array","items":{"type":"string"},"example":["StudyId:01JY6FMJMY0F6AJFV05V831SB4"]},"description":{"description":"The description for data source.","type":"string","example":"Example of transformation"},"type":{"description":"The type for data source.","type":"string","example":"price-forecast"},"version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revision of the data source. Rebuilding a data source after its data source type is updated produces a new version through a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Reprocess"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data source job."},"children":[]}]}]}],"type":"integer","example":1},"name":{"description":"The name for data source.","type":"string","example":"Forecast Q2"},"details":{"$ref":"#/components/schemas/DataSourceDetailV2"},"lastUpdated":{"$ref":"#/components/schemas/LastUpdated"}},"example":{"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"}}}},"components/schemas/DataSourceDetailV2":{"id":"components/schemas/DataSourceDetailV2","kind":"json-schema","title":"DataSourceDetailV2","data":{"description":"Details of data source job.","type":"object","properties":{"containers":{"description":"List of data containers that hold the data extracted from the sources.","type":"array","items":{"$ref":"#/components/schemas/Container"},"example":[{"path":"01JY6FMJMY0F6AJFV05V831SB4/containers/price-forecast/01JY6YFRF2QEVQYNGB3N31SWD5","type":"price-forecast","version":1,"store":"fdplan","description":"Price forecast for Robin field","labels":{"name":"Base"}}]},"dataProviders":{"$ref":"#/components/schemas/DataProviders"}},"example":{"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"}]}}},"components/schemas/TransformationProvider":{"id":"components/schemas/TransformationProvider","kind":"json-schema","title":"TransformationProvider","data":{"description":"Transformation provider defines which provider is used to process the data.","required":["name"],"type":"object","properties":{"name":{"description":"Provider name.","default":"system","type":"string"}}}},"components/schemas/CopyProvider":{"id":"components/schemas/CopyProvider","kind":"json-schema","title":"CopyProvider","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Copy provider defines which provider copies the data sources of this data source type. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"system"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (FDPlan copies internally); set a custom name to delegate copying to an external worker, which then handles "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"copy_transformation_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events. Data source types in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fdplan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" store can only be processed by the system worker and are not allowed to have a custom copy provider."},"children":[]}]}]}],"required":["name"],"type":"object","properties":{"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provider name. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"system"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the FDPlan copy worker, or a custom name to delegate copying to an external worker."},"children":[]}]}]}],"default":"system","type":"string","example":"comm-store-data-agent"}}}},"components/schemas/Editor":{"id":"components/schemas/Editor","kind":"json-schema","title":"Editor","data":{"description":"Editor defines how a data source type is provided.","required":["editorURL"],"type":"object","properties":{"editorURL":{"description":"Link to call the editor.","type":"string"},"name":{"description":"Name of the editor.","type":["string","null"]},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the editor. * Default           : Editor supports legacy single item editing only * OpportunityAware  : Editor supports opportunity aware data editing only * Both              : Editor supports both legacy single item and opportunity aware data editing"},"children":[]}]}]}],"default":"Default","enum":["Default","OpportunityAware","Both"],"type":"string"}}}},"components/schemas/Viewer":{"id":"components/schemas/Viewer","kind":"json-schema","title":"Viewer","data":{"description":"Viewer defines how a data source type is viewed.","required":["viewerURL"],"type":"object","properties":{"viewerURL":{"description":"Link to call the viewer.","type":"string"},"name":{"description":"Name of the viewer.","type":["string","null"]},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the viewer. * Default           : Viewer supports legacy single item viewing only * OpportunityAware  : Viewer supports opportunity aware data viewing only * Both              : Viewer supports both legacy single item and opportunity aware data viewing"},"children":[]}]}]}],"default":"Default","enum":["Default","OpportunityAware","Both"],"type":"string"}}}},"components/schemas/Source":{"id":"components/schemas/Source","kind":"json-schema","title":"Source","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user-facing input format - a registered data type and the store it lives in. Together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it selects the matching data source type."},"children":[]}]}]}],"required":["type","store"],"type":"object","properties":{"type":{"description":"An existing registered Data Type that describes the domain-native input format.","type":"string","example":"demo:data-types:planning-assumption-reference"},"store":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file storage option the source data lives in (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"comm-store"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fdplan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string","example":"comm-store"}}}},"components/schemas/Target":{"id":"components/schemas/Target","kind":"json-schema","title":"Target","data":{"description":"The evaluation-ready data type that computations consume, produced by the transformation.","required":["type"],"type":"object","properties":{"type":{"description":"An existing registered evaluation Data Type.","type":"string","example":"price-forecast"}}}},"components/schemas/DataProviders":{"id":"components/schemas/DataProviders","kind":"json-schema","title":"DataProviders","data":{"description":"List of data providers","required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DataProvider"}}},"example":{"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"]}]}}},"components/schemas/DataProvider":{"id":"components/schemas/DataProvider","kind":"json-schema","title":"DataProvider","data":{"description":"Repository from which the data can be extracted including a file, folder or a datalink","required":["name","sources"],"type":"object","properties":{"name":{"description":"Name of Data Provider.","type":"string","example":"Base"},"sources":{"description":"List of sources that contributes to data.","type":"array","items":{"type":"string"}},"description":{"description":"The description for data provider.","type":"string","example":"Base price forecast deck"},"metadata":{"description":"The data provider metadata.","additionalProperties":{"type":"object"},"type":"object"}},"example":{"name":"Base","description":"Base price forecast deck","sources":["https://corp.commercials.data-agent.com/reference/2fbcc17c7700258b/base"]}}},"components/schemas/WorkflowInputDataProviders":{"id":"components/schemas/WorkflowInputDataProviders","kind":"json-schema","title":"WorkflowInputDataProviders","data":{"description":"List of data providers for a workflow input data source.","required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowInputDataProvider"}}},"example":{"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"}]}}},"components/schemas/WorkflowInputDataProvider":{"id":"components/schemas/WorkflowInputDataProvider","kind":"json-schema","title":"WorkflowInputDataProvider","data":{"description":"Repository from which the data can be extracted including a file, folder or a datalink","required":["name","nodeAddress","sources"],"type":"object","properties":{"name":{"description":"Name of data provider.","type":"string","example":"Base"},"nodeAddress":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The address of the workflow input node to apply the data source binding. More than one data provider can target the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodeAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to evaluate multiple realizations within the virtual scenario."},"children":[]}]}]}],"pattern":"^\\d+:2:\\d+$","type":"string","example":"0:2:0"},"sources":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of sources that contribute to the data. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processAs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not specified, the sources are used as data links for the corresponding input."},"children":[]}]}]}],"type":"array","items":{"type":"string"}},"processAs":{"$ref":"#/components/schemas/WorkflowInputProcessAs"},"description":{"description":"The description for data provider.","type":"string","example":"Base price forecast deck"}},"example":{"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"}}},"components/schemas/WorkflowInputProcessAs":{"id":"components/schemas/WorkflowInputProcessAs","kind":"json-schema","title":"WorkflowInputProcessAs","data":{"description":"Information to process a workflow input data provider.","required":["type"],"type":"object","properties":{"type":{"description":"The type to process a workflow input data provider.","enum":["ReferenceDataSource","DataSourceType"],"type":"string"},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value for the type to process a workflow input data provider. - In case of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ReferenceDataSource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it should be an already existing data-source ID and version, format: \"01JY6YVV4QPRH7W4TY64BXEDB6:v1\""},"children":[]}]}]}],"type":"string"}},"example":{"type":"DataSourceType","value":"production-forecast:osdu"}}},"components/schemas/SetDataSourceJobState":{"id":"components/schemas/SetDataSourceJobState","kind":"json-schema","title":"SetDataSourceJobState","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The final state reported by an external transformer to terminate a data source job. Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransformationCompleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on success, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transformationErrors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","properties":{"state":{"description":"The terminal state to set for the data source job.","enum":["Failed","TransformationCompleted"],"type":"string"},"transformationErrors":{"$ref":"#/components/schemas/TransformationErrors"}},"example":{"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"}]}}}},"components/schemas/TransformationErrors":{"id":"components/schemas/TransformationErrors","kind":"json-schema","title":"TransformationErrors","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Structured errors reported by an external transformer when terminating a data source job with state "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TransformationError"}}}}},"components/schemas/TransformationError":{"id":"components/schemas/TransformationError","kind":"json-schema","title":"TransformationError","data":{"description":"A single transformation error, optionally scoped to the data providers it affects.","required":["message"],"type":"object","properties":{"dataProviderNames":{"description":"Names of the data providers this error relates to.","type":"array","items":{"type":"string"}},"message":{"description":"The error message.","type":"string"}}}},"components/schemas/PatchReq":{"id":"components/schemas/PatchReq","kind":"json-schema","title":"PatchReq","data":{"description":"An ordered list of JSON Patch operations to apply to a data source job.","minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PatchItem"},"example":[{"op":"replace","path":"dataProviders","value":{"items":[{"name":"Base","sources":["https://corp.commercials.data-agent.com/reference/01K0F086K8HD3SBMHQ1N0W6J2P/Base"]}]}}]}},"components/schemas/PatchItem":{"id":"components/schemas/PatchItem","kind":"json-schema","title":"PatchItem","data":{"description":"A JSONPatch document as defined by RFC 6902.","required":["op","path"],"properties":{"op":{"description":"The operation to be performed.","enum":["add","remove","replace"],"type":"string"},"path":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A JSON-Pointer to the field to update, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataProviders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","example":"dataProviders"},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value to be used within the operation, for example a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataProviders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object with its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object"}}}},"schema_0":{"kind":"json-schema","data":{"type":"string"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string","pattern":"^([a-zA-Z]+:[a-zA-Z0-9\\-:\\.\\|]+)(,([a-zA-Z]+:[a-zA-Z0-9\\-:\\.\\|]+)){0,4}$"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_2"}},"exampleStore":{},"securitySchemeStore":{"bearer":{"id":"bearer","type":"apiKey","in":"header","paramName":"Authorization"},"appkey":{"id":"appkey","type":"apiKey","in":"header","paramName":"appkey"}},"specVersion":"3.2.0","servers":[{"url":"https://api.delfi.slb.com/fdplan/data-sources"},{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","isMockServer":true,"description":"Mock server"}],"specType":"openapi"},"options":{"schemaDefinitionsTagName":"Schema Definitions","downloadUrls":[{"title":"Data Sources Spec","url":"https://developer.slb.com/fdplan/FDPlan-Data-Sources.yaml"}],"mockServer":{"url":"/_mock/solutions/fdplan/apis/fdplan-data-sources","position":"last","description":"Mock server"},"disableRouter":true,"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Data Sources","description":"```plain {% title=\"Client ID\" %}\nprod-nam-services-fdplan.slbservice.com\nprod-eu-services-fdplan.slbservice.com\nprod-au-services-fdplan.slbservice.com\nprod-id-services-fdplan.slbservice.com\nproduction-services-fdplan.slbservice.com\n```\n\nThe data sources API is responsible for managing data sources in FDPlan.\n\nA **data source** is a versioned input bundle consumed by scenario evaluations. It pairs a\nuser-facing `source` (a registered data type and its `store`) with one `target` data type\nunderstood by computations, and is discovered and reused across scenarios through `tags`\n(usually `StudyId:id`).\n\nData sources are never created directly. Every data source is produced by an asynchronous\n**data source job**: the caller posts the inputs (`source`, `target`, `dataProviders`, `tags`)\nand the platform runs the transformation declared on the matching **data source type** in the\nbackground. A data source type is the reusable conversion contract between a domain-native input\nformat and one or more evaluation-ready data types, and also declares the editors, viewers, and\ntransformation/copy providers used to author and process the data.\n\nKey resources:\n  * `data-source-types` - register and manage the conversion contracts (source/target, editors,\n    viewers, providers).\n  * `data-source-jobs` - create, reprocess, poll, and complete the asynchronous work that builds\n    a data source. External transformers report completion via `.../{id}/state`.\n  * `workflow-input-data-source-jobs` - build all workflow input data sources of a study at once\n    to create virtual scenarios.\n  * `data-sources` - read a given `version`, list by `tags`, and delete.\n"}},"baseSlug":"/solutions/fdplan/apis/fdplan-data-sources","routesMapping":{}}