{"items":[{"type":"link","label":"Workflow Service","link":"/solutions/core-service/apis/osdu-workflow-service","routeSlug":"/solutions/core-service/apis/osdu-workflow-service","content":{"contentType":"overview","meta":{"name":"Workflow Service"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"OSDU-Workflow-Service.json","url":"/_bundle/solutions/core-service/apis/OSDU-Workflow-Service.json?download"},{"kind":"download","label":"OSDU-Workflow-Service.yaml","url":"/_bundle/solutions/core-service/apis/OSDU-Workflow-Service.yaml?download"}]},{"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://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Workflow Service (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow Service API is a wrapper API on existing orchestrator services (Apache Airflow) defined in a way which suits the domain workflow needs. This API is responsible for creation and maintenance of the workflows. Operational tasks such as starting, stopping and pausing workflows are also part of this API. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"url: 'http://www.apache.org/licenses/LICENSE-2.0.html'"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"963f2cc6915e479fa0fcb73ec2ec90e7\n","language":"plain","title":"Client ID"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"963f2cc6915e479fa0fcb73ec2ec90e7\n"},"children":[]}]}]}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"group","label":"Workflow","link":"/solutions/core-service/apis/osdu-workflow-service/workflow","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/workflow","items":[{"label":"List all the workflows applicable for a partition.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-workflow-service/workflow/listallworkflow","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/workflow/listallworkflow","metadata":{"seo":{"title":"List all the workflows applicable for a partition.","description":"List all workflows for provided partition."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAllWorkflow","name":"List all the workflows applicable for a partition.","isWebhook":false,"pointer":"/paths/~1workflow/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all the workflows applicable for a partition.","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":"List all workflows for provided partition."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key Points"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will include both the private and public workflows."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflows can be fetched using this API."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the workflow service is down we get a 502 from gateway."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"prefix","in":"query","schemaId":"schema_0","description":"Filter workflow names which start with the full prefix specified."}],"pointer":"/paths/~1workflow/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","schemaId":"schema_0","description":"desired data partition id","required":true}],"pointer":"/paths/~1workflow/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflow","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"prefix","in":"query","required":false,"schemaId":"schema_0"}],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/workflow","href":"workflow/listallworkflow","openApiOperationId":"listAllWorkflow","summary":"List all the workflows applicable for a partition."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of all the workflows (public & private) accessible from the partition."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1"}},"schemaId":"schema_1"},{"code":"400","description":"Bad Request. Partition ID is missing/invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unknown or Invalid user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"User forbidden from accessing this API.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1workflow/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1"}}},{"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":"403","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":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow/listallworkflow"}],"panels":[]}]},"httpPath":"/workflow"},{"label":"Registers a workflow definition composed of standard and custom operators in the orchestration tool.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-workflow-service/workflow/deployworkflow","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/workflow/deployworkflow","metadata":{"seo":{"title":"Registers a workflow definition composed of standard and custom operators in the orchestration tool.","description":"Register a new workflow. Workflows (Airflow DAGs) could be composed of standard components (In-built Airflow operators, hooks & sensors) or custom components (User-defined operators, hooks and sensors). Key Points"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deployWorkflow","name":"Registers a workflow definition composed of standard and custom operators in the orchestration tool.","isWebhook":false,"pointer":"/paths/~1workflow/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Registers a workflow definition composed of standard and custom operators in the orchestration tool.","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":"Register a new workflow. Workflows (Airflow DAGs) could be composed of standard components (In-built Airflow operators, hooks & sensors) or custom components (User-defined operators, hooks and sensors)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key Points"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow name and DAG name (in workflow definition) are expected to be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the same."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API will check the syntactic validity of the workflow based on the orchestrator."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Audit information will be added automatically. Audit params are: \"createdBy\" and \"createdTimestamp\"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","schemaId":"schema_0","description":"desired data partition id","required":true}],"pointer":"/paths/~1workflow/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWorkflowRequest"}},"schemaId":"components/schemas/CreateWorkflowRequest","pointer":"/paths/~1workflow/post/requestBody","description":"Request payload for deploying new workflow."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateWorkflowRequest"}},"responseCodes":["200","400","401","403","404","409","500"],"pointer":"/workflow","href":"workflow/deployworkflow","openApiOperationId":"deployWorkflow","summary":"Registers a workflow definition composed of standard and custom operators in the orchestration tool."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateWorkflowRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWorkflowRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workflow created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowMetadata"}},"schemaId":"components/schemas/WorkflowMetadata"},{"code":"400","description":"Bad Request. Contents of DAG is invalid or partition ID is missing/invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unknown or Invalid user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"User forbidden from accessing this API.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"409","description":"Conflict - Workflow with same name already exists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1workflow/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkflowMetadata","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowMetadata"}}},{"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":"403","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":"409","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow/deployworkflow"}],"panels":[]}]},"httpPath":"/workflow"},{"label":"Get workflow by name","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-workflow-service/workflow/getworkflow","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/workflow/getworkflow","metadata":{"seo":{"title":"Get workflow by name","description":"Get details of a registered workflow using the workflow name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWorkflow","name":"Get workflow by name","isWebhook":false,"pointer":"/paths/~1workflow~1{workflow_name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get workflow by name","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get details of a registered workflow using the workflow name."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflow_name","in":"path","schemaId":"schema_0","description":"Workflow Name.","required":true}],"pointer":"/paths/~1workflow~1{workflow_name}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","schemaId":"schema_0","description":"desired data partition id","required":true}],"pointer":"/paths/~1workflow~1{workflow_name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflow/{workflow_name}","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"workflow_name","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/workflow/{workflow_name}","href":"workflow/getworkflow","openApiOperationId":"getWorkflow","summary":"Get workflow by name"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","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":"Workflow successfully returned.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowMetadata"}},"schemaId":"components/schemas/WorkflowMetadata"},{"code":"400","description":"Bad Request. Partition ID is missing/invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unknown or Invalid user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"User forbidden from accessing this API.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1workflow~1{workflow_name}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkflowMetadata","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowMetadata"}}},{"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":"403","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":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow/getworkflow"}],"panels":[]}]},"httpPath":"/workflow/{workflow_name}"},{"label":"Delete workflow by workflow name","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-workflow-service/workflow/deleteworkflow","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/workflow/deleteworkflow","metadata":{"seo":{"title":"Delete workflow by workflow name","description":"Delete a registered workflow based on the workflow name. Workflow runs with status either SUCCESS or FAILED can be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWorkflow","name":"Delete workflow by workflow name","isWebhook":false,"pointer":"/paths/~1workflow~1{workflow_name}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete workflow by workflow name","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a registered workflow based on the workflow name.  Workflow runs with status either SUCCESS or FAILED can be deleted."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflow_name","in":"path","schemaId":"schema_0","description":"Workflow Name.","required":true}],"pointer":"/paths/~1workflow~1{workflow_name}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","schemaId":"schema_0","description":"desired data partition id","required":true}],"pointer":"/paths/~1workflow~1{workflow_name}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workflow/{workflow_name}","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"workflow_name","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500"],"pointer":"/workflow/{workflow_name}","href":"workflow/deleteworkflow","openApiOperationId":"deleteWorkflow","summary":"Delete workflow by workflow name"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","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":"Workflow successfully deleted"},{"code":"400","description":"Bad Request. Partition ID is missing/invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unknown or Invalid user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"User forbidden from accessing this API.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1workflow~1{workflow_name}/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":"403","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":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow/deleteworkflow"}],"panels":[]}]},"httpPath":"/workflow/{workflow_name}"}],"content":{"contentType":"group","meta":{"name":"Workflow"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workflow","showPageActions":true},{"nodeType":"markdoc","content":"Workflow management"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workflow","summary":"List all the workflows applicable for a partition.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflow/listallworkflow","deprecated":false},{"title":"/workflow","summary":"Registers a workflow definition composed of standard and custom operators in the orchestration tool.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workflow/deployworkflow","deprecated":false},{"title":"/workflow/{workflow_name}","summary":"Get workflow by name","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflow/getworkflow","deprecated":false},{"title":"/workflow/{workflow_name}","summary":"Delete workflow by workflow name","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/workflow/deleteworkflow","deprecated":false}]}]}]}]}},{"type":"group","label":"Workflow Run","link":"/solutions/core-service/apis/osdu-workflow-service/workflow-run","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/workflow-run","items":[{"label":"Get details of all workflows ever run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-workflow-service/workflow-run/getallworkflowinstances","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/workflow-run/getallworkflowinstances","metadata":{"seo":{"title":"Get details of all workflows ever run","description":"Get all the workflow run instances for the workflow specified by the workflow name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllWorkflowInstances","name":"Get details of all workflows ever run","isWebhook":false,"pointer":"/paths/~1workflow~1{workflow_name}~1workflowRun/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get details of all workflows ever run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all the workflow run instances for the workflow specified by the workflow name."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflow_name","in":"path","schemaId":"schema_0","description":"Specify the workflow Name to get all the workflow run instances.","required":true}],"pointer":"/paths/~1workflow~1{workflow_name}~1workflowRun/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"params","in":"query","schemaId":"schema_2","description":"params can be prefix, startDate, endDate and limit\n\n  prefix : prefix of the runId.\n  \n  startDate : Date on which workflow was triggered.\n  \n  endDate : Date on which workflow execution ended.\n  \n  limit : number of results.\n  ","required":true,"example":{"startDate":1617709000423,"endDate":1617710801960,"limit":1,"prefix":"5"}}],"pointer":"/paths/~1workflow~1{workflow_name}~1workflowRun/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","schemaId":"schema_0","description":"desired data partition id","required":true}],"pointer":"/paths/~1workflow~1{workflow_name}~1workflowRun/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflow/{workflow_name}/workflowRun","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"workflow_name","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"params","in":"query","required":true,"example":{"startDate":1617709000423,"endDate":1617710801960,"limit":1,"prefix":"5"},"schemaId":"schema_2"}],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/workflow/{workflow_name}/workflowRun","href":"workflow-run/getallworkflowinstances","openApiOperationId":"getAllWorkflowInstances","summary":"Get details of all workflows ever run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","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":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3"}},"schemaId":"schema_3"},{"code":"400","description":"Bad Request. Partition ID is missing/invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unknown or Invalid user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"User forbidden from accessing this API.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1workflow~1{workflow_name}~1workflowRun/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_3","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3"}}},{"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":"403","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":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-run/getallworkflowinstances"}],"panels":[]}]},"httpPath":"/workflow/{workflow_name}/workflowRun"},{"label":"Triggers a workflow execution.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-workflow-service/workflow-run/triggerworkflow","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/workflow-run/triggerworkflow","metadata":{"seo":{"title":"Triggers a workflow execution.","description":"Trigger the execution of a valid workflow which is already registered."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerWorkflow","name":"Triggers a workflow execution.","isWebhook":false,"pointer":"/paths/~1workflow~1{workflow_name}~1workflowRun/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Triggers a workflow execution.","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":"Trigger the execution of a valid workflow which is already registered."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflow_name","in":"path","schemaId":"schema_0","description":"Specify the workflow Name to run.","required":true}],"pointer":"/paths/~1workflow~1{workflow_name}~1workflowRun/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","schemaId":"schema_0","description":"desired data partition id","required":true}],"pointer":"/paths/~1workflow~1{workflow_name}~1workflowRun/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TriggerWorkflowRequest"}},"schemaId":"components/schemas/TriggerWorkflowRequest","pointer":"/paths/~1workflow~1{workflow_name}~1workflowRun/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/{workflow_name}/workflowRun","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"workflow_name","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TriggerWorkflowRequest"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/workflow/{workflow_name}/workflowRun","href":"workflow-run/triggerworkflow","openApiOperationId":"triggerWorkflow","summary":"Triggers a workflow execution."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/TriggerWorkflowRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TriggerWorkflowRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workflow successfully triggered.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowRunResponse"}},"schemaId":"components/schemas/WorkflowRunResponse"},{"code":"400","description":"Bad Request. Partition ID is missing/invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unknown or Invalid user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"User forbidden from accessing this API.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1workflow~1{workflow_name}~1workflowRun/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkflowRunResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowRunResponse"}}},{"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":"403","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":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-run/triggerworkflow"}],"panels":[]}]},"httpPath":"/workflow/{workflow_name}/workflowRun"},{"label":"Get details of a specific workflow run instance.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-workflow-service/workflow-run/getworkflowrun","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/workflow-run/getworkflowrun","metadata":{"seo":{"title":"Get details of a specific workflow run instance.","description":"Returns the status of a workflow run which can be one of the following -"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWorkflowRun","name":"Get details of a specific workflow run instance.","isWebhook":false,"pointer":"/paths/~1workflow~1{workflow_name}~1workflowRun~1{runId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get details of a specific workflow run instance.","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":"Returns the status of a workflow run which can be one of the following -"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SUBMITTED - Workflow trigger accepted by platform, but actual"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"workflow run has not started."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RUNNING - Workflow in progress or under execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SUCCESS - Workflow run completed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED - Workflow run completed with failures."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A workflow status of either SUCCESS or FAILED represents the completion of a workflow run."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflow_name","in":"path","schemaId":"schema_0","description":"Workflow Name.","required":true},{"name":"runId","in":"path","schemaId":"schema_0","description":"Run id for the workflow.","required":true}],"pointer":"/paths/~1workflow~1{workflow_name}~1workflowRun~1{runId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","schemaId":"schema_0","description":"desired data partition id","required":true}],"pointer":"/paths/~1workflow~1{workflow_name}~1workflowRun~1{runId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflow/{workflow_name}/workflowRun/{runId}","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"workflow_name","in":"path","required":true,"schemaId":"schema_0"},{"name":"runId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/workflow/{workflow_name}/workflowRun/{runId}","href":"workflow-run/getworkflowrun","openApiOperationId":"getWorkflowRun","summary":"Get details of a specific workflow run instance."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","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":"Workflow execution detail.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowRunResponse"}},"schemaId":"components/schemas/WorkflowRunResponse"},{"code":"400","description":"Bad Request. Partition ID is missing/invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unknown or Invalid user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"User forbidden from accessing this API.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1workflow~1{workflow_name}~1workflowRun~1{runId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkflowRunResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowRunResponse"}}},{"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":"403","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":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-run/getworkflowrun"}],"panels":[]}]},"httpPath":"/workflow/{workflow_name}/workflowRun/{runId}"},{"label":"Update the status of a workflow run.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-workflow-service/workflow-run/updateworkflowrun","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/workflow-run/updateworkflowrun","metadata":{"seo":{"title":"Update the status of a workflow run.","description":"Explicitly update the status of a workflow run."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWorkflowRun","name":"Update the status of a workflow run.","isWebhook":false,"pointer":"/paths/~1workflow~1{workflow_name}~1workflowRun~1{runId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the status of a workflow run.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Explicitly update the status of a workflow run."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflow_name","in":"path","schemaId":"schema_0","description":"Workflow Name.","required":true},{"name":"runId","in":"path","schemaId":"schema_0","description":"Run id for the workflow.","required":true}],"pointer":"/paths/~1workflow~1{workflow_name}~1workflowRun~1{runId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","schemaId":"schema_0","description":"desired data partition id","required":true}],"pointer":"/paths/~1workflow~1{workflow_name}~1workflowRun~1{runId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateWorkflowRunRequest"}},"schemaId":"components/schemas/UpdateWorkflowRunRequest","pointer":"/paths/~1workflow~1{workflow_name}~1workflowRun~1{runId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workflow/{workflow_name}/workflowRun/{runId}","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"workflow_name","in":"path","required":true,"schemaId":"schema_0"},{"name":"runId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateWorkflowRunRequest"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/workflow/{workflow_name}/workflowRun/{runId}","href":"workflow-run/updateworkflowrun","openApiOperationId":"updateWorkflowRun","summary":"Update the status of a workflow run."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/UpdateWorkflowRunRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateWorkflowRunRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workflow updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowRunResponse"}},"schemaId":"components/schemas/WorkflowRunResponse"},{"code":"400","description":"Bad Request. Partition ID is missing/invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unknown or Invalid user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"User forbidden from accessing this API.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1workflow~1{workflow_name}~1workflowRun~1{runId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkflowRunResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowRunResponse"}}},{"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":"403","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":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-run/updateworkflowrun"}],"panels":[]}]},"httpPath":"/workflow/{workflow_name}/workflowRun/{runId}"},{"label":"Get signed URL of a location that can be shared by tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-workflow-service/workflow-run/getsignedurl","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/workflow-run/getsignedurl","metadata":{"seo":{"title":"Get signed URL of a location that can be shared by tasks","description":"Returns a signed url with read/write access to a location which can be shared between different tasks in a workflow run."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSignedUrl","name":"Get signed URL of a location that can be shared by tasks","isWebhook":false,"pointer":"/paths/~1workflow~1{workflowId}~1workflowRun~1{runId}~1getSignedUrl/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get signed URL of a location that can be shared by tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a signed url with read/write access to a location which can be shared between different tasks in a workflow run."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_0","description":"Workflow ID","required":true},{"name":"runId","in":"path","schemaId":"schema_0","description":"ID of the workflow run","required":true}],"pointer":"/paths/~1workflow~1{workflowId}~1workflowRun~1{runId}~1getSignedUrl/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","schemaId":"schema_0","description":"desired data partition id","required":true}],"pointer":"/paths/~1workflow~1{workflowId}~1workflowRun~1{runId}~1getSignedUrl/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflow/{workflowId}/workflowRun/{runId}/getSignedUrl","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_0"},{"name":"runId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/workflow/{workflowId}/workflowRun/{runId}/getSignedUrl","href":"workflow-run/getsignedurl","openApiOperationId":"getSignedUrl","summary":"Get signed URL of a location that can be shared by tasks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","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":"Returns signed url","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetSignedUrlResponse"}},"schemaId":"components/schemas/GetSignedUrlResponse"},{"code":"400","description":"Invalid request. Either the run completed or failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unknown or Invalid user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"User forbidden from accessing this API.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Run does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1workflow~1{workflowId}~1workflowRun~1{runId}~1getSignedUrl/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetSignedUrlResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetSignedUrlResponse"}}},{"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":"403","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":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow-run/getsignedurl"}],"panels":[]}]},"httpPath":"/workflow/{workflowId}/workflowRun/{runId}/getSignedUrl"}],"content":{"contentType":"group","meta":{"name":"Workflow Run"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workflow Run","showPageActions":true},{"nodeType":"markdoc","content":"Workflow Execution management."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workflow/{workflow_name}/workflowRun","summary":"Get details of all workflows ever run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflow-run/getallworkflowinstances","deprecated":false},{"title":"/workflow/{workflow_name}/workflowRun","summary":"Triggers a workflow execution.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workflow-run/triggerworkflow","deprecated":false},{"title":"/workflow/{workflow_name}/workflowRun/{runId}","summary":"Get details of a specific workflow run instance.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflow-run/getworkflowrun","deprecated":false},{"title":"/workflow/{workflow_name}/workflowRun/{runId}","summary":"Update the status of a workflow run.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workflow-run/updateworkflowrun","deprecated":false},{"title":"/workflow/{workflowId}/workflowRun/{runId}/getSignedUrl","summary":"Get signed URL of a location that can be shared by tasks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflow-run/getsignedurl","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Operators","link":"/solutions/core-service/apis/osdu-workflow-service/custom-operators","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/custom-operators","items":[{"label":"Add a new custom operator","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-workflow-service/custom-operators/registercustomoperator","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/custom-operators/registercustomoperator","metadata":{"seo":{"title":"Add a new custom operator","description":"Register a custom operator which can be re-used in multiple workflows."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"registerCustomOperator","name":"Add a new custom operator","isWebhook":false,"pointer":"/paths/~1customOperator/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a new custom operator","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Register a custom operator which can be re-used in multiple workflows."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","schemaId":"schema_0","description":"desired data partition id","required":true}],"pointer":"/paths/~1customOperator/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RegisterCustomOperatorRequest"}},"schemaId":"components/schemas/RegisterCustomOperatorRequest","pointer":"/paths/~1customOperator/post/requestBody","description":"Request payload for registering custom operator"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customOperator","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RegisterCustomOperatorRequest"}},"responseCodes":["200","400","401","403","409","500"],"pointer":"/customOperator","href":"custom-operators/registercustomoperator","openApiOperationId":"registerCustomOperator","summary":"Add a new custom operator"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/RegisterCustomOperatorRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RegisterCustomOperatorRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Sucessfully registered operator","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomOperator"}},"schemaId":"components/schemas/CustomOperator"},{"code":"400","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unknown or Invalid user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"User forbidden from accessing this API.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"409","description":"Operator with same name already exists","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1customOperator/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomOperator","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomOperator"}}},{"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":"403","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":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-operators/registercustomoperator"}],"panels":[]}]},"httpPath":"/customOperator"},{"label":"Get all registered custom operators","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-workflow-service/custom-operators/getallcustomoperators","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/custom-operators/getallcustomoperators","metadata":{"seo":{"title":"Get all registered custom operators","description":"Get all the registered custom operators in a data partition. The results can be limited using the limit parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllCustomOperators","name":"Get all registered custom operators","isWebhook":false,"pointer":"/paths/~1customOperator/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all registered custom operators","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all the registered custom operators in a data partition.  The results can be limited using the limit parameter."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"The maximum number of custom operators to return. Default value of Limit is 50."},{"name":"cursor","in":"query","style":"form","explode":true,"schemaId":"schema_0","description":"Cursor for subsequent request."}],"pointer":"/paths/~1customOperator/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","schemaId":"schema_0","description":"desired data partition id","required":true}],"pointer":"/paths/~1customOperator/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customOperator","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"cursor","in":"query","required":false,"schemaId":"schema_0","style":"form","explode":true}],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/customOperator","href":"custom-operators/getallcustomoperators","openApiOperationId":"getAllCustomOperators","summary":"Get all registered custom operators"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","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":"Returns list of custom operators","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAllCustomOperatorsResponse"}},"schemaId":"components/schemas/GetAllCustomOperatorsResponse"},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unknown or Invalid user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"User forbidden from accessing this API.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1customOperator/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetAllCustomOperatorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAllCustomOperatorsResponse"}}},{"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":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-operators/getallcustomoperators"}],"panels":[]}]},"httpPath":"/customOperator"},{"label":"Get custom operator by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-workflow-service/custom-operators/getcustomoperatorbyid","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/custom-operators/getcustomoperatorbyid","metadata":{"seo":{"title":"Get custom operator by ID","description":"Returns a single custom operator based on the custom operator ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomOperatorById","name":"Get custom operator by ID","isWebhook":false,"pointer":"/paths/~1customOperator~1{customOperatorId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get custom operator by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a single custom operator based on the custom operator ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customOperatorId","in":"path","schemaId":"schema_0","description":"ID of custom operator to return","required":true}],"pointer":"/paths/~1customOperator~1{customOperatorId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","schemaId":"schema_0","description":"desired data partition id","required":true}],"pointer":"/paths/~1customOperator~1{customOperatorId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customOperator/{customOperatorId}","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"customOperatorId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/customOperator/{customOperatorId}","href":"custom-operators/getcustomoperatorbyid","openApiOperationId":"getCustomOperatorById","summary":"Get custom operator by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","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":"Returns custom operator","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomOperator"}},"schemaId":"components/schemas/CustomOperator"},{"code":"401","description":"Unknown or Invalid user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"User forbidden from accessing this API.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Custom operator not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1customOperator~1{customOperatorId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomOperator","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomOperator"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","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":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-operators/getcustomoperatorbyid"}],"panels":[]}]},"httpPath":"/customOperator/{customOperatorId}"}],"content":{"contentType":"group","meta":{"name":"Custom Operators"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Operators","showPageActions":true},{"nodeType":"markdoc","content":"Custom Operators management."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/customOperator","summary":"Add a new custom operator","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-operators/registercustomoperator","deprecated":false},{"title":"/customOperator","summary":"Get all registered custom operators","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-operators/getallcustomoperators","deprecated":false},{"title":"/customOperator/{customOperatorId}","summary":"Get custom operator by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-operators/getcustomoperatorbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Info","link":"/solutions/core-service/apis/osdu-workflow-service/info","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/info","items":[{"label":"Version info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-workflow-service/info/version info","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/info/version info","metadata":{"seo":{"title":"Version info","description":"For deployment available public /info endpoint,  which provides build and git related information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Version info","name":"Version info","isWebhook":false,"pointer":"/paths/~1info/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Version info","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":"For deployment available public "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/info"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint,  which provides build and git related information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/info","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/info","href":"info/version info","openApiOperationId":"Version info","summary":"Version info"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","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":"Version info.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VersionInfo"}},"schemaId":"components/schemas/VersionInfo"}],"pointer":"/paths/~1info/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VersionInfo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VersionInfo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/info/version info"}],"panels":[]}]},"httpPath":"/info"}],"content":{"contentType":"group","meta":{"name":"Info"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Info","showPageActions":true},{"nodeType":"markdoc","content":"Build and git information"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/info","summary":"Version info","prefix":{"name":"get","color":"get"},"badges":[],"link":"/info/version info","deprecated":false}]}]}]}]}},{"type":"group","label":"Schema Definitions","link":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions","items":[{"type":"link","label":"Workflow Run","link":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/workflowrun","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/workflowrun","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WorkflowRun"},"seo":{"title":"Workflow Run"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workflow Run","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WorkflowRun"},"children":[]}]}]}},{"type":"link","label":"Error","link":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/error","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/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":"Error Details","link":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/errordetails","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/errordetails","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ErrorDetails"},"seo":{"title":"Error Details"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Error Details","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ErrorDetails"},"children":[]}]}]}},{"type":"link","label":"RegisterCustomOperatorRequest","link":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/registercustomoperatorrequest","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/registercustomoperatorrequest","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"RegisterCustomOperatorRequest"},"seo":{"title":"RegisterCustomOperatorRequest"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RegisterCustomOperatorRequest","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/RegisterCustomOperatorRequest"},"children":[]}]}]}},{"type":"link","label":"CustomOperator","link":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/customoperator","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/customoperator","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CustomOperator"},"seo":{"title":"CustomOperator"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CustomOperator","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CustomOperator"},"children":[]}]}]}},{"type":"link","label":"CustomOperatorProperty","link":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/customoperatorproperty","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/customoperatorproperty","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CustomOperatorProperty"},"seo":{"title":"CustomOperatorProperty"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CustomOperatorProperty","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CustomOperatorProperty"},"children":[]}]}]}},{"type":"link","label":"GetAllCustomOperatorsResponse","link":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/getallcustomoperatorsresponse","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/getallcustomoperatorsresponse","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"GetAllCustomOperatorsResponse"},"seo":{"title":"GetAllCustomOperatorsResponse"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GetAllCustomOperatorsResponse","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/GetAllCustomOperatorsResponse"},"children":[]}]}]}},{"type":"link","label":"GetSignedUrlResponse","link":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/getsignedurlresponse","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/getsignedurlresponse","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"GetSignedUrlResponse"},"seo":{"title":"GetSignedUrlResponse"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GetSignedUrlResponse","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/GetSignedUrlResponse"},"children":[]}]}]}},{"type":"link","label":"UpdateWorkflowRunRequest","link":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/updateworkflowrunrequest","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/updateworkflowrunrequest","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"UpdateWorkflowRunRequest"},"seo":{"title":"UpdateWorkflowRunRequest"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"UpdateWorkflowRunRequest","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/UpdateWorkflowRunRequest"},"children":[]}]}]}},{"type":"link","label":"WorkflowMetadata","link":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/workflowmetadata","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/workflowmetadata","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WorkflowMetadata"},"seo":{"title":"WorkflowMetadata"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WorkflowMetadata","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WorkflowMetadata"},"children":[]}]}]}},{"type":"link","label":"CreateWorkflowRequest","link":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/createworkflowrequest","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/createworkflowrequest","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateWorkflowRequest"},"seo":{"title":"CreateWorkflowRequest"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateWorkflowRequest","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateWorkflowRequest"},"children":[]}]}]}},{"type":"link","label":"Workflow Run Response","link":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/workflowrunresponse","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/workflowrunresponse","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WorkflowRunResponse"},"seo":{"title":"Workflow Run Response"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workflow Run Response","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WorkflowRunResponse"},"children":[]}]}]}},{"type":"link","label":"TriggerWorkflowRequest","link":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/triggerworkflowrequest","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/triggerworkflowrequest","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"TriggerWorkflowRequest"},"seo":{"title":"TriggerWorkflowRequest"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"TriggerWorkflowRequest","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/TriggerWorkflowRequest"},"children":[]}]}]}},{"type":"link","label":"RegistrationInstructions","link":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/registrationinstructions","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/registrationinstructions","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"RegistrationInstructions"},"seo":{"title":"RegistrationInstructions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RegistrationInstructions","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/RegistrationInstructions"},"children":[]}]}]}},{"type":"link","label":"RegistrationInstructionsResponse","link":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/registrationinstructionsresponse","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/registrationinstructionsresponse","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"RegistrationInstructionsResponse"},"seo":{"title":"RegistrationInstructionsResponse"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RegistrationInstructionsResponse","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/RegistrationInstructionsResponse"},"children":[]}]}]}},{"type":"link","label":"VersionInfo","link":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/versioninfo","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/versioninfo","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"VersionInfo"},"seo":{"title":"VersionInfo"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"VersionInfo","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/VersionInfo"},"children":[]}]}]}},{"type":"link","label":"ConnectedOuterService","link":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/connectedouterservice","routeSlug":"/solutions/core-service/apis/osdu-workflow-service/schema-definitions/connectedouterservice","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ConnectedOuterService"},"seo":{"title":"ConnectedOuterService"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ConnectedOuterService","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ConnectedOuterService"},"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":"Workflow Run","link":"/schema-definitions/workflowrun","deprecated":false},{"title":"Error","link":"/schema-definitions/error","deprecated":false},{"title":"Error Details","link":"/schema-definitions/errordetails","deprecated":false},{"title":"RegisterCustomOperatorRequest","link":"/schema-definitions/registercustomoperatorrequest","deprecated":false},{"title":"CustomOperator","link":"/schema-definitions/customoperator","deprecated":false},{"title":"CustomOperatorProperty","link":"/schema-definitions/customoperatorproperty","deprecated":false},{"title":"GetAllCustomOperatorsResponse","link":"/schema-definitions/getallcustomoperatorsresponse","deprecated":false},{"title":"GetSignedUrlResponse","link":"/schema-definitions/getsignedurlresponse","deprecated":false},{"title":"UpdateWorkflowRunRequest","link":"/schema-definitions/updateworkflowrunrequest","deprecated":false},{"title":"WorkflowMetadata","link":"/schema-definitions/workflowmetadata","deprecated":false},{"title":"CreateWorkflowRequest","link":"/schema-definitions/createworkflowrequest","deprecated":false},{"title":"Workflow Run Response","link":"/schema-definitions/workflowrunresponse","deprecated":false},{"title":"TriggerWorkflowRequest","link":"/schema-definitions/triggerworkflowrequest","deprecated":false},{"title":"RegistrationInstructions","link":"/schema-definitions/registrationinstructions","deprecated":false},{"title":"RegistrationInstructionsResponse","link":"/schema-definitions/registrationinstructionsresponse","deprecated":false},{"title":"VersionInfo","link":"/schema-definitions/versioninfo","deprecated":false},{"title":"ConnectedOuterService","link":"/schema-definitions/connectedouterservice","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/WorkflowRun":{"id":"components/schemas/WorkflowRun","kind":"json-schema","title":"Workflow Run","data":{"title":"Workflow Run","description":"Represents one workflow run.","type":"object","properties":{"endTimeStamp":{"readOnly":true,"type":"number","description":"End timestamp of the workflow run. Epoch timestamp."},"runId":{"readOnly":true,"type":"string","description":"Run id for the workflow."},"startTimeStamp":{"readOnly":true,"type":"number","description":"Start timestamp of the workflow run. Epoch time stamp."},"status":{"description":"Task execution status","enum":["submitted","running","failed","success"],"title":"status","type":"string"},"submittedBy":{"readOnly":true,"type":"string","description":"System captured user details which triggered the  run."},"workflowEngineExecutionDate":{"type":"string","format":"date-time"},"workflowId":{"readOnly":true,"type":"string","description":"Workflow id for the workflow."},"workflowName":{"type":"string","description":"Name of the workflow."}}}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"title":"Error","type":"object","properties":{"code":{"type":"integer","format":"int32"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetails"}},"message":{"type":"string"}}}},"components/schemas/ErrorDetails":{"id":"components/schemas/ErrorDetails","kind":"json-schema","title":"Error Details","data":{"title":"Error Details","type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string"}}}},"components/schemas/RegisterCustomOperatorRequest":{"id":"components/schemas/RegisterCustomOperatorRequest","kind":"json-schema","title":"RegisterCustomOperatorRequest","data":{"type":"object","required":["name","className","description","content"],"properties":{"name":{"type":"string","example":"hello_world_operator"},"className":{"type":"string","example":"HelloWorld"},"description":{"type":"string","example":"Used to print hello world"},"content":{"type":"string","example":"Content of the custom operator"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/CustomOperatorProperty"}}}}},"components/schemas/CustomOperator":{"id":"components/schemas/CustomOperator","kind":"json-schema","title":"CustomOperator","data":{"type":"object","required":["id","name","className","description"],"properties":{"id":{"type":"string","example":"some_id"},"name":{"type":"string","example":"hello_world_operator"},"className":{"type":"string","example":"HelloWorld"},"description":{"type":"string","example":"Used to print hello world"},"createdBy":{"type":"string","readOnly":true},"createdAt":{"type":"string","format":"date-time"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/CustomOperatorProperty"}}}}},"components/schemas/CustomOperatorProperty":{"id":"components/schemas/CustomOperatorProperty","kind":"json-schema","title":"CustomOperatorProperty","data":{"type":"object","properties":{"name":{"type":"string","example":"some Variable"},"description":{"type":"string","example":"some Description"},"mandatory":{"type":"boolean","example":true}}}},"components/schemas/GetAllCustomOperatorsResponse":{"id":"components/schemas/GetAllCustomOperatorsResponse","kind":"json-schema","title":"GetAllCustomOperatorsResponse","data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CustomOperator"}},"cursor":{"type":"string"}}}},"components/schemas/GetSignedUrlResponse":{"id":"components/schemas/GetSignedUrlResponse","kind":"json-schema","title":"GetSignedUrlResponse","data":{"type":"object","required":["url"],"properties":{"url":{"type":"string","example":"https://foo.com"}}}},"components/schemas/UpdateWorkflowRunRequest":{"id":"components/schemas/UpdateWorkflowRunRequest","kind":"json-schema","title":"UpdateWorkflowRunRequest","data":{"type":"object","properties":{"status":{"type":"string","enum":["submitted","running","failed","success"]}},"title":"UpdateWorkflowRunRequest"}},"components/schemas/WorkflowMetadata":{"id":"components/schemas/WorkflowMetadata","kind":"json-schema","title":"WorkflowMetadata","data":{"type":"object","properties":{"createdBy":{"type":"string"},"creationTimestamp":{"type":"integer","format":"int64"},"description":{"type":"string"},"registrationInstructions":{"type":"object","$ref":"#/components/schemas/RegistrationInstructionsResponse"},"version":{"type":"integer","format":"int64"},"workflowId":{"type":"string"},"workflowName":{"type":"string"}},"title":"WorkflowMetadata"}},"components/schemas/CreateWorkflowRequest":{"id":"components/schemas/CreateWorkflowRequest","kind":"json-schema","title":"CreateWorkflowRequest","data":{"type":"object","properties":{"description":{"type":"string"},"registrationInstructions":{"type":"object","$ref":"#/components/schemas/RegistrationInstructions"},"workflowName":{"type":"string"}},"title":"CreateWorkflowRequest"}},"components/schemas/WorkflowRunResponse":{"id":"components/schemas/WorkflowRunResponse","kind":"json-schema","title":"Workflow Run Response","data":{"title":"Workflow Run Response","description":"Represent one workflow run.","type":"object","properties":{"endTimeStamp":{"readOnly":true,"type":"number","description":"End timestamp of the workflow run. Epoch timestamp."},"runId":{"readOnly":true,"type":"string","description":"Run id for the workflow."},"startTimeStamp":{"readOnly":true,"type":"number","description":"Start timestamp of the workflow run. Epoch timestamp."},"status":{"description":"Task execution status","enum":["submitted","running","failed","success"],"title":"status","type":"string"},"submittedBy":{"readOnly":true,"type":"string","description":"System captured user details which triggered the run."},"workflowId":{"readOnly":true,"type":"string","description":"Workflow id for the workflow."}}}},"components/schemas/TriggerWorkflowRequest":{"id":"components/schemas/TriggerWorkflowRequest","kind":"json-schema","title":"TriggerWorkflowRequest","data":{"type":"object","properties":{"executionContext":{"type":"object","properties":{"id":{"type":"string","description":"Record id of file metadata record."},"dataPartitionId":{"type":"string","description":"Data partition id."}}},"runId":{"type":"string","description":"Optional. Run ID can be set explicitly by the user. If not set, the system will generate a run ID for the workflow run."}},"title":"TriggerWorkflowRequest"}},"components/schemas/RegistrationInstructions":{"id":"components/schemas/RegistrationInstructions","kind":"json-schema","title":"RegistrationInstructions","data":{"type":"object","title":"RegistrationInstructions","properties":{"dagName":{"type":"string","description":"Name of the DAG"},"dagContent":{"type":"string","description":"Workflow Detail file content which contains orchestration artifacts. For example, in case of Airflow, this field will contain contents of a python DAG file."}}}},"components/schemas/RegistrationInstructionsResponse":{"id":"components/schemas/RegistrationInstructionsResponse","kind":"json-schema","title":"RegistrationInstructionsResponse","data":{"type":"object","title":"RegistrationInstructionsResponse","properties":{"dagName":{"type":"string","description":"Name of the DAG"}}}},"components/schemas/VersionInfo":{"id":"components/schemas/VersionInfo","kind":"json-schema","title":"VersionInfo","data":{"type":"object","properties":{"groupId":{"type":"string","description":"Maven artifact group ID."},"actifactId":{"type":"string","description":"Maven artifact ID."},"version":{"type":"string","description":"Maven artifact version"},"buildTime":{"type":"string","description":"Maven artifact build time"},"branch":{"type":"string","description":"Current git branch"},"commitId":{"type":"string","description":"Latest commit hash"},"commitMessage":{"type":"string","description":"Latest commit message"},"connectedOuterServices":{"type":"array","description":"Connected outer services information","items":{"$ref":"#/components/schemas/ConnectedOuterService"}}},"description":"Version info."}},"components/schemas/ConnectedOuterService":{"id":"components/schemas/ConnectedOuterService","kind":"json-schema","title":"ConnectedOuterService","data":{"type":"object","properties":{"name":{"type":"string","description":"Connected outer service name."},"version":{"type":"string","description":"Connected outer service version."}},"description":"Connected outer service information."}},"schema_0":{"kind":"json-schema","data":{"type":"string"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/WorkflowMetadata"},"type":"array"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"object"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowRun"}},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_4"}},"exampleStore":{},"securitySchemeStore":{"bearer":{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}},"specVersion":"3.0.0","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/workflow/v1","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","isMockServer":true,"description":"Mock server"}],"specType":"openapi"},"options":{"schemaDefinitionsTagName":"Schema Definitions","mockServer":{"url":"/_mock/solutions/core-service/apis/osdu-workflow-service","position":"last","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/solutions/core-service/apis/OSDU-Workflow-Service.json?download"},{"url":"/_bundle/solutions/core-service/apis/OSDU-Workflow-Service.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Workflow Service","description":"Workflow Service API is a wrapper API on existing orchestrator services (Apache Airflow) defined in a way which suits the domain workflow needs. This API is responsible for creation and maintenance of the workflows. Operational tasks such as starting, stopping and pausing workflows are also part of this API. <br><br>\nurl: 'http://www.apache.org/licenses/LICENSE-2.0.html'\n\n```plain {% title=\"Client ID\" %}\n963f2cc6915e479fa0fcb73ec2ec90e7\n```\n"}},"baseSlug":"/solutions/core-service/apis/osdu-workflow-service","routesMapping":{}}