{"templateId":"markdown","sharedDataIds":{},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Working With Datasets","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":1,"id":"working-with-datasets","__idx":0},"children":["Working With Datasets"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Datasets are the fundamental data resources. A dataset resource is stored inside a subproject and can be placed under a logical folder path. The dataset path is optional and has the same meaning as a directory in a generic file system."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Upload/download a dataset in seismic store is a composed operation (multiple API calls)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Upload a file in a seismic store dataset:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"1. call the register endpoint to register the dataset in seismic store (location in the storage will be generated)\n2. call the get-storage-credential endpoint to generate storage access credential.\n3. upload the bytestream to the reserved storage resource location using the generated credential\n4. call the patch endpoint to close the dataset and fix the filemetadata (mata information that represent the physical data structure)\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["download a seismic store dataset to a file:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"1. call the dataset get endpoint to retrieve the dataset meta-information from seismic store\n2. call the get-storage-credential endpoint to generate storage access credential.\n3. download the bytestream from the reserved storage resource location using the generated credential\n\nA command line utility, sdutil, has been created to upload/download dataset to/from seismic store with a user friendly interface. \nTo download the utility, see the download tab. Please follow the utility tutorial (released with the utility package) to upload/download \ndataset to/from seismic store.\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"register-a-dataset-in-seismic-store","__idx":1},"children":["Register a dataset in seismic store"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required Role"]},": subproject.admin"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]},": register a new dataset in seismic store (it create a location in the storage and an entry in the seismic store registry)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Notes"]},": This method registers the dataset metadata in seismicstore and reserves a location in the storage resource where stores physical data. (URI returned within the response)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Param.header.ltag(optional)"]},": the dataset legal tag. If not provided the default subproject one will be used. Refer to the Compliance Service tutorial to learn how to create and manage legal Tags."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Param.body.type(optional)"]},": the type of the dataset (zgy, segy, text, my data)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Param.body.gtags(optional)"]},": a list of generic-tags. This will enable the datasets to search in a subproject by tags."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Param.body.seismicmeta(optional)"]},": the storage service metadata to link with the dataset in seismic store. Refer to the Storage Service tutorial to learn how to create and manage storage metadata."]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# seistore dataset API call\ncurl -s -X POST \\\"https://HOST/seistore-svc/api/v3/dataset/tenant/TENANT_NAME/subproject/SUBPROJECT_NAME/dataset/DATASET_NAME?path=DATASET_PATH\\\" \\\\\n    -H \\\"accept: application/json\\\" \\\\\n    -H \\\"Authorization: Bearer STOKEN\\\" \\\\\n    -H \\\"ltag: LEGAL_TAG\\\" \\\\\n    -d \\\"{ \\\\\\\"type\\\\\\\": \\\\\\\"text\\\\\\\"}\\\"\n\n# API response \n{\n  \\\"subproject\\\": \\\"tutorial\\\",\n  \\\"gcsurl\\\": \\\"ss-p4d-eoldihs4vk7oo1yo/kmD6lvCCxBTDc3Ht\\\",\n  \\\"path\\\": \\\"/data/\\\",\n  \\\"last_modified_date\\\": \\\"Mon Jun 22 2020 13:10:21 GMT+0000 (Coordinated Universal Time)\\\",\n  \\\"created_date\\\": \\\"Mon Jun 22 2020 13:10:21 GMT+0000 (Coordinated Universal Time)\\\",\n  \\\"sbit_count\\\": 1,\n  \\\"tenant\\\": \\\"company\\\",\n  \\\"name\\\": \\\"testdata.txt\\\",\n  \\\"sbit\\\": \\\"WjPfaixGXZnwJAEi\\\",\n  \\\"ltag\\\": \\\"company-public-usa-seistore-1\\\",\n  \\\"type\\\": \\\"text\\\",\n  \\\"created_by\\\": \\\"testUserSeistoreViewer@company.com\\\",\n  \\\"ctag\\\": \\\"0000000000000000p4d-ddl-eu-company\\\"\n}\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"retrieve-stat-information-for-a-dataset","__idx":2},"children":["Retrieve stat information for a dataset"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required Role"]},": subproject.admin, subproject.viewer"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]},": retrieve the dataset meta-information maintained in the seismic store registry"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# seistore dataset API call\ncurl -s -X GET \\\"https://HOST/seistore-svc/api/v3/dataset/tenant/TENANT_NAME/subproject/SUBPROJECT_NAME/dataset/DATASET_NAME?path=DATASET_PATH\\\" \\\\\n    -H \\\"accept: application/json\\\" \\\\\n    -H \\\"Authorization: Bearer STOKEN\\\" \n\n# API response \n{\n  \\\"subproject\\\": \\\"tutorial\\\",\n  \\\"gcsurl\\\": \\\"ss-p4d-eoldihs4vk7oo1yo/kmD6lvCCxBTDc3Ht\\\",\n  \\\"path\\\": \\\"/data/\\\",\n  \\\"last_modified_date\\\": \\\"Mon Jun 22 2020 13:10:21 GMT+0000 (Coordinated Universal Time)\\\",\n  \\\"created_date\\\": \\\"Mon Jun 22 2020 13:10:21 GMT+0000 (Coordinated Universal Time)\\\",\n  \\\"sbit_count\\\": 1,\n  \\\"tenant\\\": \\\"company\\\",\n  \\\"name\\\": \\\"testdata.txt\\\",\n  \\\"sbit\\\": \\\"WjPfaixGXZnwJAEi\\\",\n  \\\"ltag\\\": \\\"company-public-usa-seistore-1\\\",\n  \\\"created_by\\\": \\\"testUserSeistoreViewer@company.com\\\",\n  \\\"ctag\\\": \\\"0000000000000000p4d-ddl-eu-company\\\"\n}\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"update-the-dataset-meta-information","__idx":3},"children":["Update the dataset meta-information"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required Role"]},": subproject.admin"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]},": Update the dataset information in the seismic store registry"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Param.body.ltag(optional)"]},": the dataset legal tag. Refer to the compliance service tutorial to learn how to create a manage legal Tags."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Param.body.dataset_new_name(optional)"]},": to rename a dataset"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Param.body.metadata(optional)"]},": a generic metadata field that can be used to inject any client-specific JSON data to link to the dataset. These metadata, seismic store specific, will not be stored and queryable in/from the system."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Param.body.filemetadata(optional)"]},": a JSON object that represents the physical structure of the dataset objects in the physical storage resource (GCS Bucket, Azure container, etc, ). These file metadata are seismic store-specific and mainly used by client libraries."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Param.body.seismicmeta(optional)"]},": the storage service metadata to link with the dataset in seismic store. Refer to the storage service tutorial to learn how to create a managed storage metadata."]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# seistore dataset API call\ncurl -s -X PATCH \\\"https://HOST/seistore-svc/api/v3/dataset/tenant/TENANT_NAME/subproject/SUBPROJECT_NAME/dataset/DATASET_NAME?path=DATASET_PATH\\\" \\\\\n    -H \\\"accept: application/json\\\" \\\\\n    -H \\\"Authorization: Bearer STOKEN\\\" \\\\\n    -H \\\"ltag: LEGAL_TAG\\\" \\\\\n    -d \\\"{ \\\\\\\"dataset_new_name\\\\\\\": \\\\\\\"testdata02\\\\\\\"}\\\"\n\n# API response \n{\n  \\\"subproject\\\": \\\"tutorial\\\",\n  \\\"gcsurl\\\": \\\"ss-p4d-eoldihs4vk7oo1yo/kmD6lvCCxBTDc3Ht\\\",\n  \\\"path\\\": \\\"/data/\\\",\n  \\\"last_modified_date\\\": \\\"Mon Jun 22 2020 13:10:21 GMT+0000 (Coordinated Universal Time)\\\",\n  \\\"created_date\\\": \\\"Mon Jun 22 2020 13:10:21 GMT+0000 (Coordinated Universal Time)\\\",\n  \\\"sbit_count\\\": 1,\n  \\\"tenant\\\": \\\"company\\\",\n  \\\"name\\\": \\\"testdata02.txt\\\",\n  \\\"sbit\\\": \\\"WjPfaixGXZnwJAEi\\\",\n  \\\"ltag\\\": \\\"company-public-usa-seistore-1\\\",\n  \\\"type\\\": \\\"text\\\",\n  \\\"created_by\\\": \\\"testUserSeistoreViewer@company.com\\\",\n  \\\"ctag\\\": \\\"0000000000000000p4d-ddl-eu-company\\\"\n}\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list-all-datasets-in-a-subproject","__idx":4},"children":["List all datasets in a subproject"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required Role"]},": subproject.admin, subproject.viewer"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]},": retrieve all datasets meta-information maintained in the seismic store registry (in a subproject)"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# seistore dataset API call\ncurl -s -X GET \\\"https://HOST/seistore-svc/api/v3/dataset/tenant/TENANT_NAME/subproject/SUBPROJECT_NAME?path=DATASET_PATH\\\" \\\\\n    -H \\\"accept: application/json\\\" \\\\\n    -H \\\"Authorization: Bearer STOKEN\\\" \n\n# API response \n[\n  {\n    \\\"subproject\\\": \\\"tutorial\\\",\n    \\\"gcsurl\\\": \\\"ss-p4d-eoldihs4vk7oo1yo/kmD6lvCCxBTDc3Ht\\\",\n    \\\"path\\\": \\\"/data/\\\",\n    \\\"last_modified_date\\\": \\\"Mon Jun 22 2020 13:10:21 GMT+0000 (Coordinated Universal Time)\\\",\n    \\\"created_date\\\": \\\"Mon Jun 22 2020 13:10:21 GMT+0000 (Coordinated Universal Time)\\\",\n    \\\"sbit_count\\\": 1,\n    \\\"tenant\\\": \\\"company\\\",\n    \\\"name\\\": \\\"testdata.txt\\\",\n    \\\"sbit\\\": \\\"WjPfaixGXZnwJAEi\\\",\n    \\\"ltag\\\": \\\"company-public-usa-seistore-1\\\",\n    \\\"created_by\\\": \\\"testUserSeistoreViewer@company.com\\\",\n    \\\"ctag\\\": \\\"0000000000000000p4d-ddl-eu-company\\\"\n  }\n]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"lock-a-dataset-for-readwrite","__idx":5},"children":["Lock a dataset for read/write"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required Role lock-read"]},": subproject.admin, subproject.viewer"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required Role lock-write"]},": subproject.admin"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]},": lock a dataset for reading or write (the lockID will be returned with the response)",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If request lock for reading any next write request will be rejected (write-data-protection)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If request lock for write any next read/write request will be rejected (read-write-data-protection)"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Notes"]},": The lock, if not explicitly removed, will be automatically released after 1 hour."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Param.query.openmode(optional)"]},": define the locking policy, read(default) or write."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Param.query.wid(optional)"]},": set the lockID in this field to bypass the locking. For example, the first call lock for reading, generate the lockID and use it in all next calls for bypass the locking (master-slave model)"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# seistore dataset API call\ncurl -s -X PUT \\\"https://HOST/seistore-svc/api/v3/dataset/tenant/TENANT_NAME/subproject/SUBPROJECT_NAME/dataset/DATASET_ID/lock?path=DATASET_PATH&openmode=write\\\" \\\\\n    -H \\\"accept: application/json\\\" \\\\\n    -H \\\"Authorization: Bearer STOKEN\\\" \n\n# API response\n{\n  \\\"subproject\\\": \\\"tutorial\\\",\n  \\\"gcsurl\\\": \\\"ss-p4d-eoldihs4vk7oo1yo/kmD6lvCCxBTDc3Ht\\\",\n  \\\"path\\\": \\\"/data/\\\",\n  \\\"last_modified_date\\\": \\\"Mon Jun 22 2020 13:10:21 GMT+0000 (Coordinated Universal Time)\\\",\n  \\\"created_date\\\": \\\"Mon Jun 22 2020 .13:10:21 GMT+0000 (Coordinated Universal Time)\\\",\n  \\\"sbit_count\\\": 1,\n  \\\"tenant\\\": \\\"company\\\",\n  \\\"name\\\": \\\"testdata.txt\\\",\n  \\\"sbit\\\": \\\"Wyufa3xcXZnaJgsH\\\",\n  \\\"ltag\\\": \\\"company-public-usa-seistore-1\\\",\n  \\\"created_by\\\": \\\"testUserSeistoreViewer@company.com\\\",\n  \\\"ctag\\\": \\\"0000000000000000p4d-ddl-eu-company\\\"\n}\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"unlock-a-dataset","__idx":6},"children":["Unlock a dataset"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required Role"]},": subproject.admin,"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]},": force seismic store to release a lock, read or write, applied to a dataset"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# seistore dataset API call\ncurl -s -X PUT \\\"https://CURL/seistore-svc/api/v3/dataset/tenant/TENANT_NAME/subproject/SUBPROJECT_NAME/dataset/DATASET_ID/unlock?path=DATASET_PATH\\\" \\\\\n    -H \\\"accept: application/json\\\" \\\\\n    -H \\\"Authorization: Bearer STOKEN\\\"\n\n# this api returns an empty response\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"retrieve-user-permission-on-a-dataset","__idx":7},"children":["Retrieve user permission on a dataset"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required Role"]},": subproject.admin, subproject.viewer"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]},": return user access roles in term as read/write/delete"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Notes"]},": the returned permissions are the same for all datasets in a subproject (permissions uniformly applied at subproject level)"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# seistore dataset API call\ncurl -s -X GET \\\"https://HOST/seistore-svc/api/v3/dataset/tenant/TENANT_NAME/subproject/SUBPROJECT_NAME/dataset/DATASET_ID/permission?path=DATASET_PATH\\\" \\\\\n    -H \\\"accept: application/json\\\" \\\\\n    -H \\\"Authorization: Bearer STOKEN\\\"\n\n# API response \n{\n  \\\"read\\\": true,\n  \\\"write\\\": false,\n  \\\"delete\\\": false\n}\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"validate-the-coherencytag-of-a-dataset","__idx":8},"children":["Validate the CoherencyTag of a dataset"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required Role"]},": subproject.admin, subproject.viewer"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]},": return user access roles in terms as reading/write/delete"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Notes"]},": the coherency tag (ctag) is always returned with the dataset metadata. The dataset ctag can be validated with this endpoint to learn if the dataset metadata changed in the backend catalog. Clients will be able to cache dataset meta-information and reduce the number of calls issued to the service."]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# seistore dataset API call\ncurl -s -X GET \\\"https://HOST/seistore-svc/api/v3/dataset/tenant/TENANT_NAME/subproject/SUBPROJECT_NAME/dataset/DATASET_ID/ctagcheck?path=DATASET_PATH&ctagcheck=anInvalidValue\\\" \\\\\n    -H \\\"accept: application/json\\\" \\\\\n    -H \\\"Authorization: Bearer STOKEN\\\"\n\n# API response \nfalse\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"upsert-tags-to-a-dataset","__idx":9},"children":["Upsert tags to a dataset"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required Role"]},": subproject.admin"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]},": upsert tags to existing dataset metadata. If the dataset metadata already has gtags, then new gtags are appended to this list."]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# seistore dataset API call\ncurl -s -X PUT \\\"https://HOST/seistore-svc/api/v3/dataset/tenant/TENANT_NAME/subproject/SUBPROJECT_NAME/dataset/DATASET_ID/gtags?path=DATASET_PATH&gtag=tag01;tag02\\\" \\\\\n    -H \\\"accept: application/json\\\" \\\\\n    -H \\\"Authorization: Bearer STOKEN\\\"\n\n# API response \n# this api returns an empty response\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"check-if-a-list-of-datasets-exists-in-a-subproject","__idx":10},"children":["Check if a list of datasets exists in a subproject"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required Role"]},": subproject.admin, subproject.viewer"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]},": check if a list of datasets exists in a subproject. It can perform multiple existence check-in once datasets are provided as input lists to the call."]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# seistore dataset API call\ncurl -s -X POST \\\"https://HOST/seistore-svc/api/v3/dataset/tenant/TENANT_NAME/subproject/SUBPROJECT_NAME/exist\\\" \\\\\n    -H \\\"accept: application/json\\\" \\\\\n    -H \\\"Authorization: Bearer STOKEN\\\" \\\\\n    -d \\\"{ \\\\\\\"datasets\\\\\\\": [ \\\\\\\"DATASET_PATH/DATASET_NAME\\\\\\\", \\\\\\\"DATASET_NAME\\\\\\\" ]}\\\"\n\n# API response \n[\n  true,\n  false\n]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"retrieve-sizes-for-a-list-of-datasets","__idx":11},"children":["Retrieve sizes for a list of datasets"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required Role"]},": subproject.admin, subproject.viewer"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]},": retrieve sizes in bytes for a list of datasets in a subproject. If the dataset does not exist or it has not any physical data associated, it will return -1."]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# seistore dataset API call\ncurl -s -X POST \\\"https://HOST/seistore-svc/api/v3/dataset/tenant/TENANT_NAME/subproject/SUBPROJECT_NAME/sizes\\\" \\\\\n    -H \\\"accept: application/json\\\" \\\\\n    -H \\\"Authorization: Bearer STOKEN\\\" \\\\\n    -d \\\"{ \\\\\\\"datasets\\\\\\\": [ \\\\\\\"DATASET_PATH/DATASET_NAME\\\\\\\", \\\\\\\"DATASET_NAME\\\\\\\" ]}\\\"\n\n# API response \n[\n  -1, # exist but no physical data associated\n  -1  # not exist\n]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"compute-retrieve-the-size-of-datasets","__idx":12},"children":["Compute retrieve the size of datasets"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required Role"]},": subproject.admin, subproject.viewer"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]},": Compute and retrieve the size of a dataset and the date of when the size was computed."]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# seistore dataset API call\ncurl -s -X POST \\\"https://HOST/seistore-svc/api/v3/dataset/tenant/TENANT_NAME/subproject/SUBPROJECT_NAME/DATASET_NAME/size\\\" \\\\\n    -H \\\"accept: application/json\\\" \\\\\n    -H \\\"Authorization: Bearer STOKEN\\\" \\\\\n    -d \\\"\"\n\n# API response \n[\n  computed_size: 35461\n  computed_size_date: Thu Mar 16 2023 16:16:40 GMT-0500 (Central Daylight Time)\n]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"delete-a-dataset","__idx":13},"children":["Delete a dataset"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required Role"]},": subproject.admin"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]},": delete a dataset from seismic store (both entry in registry and physical data)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Notes"]},": this is an hard-delete operation and cannot be reversed. It will ignore locked datasets (these will be deleted also if locked)"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# seistore dataset API call\ncurl -s -X DELETE \\\"https://HOST/seistore-svc/api/v3/dataset/tenant/TENANT_NAME/subproject/SUBPROJECT_NAME?path=DATASET_PATH\\\" \\\\\n    -H \\\"accept: application/json\\\" \\\\\n    -H \\\"Authorization: Bearer STOKEN\\\" \n\n# this api returns an empty response\n","lang":"bash"},"children":[]}]},"headings":[{"value":"Working With Datasets","id":"working-with-datasets","depth":1},{"value":"Register a dataset in seismic store","id":"register-a-dataset-in-seismic-store","depth":2},{"value":"Retrieve stat information for a dataset","id":"retrieve-stat-information-for-a-dataset","depth":2},{"value":"Update the dataset meta-information","id":"update-the-dataset-meta-information","depth":2},{"value":"List all datasets in a subproject","id":"list-all-datasets-in-a-subproject","depth":2},{"value":"Lock a dataset for read/write","id":"lock-a-dataset-for-readwrite","depth":2},{"value":"Unlock a dataset","id":"unlock-a-dataset","depth":2},{"value":"Retrieve user permission on a dataset","id":"retrieve-user-permission-on-a-dataset","depth":2},{"value":"Validate the CoherencyTag of a dataset","id":"validate-the-coherencytag-of-a-dataset","depth":2},{"value":"Upsert tags to a dataset","id":"upsert-tags-to-a-dataset","depth":2},{"value":"Check if a list of datasets exists in a subproject","id":"check-if-a-list-of-datasets-exists-in-a-subproject","depth":2},{"value":"Retrieve sizes for a list of datasets","id":"retrieve-sizes-for-a-list-of-datasets","depth":2},{"value":"Compute retrieve the size of datasets","id":"compute-retrieve-the-size-of-datasets","depth":2},{"value":"Delete a dataset","id":"delete-a-dataset","depth":2}],"frontmatter":{"seo":{"title":"Working With Datasets"}},"lastModified":"2025-04-08T20:08:32.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/seismic-dms/tutorial/datasets","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}