{"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":"a","attributes":{"name":"TOC"},"children":[]}]},{"$$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":"#ingestion-framework"},"children":["Ingestion framework"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#components"},"children":["Components"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#access-controls"},"children":["Access controls"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#how-to-execute-the-shapefile-workflow"},"children":["How to execute the Shapefile workflow"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#1-register-schema-using-schema-service"},"children":["1.\tRegister a schema using the Schema service"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#2-get-signed-url-using-file-service"},"children":["2. Get a signed URL using the File service"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#3-upload-shapefile-using-signed-url"},"children":["3.\tUpload a shapefile using a signed URL"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#4-create-file-metadata-record-using-file-service"},"children":["4.\tCreate a file metadata record using the File service"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#5-run-the-shapefile-workflow"},"children":["5.\tRun the Shapefile workflow"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#6-monitor-the-workflow-status"},"children":["6. Monitor the workflow status"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#7-validate-the-ingested-data"},"children":["7.\tValidate the ingested data"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#input-file-and-schemas"},"children":["Input file and schemas"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#file-metadata-record"},"children":["File metadata record"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#preregistered-dags"},"children":["Preregistered DAG"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#limitations"},"children":["Limitations"]}]}]},{"$$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":["This document guides users who want to leverage the preregistered shapefile Directed Acyclic Graph (DAG) and have their data ingested from shapefiles. It covers the existing shapefile DAG capability, defines a way to trigger the DAG, and describes how to upload shapefiles for ingestion."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"ingestion-framework","__idx":2},"children":["Ingestion framework ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"ingestion-framework"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The OSDU R3 ingestion framework is built to ingest various data file types such as Shapefile, LAS, DLIS, and so on, with Apache Airflow, an open-source platform to author, schedule, and monitor workflows. Workflows in Airflow are collections of tasks that have directional dependencies. Specifically, Airflow uses a DAG to represent a workflow. At a high level, a DAG can be thought of as a container that holds tasks and their dependencies, and sets the context for when and how those tasks are executed."," ","There are various components in the framework which enable uploading a file, creating the required schemas for ingestion, or invoking the ingestors. Each is explained in detail in the sections that follow."," ","The ingestion framework comes with several preregistered DAGs. These are available out-of-the-box, and you can use them to execute specific workflows. Some of these preregistered DAGs are for shapefile, CSV, LAS, and Document ingestion workflows."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"components","__idx":3},"children":["Components ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"components"},"children":[]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/core-service/apis/osdu-file-service"},"children":["File service"]}]}," – This service facilitates management of files on the data platform. Uploading, secure discovery, and downloading of files are capabilities provided by File Service."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["[Storage service][(../../core-service/apis/OSDU-Storage-Service.yaml)"]}," – This JSON object store facilitates storage of metadata information for domain entities. It also raises storage events when the records are saved using the Storage service."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Notification service"]}," – Consumers use this service to subscribe to storage events. Use the Register service to register the subscription."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/core-service/apis/osdu-workflow-service"},"children":["Workflow service"]}]}," – This service facilitates the management of workflows on the data platform by providing a wrapper around the workflow engine to abstract some of the technical nuances of the workflow engine from consumers."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Airflow engine"]}," – This service is the heart of the ingestion framework and acts as a workflow orchestrator."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["DAGs"]}," – This service is based on Direct Acyclic Graph concept and represent workflows that are authored, orchestrated, managed, and monitored by the workflow engine."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/csv-components.e267a525cd09ca4e7a0cd25d51d6bd063a0b6b112ba001aee852beca676c87ec.cff9a875.png","alt":"API Security - High level"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"access-controls","__idx":4},"children":["Access controls ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"access-controls"},"children":[]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Access required:"]},{"$$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":"#"},"children":["#"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Service level group"},"children":["Service level group"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Service API operations"},"children":["Service API operations"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["service.workflow.viewer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List custom operators"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["service.workflow.creator"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Register DAG"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["3"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["service.workflow.admin"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Register custom operator, trigger workflow, and data sharing between two tasks in ONE workflow (SAS URL)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["4"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["service.file.viewers & service.file.editors"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["To upload and download the file and create file metadata"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["5"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["service.legal.editor & service.legal.user"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create and retrieve legal tags"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["6"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["service.schema-service.editors, service.schema-service.viewers & service.schema-service.admin"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["To create, update, and view the schema"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["7"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["service.storage.admin, service.storage.creator & service.storage.viewer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["To create, update, and view the records in storage"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["8"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["service.search.user & service.search.admin"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["To search the records"]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-to-execute-the-shapefile-workflow","__idx":5},"children":["How to execute the Shapefile workflow ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"how-to-execute-the-shapefile-workflow"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/csv-ingestion.ecb11d5744a416ad4faf6f86aa15e1645ca7fe56d478c4636efa4c621605f337.cff9a875.png","alt":"Generic steps to execute a DAG using the Ingestion workflow service"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"1register-your-schema-using-the-schema-service","__idx":6},"children":["1.\tRegister your schema using the Schema service  ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"1-register-schema-using-schema-service"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the Schema service to register your schema that describes the data model for each Excel sheet. The schema used to ingest data must have spatial references. For more information, refer to the Schema service tutorial and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/core-service/apis/osdu-schema-service"},"children":["API Reference"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"2-get-a-signed-url-using-the-file-service","__idx":7},"children":["2. Get a signed URL using the File service ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"2-get-signed-url-using-file-service"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A signed URL is required in order to upload the shapefile to cloud storage. The input file must be a .zip or .tar file (.zipx is not supported)."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/core-service/apis/osdu-file-service"},"children":["API Reference"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["GET Request: /file/v2/files/uploadURL"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response:"]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[" Sample Response  "]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"    {\n        \"FileID\": \"0bc2ad23cecb4275916089280da336ca\",\n        \"Location\": {\n            \"SignedURL\": \"https://osdur3mvpdp1qadizpdata.blob.core.windows.net/file-staging-area/osdu-user%2F1611218353490-2021-01-21-08-39-13-490%2F0bc2ad23cecb4275916089280da336ca?sv=2019-12-12&se=2021-01-28T08%3A39%3A14Z&sr=b&sp=cw&sig=y3%2FVHfeCyotI5bJU9446vHnpbIIchtrsB40szoj0QMM%3D\",\n            \"FileSource\": \"/osdu-user/1611218353490-2021-01-21-08-39-13-490/0bc2ad23cecb4275916089280da336ca\"\n        }\n    }\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["We refer to this response in next step. The ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["SignedURL"]}," attribute is used to upload the file in the next step (3), and the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["FileSource"]}," is used in step 5 to run workflow."]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"3upload-the-shapefile-using-a-signed-url","__idx":8},"children":["3.\tUpload the Shapefile using a signed URL ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"3-upload-shapefile-using-signed-url"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Upload the file using the signed URL obtained in the previous step. Use a PUT request to pass the input file. The file is uploaded to cloud storage."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["PUT Request: Use the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["SignedURL"]}," value from previous step"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["HTTP Headers:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["'x-ms-blob-type: BlockBlob'"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Execute the PUT request by adding the file as a binary request."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"4create-a-file-metadata-record-using-the-file-service","__idx":9},"children":["4.\tCreate a file metadata record using the File service ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"4-create-file-metadata-record-using-file-service"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the File service to create metadata. The metadata enables the discovery of the file and secure downloads. It also provides a mechanism to query information associated with the file that is required during its processing. For more information, refer to the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#file-metadata-record"},"children":["File Metadata Record Reference"]}," below for more details."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API reference"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/core-service/apis/osdu-file-service"},"children":["File Service API"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["POST request: /file/v2/files/metadata"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payload:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set the metadata ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.Filesource"]}," parameter to be the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["FileSource"]}," value obtained from step 2."]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[" Sample Request  "]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n\"data\": {\n    \"Endian\": \"BIG\",\n    \"Description\": \"string\",\n    \"DatasetProperties\": {\n    \"FileSourceInfo\": {\n        \"FileSource\": \"<filesource>\",\n        \"PreLoadFilePath\": \"string\",\n        \"PreloadFileCreateUser\": \"user@slb.com\",\n        \"PreloadFileModifyUser\": \"string\",\n        \"PreloadFileModifyDate\": \"string\",\n        \"Name\": \"states.zip\",\n        \"FileSize\": \"65kb\",\n        \"EncodingFormatTypeID\": \"UTF-8\"\n    }\n    },\n    \"ResourceLifecycleStatus\": \"string\",\n    \"TotalSize\": \"65kb\",\n    \"ResourceCurationStatus\": \"string\",\n    \"EncodingFormatTypeID\": \"string\",\n    \"Name\": \"states.zip\",\n    \"ResourceHomeRegionID\": \"string\",\n    \"ResourceHostRegionIDs\": [\n    \"string\"\n    ],\n    \"ExtensionProperties\": {\n    \"Classification\": \"string\",\n    \"Description\": \"US states shape file\",\n    \"ExternalIds\": [\n        \"string\"\n    ],\n    \"FileDateCreated\": {},\n    \"FileDateModified\": {},\n    \"FileContentsDetails\": {\n        \"TargetKind\": \"<authority>:<source>:<entity type>:1.0.0\",\n        \"FrameOfReference\": [\n                {\n                    \"kind\": \"CRS\",\n                    \"name\": \"GCS_North_American_1983\",\n                    \"persistableReference\": \"{\\\"lateBoundCRS\\\":{\\\"wkt\\\":\\\"GEOGCS[\\\\\\\"GCS_North_American_1983\\\\\\\",DATUM[\\\\\\\"D_North_American_1983\\\\\\\",SPHEROID[\\\\\\\"GRS_1980\\\\\\\",6378137.0,298.257222101]],PRIMEM[\\\\\\\"Greenwich\\\\\\\",0.0],UNIT[\\\\\\\"Degree\\\\\\\",0.0174532925199433],AUTHORITY[\\\\\\\"EPSG\\\\\\\",4269]]\\\",\\\"ver\\\":\\\"PE_10_3_1\\\",\\\"name\\\":\\\"GCS_North_American_1983\\\",\\\"authCode\\\":{\\\"auth\\\":\\\"EPSG\\\",\\\"code\\\":\\\"4269\\\"},\\\"type\\\":\\\"LBC\\\"},\\\"singleCT\\\":{\\\"wkt\\\":\\\"GEOGTRAN[\\\\\\\"NAD_1983_To_WGS_1984_1\\\\\\\",GEOGCS[\\\\\\\"GCS_North_American_1983\\\\\\\",DATUM[\\\\\\\"D_North_American_1983\\\\\\\",SPHEROID[\\\\\\\"GRS_1980\\\\\\\",6378137.0,298.257222101]],PRIMEM[\\\\\\\"Greenwich\\\\\\\",0.0],UNIT[\\\\\\\"Degree\\\\\\\",0.0174532925199433]],GEOGCS[\\\\\\\"GCS_WGS_1984\\\\\\\",DATUM[\\\\\\\"D_WGS_1984\\\\\\\",SPHEROID[\\\\\\\"WGS_1984\\\\\\\",6378137.0,298.257223563]],PRIMEM[\\\\\\\"Greenwich\\\\\\\",0.0],UNIT[\\\\\\\"Degree\\\\\\\",0.0174532925199433]],METHOD[\\\\\\\"Geocentric_Translation\\\\\\\"],PARAMETER[\\\\\\\"X_Axis_Translation\\\\\\\",0.0],PARAMETER[\\\\\\\"Y_Axis_Translation\\\\\\\",0.0],PARAMETER[\\\\\\\"Z_Axis_Translation\\\\\\\",0.0],AUTHORITY[\\\\\\\"EPSG\\\\\\\",1188]]\\\",\\\"ver\\\":\\\"PE_10_3_1\\\",\\\"name\\\":\\\"NAD_1983_To_WGS_1984_1\\\",\\\"authCode\\\":{\\\"auth\\\":\\\"EPSG\\\",\\\"code\\\":\\\"1188\\\"},\\\"type\\\":\\\"ST\\\"},\\\"ver\\\":\\\"PE_10_3_1\\\",\\\"name\\\":\\\"NAD83 * DMA-N Am [4269,1188]\\\",\\\"authCode\\\":{\\\"auth\\\":\\\"SLB\\\",\\\"code\\\":\\\"4269001\\\"},\\\"type\\\":\\\"EBC\\\"}\",\n                    \"propertyNames\": [\n                    \"SpatialLocation.AsIngestedCoordinates\"\n                    ]\n                },\n                {\n                    \"kind\": \"Unit\",\n                    \"name\": \"km\",\n                    \"persistableReference\": \"{\\\"scaleOffset\\\":{\\\"scale\\\":1.0,\\\"offset\\\":0.0},\\\"symbol\\\":\\\"km\\\",\\\"baseMeasurement\\\":{\\\"ancestry\\\":\\\"Length\\\",\\\"type\\\":\\\"UM\\\"},\\\"type\\\":\\\"USO\\\"}\",\n                    \"propertyNames\": []\n                }\n        ],\n        \"relationships\": [\n                    {\n                        \"projects\": {\n                            \"ids\": [\n                                \"<authority>:wing:project-sxs0f1a5219-4640-50af-9f63-c09140d57c4d\",\n                                \"<authority>:wing:project-sxs0f1a5219-4640-50af-9f63-c09140d57c5e\",\n                                \"<authority>:wing:project-sxs0f1a5219-4640-50af-9f63-c09140d57c6f\"\n                            ]\n                        },\n                        \"Abbreviation\": {\n                            \"ids\": [\n                                \"<authority>:wing:ABBR-sxs0f1a5219-4640-50af-9f63-c09140d57c4d\"\n                            ]\n                        }\n                    }\n                ],\n                \"relatedNaturalKey\": [\n                    {\n                        \"well\": {\n                            \"targetKind\": \"<authority>:shape:well:1.0.0\",\n                            \"keys\": [\n                                {\n                                    \"sourceColumn\": \"WELL_ID\",\n                                    \"targetAttribute\": \"uwi\"\n                                }\n                            ]\n                        }\n                    },\n                    {\n                        \"Wellbore\": {\n                            \"targetKind\": \"<authority>:shape:wellbore:1.0.0\",\n                            \"keys\": [\n                                {\n                                    \"sourceColumn\": \"WELLORE_ID\",\n                                    \"targetAttribute\": \"UBHI\"\n                                }\n                            ]\n                        }\n                    }\n                ],\n        \"extensionProperties\": {\n        \"skipDupes\": false,\n        \"overrideUniqueId\": false\n        }\n    }\n    },\n    \"ResourceSecurityClassification\": \"string\",\n    \"ExistenceKind\": \"string\",\n    \"SchemaFormatTypeID\": \"string\"\n},\n\"meta\": [\n    {}\n],\n\"id\": \"<authority>:dec44cb4-916c-4bee-85da-0de713a32f26\",\n\"version\": 1622547133262813,\n\"kind\": \"<authority>:wks:dataset--File.Generic:1.0.0\",\n\"acl\": {\n        \"viewers\": [\n        \"data.default.viewers@{domain}.com\"\n        ],\n        \"owners\": [\n        \"data.default.viewers@{domain}.com\"\n        ]\n    },\n\"legal\": {\n    \"legaltags\": [\n        \"<valid legal tag>\"\n    ],\n    \"otherRelevantDataCountries\": [\n        \"US\"\n    ],\n    \"status\": \"compliant\"\n  }\n}\n\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[" Sample Response  "]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n\"id\": \"<authority>:file:4cedbed0-837b-4797-9683-f088a7a15014\"\n}            \n","lang":"json"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"5run-the-shapefile-workflow","__idx":10},"children":["5.\tRun the Shapefile workflow  ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"5-run-the-shapefile-workflow"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can trigger the execution of an ingestion workflow using the Workflow service ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflowRun"]}," endpoint."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API reference: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/core-service/apis/osdu-workflow-service"},"children":["Workflow Service"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["POST request: /workflow/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<workflow_name>"]},"/workflowRun"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shapefile_ingestor_wf"]}," is the default shapefile ingestion ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflow_name"]}," defined by the ingestion framework."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payload:"]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[" Sample Request Payload "]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"executionContext\": {\n    \"id\": \"<file metadata id obtained in step 4 >\",\n    \"dataPartitionId\": \"<dataPartition>\"\n  },\n  \"runId\": \"Optional. Run ID can be set explicitly by the user. If not set, the system will generate a run ID for the workflow run.\"\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[" Sample Response Payload "]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"workflowId\": \"shapefile_ingestor_wf\",\n    \"runId\": \"12c04dd5-666b-43c4-ae3d-16a71f089943\",\n    \"startTimeStamp\": 1623826405588,\n    \"status\": \"submitted\",\n    \"submittedBy\": \"<user>@<domain>.com\"\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[" Error Codes "]},{"$$mdtype":"Tag","name":"pre","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\n | Code | Message                                       |\n | ---- | --------------------------------------------- |\n | 400  | Bad Request. Partition ID is missing/invalid. |\n | 401  | Unknown or Invalid user.                      |\n | 403  | User forbidden from accessing this API.       |\n | 404  | Not Found. Workflow Doesn't exist.            |\n "]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"6-monitor-the-workflow-status","__idx":11},"children":["6. Monitor the workflow status ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"6-monitor-the-workflow-status"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can monitor the execution status of the workflow using the monitor Workflow Status API. The workflow can have these status codes:"]},{"$$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":"Code"},"children":["Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Message"},"children":["Message"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SUBMITTED"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Workflow trigger accepted by platform, but actual workflow run has not started."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["RUNNING/IN_PROGRESS"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Workflow in progress or under execution."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["FAILED"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Workflow execution completed with failures."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SUCCESS"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Workflow execution completed successfully."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After the execution begins, monitor the execution status of the workflow using the Workflow service. Use the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflow_name"]}," and the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["runId"]}," from the response in Step 5."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API reference: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/core-service/apis/osdu-workflow-service"},"children":["Workflow Service"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["GET request: /workflow/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<workflow_name>"]},"/workflowRun/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<runId>"]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[" Sample Response Payload "]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"workflowId\": \"shapefile_ingestor_wf\",\n    \"runId\": \"12c04dd5-666b-43c4-ae3d-16a71f089943\",\n    \"startTimeStamp\": 1614579997265,\n    \"endTimeStamp\": 1614607532205,\n    \"status\": \"success\",\n    \"submittedBy\": \"<user>@<domain>.com\",\n}\n","lang":"json"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"7validate-the-ingested-data","__idx":12},"children":["7.\tValidate the ingested data ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"7-validate-the-ingested-data"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Search the ingested records using the Search service POST ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/query_with_cursor"]}," endpoint."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/core-service/apis/osdu-search-service"},"children":["API Reference"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["POST request: /query_with_cursor"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payload:"]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[" Sample Request Payload "]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"kind\": \"<metadata target kind>\",\n    \"query\": \"<search query>\"\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[" Sample Response Payload "]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"cursor\": \"<cursor_id>\",\n    \"results\": [\n        {\n            \"data\": {},\n            \"kind\": \"<kind>\",\n            \"id\": \"<record_id>\"\n        }\n    ],\n    \"totalCount\": 1\n}\n","lang":"json"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can find the ingested records using the Status Processor service POST ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/status/query"]}," endpoint. You can find the correlation ID in the response header of the triggered workflow run. The correlationId is a mandatory parameter with which you can find the details of the ingested records."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/data-workspace/apis/osdu-status-processor-service"},"children":["API Reference"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["POST request: /v1/status/query"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payload:"]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[" Sample Request Payload "]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"statusQuery\": {\n        \"correlationId\": \"91072956-c2c0-44bc-96b0-2d2cec4f12af\",\n        \"stage\": [\n        \"INGESTOR\"\n        ]\n    }\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[" Sample Response Payload "]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"results\": [\n        {\n        \"correlationId\": \"91072956-c2c0-44bc-96b0-2d2cec4f12af\",\n        \"recordId\": \"9316e92e-db48-482a-a39f-e3735ebf50bb\"\n        \"stage\": \"INGESTOR\",\n        \"status\": \"SUBMITTED\",\n        \"message\": \"Workflow run submitted. \",\n        \"errorCode\": 0,\n        \"userEmail\": \"39916b94-71a9-409e-856e-0f29558fa908\",\n        \"timestamp\": 1631451165294\n        },\n        {\n        \"correlationId\": \"91072956-c2c0-44bc-96b0-2d2cec4f12af\",\n        \"recordId\": \"9316e92e-db48-482a-a39f-e3735ebf50bb\"\n        \"stage\": \"INGESTOR\",\n        \"status\": \"IN_PROGRESS\",\n        \"message\": \"Workflow execution started\",\n        \"errorCode\": 0,\n        \"userEmail\": \"39916b94-71a9-409e-856e-0f29558fa908\",\n        \"timestamp\": 1631451190\n        },\n        {\n        \"correlationId\": \"91072956-c2c0-44bc-96b0-2d2cec4f12af\",\n        \"recordId\": \"9316e92e-db48-482a-a39f-e3735ebf50bb\"\n        \"stage\": \"INGESTOR\",\n        \"status\": \"SUCCESS\",\n        \"message\": \"Workflow execution successful\",\n        \"errorCode\": 0,\n        \"userEmail\": \"39916b94-71a9-409e-856e-0f29558fa908\",\n        \"timestamp\": 1631451240\n        }\n    ],\n    \"count\": 3,\n    \"totalCount\": 3,\n    \"limit\": 100\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Status of records:"]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[" Status of records for Payload "]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n\"statusQuery\": {\n    \"correlationId\": \"b6885659-1b54-4923-ac52-1221c11f6ab7\",\n    \"stage\": [\n    \"INGESTOR_SYNC\"\n    ]\n}\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[" Status of records for Response "]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"results\": [\n        {\n            \"correlationId\": \"b6885659-1b54-4923-ac52-1221c11f6ab7\",\n            \"recordId\": \"<authority>:point:automation-Oi8vMWQ5YTJkZDEtZGQxZC00Njc2LWE5MmUtNjA1N2U2NGQzM2MyL2U1NTczZWY2LTIwMTEtNDAxZi04NTk0LWIxNDlkMGU0ODkyNw\"\n            \"stage\": \"INGESTOR_SYNC\",\n            \"status\": \"SUCCESS\",\n            \"message\": \"Record ingestion successful.\",\n            \"errorCode\": 0,\n            \"userEmail\": \"39916b94-71a9-409e-856e-0f29558fa908\",\n            \"timestamp\": 1631623800\n        }\n    ],\n    \"count\": 1,\n    \"totalCount\": 1,\n    \"limit\": 100\n}\n","lang":"json"},"children":[]}]}]}]},{"$$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":"Stage"},"children":["Stage"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Message"},"children":["Message"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["INGESTOR"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Job-level messages."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["INGESTOR_SYNC"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Record-level messages."]}]}]}]}]},{"$$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":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Message"},"children":["Message"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SUBMITTED"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Workflow trigger accepted by the platform, but actual the workflow run has not started."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["IN_PROGRESS"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Workflow in progress or under execution."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["FAILED"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Workflow execution completed with failures."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SUCCESS"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Workflow execution completed successfully."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Validate the ingested data using the Storage service."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/core-service/apis/osdu-storage-service"},"children":["API Reference"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["GET request: /storage/v2/records/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<record_id>"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Parameter ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["record_id"]}," is the ID of the received ingested record, for example, in the response of the above search query."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The response shows the ingested data."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"input-file-and-schemas","__idx":13},"children":["Input file and schemas ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"input-file-and-schemas"},"children":[]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Input files"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The input file must be a .zip or .tar.gz file (.zipx and .tar are not supported). The required files within this shapefile collection are:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[".shp: This file contains the geospatial co-ordinates of all the objects in the shapefile collection as a list of vertices for each record, along with their shape types."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[".shx: This file is an index of the .shp file and contains the offset and length information for each record with respect to the previous one. This file itself has only fixed record lengths, preceded by a header."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[".dbf: This file contains the information in the form of a header and a table containing attributes for each record in the shapefile. For correct parsing, this file must contain a key attribute that contains unique values."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In addition to the required files, a .zip or .tar.gz file can also contain some non-mandatory files. A few examples of optional files are:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[".prj: This file contains a Coordinate Reference System (CRS) and associated transforms in which the data is declared, for example:\"WGS_1984_UTM_Zone_55S\",\"ED_1950_UTM_Zone_32N\" etc."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[".cpg: This file contains information about character encoding, for example: UTF-8 , latin1, etc., which is used while reading and encoding the information from the .dbf file."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Sample shapefile: states.zip"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Schema service"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use the Schema service to map the attributes and their kinds. The Schema kind should be unique; construct it using the attributes under schemaIdentity. The basic format is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<authority>:<source>:<entityType>:<version>"]},". The schema used to ingest data must have spatial references."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/core-service/apis/osdu-schema-service"},"children":["API Reference"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A sample schema for a states shapefile:"]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[" Sample file: states_Schema.json "]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["{"," ","\"schemaInfo\": {"," ","\"schemaIdentity\": {"," ","\"authority\": \"",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<authority>"]},"\","," ","\"source\": \"",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<source>"]},"\","," ","\"entityType\": \"",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<entity type>"]},"\","," ","\"schemaVersionMajor\": 1,"," ","\"schemaVersionMinor\": 0,"," ","\"schemaVersionPatch\": 0"," ","},"," ","\"status\": \"DEVELOPMENT\""," ","},"," ","\"schema\": {"," ","\"$schema\": \"http://json-schema.org/draft-07/schema#\","," ","\"x-slb-lifecycle-state\": \"published\","," ","\"description\": \"The entity shapefile.\","," ","\"title\": \"ShapeFile\","," ","\"type\": \"object\","," ","\"definitions\": {"," ","\"legal\": {"," ","\"description\": \"Legal metadata such as legal tags, relevant other countries, legal status, etc.\","," ","\"title\": \"Legal Metadata\","," ","\"type\": \"object\","," ","\"properties\": {"," ","\"legaltags\": {"," ","\"description\": \"The list of legal tags, see Compliance API.\","," ","\"title\": \"Legal Tags\","," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"string\""," ","}"," ","},"," ","\"otherRelevantDataCountries\": {"," ","\"description\": \"The list of other relevant data countries using the ISO 2-letter codes, see Compliance API.\","," ","\"title\": \"Other Relevant Data Countries\","," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"string\""," ","}"," ","},"," ","\"status\": {"," ","\"title\": \"Legal Status\","," ","\"type\": \"string\","," ","\"description\": \"The legal status.\""," ","}"," ","}"," ","},"," ","\"accessControlList\": {"," ","\"description\": \"The access control tags associated with this entity.\","," ","\"title\": \"Access Control List\","," ","\"type\": \"object\","," ","\"properties\": {"," ","\"viewers\": {"," ","\"description\": \"The data viewer's group specification.\","," ","\"title\": \"Owners\","," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"string\""," ","},"," ","\"example\": ["," ","\"data.default.viewers@slb.p4d.cloud.slb-ds.com\""," ","]"," ","},"," ","\"owners\": {"," ","\"description\": \"The data owner group specification.\","," ","\"title\": \"Owners\","," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"string\""," ","},"," ","\"example\": ["," ","\"data.default.owners@slb.p4d.cloud.slb-ds.com\""," ","]"," ","}"," ","}"," ","},"," ","\"ancestryList\": {"," ","\"description\": \"A list of entity IDs in the data lake, which act as legal parents/sources to the current entity.\","," ","\"title\": \"Parent List\","," ","\"type\": \"object\","," ","\"properties\": {"," ","\"parents\": {"," ","\"description\": \"An array of none, one, or many entity references in the data lake, which identify the source of data in the legal sense. Example: The 'parents' will be queried when, for example, the subscription of source data services is terminated; access to the derivatives is also terminated.\","," ","\"title\": \"Parents\","," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"string\""," ","},"," ","\"example\": []"," ","}"," ","}"," ","},"," ","\"tags\": {"," ","\"description\": \"A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.\","," ","\"additionalProperties\": {"," ","\"type\": \"string\""," ","},"," ","\"title\": \"Tag Dictionary\","," ","\"type\": \"object\","," ","\"example\": {"," ","\"NameOfKey\": \"String value\""," ","}"," ","},"," ","\"metaItem\": {"," ","\"description\": \"A metadata item that allows the association of named properties or property values to a Unit/Measurement/CRS/Azimuth/Time context.\","," ","\"title\": \"Frame of Reference Metadata Item\","," ","\"type\": \"object\","," ","\"properties\": {"," ","\"name\": {"," ","\"description\": \"The name of the CRS or the symbol/name of the unit.\","," ","\"title\": \"Name or Symbol\","," ","\"type\": \"string\","," ","\"example\": ["," ","\"NAD27 * OGP-Usa Conus / North Dakota South [32021,15851]\","," ","\"ft\""," ","]"," ","},"," ","\"propertyValues\": {"," ","\"description\": \"The list of property values, to which this meta data item provides Unit/CRS context. Typically a unit symbol is a value to a data structure. This symbol is then registered in this propertyValues array and the persistableReference provides the absolute reference.\","," ","\"title\": \"Attribute Names\","," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"string\""," ","},"," ","\"example\": ["," ","\"F\","," ","\"ftUS\","," ","\"deg\""," ","]"," ","},"," ","\"persistableReference\": {"," ","\"description\": \"The persistable reference string uniquely identifying the CRS or Unit.\","," ","\"title\": \"Persistable Reference\","," ","\"type\": \"string\","," ","\"example\": \"{scaleOffset:{scale:0.3048006096012192,offset:0.0},symbol:ftUS,baseMeasurement:{ancestry:Length,type:UM},type:USO}\""," ","},"," ","\"uncertainty\": {"," ","\"title\": \"Uncertainty\","," ","\"type\": \"number\","," ","\"description\": \"The uncertainty of the values measured given the unit or CRS unit.\""," ","},"," ","\"kind\": {"," ","\"description\": \"The kind of reference: unit, measurement, CRS, or azimuth reference.\","," ","\"title\": \"Reference Kind\","," ","\"type\": \"string\","," ","\"enum\": ["," ","\"CRS\","," ","\"Unit\","," ","\"Measurement\","," ","\"AzimuthReference\","," ","\"DateTime\""," ","]"," ","},"," ","\"propertyNames\": {"," ","\"description\": \"The list of property names, to which this metadata item provides Unit/CRS context. Data structures, which come in a single frame of reference, can register the property name. Others require a full path, such as data.structureA.propertyB to define a unique context.\","," ","\"title\": \"Attribute Names\","," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"string\""," ","},"," ","\"example\": ["," ","\"elevationFromMsl\","," ","\"totalDepthMdDriller\","," ","\"wellHeadProjected\""," ","]"," ","}"," ","},"," ","\"required\": ["," ","\"kind\","," ","\"persistableReference\""," ","]"," ","},"," ","\"data\": {"," ","\"description\": \"The entity shapefile.\","," ","\"$schema\": \"http://json-schema.org/draft-07/schema#\","," ","\"x-slb-lifecycle-state\": \"published\","," ","\"title\": \"ShapeFile\","," ","\"type\": \"object\","," ","\"properties\": {"," ","\"STATE_NAME\": {"," ","\"type\": \"string\","," ","\"description\": \"State name\","," ","\"x-osdu-natural-key\": 1"," ","},"," ","\"DRAWSEQ\": {"," ","\"type\": \"number\","," ","\"description\": \"Draw sequency\""," ","},"," ","\"STATE_FIPS\": {"," ","\"type\": \"int\","," ","\"description\": \"State FIPS code\""," ","},"," ","\"SUB_REGION\": {"," ","\"type\": \"string\","," ","\"description\": \"State sub region\""," ","},"," ","\"STATE_ABBR\": {"," ","\"type\": \"string\","," ","\"description\": \"State Abbreviation code\","," ","\"x-osdu-relationship\": ["," ","{"," ","\"EntityType\": \"Abbreviation\","," ","\"GroupType\": \"master-data\""," ","}"," ","]\t\t\t\t\t\t"," ","},"," ","\"WELL_ID\": {"," ","\"type\": \"string\","," ","\"description\": \"NAME\","," ","\"x-osdu-relationship\": ["," ","{"," ","\"EntityType\": \"Well\","," ","\"GroupType\": \"master-data\""," ","}"," ","]"," ","},"," ","\"SpatialLocation\": {"," ","\"type\": \"object\","," ","\"description\": \"The spatial location information such as coordinates or CRS information.\","," ","\"$ref\": \"#/definitions/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<authority>"]},":wks:AbstractSpatialLocation:1.0.0\""," ","}"," ","}"," ","},"," ","\"",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<authority>"]},":wks:AbstractSpatialLocation:1.0.0\": {"," ","\"x-osdu-inheriting-from-kind\": [],"," ","\"x-osdu-license\": \"Copyright 2021, The Open Group \\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\","," ","\"$schema\": \"http://json-schema.org/draft-07/schema#\","," ","\"x-osdu-schema-source\": \"osdu:wks:AbstractSpatialLocation:1.0.0\","," ","\"description\": \"A geographic object which can be described by a set of points.\","," ","\"title\": \"AbstractSpatialLocation\","," ","\"type\": \"object\","," ","\"properties\": {"," ","\"AsIngestedCoordinates\": {"," ","\"description\": \"The original or 'as ingested' coordinates: Point, MultiPoint, LineString, MultiLineString, Polygon, or MultiPolygon. The name 'AsIngestedCoordinates' was chosen to contrast it to 'OriginalCoordinates', which carries the uncertainty whether any coordinate operations took place before ingestion. In cases where the original CRS is different from the as-ingested CRS, the OperationsApplied can also contain the list of operations applied to the coordinate prior to ingestion. The data structure is similar to GeoJSON FeatureCollection; however, in a CRS context explicitly defined within the AbstractAnyCrsFeatureCollection. The coordinate sequence follows GeoJSON standard, for example 'eastward/longitude', 'northward/latitude', or 'upward/height' unless overridden by an explicit direction in the AsIngestedCoordinates.VerticalCoordinateReferenceSystemID.\","," ","\"x-osdu-frame-of-reference\": \"CRS:\","," ","\"title\": \"As Ingested Coordinates\","," ","\"$ref\": \"#/definitions/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<authority>"]},":wks:AbstractAnyCrsFeatureCollection:1.0.0\""," ","},"," ","\"SpatialParameterTypeID\": {"," ","\"pattern\": \"^[\\w\\-\\.]+:reference-data\\-\\-SpatialParameterType:[\\w\\-\\.\\:\\%]+:[0-9]",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["$\","," ","\"description\": \"A type of spatial representation of an object, often general (for example, an Outline, which could be applied to Field, Reservoir, Facility, etc.) or sometimes specific (for example: Onshore Outline, State Offshore Outline, Federal Offshore Outline, or 3 spatial representations that may be used by countries).\","," ","\"x-osdu-relationship\": ["," ","{"," ","\"EntityType\": \"SpatialParameterType\","," ","\"GroupType\": \"reference-data\""," ","}"," ","],"," ","\"type\": \"string\""," ","},"," ","\"QuantitativeAccuracyBandID\": {"," ","\"pattern\": \"^[\\w\\-\\.]+:reference-data\\-\\-QuantitativeAccuracyBand:[\\w\\-\\.\\:\\%]+:[0-9]"]},"$\","," ","\"description\": \"An approximate quantitative assessment of the quality of a location, accurate to > 500 m (meaning, not very accurate), to < 1 m, etc.\","," ","\"x-osdu-relationship\": ["," ","{"," ","\"EntityType\": \"QuantitativeAccuracyBand\","," ","\"GroupType\": \"reference-data\""," ","}"," ","],"," ","\"type\": \"string\""," ","},"," ","\"CoordinateQualityCheckRemarks\": {"," ","\"type\": \"array\","," ","\"description\": \"Freetext remarks on a quality check.\","," ","\"items\": {"," ","\"type\": \"string\""," ","}"," ","},"," ","\"AppliedOperations\": {"," ","\"description\": \"The audit trail of operations applied to the coordinates from the original state to the current state. The list may contain operations applied prior to ingestion as well as the operations applied to produce the Wgs84Coordinates. The text elements refer to ESRI style CRS and transformation names, which may have to be translated to EPSG standard names.\","," ","\"title\": \"Operations Applied\","," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"string\""," ","},"," ","\"example\": ["," ","\"conversion from ED_1950_UTM_Zone_31N to GCS_European_1950; 1 points converted\","," ","\"transformation GCS_European_1950 to GCS_WGS_1984 using ED_1950_To_WGS_1984_24; 1 points successfully transformed\""," ","]"," ","},"," ","\"QualitativeSpatialAccuracyTypeID\": {"," ","\"pattern\": \"^[\\w\\-\\.]+:reference-data\\-\\-QualitativeSpatialAccuracyType:[\\w\\-\\.\\:\\%]+:[0-9]",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["$\","," ","\"description\": \"A qualitative description of the quality of a spatial location, such as unverifiable, not verified, basic validation.\","," ","\"x-osdu-relationship\": ["," ","{"," ","\"EntityType\": \"QualitativeSpatialAccuracyType\","," ","\"GroupType\": \"reference-data\""," ","}"," ","],"," ","\"type\": \"string\""," ","},"," ","\"CoordinateQualityCheckPerformedBy\": {"," ","\"type\": \"string\","," ","\"description\": \"The user who performed the quality check.\""," ","},"," ","\"SpatialLocationCoordinatesDate\": {"," ","\"format\": \"date-time\","," ","\"description\": \"Date when coordinates were measured or retrieved.\","," ","\"x-osdu-frame-of-reference\": \"DateTime\","," ","\"type\": \"string\""," ","},"," ","\"CoordinateQualityCheckDateTime\": {"," ","\"format\": \"date-time\","," ","\"description\": \"The date of the quality check.\","," ","\"x-osdu-frame-of-reference\": \"DateTime\","," ","\"type\": \"string\""," ","},"," ","\"Wgs84Coordinates\": {"," ","\"title\": \"WGS 84 Coordinates\","," ","\"description\": \"The normalized coordinates (Point, MultiPoint, LineString, MultiLineString, Polygon, or MultiPolygon) based on WGS 84 (EPSG:4326 for 2-dimensional coordinates, EPSG:4326 + EPSG:5714 (MSL) for 3-dimensional coordinates). This derived coordinate representation is intended for global discoverability only. The schema of this substructure is identical to the GeoJSON FeatureCollection https://geojson.org/schema/FeatureCollection.json. The coordinate sequence follows the GeoJSON standard, for example, longitude, latitude, or height.\","," ","\"$ref\": \"#/definitions/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<authority>"]},":wks:AbstractFeatureCollection:1.0.0\""," ","},"," ","\"SpatialGeometryTypeID\": {"," ","\"pattern\": \"^[\\w\\-\\.]+:reference-data\\-\\-SpatialGeometryType:[\\w\\-\\.\\:\\%]+:[0-9]"]},"$\","," ","\"description\": \"Indicates the expected look of the SpatialParameterType, for example, Point, MultiPoint, LineString, MultiLineString, Polygon, or MultiPolygon. The value constrains the type of geometries in the GeoJSON Wgs84Coordinates and AsIngestedCoordinates.\","," ","\"x-osdu-relationship\": ["," ","{"," ","\"EntityType\": \"SpatialGeometryType\","," ","\"GroupType\": \"reference-data\""," ","}"," ","],"," ","\"type\": \"string\""," ","}"," ","},"," ","\"$id\": \"https://schema.osdu.opengroup.org/json/abstract/AbstractSpatialLocation.1.0.0.json\""," ","},"," ","\"",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<authority>"]},":wks:AbstractFeatureCollection:1.0.0\": {"," ","\"x-osdu-inheriting-from-kind\": [],"," ","\"x-osdu-license\": \"Copyright 2021, The Open Group \\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\","," ","\"$schema\": \"http://json-schema.org/draft-07/schema#\","," ","\"x-osdu-schema-source\": \"osdu:wks:AbstractFeatureCollection:1.0.0\","," ","\"description\": \"GeoJSON feature collection as originally published in https://geojson.org/schema/FeatureCollection.json. Attention: The coordinate order is fixed: Longitude first, followed by Latitude, and optionally the height above MSL (EPSG:5714) as a third coordinate.\","," ","\"title\": \"GeoJSON FeatureCollection\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"features\""," ","],"," ","\"properties\": {"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"FeatureCollection\""," ","]"," ","},"," ","\"features\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"title\": \"GeoJSON Feature\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"properties\","," ","\"geometry\""," ","],"," ","\"properties\": {"," ","\"geometry\": {"," ","\"oneOf\": ["," ","{"," ","\"type\": \"null\""," ","},"," ","{"," ","\"title\": \"GeoJSON Point\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"Point\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"GeoJSON LineString\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"LineString\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"GeoJSON Polygon\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"Polygon\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"GeoJSON MultiPoint\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"MultiPoint\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"GeoJSON MultiLineString\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"MultiLineString\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"GeoJSON MultiPolygon\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"MultiPolygon\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"GeoJSON GeometryCollection\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"geometries\""," ","],"," ","\"properties\": {"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"GeometryCollection\""," ","]"," ","},"," ","\"geometries\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"oneOf\": ["," ","{"," ","\"title\": \"GeoJSON Point\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"Point\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"GeoJSON LineString\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"LineString\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"GeoJSON Polygon\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"Polygon\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"GeoJSON MultiPoint\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"MultiPoint\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"GeoJSON MultiLineString\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"MultiLineString\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"GeoJSON MultiPolygon\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"MultiPolygon\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","}"," ","]"," ","}"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","}"," ","]"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"Feature\""," ","]"," ","},"," ","\"properties\": {"," ","\"oneOf\": ["," ","{"," ","\"type\": \"null\""," ","},"," ","{"," ","\"type\": \"object\""," ","}"," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","}"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","},"," ","\"$id\": \"https://schema.osdu.opengroup.org/json/abstract/AbstractFeatureCollection.1.0.0.json\""," ","},"," ","\"",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<authority>"]},":wks:AbstractAnyCrsFeatureCollection:1.0.0\": {"," ","\"x-osdu-inheriting-from-kind\": [],"," ","\"x-osdu-license\": \"Copyright 2021, The Open Group \\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\","," ","\"$schema\": \"http://json-schema.org/draft-07/schema#\","," ","\"x-osdu-schema-source\": \"osdu:wks:AbstractAnyCrsFeatureCollection:1.0.0\","," ","\"description\": \"A schema similar to GeoJSON FeatureCollection with a non-WGS 84 CRS context, based on https://geojson.org/schema/FeatureCollection.json. Attention: The coordinate order is fixed: Longitude/Easting/Westing/X first, followed by Latitude/Northing/Southing/Y, and optionally height as third coordinate.\","," ","\"title\": \"AbstractAnyCrsFeatureCollection\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"persistableReferenceCrs\","," ","\"features\""," ","],"," ","\"properties\": {"," ","\"CoordinateReferenceSystemID\": {"," ","\"pattern\": \"^[\\w\\-\\.]+:reference-data\\-\\-CoordinateReferenceSystem:[\\w\\-\\.\\:\\%]+:[0-9]",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["$\","," ","\"description\": \"The CRS reference into the CoordinateReferenceSystem catalog.\","," ","\"x-osdu-relationship\": ["," ","{"," ","\"EntityType\": \"CoordinateReferenceSystem\","," ","\"GroupType\": \"reference-data\""," ","}"," ","],"," ","\"title\": \"Coordinate Reference System ID\","," ","\"type\": \"string\","," ","\"example\": \"namespace:reference-data--CoordinateReferenceSystem:BoundCRS.SLB.32021.15851:\""," ","},"," ","\"persistableReferenceCrs\": {"," ","\"description\": \"The CRS reference as a persistableReference string. If populated, the CoordinateReferenceSystemID takes precedence.\","," ","\"type\": \"string\","," ","\"title\": \"CRS Reference\","," ","\"example\": \"{\"lateBoundCRS\":{\"wkt\":\"PROJCS[\\\"NAD_1927_StatePlane_North_Dakota_South_FIPS_3302\\\",GEOGCS[\\\"GCS_North_American_1927\\\",DATUM[\\\"D_North_American_1927\\\",SPHEROID[\\\"Clarke_1866\\\",6378206.4,294.9786982]],PRIMEM[\\\"Greenwich\\\",0.0],UNIT[\\\"Degree\\\",0.0174532925199433]],PROJECTION[\\\"Lambert_Conformal_Conic\\\"],PARAMETER[\\\"False_Easting\\\",2000000.0],PARAMETER[\\\"False_Northing\\\",0.0],PARAMETER[\\\"Central_Meridian\\\",-100.5],PARAMETER[\\\"Standard_Parallel_1\\\",46.1833333333333],PARAMETER[\\\"Standard_Parallel_2\\\",47.4833333333333],PARAMETER[\\\"Latitude_Of_Origin\\\",45.6666666666667],UNIT[\\\"Foot_US\\\",0.304800609601219],AUTHORITY[\\\"EPSG\\\",32021]]\",\"ver\":\"PE_10_3_1\",\"name\":\"NAD_1927_StatePlane_North_Dakota_South_FIPS_3302\",\"authCode\":{\"auth\":\"EPSG\",\"code\":\"32021\"},\"type\":\"LBC\"},\"singleCT\":{\"wkt\":\"GEOGTRAN[\\\"NAD_1927_To_WGS_1984_79_CONUS\\\",GEOGCS[\\\"GCS_North_American_1927\\\",DATUM[\\\"D_North_American_1927\\\",SPHEROID[\\\"Clarke_1866\\\",6378206.4,294.9786982]],PRIMEM[\\\"Greenwich\\\",0.0],UNIT[\\\"Degree\\\",0.0174532925199433]],GEOGCS[\\\"GCS_WGS_1984\\\",DATUM[\\\"D_WGS_1984\\\",SPHEROID[\\\"WGS_1984\\\",6378137.0,298.257223563]],PRIMEM[\\\"Greenwich\\\",0.0],UNIT[\\\"Degree\\\",0.0174532925199433]],METHOD[\\\"NADCON\\\"],PARAMETER[\\\"Dataset_conus\\\",0.0],AUTHORITY[\\\"EPSG\\\",15851]]\",\"ver\":\"PE_10_3_1\",\"name\":\"NAD_1927_To_WGS_1984_79_CONUS\",\"authCode\":{\"auth\":\"EPSG\",\"code\":\"15851\"},\"type\":\"ST\"},\"ver\":\"PE_10_3_1\",\"name\":\"NAD27 * OGP-Usa Conus / North Dakota South [32021,15851]\",\"authCode\":{\"auth\":\"SLB\",\"code\":\"32021079\"},\"type\":\"EBC\"}\""," ","},"," ","\"features\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"title\": \"AnyCrsGeoJSON Feature\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"properties\","," ","\"geometry\""," ","],"," ","\"properties\": {"," ","\"geometry\": {"," ","\"oneOf\": ["," ","{"," ","\"type\": \"null\""," ","},"," ","{"," ","\"title\": \"AnyCrsGeoJSON Point\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"AnyCrsPoint\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"AnyCrsGeoJSON LineString\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"AnyCrsLineString\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"AnyCrsGeoJSON Polygon\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"AnyCrsPolygon\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"AnyCrsGeoJSON MultiPoint\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"AnyCrsMultiPoint\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"AnyCrsGeoJSON MultiLineString\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"AnyCrsMultiLineString\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"AnyCrsGeoJSON MultiPolygon\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"AnyCrsMultiPolygon\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"AnyCrsGeoJSON GeometryCollection\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"geometries\""," ","],"," ","\"properties\": {"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"AnyCrsGeometryCollection\""," ","]"," ","},"," ","\"geometries\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"oneOf\": ["," ","{"," ","\"title\": \"AnyCrsGeoJSON Point\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"AnyCrsPoint\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"AnyCrsGeoJSON LineString\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"AnyCrsLineString\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"AnyCrsGeoJSON Polygon\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"AnyCrsPolygon\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"AnyCrsGeoJSON MultiPoint\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"AnyCrsMultiPoint\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"AnyCrsGeoJSON MultiLineString\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"AnyCrsMultiLineString\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","},"," ","{"," ","\"title\": \"AnyCrsGeoJSON MultiPolygon\","," ","\"type\": \"object\","," ","\"required\": ["," ","\"type\","," ","\"coordinates\""," ","],"," ","\"properties\": {"," ","\"coordinates\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"minItems\": 2,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","}"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"AnyCrsMultiPolygon\""," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","}"," ","]"," ","}"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","}"," ","]"," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"AnyCrsFeature\""," ","]"," ","},"," ","\"properties\": {"," ","\"oneOf\": ["," ","{"," ","\"type\": \"null\""," ","},"," ","{"," ","\"type\": \"object\""," ","}"," ","]"," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","}"," ","}"," ","}"," ","},"," ","\"persistableReferenceUnitZ\": {"," ","\"description\": \"The unit of measure for the Z-axis, only for 3-dimensional coordinates, where the CRS does not describe the vertical unit. Note that the direction is upwards positive, so Z means height.\","," ","\"type\": \"string\","," ","\"title\": \"Z-Unit Reference\","," ","\"example\": \"{\"scaleOffset\":{\"scale\":1.0,\"offset\":0.0},\"symbol\":\"m\",\"baseMeasurement\":{\"ancestry\":\"Length\",\"type\":\"UM\"},\"type\":\"USO\"}\""," ","},"," ","\"bbox\": {"," ","\"minItems\": 4,"," ","\"type\": \"array\","," ","\"items\": {"," ","\"type\": \"number\""," ","}"," ","},"," ","\"persistableReferenceVerticalCrs\": {"," ","\"description\": \"The VerticalCRS reference as a persistableReference string. If populated, the VerticalCoordinateReferenceSystemID takes precedence. The property is null or empty for 2D geometries. For 3D geometries and absent or null persistableReferenceVerticalCrs, the vertical CRS is either provided via the persistableReferenceCrs's CompoundCR,S or it is implicitly defined as EPSG:5714 MSL height.\","," ","\"type\": \"string\","," ","\"title\": \"Vertical CRS Reference\","," ","\"example\": \"{\"authCode\":{\"auth\":\"EPSG\",\"code\":\"5773\"},\"type\":\"LBC\",\"ver\":\"PE_10_3_1\",\"name\":\"EGM96_Geoid\",\"wkt\":\"VERTCS[\\\"EGM96_Geoid\\\",VDATUM[\\\"EGM96_Geoid\\\"],PARAMETER[\\\"Vertical_Shift\\\",0.0],PARAMETER[\\\"Direction\\\",1.0],UNIT[\\\"Meter\\\",1.0],AUTHORITY[\\\"EPSG\\\",5773]]\"}\""," ","},"," ","\"type\": {"," ","\"type\": \"string\","," ","\"enum\": ["," ","\"AnyCrsFeatureCollection\""," ","]"," ","},"," ","\"VerticalCoordinateReferenceSystemID\": {"," ","\"pattern\": \"^[\\w\\-\\.]+:reference-data\\-\\-CoordinateReferenceSystem:[\\w\\-\\.\\:\\%]+:[0-9]"]},"$\","," ","\"description\": \"The explicit VerticalCRS reference in the CoordinateReferenceSystem catalog. This property stays empty for 2D geometries. Absent or empty values for 3D geometries mean the context may be provided by a CompoundCRS in 'CoordinateReferenceSystemID' or implicitly as EPSG:5714 MSL height\","," ","\"x-osdu-relationship\": ["," ","{"," ","\"EntityType\": \"CoordinateReferenceSystem\","," ","\"GroupType\": \"reference-data\""," ","}"," ","],"," ","\"title\": \"Vertical Coordinate Reference System ID\","," ","\"type\": \"string\","," ","\"example\": \"namespace:reference-data--CoordinateReferenceSystem:VerticalCRS.EPSG.5773:\""," ","}"," ","},"," ","\"$id\": \"https://schema.osdu.opengroup.org/json/abstract/AbstractAnyCrsFeatureCollection.1.0.0.json\""," ","}"," ","},"," ","\"properties\": {"," ","\"id\": {"," ","\"description\": \"The unique identifier of the shapefile Record\","," ","\"title\": \"Shapefile Record ID\","," ","\"type\": \"string\""," ","},"," ","\"version\": {"," ","\"format\": \"int64\","," ","\"description\": \"The version number of this shapefile record, set by the framework.\","," ","\"title\": \"Entity Version Number\","," ","\"type\": \"number\","," ","\"example\": \"1631210408153985\""," ","},"," ","\"kind\": {"," ","\"description\": \"Shapefile Entity kind specification.\","," ","\"title\": \"Shapefile Entity Kind\","," ","\"type\": \"string\""," ","},"," ","\"type\": {"," ","\"description\": \"The reference entity type as declared in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<authority>"]},":metadata:entity:*.\","," ","\"title\": \"Entity Type\","," ","\"type\": \"string\""," ","},"," ","\"legal\": {"," ","\"description\": \"The geological interpretation's legal tags\","," ","\"title\": \"Legal Tags\","," ","\"$ref\": \"#/definitions/legal\""," ","},"," ","\"acl\": {"," ","\"description\": \"The access control tags associated with this entity.\","," ","\"title\": \"Access Control List\","," ","\"$ref\": \"#/definitions/accessControlList\""," ","},"," ","\"ancestry\": {"," ","\"description\": \"The links to data, which constitute the inputs.\","," ","\"title\": \"Ancestry\","," ","\"$ref\": \"#/definitions/ancestryList\""," ","},"," ","\"tags\": {"," ","\"title\": \"Tag Dictionary\","," ","\"description\": \"A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.\","," ","\"type\": \"array\","," ","\"items\": {"," ","\"$ref\": \"#/definitions/tags\""," ","}"," ","},"," ","\"meta\": {"," ","\"description\": \"The meta data section linking the unit, CRS to self-contained definitions (persistableReference).\","," ","\"title\": \"Frame of Reference Meta Data\","," ","\"type\": \"array\","," ","\"items\": {"," ","\"$ref\": \"#/definitions/metaItem\""," ","}"," ","},"," ","\"data\": {"," ","\"description\": \"Shapefile data\","," ","\"title\": \"Shapefile Data\","," ","\"$ref\": \"#/definitions/data\""," ","}"," ","}"," ","}"," ","}"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"file-metadata-record","__idx":14},"children":["File Metadata record ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"file-metadata-record"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The File Metadata is used to provide the ACL, legal tags, file source, and target kind of the ingested data, attributes, and their kinds, and metadata information like Unit, CRS, and established relationships with existing parents."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sample metadata:"]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[" Sample File: sample_metadata_states.json "]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"\n    {\n        \"data\": {\n            \"Endian\": \"BIG\",\n            \"Description\": \"string\",\n            \"DatasetProperties\": {\n            \"FileSourceInfo\": {\n                \"FileSource\": \"<filesource>\",\n                \"PreLoadFilePath\": \"string\",\n                \"PreloadFileCreateUser\": \"user@slb.com\",\n                \"PreloadFileModifyUser\": \"string\",\n                \"PreloadFileModifyDate\": \"string\",\n                \"Name\": \"states.zip\",\n                \"FileSize\": \"65kb\",\n                \"EncodingFormatTypeID\": \"UTF-8\"\n            }\n            },\n            \"ResourceLifecycleStatus\": \"string\",\n            \"TotalSize\": \"65kb\",\n            \"ResourceCurationStatus\": \"string\",\n            \"EncodingFormatTypeID\": \"string\",\n            \"Name\": \"states.zip\",\n            \"ResourceHomeRegionID\": \"string\",\n            \"ResourceHostRegionIDs\": [\n            \"string\"\n            ],\n            \"ExtensionProperties\": {\n            \"Classification\": \"string\",\n            \"Description\": \"US states shape file\",\n            \"ExternalIds\": [\n                \"string\"\n            ],\n            \"FileDateCreated\": {},\n            \"FileDateModified\": {},\n            \"FileContentsDetails\": {\n                \"TargetKind\": \"`<authority>`:<source>:<entity type>:1.0.0\",\n                \"FrameOfReference\": [\n                        {\n                            \"kind\": \"CRS\",\n                            \"name\": \"GCS_North_American_1983\",\n                            \"persistableReference\": \"{\\\"lateBoundCRS\\\":{\\\"wkt\\\":\\\"GEOGCS[\\\\\\\"GCS_North_American_1983\\\\\\\",DATUM[\\\\\\\"D_North_American_1983\\\\\\\",SPHEROID[\\\\\\\"GRS_1980\\\\\\\",6378137.0,298.257222101]],PRIMEM[\\\\\\\"Greenwich\\\\\\\",0.0],UNIT[\\\\\\\"Degree\\\\\\\",0.0174532925199433],AUTHORITY[\\\\\\\"EPSG\\\\\\\",4269]]\\\",\\\"ver\\\":\\\"PE_10_3_1\\\",\\\"name\\\":\\\"GCS_North_American_1983\\\",\\\"authCode\\\":{\\\"auth\\\":\\\"EPSG\\\",\\\"code\\\":\\\"4269\\\"},\\\"type\\\":\\\"LBC\\\"},\\\"singleCT\\\":{\\\"wkt\\\":\\\"GEOGTRAN[\\\\\\\"NAD_1983_To_WGS_1984_1\\\\\\\",GEOGCS[\\\\\\\"GCS_North_American_1983\\\\\\\",DATUM[\\\\\\\"D_North_American_1983\\\\\\\",SPHEROID[\\\\\\\"GRS_1980\\\\\\\",6378137.0,298.257222101]],PRIMEM[\\\\\\\"Greenwich\\\\\\\",0.0],UNIT[\\\\\\\"Degree\\\\\\\",0.0174532925199433]],GEOGCS[\\\\\\\"GCS_WGS_1984\\\\\\\",DATUM[\\\\\\\"D_WGS_1984\\\\\\\",SPHEROID[\\\\\\\"WGS_1984\\\\\\\",6378137.0,298.257223563]],PRIMEM[\\\\\\\"Greenwich\\\\\\\",0.0],UNIT[\\\\\\\"Degree\\\\\\\",0.0174532925199433]],METHOD[\\\\\\\"Geocentric_Translation\\\\\\\"],PARAMETER[\\\\\\\"X_Axis_Translation\\\\\\\",0.0],PARAMETER[\\\\\\\"Y_Axis_Translation\\\\\\\",0.0],PARAMETER[\\\\\\\"Z_Axis_Translation\\\\\\\",0.0],AUTHORITY[\\\\\\\"EPSG\\\\\\\",1188]]\\\",\\\"ver\\\":\\\"PE_10_3_1\\\",\\\"name\\\":\\\"NAD_1983_To_WGS_1984_1\\\",\\\"authCode\\\":{\\\"auth\\\":\\\"EPSG\\\",\\\"code\\\":\\\"1188\\\"},\\\"type\\\":\\\"ST\\\"},\\\"ver\\\":\\\"PE_10_3_1\\\",\\\"name\\\":\\\"NAD83 * DMA-N Am [4269,1188]\\\",\\\"authCode\\\":{\\\"auth\\\":\\\"SLB\\\",\\\"code\\\":\\\"4269001\\\"},\\\"type\\\":\\\"EBC\\\"}\",\n                            \"propertyNames\": [\n                            \"SpatialLocation.AsIngestedCoordinates\"\n                            ]\n                        },\n                        {\n                            \"kind\": \"Unit\",\n                            \"name\": \"km\",\n                            \"persistableReference\": \"{\\\"scaleOffset\\\":{\\\"scale\\\":1.0,\\\"offset\\\":0.0},\\\"symbol\\\":\\\"km\\\",\\\"baseMeasurement\\\":{\\\"ancestry\\\":\\\"Length\\\",\\\"type\\\":\\\"UM\\\"},\\\"type\\\":\\\"USO\\\"}\",\n                            \"propertyNames\": []\n                        }\n                ],\n                \"relationships\": [\n                            {\n                                \"projects\": {\n                                    \"ids\": [\n                                        \"`<authority>`:wing:project-sxs0f1a5219-4640-50af-9f63-c09140d57c4d\",\n                                        \"`<authority>`:wing:project-sxs0f1a5219-4640-50af-9f63-c09140d57c5e\",\n                                        \"`<authority>``:wing:project-sxs0f1a5219-4640-50af-9f63-c09140d57c6f\"\n                                    ]\n                                },\n                                \"Abbreviation\": {\n                                    \"ids\": [\n                                        \"`<authority>`:wing:ABBR-sxs0f1a5219-4640-50af-9f63-c09140d57c4d\"\n                                    ]\n                                }\n                            }\n                        ],\n                        \"relatedNaturalKey\": [\n                            {\n                                \"well\": {\n                                    \"targetKind\": \"`<authority>`:shape:well:1.0.0\",\n                                    \"keys\": [\n                                        {\n                                            \"sourceColumn\": \"WELL_ID\",\n                                            \"targetAttribute\": \"uwi\"\n                                        }\n                                    ]\n                                }\n                            },\n                            {\n                                \"Wellbore\": {\n                                    \"targetKind\": \"`<authority>`:shape:wellbore:1.0.0\",\n                                    \"keys\": [\n                                        {\n                                            \"sourceColumn\": \"WELLORE_ID\",\n                                            \"targetAttribute\": \"UBHI\"\n                                        }\n                                    ]\n                                }\n                            }\n                        ],\n                \"extensionProperties\": {\n                \"skipDupes\": false,\n                \"overrideUniqueId\": false\n                }\n            }\n            },\n            \"ResourceSecurityClassification\": \"string\",\n            \"ExistenceKind\": \"string\",\n            \"SchemaFormatTypeID\": \"string\"\n        },\n        \"meta\": [\n            {}\n        ],\n        \"id\": \"`<authority>`:dec44cb4-916c-4bee-85da-0de713a32f26\",\n        \"version\": 1622547133262813,\n        \"kind\": \"`<authority>`:wks:dataset--File.Generic:1.0.0\",\n        \"acl\": {\n                \"viewers\": [\n                \"data.default.viewers@{domain}.com\"\n                ],\n                \"owners\": [\n                \"data.default.viewers@{domain}.com\"\n                ]\n            },\n        \"legal\": {\n            \"legaltags\": [\n                \"<valid legal tag>\"\n            ],\n            \"otherRelevantDataCountries\": [\n                \"US\"\n            ],\n            \"status\": \"compliant\"\n        }\n    }\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["ACL:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Specifies the Access Control list."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/compliance-service/apis/osdu-entitlements-service-v2"},"children":["API Reference"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"    \"acl\": {\n        \"viewers\": [\n            \"data.default.viewers@{domain}.com\"\n        ],\n        \"owners\": [\n            \"data.default.viewers@{domain}.com\"\n        ]\n    }\n","lang":"json"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Legal Tags:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Specifies the legal tags. This holds the details of the data compliance for the data ingested."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/compliance-service/apis/osdu-compliance-service"},"children":["API Reference"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Example:",{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"  \"legal\": {\n      \"legaltags\": [\n          \"opendes-public-usa-dataset-7643990\"\n      ],\n      \"otherRelevantDataCountries\": [\n          \"US\"\n      ],\n      \"status\": \"compliant\"\n  }\n\n","lang":"json"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["FileSource:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FileSource"]}," in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FileSourceInfo"]}," is the relative file path of the shapefile uploaded in the file-staging-area."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["This value is the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["relative file path"]}," received from the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Get Signed Url"]}," response (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#3-get-signed-url-using-file-service"},"children":["mentioned above in Step #2"]},")."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["TargetKind:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["This is the schema kind in which the data is ingested in the following format ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<<authority>:<source>:<entityType>:<version>>"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Name:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Name"]}," in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FileSourceInfo"]}," is the name of the files inside the zip file that needs to be ingested."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["This is a mandatory input required for creating metadata for shapefile ingestion."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Unit:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["This block is used to provide the unit frame of reference information for the corresponding property in the .dbf file. This information is stored in the meta[] block of the record."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["CRS:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["This block is used to provide the source CRS frame of reference information."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If the CRS information is provided in the metadata, ensure that CRS information is defined for propertyNames ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SpatialLocation.AsIngestedCoordinates"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If there is no CRS information provided in the metadata, the information is fetched from the .prj file. If neither the metadata nor the .prj file contain the CRS information, the ingestion fails."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Relationships:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Shapefile ingestion supports two kinds of relationships:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Deterministic (Schema-driven)"]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"These relationships require that the entity be referred to in the record's ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["targetKind"]}," schema under an attribute that has an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-osdu-relationship"]}," tag. Because they are present in the schema, they are represented directly as attributes in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," block of the record.",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Currently, only string type relationships are supported."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Non Deterministic (Data-driven)"]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"These relationships do not require any mention in the schema. They are represented within the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.relationships"]}," block of the record."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ExtensionProperties block in the file metadata record is used to provide additional information for ingestion. You can use this block to provide relationship information. There are three ways of providing this information:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["relationships"]}," block, with the entity name and a list of parent record IDs. The IDs provided are directly used to establish the relationships."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["relatedNaturalKey"]}," block, as an entity that requires a search of the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["targetKind"]}," using the natural ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["keys"]}," provided to establish a relationship."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["sourceColumn"]},": Column name of the shapeFile that refers to the key parent attribute."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["targetKind"]},": Schema ID of the parent record."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["targetAttribute"]},": The key attribute of the parent record which is used to search the parent record."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Pre-requisites"]}]},": The .dbf file present in the input shapefile contains the key attributes of the parent records."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["relatedNaturalKey"]}," block, as an entity that has the related parent record ID directly in the shapefile under the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["sourceColumn"]}," of the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["keys"]}," block."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["sourceColumn"]},": Column name of the shapefile that refers to the parent record ID."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Pre-requisites"]}]},": The parent record ID should be present under the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["sourceColumn"]}," in the shapefile."]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sample data"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Metadata sample for the Relationships block:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":" {\n     \"data\": {\n         \"Endian\": \"BIG\",\n         \"Description\": \"string\",\n         \"DatasetProperties\": {\n         \"FileSourceInfo\": {\n             \"FileSource\": \"<filesource>\",\n             \"PreLoadFilePath\": \"string\",\n             \"PreloadFileCreateUser\": \"user@slb.com\",\n             \"PreloadFileModifyUser\": \"string\",\n             \"PreloadFileModifyDate\": \"string\",\n             \"Name\": \"states.zip\",\n             \"FileSize\": \"65kb\",\n             \"EncodingFormatTypeID\": \"UTF-8\"\n         }\n         },\n         \"ResourceLifecycleStatus\": \"string\",\n         \"TotalSize\": \"65kb\",\n         \"ResourceCurationStatus\": \"string\",\n         \"EncodingFormatTypeID\": \"string\",\n         \"Name\": \"states.zip\",\n         \"ResourceHomeRegionID\": \"string\",\n         \"ResourceHostRegionIDs\": [\n         \"string\"\n         ],\n         \"ExtensionProperties\": {\n         \"Classification\": \"string\",\n         \"Description\": \"US states shape file\",\n         \"ExternalIds\": [\n             \"string\"\n         ],\n         \"FileDateCreated\": {},\n         \"FileDateModified\": {},\n         \"FileContentsDetails\": {\n             \"TargetKind\": \"`<authority>`:<source>:<entity type>:1.0.0\",\n             \"FrameOfReference\": [\n                     {\n                         \"kind\": \"CRS\",\n                         \"name\": \"GCS_North_American_1983\",\n                         \"persistableReference\": \"{\\\"lateBoundCRS\\\":{\\\"wkt\\\":\\\"GEOGCS[\\\\\\\"GCS_North_American_1983\\\\\\\",DATUM[\\\\\\\"D_North_American_1983\\\\\\\",SPHEROID[\\\\\\\"GRS_1980\\\\\\\",6378137.0,298.257222101]],PRIMEM[\\\\\\\"Greenwich\\\\\\\",0.0],UNIT[\\\\\\\"Degree\\\\\\\",0.0174532925199433],AUTHORITY[\\\\\\\"EPSG\\\\\\\",4269]]\\\",\\\"ver\\\":\\\"PE_10_3_1\\\",\\\"name\\\":\\\"GCS_North_American_1983\\\",\\\"authCode\\\":{\\\"auth\\\":\\\"EPSG\\\",\\\"code\\\":\\\"4269\\\"},\\\"type\\\":\\\"LBC\\\"},\\\"singleCT\\\":{\\\"wkt\\\":\\\"GEOGTRAN[\\\\\\\"NAD_1983_To_WGS_1984_1\\\\\\\",GEOGCS[\\\\\\\"GCS_North_American_1983\\\\\\\",DATUM[\\\\\\\"D_North_American_1983\\\\\\\",SPHEROID[\\\\\\\"GRS_1980\\\\\\\",6378137.0,298.257222101]],PRIMEM[\\\\\\\"Greenwich\\\\\\\",0.0],UNIT[\\\\\\\"Degree\\\\\\\",0.0174532925199433]],GEOGCS[\\\\\\\"GCS_WGS_1984\\\\\\\",DATUM[\\\\\\\"D_WGS_1984\\\\\\\",SPHEROID[\\\\\\\"WGS_1984\\\\\\\",6378137.0,298.257223563]],PRIMEM[\\\\\\\"Greenwich\\\\\\\",0.0],UNIT[\\\\\\\"Degree\\\\\\\",0.0174532925199433]],METHOD[\\\\\\\"Geocentric_Translation\\\\\\\"],PARAMETER[\\\\\\\"X_Axis_Translation\\\\\\\",0.0],PARAMETER[\\\\\\\"Y_Axis_Translation\\\\\\\",0.0],PARAMETER[\\\\\\\"Z_Axis_Translation\\\\\\\",0.0],AUTHORITY[\\\\\\\"EPSG\\\\\\\",1188]]\\\",\\\"ver\\\":\\\"PE_10_3_1\\\",\\\"name\\\":\\\"NAD_1983_To_WGS_1984_1\\\",\\\"authCode\\\":{\\\"auth\\\":\\\"EPSG\\\",\\\"code\\\":\\\"1188\\\"},\\\"type\\\":\\\"ST\\\"},\\\"ver\\\":\\\"PE_10_3_1\\\",\\\"name\\\":\\\"NAD83 * DMA-N Am [4269,1188]\\\",\\\"authCode\\\":{\\\"auth\\\":\\\"SLB\\\",\\\"code\\\":\\\"4269001\\\"},\\\"type\\\":\\\"EBC\\\"}\",\n                         \"propertyNames\": [\n                         \"SpatialLocation.AsIngestedCoordinates\"\n                         ]\n                     },\n                     {\n                         \"kind\": \"Unit\",\n                         \"name\": \"km\",\n                         \"persistableReference\": \"{\\\"scaleOffset\\\":{\\\"scale\\\":1.0,\\\"offset\\\":0.0},\\\"symbol\\\":\\\"km\\\",\\\"baseMeasurement\\\":{\\\"ancestry\\\":\\\"Length\\\",\\\"type\\\":\\\"UM\\\"},\\\"type\\\":\\\"USO\\\"}\",\n                         \"propertyNames\": []\n                     }\n             ],\n             \"relationships\": [\n                         {\n                             \"projects\": {\n                                 \"ids\": [\n                                     \"`<authority>`:wing:project-sxs0f1a5219-4640-50af-9f63-c09140d57c4d\",\n                                     \"`<authority>`:wing:project-sxs0f1a5219-4640-50af-9f63-c09140d57c5e\",\n                                     \"`<authority>`:wing:project-sxs0f1a5219-4640-50af-9f63-c09140d57c6f\"\n                                 ]\n                             },\n                             \"Abbreviation\": {\n                                 \"ids\": [\n                                     \"`<authority>`:wing:ABBR-sxs0f1a5219-4640-50af-9f63-c09140d57c4d\"\n                                 ]\n                             }\n                         }\n                     ],\n                     \"relatedNaturalKey\": [\n                         {\n                             \"well\": {\n                                 \"targetKind\": \"`<authority>`:shape:well:1.0.0\",\n                                 \"keys\": [\n                                     {\n                                         \"sourceColumn\": \"WELL_ID\",\n                                         \"targetAttribute\": \"uwi\"\n                                     }\n                                 ]\n                             }\n                         },\n                         {\n                             \"Wellbore\": {\n                                 \"targetKind\": \"`<authority>`:shape:wellbore:1.0.0\",\n                                 \"keys\": [\n                                     {\n                                         \"sourceColumn\": \"WELLORE_ID\",\n                                         \"targetAttribute\": \"UBHI\"\n                                     }\n                                 ]\n                             }\n                         }\n                     ],\n             \"extensionProperties\": {\n             \"skipDupes\": false,\n             \"overrideUniqueId\": false\n             }\n         }\n         },\n         \"ResourceSecurityClassification\": \"string\",\n         \"ExistenceKind\": \"string\",\n         \"SchemaFormatTypeID\": \"string\"\n     },\n     \"meta\": [\n         {}\n     ],\n     \"id\": \"`<authority>`:dec44cb4-916c-4bee-85da-0de713a32f26\",\n     \"version\": 1622547133262813,\n     \"kind\": \"`<authority>`:wks:dataset--File.Generic:1.0.0\",\n     \"acl\": {\n             \"viewers\": [\n             \"data.default.viewers@{domain}.com\"\n             ],\n             \"owners\": [\n             \"data.default.viewers@{domain}.com\"\n             ]\n         },\n     \"legal\": {\n         \"legaltags\": [\n             \"<valid legal tag>\"\n         ],\n         \"otherRelevantDataCountries\": [\n             \"US\"\n         ],\n         \"status\": \"compliant\"\n     }\n }\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The schema of the record should contain information about attributes that might contain deterministic relationships."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The EntityType field within the x-osdu-relationship block should contain the entity that needs to be matched from the Relationships block in ExtensionProperties."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"  {\n      \"properties\": {\n                  \"STATE_ABBR\": {\n                          \"type\": \"string\",\n                          \"description\": \"State Abbreviation code\",\n                          \"x-osdu-relationship\": [\n                                          {\n                                              \"EntityType\": \"Abbreviation\",\n                                              \"GroupType\": \"master-data\"\n                                          }\n                                      ]\t\t\t\t\t\t\n                      },\n                      \"WELL_ID\": {\n                                      \"type\": \"string\",\n                                      \"description\": \"NAME\",\n                                      \"x-osdu-relationship\": [\n                                          {\n                                              \"EntityType\": \"Well\",\n                                              \"GroupType\": \"master-data\"\n                                          }\n                                      ]\n                      }\n  },        \n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The final record has the relationships defined as follows:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":" {\n  \"data\": {\n  \"STATE_ABBR\": \"`<authority>`:wing:ABBR-sxs0f1a5219-4640-50af-9f63-c09140d57c4d:\",\n  \"WELL_ID\": \"`<authority>`:well:shape-REQxODI4MTAxMw:\"\n  \"relationships\": {\n      \"projects\": {\n              \"ids\": [\n                      \"`<authority>`:wing:project-sxs0f1a5219-4640-50af-9f63-c09140d57c4d:\",\n                      \"`<authority>``:wing:project-sxs0f1a5219-4640-50af-9f63-c09140d57c5e:\",\n                      \"`<authority>`:wing:project-sxs0f1a5219-4640-50af-9f63-c09140d57c6f:\"\n                  ]\n              }\n      \"Wellbore\": {\n          \"ids\": [\n                  \"`<authority>`:wellbore:shape-RETYQAGFTYU:\"\n                 ]\n              }\n          }\n      }\n  }\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note: Currently, only the string type relationships are supported. The first record of the project entity in the relationships block of the metadata is added to the value of the NAME attribute in the ingested record. The second record of the project entity in the relationships block of metadata is added to the project entity in the relationships block of the ingested record."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["ExtensionProperties:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["FileContentsDetails:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ExtensionProperties information is used to handle duplicate records and record ID creation when none of the columns or sequence of columns are unique in the .dbf file.",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["skipDupes: If true, the duplicate records are skipped by the Storage service. If false, the duplicate records are ingested as new version of the same record."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["overrideUniqueId: If true, the record IDs are generated based on the row number in the .dbf file. Unique ID columns mentioned in the targetKind schema are ignored."," ","If false, the record IDs are generated based on the unique ID columns mentioned in target kind schema."]}]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"preregistered-dag","__idx":15},"children":["Preregistered DAG ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"preregistered-dags"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ingestion framework has a preregistered DAG to perform shapefile ingestion."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["workflow name: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shapefile_ingestor_wf"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"limitations","__idx":16},"children":["Limitations ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"limitations"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ingestion Workflow service known limitations:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Not yet integrated with the OSDU Notification service.",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Manually call the Workflow service to execute a registered DAG."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A nested schema is not supported by shapefile Ingestion."]}]}]},"headings":[{"value":"Table of contents","id":"table-of-contents","depth":2},{"value":"Introduction","id":"introduction","depth":2},{"value":"Ingestion framework","id":"ingestion-framework","depth":2},{"value":"Components","id":"components","depth":3},{"value":"Access controls","id":"access-controls","depth":3},{"value":"How to execute the Shapefile workflow","id":"how-to-execute-the-shapefile-workflow","depth":2},{"value":"1.\tRegister your schema using the Schema service","id":"1register-your-schema-using-the-schema-service","depth":3},{"value":"2. Get a signed URL using the File service","id":"2-get-a-signed-url-using-the-file-service","depth":3},{"value":"3.\tUpload the Shapefile using a signed URL","id":"3upload-the-shapefile-using-a-signed-url","depth":3},{"value":"4.\tCreate a file metadata record using the File service","id":"4create-a-file-metadata-record-using-the-file-service","depth":3},{"value":"5.\tRun the Shapefile workflow","id":"5run-the-shapefile-workflow","depth":3},{"value":"6. Monitor the workflow status","id":"6-monitor-the-workflow-status","depth":3},{"value":"7.\tValidate the ingested data","id":"7validate-the-ingested-data","depth":3},{"value":"Input file and schemas","id":"input-file-and-schemas","depth":2},{"value":"File Metadata record","id":"file-metadata-record","depth":2},{"value":"Preregistered DAG","id":"preregistered-dag","depth":2},{"value":"Limitations","id":"limitations","depth":2}],"frontmatter":{"seo":{"title":"Table of contents"}},"lastModified":"2025-11-25T04:17:58.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/data-workspace/tutorial/shapefile-ingestion","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}