{"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 Publisher endpoints"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$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 Publisher service provides APIs for publishing dataset details and status messages to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["statuschangedtopic"]},"."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Dataset details"]}," - A dataset can be anything that contains data. A file is one type of dataset that contains data inside. A file collection is another type of dataset that contains a set of files."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Status"]}," - Holds the overall status of the dataflow."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"status-publisher-endpoints","__idx":2},"children":["Status Publisher endpoints ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"endpoints"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Status Publisher service supports the operations listed below from different endpoints:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"publish-dataset-details","__idx":3},"children":["Publish dataset details ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"publishDataset"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can use the POST /dataset-details endpoint to publish the dataset details message to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["statuschangedtopic"]},"."," ","The endpoint accepts a list of dataset details."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"sample-dataset-details-publish-request","__idx":4},"children":["Sample dataset details publish request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"[\n  {\n    \"correlationId\": \"1cc462e9-9a39-48b9-84c3-9d53b18b8089\",\n    \"datasetId\": \"opendes:dataset--File.Generic:332b55d5-0cf2-4474-a3e5-d3cff0c5746a\",\n    \"datasetVersionId\": \"opendes:dataset--File.Generic:332b55d5-0cf2-4474-a3e5-d3cff0c5746a:23423432\",\n    \"datasetType\": \"FILE\",\n    \"recordCount\": 1\n  }\n]\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"publish-status","__idx":5},"children":["Publish status ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"publishStatus"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can use the POST /status endpoint to publish the status message to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["statuschangedtopic"]},"."," ","The endpoint accepts a list of statuses."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"sample-status-publish-request","__idx":6},"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":7},"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 the 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, and 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 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Boolean"]},". Examples: opendes:wellbore:osdudemo-5noUsKs81vWsu0w3, true, and 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":["You can find more details about supported stages and statuses 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":8},"children":["API Specs ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"api-specs"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All available Status Publisher service APIs are in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/data-workspace/apis/osdu-status-publisher-service"},"children":["API Reference"]},"."]}]},"headings":[{"value":"Table of Contents","id":"table-of-contents","depth":2},{"value":"Introduction","id":"introduction","depth":2},{"value":"Status Publisher endpoints","id":"status-publisher-endpoints","depth":2},{"value":"Publish dataset details","id":"publish-dataset-details","depth":3},{"value":"Sample dataset details publish request","id":"sample-dataset-details-publish-request","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-04-14T18:27:59.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/data-workspace/tutorial/status-publisher-service","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}