{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Table of Contents","description":"Accelerate E&P application development and protect your innovation by consuming our Data and Domain APIs / Platform APIs.","lang":"en-US","meta":[{"name":"robots","content":"noindex"}],"llmstxt":{"hide":true,"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"table-of-contents","__idx":0},"children":["Table of Contents"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#introduction"},"children":["Introduction"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#endpoints"},"children":["Status Processor endpoints"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#queryDataset"},"children":["Query Dataset details"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#queryStatus"},"children":["Query Status"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#publishDataset"},"children":["Publish Dataset details"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#publishStatus"},"children":["Publish Status"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#api-specs"},"children":["API Specs"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"introduction","__idx":1},"children":["Introduction ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"introduction"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Status Processor Service allows you to monitor the status of files, data, and records ingested through the File Service, Storage API, and pecific DOMS. It is consumed by dependent services."," ","The status can show you whether the dataflow has finished or not, and if it was successful or failed. To track the status of a dataflow, use the provided APIs."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"status-processor-endpoints","__idx":2},"children":["Status Processor endpoints ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"endpoints"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Status Processor service supports the operations listed below via different endpoints:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"query-dataset-details","__idx":3},"children":["Query Dataset details ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"queryDataset"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can query dataset details using the GET /dataset-details endpoint based on the following parameters:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Attribute"},"children":["Attribute"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Use"},"children":["Use"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Data type"},"children":["Data type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required (Yes/No)"},"children":["Required (Yes/No)"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["correlationId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["CorrelationId"]}," is a unique GUID used to capture a single request going through different stages of the Data Platform. You must send it as correlation-id header while initiating the call on the Data Platform. For File Service, the correlation-id is provided for the Metadata API call. The correlation-id is created or generated by the user, so the user already has it."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["0a231229-cf4b-4a71-8f7d-8a499289364d"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes. CorrelationId or datasetId is required."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["datasetId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["DatasetId"]}," is a metadata record id that is returned in the response by the Metadata API while the metadata record is created. You can use the same id for querying the DataSet API of the Status Processor to fetch the correlation-id associated with this request."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["partitionId:dataset--File.Generic:fe57d55d-1736-42d4-b13c-115bc5f96ead"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes. CorrelationId or datasetId is required."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"query-status","__idx":4},"children":["Query Status ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"queryStatus"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can query the status using the POST /status/query endpoint that is available in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/data-workspace/apis/osdu-status-processor-service"},"children":["API Reference"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"sample-status-query-request","__idx":5},"children":["Sample Status Query Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"statusQuery\": {\n    \"correlationId\": \"1cc462e9-9a39-48b9-84c3-9d53b18b8089\"\n  },\n  \"limit\": 10,\n  \"cursor\": \"eyJjb21wb3NpdGVUb2tlbiI6IntcInRva2VuXCI6bnVsbCxcInJhbmdlXCI6e1wibWluXCI6XCJcIixcIm1heFwiOlwiMDVDMURGRkZGRkZGRkNcIn19Iiwib3JkZXJCeUl0ZW1zIjpbeyJwcm9wZXJ0eUJhZyI6eyJpdGVtIjoxNjMwMDQ0ODI0fSwiaXRlbSI6MTYzMDA0NDgyNCwibWFwIjp7Iml0ZW0iOjE2MzAwNDQ4MjR9fV0sInJpZCI6InFHMDVBTllhK3VoNHRuVUFBQUFBQUE9PSIsImluY2x1c2l2ZSI6dHJ1ZX0\"\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"statusQuery\": {\n    \"correlationId\": \"1cc462e9-9a39-48b9-84c3-9d53b18b8089\",\n    \"stage\": [\n      \"FILE_SYNC\",\n      \"STORAGE_SYNC\"\n    ],\n    \"status\": [\n      \"SUCCESS\"\n    ]\n  },\n  \"limit\": 100\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"statusQuery\": {\n    \"correlationId\": \"1cc462e9-9a39-48b9-84c3-9d53b18b8089\",\n    \"stage\": [\n      \"WKS_SYNC\"\n    ],\n    \"status\": [\n      \"SKIPPED\",\n      \"FAILED\"\n    ]\n  },\n  \"limit\": 100\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"statusQuery\": {\n    \"correlationId\": \"1cc462e9-9a39-48b9-84c3-9d53b18b8089\",\n    \"status\": [\n      \"FAILED\"\n    ],\n    \"errorCode\": [\n      400,\n      500\n    ],\n    \"fromTimestamp\": 1628571397,\n    \"toTimestamp\": 1628639797\n  },\n  \"limit\": 100\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"sample-status-query-request-with-additionalproperties","__idx":6},"children":["Sample Status Query Request with additionalProperties:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Additional Properties is a map of key-value pairs that provides additional information for the status."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It accepts key-value pair at the first level only."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The supported data type for the keys is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["String"]}," and any string value can be key. Examples: inputRecordId, version, timestamp."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The supported data types for the values are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["String, Integer, Number, and Boolean"]},". Example: opendes:wellbore:osdudemo-5noUsKs81vWsu0w3, true, 1234567."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can query additional status properties using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additionalProperties"]}," by specifying one or more properties."]},{"$$mdtype":"Tag","name":"table","attributes":{"style":{"width":"100%","tableLayout":"fixed","borderCollapse":"collapse"}},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{},"children":["Status Record"]},{"$$mdtype":"Tag","name":"th","attributes":{},"children":["Status Query"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"valign":"top","style":{"width":"50%","padding":"5px","border":"1px solid #ccc"}},"children":[{"$$mdtype":"Tag","name":"pre","attributes":{"style":{"margin":"0","whiteSpace":"pre-wrap","wordBreak":"break-word"}},"children":["\n{\n    \"kind\": \"status\",\n    \"properties\": {\n      \"correlationId\": \"1cc462e9-9a39-48b9-84c3-9d53b18b8089\",\n      \"recordId\": \"opendes:wellbore:wks-35b7eecfa2c35145053b150f47461bea630a.osdu.wks.wellbore.2\",\n      \"recordIdVersion\": \"opendes:wellbore:wks-35b7eecfa2c35145053b150f47461bea630a.osdu.wks.wellbore.2\",\n      \"stage\": \"WKS_SYNC\",\n      \"status\": \"SUCCESS\",\n      \"errorCode\": 0,\n      \"userEmail\": \"test@email.com\",\n      \"timestamp\": 1625221800,\n      \"additionalProperties\": {\n        \"inputRecordId\": \"opendes:wellbore:osdudemo-5noUsKs81vWsu0w3\",\n        \"inputRecordIdVersion\": \"opendes:wellbore:osdudemo-5noUsKs81vWsu0w3:23423432\"\n      }\n    }\n  }\n"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"valign":"top","style":{"width":"50%","padding":"5px","border":"1px solid #ccc"}},"children":[{"$$mdtype":"Tag","name":"pre","attributes":{"style":{"margin":"0","whiteSpace":"pre-wrap","wordBreak":"break-word"}},"children":["\n{\n  \"statusQuery\": {\n    \"correlationId\": \"1cc462e9-9a39-48b9-84c3-9d53b18b8089\",\n    \"additionalProperties\": {\n       \"inputRecordId\": \"opendes:wellbore:osdudemo-5noUsKs81vWsu0w3\",\n       \"inputRecordIdVersion\": \"opendes:wellbore:osdudemo-5noUsKs81vWsu0w3:23423432\"\n    }\n  },\n  \"limit\": 10\n}\n"]}]}]}]},{"$$mdtype":"Tag","name":"table","attributes":{"style":{"width":"100%","tableLayout":"fixed","borderCollapse":"collapse"}},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"valign":"top","style":{"width":"50%","padding":"5px","border":"1px solid #ccc"}},"children":[{"$$mdtype":"Tag","name":"pre","attributes":{"style":{"margin":"0","whiteSpace":"pre-wrap","wordBreak":"break-word"}},"children":["\n{\n    \"kind\": \"status\",\n    \"properties\": {\n      \"correlationId\": \"1cc462e9-9a39-48b9-84c3-9d53b18b8089\",\n      \"recordId\": \"opendes:wellbore:wks-35b7eecfa2c35145053b150f47461bea630a.osdu.wks.wellbore.2\",\n      \"recordIdVersion\": \"opendes:wellbore:wks-35b7eecfa2c35145053b150f47461bea630a.osdu.wks.wellbore.2\",\n      \"stage\": \"WKS_SYNC\",\n      \"status\": \"SUCCESS\",\n      \"errorCode\": 0,\n      \"userEmail\": \"test@email.com\",\n      \"timestamp\": 1625221800,\n      \"additionalProperties\": {\n        \"inputRecordId\": \"opendes:wellbore:osdudemo-5noUsKs81vWsu0w3\",\n        \"inputRecordIdVersion\": \"opendes:wellbore:osdudemo-5noUsKs81vWsu0w3:23423432\"\n      }\n    }\n  }\n"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"valign":"top","style":{"width":"50%","padding":"5px","border":"1px solid #ccc"}},"children":[{"$$mdtype":"Tag","name":"pre","attributes":{"style":{"margin":"0","whiteSpace":"pre-wrap","wordBreak":"break-word"}},"children":["\n{\n  \"statusQuery\": {\n    \"correlationId\": \"1cc462e9-9a39-48b9-84c3-9d53b18b8089\",\n    \"stage\": [\n      \"FILE_SYNC\",\n      \"WKS_SYNC\"\n    ],\n    \"status\": [\n      \"SUCCESS\"\n    ],\n    \"additionalProperties\": {\n       \"inputRecordIdVersion\": \"opendes:wellbore:osdudemo-5noUsKs81vWsu0w3:23423432\"\n    }\n  },\n  \"limit\": 100\n}\n"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"publish-status","__idx":7},"children":["Publish Status ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"publishStatus"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note"]},": Endpoint is DEPRECATED. To publish Status refer ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/data-workspace/tutorial/status-publisher-service"},"children":["Status Publisher tutorial"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can use the POST /status endpoint to publish the Status message to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["statuschangedtopic"]},"."," ","The endpoint accepts s list of statuses."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"sample-status-publish-request","__idx":8},"children":["Sample Status Publish Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"[\n  {\n    \"correlationId\": \"1cc462e9-9a39-48b9-84c3-9d53b18b8089\",\n    \"recordId\": \"opendes:wellbore:osdudemo-ATVMxMDEzTVMxMDQ\",\n    \"recordIdVersion\": \"opendes:wellbore:osdudemo-ATVMxMDEzTVMxMDQ:23423432\",\n    \"stage\": \"FILE_SYNC\",\n    \"status\": \"SUCCESS\",\n    \"message\": \"File metadata stored successfully\",\n    \"errorCode\": 0\n  }\n]\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"[\n  {\n    \"correlationId\": \"1cc462e9-9a39-48b9-84c3-9d53b18b8089\",\n    \"recordId\": \"opendes:wellbore:5noUsKs81vWsu0w3\",\n    \"stage\": \"WKS_SYNC\",\n    \"status\": \"FAILED\",\n    \"message\": \"Raw record not present\",\n    \"errorCode\": 400\n  }\n]\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"sample-status-publish-request-with-additionalproperties","__idx":9},"children":["Sample Status Publish Request with additionalProperties"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Additional Properties ('additionalProperties') is a map of key-value pairs that provides additional information for the status."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It accepts a key-value pair at 1st level only."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The supported data type for the keys is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["String"]}," and any string value can be a key. Examples: inputRecordId, version, timestamp."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Supported data types for the values are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["String, Integer, Long, Double,  and Boolean"]},". Examples: opendes:wellbore:osdudemo-5noUsKs81vWsu0w3, true, 1234567."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"[\n  {\n    \"kind\": \"status\",\n    \"properties\": {\n      \"correlationId\": \"1cc462e9-9a39-48b9-84c3-9d53b18b8089\",\n      \"recordId\": \"opendes:wellbore:wks-35b7eecfa2c35145053b150f47461bea630a.osdu.wks.wellbore.2\",\n      \"recordIdVersion\": \"opendes:wellbore:wks-35b7eecfa2c35145053b150f47461bea630a.osdu.wks.wellbore.2\",\n      \"stage\": \"WKS_SYNC\",\n      \"status\": \"SUCCESS\",\n      \"errorCode\": 0,\n      \"userEmail\": \"test@email.com\",\n      \"timestamp\": 1625221800,\n      \"additionalProperties\": {\n        \"inputRecordId\": \"opendes:wellbore:osdudemo-5noUsKs81vWsu0w3\",\n        \"inputRecordIdVersion\": \"opendes:wellbore:osdudemo-5noUsKs81vWsu0w3:23423432\"\n      }\n    }\n  }\n]\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["More details about supported Stages and Statuses can be found in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/data-workspace/tutorial/global-status-monitoring"},"children":["Global Status Monitoring tutorial"]}," in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Supported Stages and Statuses"]}," section."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-specs","__idx":10},"children":["API Specs ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"api-specs"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All available Status Processor service APIs are in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/data-workspace/apis/osdu-status-processor-service"},"children":["API Reference"]},"."]}]},"headings":[{"value":"Table of Contents","id":"table-of-contents","depth":2},{"value":"Introduction","id":"introduction","depth":2},{"value":"Status Processor endpoints","id":"status-processor-endpoints","depth":2},{"value":"Query Dataset details","id":"query-dataset-details","depth":3},{"value":"Query Status","id":"query-status","depth":3},{"value":"Sample Status Query Request","id":"sample-status-query-request","depth":4},{"value":"Sample Status Query Request with additionalProperties:","id":"sample-status-query-request-with-additionalproperties","depth":4},{"value":"Publish Status","id":"publish-status","depth":3},{"value":"Sample Status Publish Request","id":"sample-status-publish-request","depth":4},{"value":"Sample Status Publish Request with additionalProperties","id":"sample-status-publish-request-with-additionalproperties","depth":4},{"value":"API Specs","id":"api-specs","depth":2}],"frontmatter":{"seo":{"title":"Table of Contents"}},"lastModified":"2025-07-25T15:08:51.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/data-workspace/tutorial/status-processor-service","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}