{ "info": { "_postman_id": "19febf47-bdbe-4180-b40e-1448664cadcf", "name": "Seismic DDMS", "description": "Exploring Authorization API in OSDU. This collection allows doing the following requests:\n\n1) Getting access and id tokens (aihtorization code flow)\n2) Discover OpenID Connect configuration\n3) Refreshing tokens\n4) Making secured User Info request (to validate the token)", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json", "_exporter_id": "28759361" }, "item": [ { "name": "Setup", "item": [ { "name": "Get an SPN Token", "event": [ { "listen": "test", "script": { "exec": [ "cp = pm.environment.get(\"cloud_platform\");\r", "\r", "var data = JSON.parse(responseBody)\r", "pm.environment.set(\"access_token\", data.access_token);\r", "\r", "// Uncomment if server returns a new refresh_token,\r", "// otherwise comment out to prevent overwriting it with null\r", "if (cp == \"Azure\") {\r", " pm.environment.set(\"refresh_token\", data.refresh_token);\r", "}\r", "\r", "pm.test(\"Status code is 200\", function () {\r", " pm.response.to.have.status(200);\r", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "grant_type", "value": "client_credentials", "type": "text" }, { "key": "client_id", "value": "{{client_id}}", "type": "text" }, { "key": "client_secret", "value": "{{client_secret}}", "type": "text" }, { "key": "scope", "value": "{{scope}}", "type": "text" } ] }, "url": "https://login.microsoftonline.com/{{tenant_id}}/oauth2/v2.0/token" }, "response": [] }, { "name": "Create Legal Tag for SDMS", "event": [ { "listen": "prerequest", "script": { "exec": [ "var rand = _.random(999111111111, 999999999999);\r", "var dataPartition = pm.environment.get(\"data_partition_id\");\r", "pm.environment.set(\"tag_name\", \"Seismic-Legal-Tag-Test\" + rand);" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "// Tags should be added or already exists", "pm.test(\"Status code is 201 or 409\", function () {", " pm.expect(pm.response.code).to.be.oneOf([201,409]);", "});", "", "var jsonData = pm.response.json();", "pm.environment.set(\"legal_tag\", jsonData.name);" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Data-Partition-Id", "value": "{{data_partition_id}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"{{tag_name}}\",\n \"description\": \"Legal Tag added for Seismic\",\n \"properties\": {\n \"countryOfOrigin\": [\n \"US\"\n ],\n \"contractId\": \"No Contract Related\",\n \"expirationDate\": \"2099-01-01\",\n \"dataType\": \"Public Domain Data\",\n \"originator\": \"OSDU\",\n \"securityClassification\": \"Public\",\n \"exportClassification\": \"EAR99\",\n \"personalData\": \"No Personal Data\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{base_url}}/{{legal_api}}/legaltags" }, "response": [] } ] }, { "name": "Seismic DDMS", "item": [ { "name": "Service Verification", "item": [ { "name": "Check Readines", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {\r", " pm.expect(pm.response.code).to.be.oneOf([200]);\r", "});\r", "\r", "pm.test(\"Have valid body\", function () {\r", " let json = pm.response.json();\r", " pm.expect(json.ready).to.be.equal(true);\r", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "type": "text", "value": "application/json" }, { "key": "data-partition-id", "type": "text", "value": "{{data_partition_id}}" }, { "description": "Legal tag of the dataset", "key": "ltag", "type": "text", "value": "opendes-public-usa-dataset-1", "disabled": true } ], "body": { "mode": "raw", "raw": "" }, "url": "{{base_url}}/{{seismic_api}}/svcstatus/readiness" }, "response": [] }, { "name": "Check Access", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {\r", " pm.expect(pm.response.code).to.be.oneOf([200]);\r", "});\r", "\r", "pm.test(\"Have valid body\", function () {\r", " let json = pm.response.json();\r", " pm.expect(json.status).to.be.equal('running');\r", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "type": "text", "value": "application/json" }, { "key": "data-partition-id", "type": "text", "value": "{{data_partition_id}}" }, { "description": "Legal tag of the dataset", "key": "ltag", "type": "text", "value": "opendes-public-usa-dataset-1", "disabled": true } ], "body": { "mode": "raw", "raw": "" }, "url": "{{base_url}}/{{seismic_api}}/svcstatus/access" }, "response": [] }, { "name": "Check Status", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {\r", " pm.expect(pm.response.code).to.be.oneOf([200]);\r", "});\r", "\r", "pm.test(\"Have valid body\", function () {\r", " let text = pm.response.text();\r", " pm.expect(text).to.be.equal('service OK');\r", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "type": "text", "value": "application/json" }, { "key": "data-partition-id", "type": "text", "value": "{{data_partition_id}}" }, { "description": "Legal tag of the dataset", "key": "ltag", "type": "text", "value": "opendes-public-usa-dataset-1", "disabled": true } ], "body": { "mode": "raw", "raw": "" }, "url": "{{base_url}}/{{seismic_api}}/svcstatus" }, "response": [] } ] }, { "name": "Tenant", "item": [ { "name": "Register a seismic-dms tenant", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"gcpid\": \"{{seismic_project}}\",\n \"esd\": \"{{data_partition_id}}{{domain}}\",\n \"default_acl\": \"users.datalake.admins@{{data_partition_id}}{{domain}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{base_url}}/{{seismic_api}}/tenant/{{seismic_project}}", "description": "" }, "response": [ { "name": "Creation of the tenant was successful.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"gcpid\": \"\",\n \"des\": \"\",\n \"default_acl\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/tenant/:tenantid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "tenant", ":tenantid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "", "description": "(Required) Name of the tenant" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"\",\n \"esd\": \"\",\n \"gcpid\": \"\"\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"gcpid\": \"\",\n \"des\": \"\",\n \"default_acl\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/tenant/:tenantid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "tenant", ":tenantid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "", "description": "(Required) Name of the tenant" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"gcpid\": \"\",\n \"des\": \"\",\n \"default_acl\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/tenant/:tenantid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "tenant", ":tenantid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "", "description": "(Required) Name of the tenant" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"gcpid\": \"\",\n \"des\": \"\",\n \"default_acl\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/tenant/:tenantid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "tenant", ":tenantid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "", "description": "(Required) Name of the tenant" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"gcpid\": \"\",\n \"des\": \"\",\n \"default_acl\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/tenant/:tenantid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "tenant", ":tenantid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "", "description": "(Required) Name of the tenant" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Conflict", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"gcpid\": \"\",\n \"des\": \"\",\n \"default_acl\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/tenant/:tenantid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "tenant", ":tenantid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "", "description": "(Required) Name of the tenant" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Retrieve the tenant metadata", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{base_url}}/{{seismic_api}}/tenant/{{seismic_project}}", "description": "
  • Return the tenant metadata.
  • Required roles: seistore.system.admin
" }, "response": [ { "name": "Retrieved subproject metadata successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/tenant/:tenantid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "tenant", ":tenantid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "", "description": "(Required) Name of the tenant" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"\",\n \"esd\": \"\",\n \"gcpid\": \"\"\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/tenant/:tenantid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "tenant", ":tenantid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "", "description": "(Required) Name of the tenant" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/tenant/:tenantid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "tenant", ":tenantid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "", "description": "(Required) Name of the tenant" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/tenant/:tenantid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "tenant", ":tenantid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "", "description": "(Required) Name of the tenant" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/tenant/:tenantid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "tenant", ":tenantid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "", "description": "(Required) Name of the tenant" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Retrieve the tenant seismic store path", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/{{seismic_api}}/tenant/sdpath?datapartition={{data_partition_id}}", "host": [ "{{base_url}}" ], "path": [ "{{seismic_api}}", "tenant", "sdpath" ], "query": [ { "key": "datapartition", "value": "{{data_partition_id}}" } ] }, "description": "
  • Return the seistore path to a tenant associated with the data partition.
  • Required roles: none
" }, "response": [ { "name": "Seismic store path to the tenant retrieved successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/tenant/sdpath?datapartition=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "tenant", "sdpath" ], "query": [ { "key": "datapartition", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "\"\"" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/tenant/sdpath?datapartition=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "tenant", "sdpath" ], "query": [ { "key": "datapartition", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/tenant/sdpath?datapartition=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "tenant", "sdpath" ], "query": [ { "key": "datapartition", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/tenant/sdpath?datapartition=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "tenant", "sdpath" ], "query": [ { "key": "datapartition", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/tenant/sdpath?datapartition=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "tenant", "sdpath" ], "query": [ { "key": "datapartition", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Subproject", "item": [ { "name": "Create a new subproject", "event": [ { "listen": "prerequest", "script": { "exec": [ "var rand = _.random(999111111, 999999999);\r", "pm.environment.set(\"seismic_subproject\", \"test\" + rand)" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "description": "Legal tag of the datapartition/tenant", "key": "ltag", "value": "{{legal_tag}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"admin\": \"{{client_id}}\",\n \"access_policy\": \"dataset\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{base_url}}/{{seismic_api}}/subproject/tenant/{{seismic_project}}/subproject/{{seismic_subproject}}", "description": "
  • Creates a new sub-project resource in seismic store.
  • Required roles: users.datalake.admin
" }, "response": [ { "name": "Creation of the subproject is successful.", "originalRequest": { "method": "POST", "header": [ { "description": "Legal tag of the datapartition/tenant", "key": "ltag", "value": "Slb-Private-USA-EHC" } ], "body": { "mode": "raw", "raw": "{\n \"admin\": \"\",\n \"storage_class\": \"\",\n \"storage_location\": \"\",\n \"access_policy\": \"uniform\",\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid/subproject/:subprojectid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"\",\n \"tenant\": \"\",\n \"storage_class\": \"\",\n \"storage_location\": \"\",\n \"admin\": \"\",\n \"ltag\": \"\",\n \"gcs_bucket\": \"\",\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "description": "Legal tag of the datapartition/tenant", "key": "ltag", "value": "Slb-Private-USA-EHC" } ], "body": { "mode": "raw", "raw": "{\n \"admin\": \"\",\n \"storage_class\": \"\",\n \"storage_location\": \"\",\n \"access_policy\": \"uniform\",\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid/subproject/:subprojectid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Legal tag of the datapartition/tenant", "key": "ltag", "value": "Slb-Private-USA-EHC" } ], "body": { "mode": "raw", "raw": "{\n \"admin\": \"\",\n \"storage_class\": \"\",\n \"storage_location\": \"\",\n \"access_policy\": \"uniform\",\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid/subproject/:subprojectid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "description": "Legal tag of the datapartition/tenant", "key": "ltag", "value": "Slb-Private-USA-EHC" } ], "body": { "mode": "raw", "raw": "{\n \"admin\": \"\",\n \"storage_class\": \"\",\n \"storage_location\": \"\",\n \"access_policy\": \"uniform\",\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid/subproject/:subprojectid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "description": "Legal tag of the datapartition/tenant", "key": "ltag", "value": "Slb-Private-USA-EHC" } ], "body": { "mode": "raw", "raw": "{\n \"admin\": \"\",\n \"storage_class\": \"\",\n \"storage_location\": \"\",\n \"access_policy\": \"uniform\",\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid/subproject/:subprojectid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Conflict", "originalRequest": { "method": "POST", "header": [ { "description": "Legal tag of the datapartition/tenant", "key": "ltag", "value": "Slb-Private-USA-EHC" } ], "body": { "mode": "raw", "raw": "{\n \"admin\": \"\",\n \"storage_class\": \"\",\n \"storage_location\": \"\",\n \"access_policy\": \"uniform\",\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid/subproject/:subprojectid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Retrieve the subproject metadata", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/{{seismic_api}}/subproject/tenant/{{seismic_project}}/subproject/{{seismic_subproject}}?translate-user-info=true", "host": [ "{{base_url}}" ], "path": [ "{{seismic_api}}", "subproject", "tenant", "{{seismic_project}}", "subproject", "{{seismic_subproject}}" ], "query": [ { "key": "translate-user-info", "value": "true", "description": "translate the user-id to a more human readable user info" } ] }, "description": "
  • Return the metadata for a requested sub-project.
  • Required roles: subproject.admin
" }, "response": [ { "name": "Retrieved subproject metadata successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid/subproject/:subprojectid?translate-user-info=true&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "translate-user-info", "value": "true" }, { "key": "key", "value": "" } ], "variable": [ { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"\",\n \"tenant\": \"\",\n \"storage_class\": \"\",\n \"storage_location\": \"\",\n \"admin\": \"\",\n \"ltag\": \"\",\n \"gcs_bucket\": \"\",\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid/subproject/:subprojectid?translate-user-info=true&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "translate-user-info", "value": "true" }, { "key": "key", "value": "" } ], "variable": [ { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid/subproject/:subprojectid?translate-user-info=true&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "translate-user-info", "value": "true" }, { "key": "key", "value": "" } ], "variable": [ { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid/subproject/:subprojectid?translate-user-info=true&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "translate-user-info", "value": "true" }, { "key": "key", "value": "" } ], "variable": [ { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid/subproject/:subprojectid?translate-user-info=true&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "translate-user-info", "value": "true" }, { "key": "key", "value": "" } ], "variable": [ { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "List subprojects in a tenant", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{base_url}}/{{seismic_api}}/subproject/tenant/{{seismic_project}}", "description": "
  • Return the list of sub-project in a tenant.
  • Required roles: users.datalake.admin
" }, "response": [ { "name": "Retrieved the list of subprojects in the tenant successfully.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"name\": \"\",\n \"tenant\": \"\",\n \"storage_class\": \"\",\n \"storage_location\": \"\",\n \"admin\": \"\",\n \"ltag\": \"\",\n \"gcs_bucket\": \"\",\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"name\": \"\",\n \"tenant\": \"\",\n \"storage_class\": \"\",\n \"storage_location\": \"\",\n \"admin\": \"\",\n \"ltag\": \"\",\n \"gcs_bucket\": \"\",\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n }\n]" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Patch a subproject metadata Copy", "request": { "method": "PATCH", "header": [ { "description": "(Required) Legal tag of the subproject", "key": "ltag", "value": "{{legal_tag}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"acls\": {\n \"admins\": [\n \"{{new_owner_data_group}}@{{data_partition_id}}{{domain}}\"\n ],\n \"viewers\": [\n \"{{new_viewer_data_group}}@{{data_partition_id}}{{domain}}\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/{{seismic_api}}/subproject/tenant/{{seismic_project}}/subproject/{{seismic_subproject}}?recursive=", "host": [ "{{base_url}}" ], "path": [ "{{seismic_api}}", "subproject", "tenant", "{{seismic_project}}", "subproject", "{{seismic_subproject}}" ], "query": [ { "key": "recursive", "value": "", "description": "True if the legal tags of all datasets in a subproject needs to be updated" } ] }, "description": "
  • Patch a subproject metadata in seismic store.
  • Required roles: subproject.admin
" }, "response": [ { "name": "Updated subproject metadata successfully", "originalRequest": { "method": "PATCH", "header": [ { "description": "(Required) Legal tag of the subproject", "key": "ltag", "value": "Slb-Private-USA-EHC" } ], "body": { "mode": "raw", "raw": "{\n \"access_policy\": \"dataset\",\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid/subproject/:subprojectid?recursive=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "recursive", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"\",\n \"tenant\": \"\",\n \"storage_class\": \"\",\n \"storage_location\": \"\",\n \"admin\": \"\",\n \"ltag\": \"\",\n \"gcs_bucket\": \"\",\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "PATCH", "header": [ { "description": "(Required) Legal tag of the subproject", "key": "ltag", "value": "Slb-Private-USA-EHC" } ], "body": { "mode": "raw", "raw": "{\n \"access_policy\": \"dataset\",\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid/subproject/:subprojectid?recursive=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "recursive", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PATCH", "header": [ { "description": "(Required) Legal tag of the subproject", "key": "ltag", "value": "Slb-Private-USA-EHC" } ], "body": { "mode": "raw", "raw": "{\n \"access_policy\": \"dataset\",\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid/subproject/:subprojectid?recursive=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "recursive", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "PATCH", "header": [ { "description": "(Required) Legal tag of the subproject", "key": "ltag", "value": "Slb-Private-USA-EHC" } ], "body": { "mode": "raw", "raw": "{\n \"access_policy\": \"dataset\",\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid/subproject/:subprojectid?recursive=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "recursive", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "PATCH", "header": [ { "description": "(Required) Legal tag of the subproject", "key": "ltag", "value": "Slb-Private-USA-EHC" } ], "body": { "mode": "raw", "raw": "{\n \"access_policy\": \"dataset\",\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid/subproject/:subprojectid?recursive=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "recursive", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Dataset", "item": [ { "name": "Register a new dataset", "request": { "method": "POST", "header": [ { "description": "Legal tag of the dataset", "key": "ltag", "value": "{{legal_tag}}" }, { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"admin\": \"{{client_id}}\",\n \"storage_class\": \"MULTI_REGIONAL\",\n \"storage_location\": \"US\",\n \"access_policy\": \"dataset\",\n \"acls\": {\n \"admins\": [\n \"{{new_owner_data_group}}@{{data_partition_id}}{{domain}}\"\n ],\n \"viewers\": [\n \"{{new_viewer_data_group}}@{{data_partition_id}}{{domain}}\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{base_url}}/{{seismic_api}}/dataset/tenant/{{seismic_project}}/subproject/{{seismic_subproject}}/dataset/{{seismic_segy_file_name}}", "description": "
  • Register a new dataset in seismic store.
  • Required roles: subproject.admin, subproject.editor
" }, "response": [ { "name": "Registered dataset metadata", "originalRequest": { "method": "POST", "header": [ { "description": "Legal tag of the dataset", "key": "ltag", "value": "Slb-Private-USA-EHC" }, { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"gtags\": [\n \"\",\n \"\"\n ],\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n },\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"\",\n \"tenant\": \"\",\n \"subproject\": \"\",\n \"path\": \"\",\n \"created_by\": \"\",\n \"created_date\": \"\",\n \"last_modified_date\": \"\",\n \"gcsurl\": \"\",\n \"ctag\": \"\",\n \"filemetadata\": \"\",\n \"metadata\": \"\",\n \"readonly\": \"\",\n \"ltag\": \"\",\n \"seismicmeta_guid\": \"\",\n \"sbit\": \"\",\n \"sbit_count\": \"\",\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "description": "Legal tag of the dataset", "key": "ltag", "value": "Slb-Private-USA-EHC" }, { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"gtags\": [\n \"\",\n \"\"\n ],\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n },\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Legal tag of the dataset", "key": "ltag", "value": "Slb-Private-USA-EHC" }, { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"gtags\": [\n \"\",\n \"\"\n ],\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n },\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "description": "Legal tag of the dataset", "key": "ltag", "value": "Slb-Private-USA-EHC" }, { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"gtags\": [\n \"\",\n \"\"\n ],\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n },\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "description": "Legal tag of the dataset", "key": "ltag", "value": "Slb-Private-USA-EHC" }, { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"gtags\": [\n \"\",\n \"\"\n ],\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n },\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Conflict", "originalRequest": { "method": "POST", "header": [ { "description": "Legal tag of the dataset", "key": "ltag", "value": "Slb-Private-USA-EHC" }, { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"gtags\": [\n \"\",\n \"\"\n ],\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n },\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Locked", "originalRequest": { "method": "POST", "header": [ { "description": "Legal tag of the dataset", "key": "ltag", "value": "Slb-Private-USA-EHC" }, { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"gtags\": [\n \"\",\n \"\"\n ],\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n },\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Locked (WebDAV) (RFC 4918)", "code": 423, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Retrieve a dataset", "request": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/{{seismic_api}}/dataset/tenant/{{seismic_project}}/subproject/{{seismic_subproject}}/dataset/{{seismic_segy_file_name}}", "host": [ "{{base_url}}" ], "path": [ "{{seismic_api}}", "dataset", "tenant", "{{seismic_project}}", "subproject", "{{seismic_subproject}}", "dataset", "{{seismic_segy_file_name}}" ], "query": [ { "key": "path", "value": "a/b/c", "description": "(Required) Hierarchical path of the dataset", "disabled": true }, { "key": "seismicmeta", "value": "", "description": "Include the seismic storage metadata record if it exists", "disabled": true }, { "key": "translate-user-info", "value": "true", "description": "translate the user-id to a more human readable user info", "disabled": true }, { "key": "record-version", "value": "", "description": "Retrieve a specific version of the seismic storage metadata record", "disabled": true } ] }, "description": "
  • Return the dataset metadata from seismic store.
  • Required roles: subproject.admin, subproject.editor, subproject.viewer
" }, "response": [ { "name": "Metadata of the dataset", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&seismicmeta=&translate-user-info=true&record-version=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "seismicmeta", "value": "" }, { "key": "translate-user-info", "value": "true" }, { "key": "record-version", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"\",\n \"tenant\": \"\",\n \"subproject\": \"\",\n \"path\": \"\",\n \"created_by\": \"\",\n \"created_date\": \"\",\n \"last_modified_date\": \"\",\n \"gcsurl\": \"\",\n \"ctag\": \"\",\n \"filemetadata\": \"\",\n \"metadata\": \"\",\n \"readonly\": \"\",\n \"ltag\": \"\",\n \"seismicmeta_guid\": \"\",\n \"sbit\": \"\",\n \"sbit_count\": \"\",\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&seismicmeta=&translate-user-info=true&record-version=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "seismicmeta", "value": "" }, { "key": "translate-user-info", "value": "true" }, { "key": "record-version", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&seismicmeta=&translate-user-info=true&record-version=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "seismicmeta", "value": "" }, { "key": "translate-user-info", "value": "true" }, { "key": "record-version", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&seismicmeta=&translate-user-info=true&record-version=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "seismicmeta", "value": "" }, { "key": "translate-user-info", "value": "true" }, { "key": "record-version", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&seismicmeta=&translate-user-info=true&record-version=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "seismicmeta", "value": "" }, { "key": "translate-user-info", "value": "true" }, { "key": "record-version", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Patch the dataset metadata", "request": { "method": "PATCH", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"admin\": \"{{client_id}}\",\n \"storage_class\": \"MULTI_REGIONAL\",\n \"storage_location\": \"US\",\n \"acls\": {\n \"admins\": [\n \"{{new_owner_data_group}}@{{data_partition_id}}{{domain}}\"\n ],\n \"viewers\": [\n \"{{new_viewer_data_group}}@{{data_partition_id}}{{domain}}\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/{{seismic_api}}/dataset/tenant/{{seismic_project}}/subproject/{{seismic_subproject}}/dataset/{{seismic_segy_file_name}}", "host": [ "{{base_url}}" ], "path": [ "{{seismic_api}}", "dataset", "tenant", "{{seismic_project}}", "subproject", "{{seismic_subproject}}", "dataset", "{{seismic_segy_file_name}}" ], "query": [ { "key": "path", "value": "a/b/c", "description": "(Required) Hierarchical path of the dataset", "disabled": true }, { "key": "close", "value": "", "description": "Non null sbit value of the dataset. Using this value here will close the dataset", "disabled": true } ] }, "description": "
  • Update the dataset meta information in seismic store or close(unlock) the dataset. If the endpoint is used without the close parameter, at least one body field is required or the endpoint will return an error.
  • Required roles: subproject.admin, subproject.editor
  • Patchable fields:
    • dataset_new_name: new name to use for the dataset (rename)
    • filemetadata: this is a seistore specific field and describe how the physical data are stored in the cloud storage system (GCS/AzureContainer etc etc). This metadata is mainly used by client libraries to correctly reconstruct the dataset. For example you can store a dataset as truncated in multiple objects of 64MB each, name them from 0 to N and save the filemetadata = “{nObject: N, totalSize: 1024, objsize: 64, sizeUnit: MB }”.
    • last_modified_date: mark this field as true to update the dataset last modified date
    • gtags: upsert tags to an existing dataset metadata. If the dataset metadata already has gtags, then new gtags are appended to this list.
    • ltag: update the existing legalTag value
    • readonly: update the dataset mode to readonly(true) or to read/write(false)
    • seismicmeta: update the DataEcosystem storage metadata (refer to the DataEcosystem storage service tutorial for more help)
" }, "response": [ { "name": "Metadata of the patched dataset", "originalRequest": { "method": "PATCH", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"dataset_new_name\": \"\",\n \"metadata\": \"\",\n \"filemetadata\": \"\",\n \"last_modified_date\": \"\",\n \"ltag\": \"\",\n \"readonly\": \"\",\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n },\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&close=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "close", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"\",\n \"tenant\": \"\",\n \"subproject\": \"\",\n \"path\": \"\",\n \"created_by\": \"\",\n \"created_date\": \"\",\n \"last_modified_date\": \"\",\n \"gcsurl\": \"\",\n \"ctag\": \"\",\n \"filemetadata\": \"\",\n \"metadata\": \"\",\n \"readonly\": \"\",\n \"ltag\": \"\",\n \"seismicmeta_guid\": \"\",\n \"sbit\": \"\",\n \"sbit_count\": \"\",\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "PATCH", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"dataset_new_name\": \"\",\n \"metadata\": \"\",\n \"filemetadata\": \"\",\n \"last_modified_date\": \"\",\n \"ltag\": \"\",\n \"readonly\": \"\",\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n },\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&close=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "close", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PATCH", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"dataset_new_name\": \"\",\n \"metadata\": \"\",\n \"filemetadata\": \"\",\n \"last_modified_date\": \"\",\n \"ltag\": \"\",\n \"readonly\": \"\",\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n },\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&close=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "close", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "PATCH", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"dataset_new_name\": \"\",\n \"metadata\": \"\",\n \"filemetadata\": \"\",\n \"last_modified_date\": \"\",\n \"ltag\": \"\",\n \"readonly\": \"\",\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n },\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&close=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "close", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "PATCH", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"dataset_new_name\": \"\",\n \"metadata\": \"\",\n \"filemetadata\": \"\",\n \"last_modified_date\": \"\",\n \"ltag\": \"\",\n \"readonly\": \"\",\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n },\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&close=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "close", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Conflict", "originalRequest": { "method": "PATCH", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"dataset_new_name\": \"\",\n \"metadata\": \"\",\n \"filemetadata\": \"\",\n \"last_modified_date\": \"\",\n \"ltag\": \"\",\n \"readonly\": \"\",\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n },\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&close=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "close", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Locked", "originalRequest": { "method": "PATCH", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"dataset_new_name\": \"\",\n \"metadata\": \"\",\n \"filemetadata\": \"\",\n \"last_modified_date\": \"\",\n \"ltag\": \"\",\n \"readonly\": \"\",\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n },\n \"acls\": {\n \"admins\": [\n \"\",\n \"\"\n ],\n \"viewers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&close=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "close", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Locked (WebDAV) (RFC 4918)", "code": 423, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Get the list of datasets in a subproject", "request": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/{{seismic_api}}/dataset/tenant/{{seismic_project}}/subproject/{{seismic_subproject}}", "host": [ "{{base_url}}" ], "path": [ "{{seismic_api}}", "dataset", "tenant", "{{seismic_project}}", "subproject", "{{seismic_subproject}}" ], "query": [ { "key": "gtag", "value": "", "description": "Gtags associated with dataset metadata", "disabled": true }, { "key": "gtag", "value": "", "description": "Gtags associated with dataset metadata", "disabled": true }, { "key": "limit", "value": "", "description": "Limit the number of datasets in the response", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor for pagination on the datasets list", "disabled": true }, { "key": "translate-user-info", "value": "true", "description": "translate the user-id to a more human readable user info", "disabled": true } ] }, "description": "
  • Return the list of datasets in a sub-project.If gtags are in the request parameters, then get only those datasets that have the exact list of gtags.
  • Required roles: subproject.admin, subproject.editor, subproject.viewer
" }, "response": [ { "name": "The list of all datasets in the subproject if no gtags are in the request parameters. If gtags exist in the request parameters, then datasets that have the same list of gtags.", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid?gtag=>ag=&limit=&cursor=&translate-user-info=true&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "gtag", "value": "" }, { "key": "gtag", "value": "" }, { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "translate-user-info", "value": "true" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"name\": \"\",\n \"tenant\": \"\",\n \"subproject\": \"\",\n \"path\": \"\",\n \"created_by\": \"\",\n \"created_date\": \"\",\n \"last_modified_date\": \"\",\n \"gcsurl\": \"\",\n \"ctag\": \"\",\n \"filemetadata\": \"\",\n \"metadata\": \"\",\n \"readonly\": \"\",\n \"ltag\": \"\",\n \"seismicmeta_guid\": \"\",\n \"sbit\": \"\",\n \"sbit_count\": \"\",\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"tenant\": \"\",\n \"subproject\": \"\",\n \"path\": \"\",\n \"created_by\": \"\",\n \"created_date\": \"\",\n \"last_modified_date\": \"\",\n \"gcsurl\": \"\",\n \"ctag\": \"\",\n \"filemetadata\": \"\",\n \"metadata\": \"\",\n \"readonly\": \"\",\n \"ltag\": \"\",\n \"seismicmeta_guid\": \"\",\n \"sbit\": \"\",\n \"sbit_count\": \"\",\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n }\n }\n]" }, { "name": "Paginated dataset list with nextPageCursor. For documentation purposes, if limit or cursor is given, status code here is 200.", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid?gtag=>ag=&limit=&cursor=&translate-user-info=true&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "gtag", "value": "" }, { "key": "gtag", "value": "" }, { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "translate-user-info", "value": "true" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"datasets\": [\n {\n \"name\": \"\",\n \"tenant\": \"\",\n \"subproject\": \"\",\n \"path\": \"\",\n \"created_by\": \"\",\n \"created_date\": \"\",\n \"last_modified_date\": \"\",\n \"gcsurl\": \"\",\n \"ctag\": \"\",\n \"filemetadata\": \"\",\n \"metadata\": \"\",\n \"readonly\": \"\",\n \"ltag\": \"\",\n \"seismicmeta_guid\": \"\",\n \"sbit\": \"\",\n \"sbit_count\": \"\",\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"tenant\": \"\",\n \"subproject\": \"\",\n \"path\": \"\",\n \"created_by\": \"\",\n \"created_date\": \"\",\n \"last_modified_date\": \"\",\n \"gcsurl\": \"\",\n \"ctag\": \"\",\n \"filemetadata\": \"\",\n \"metadata\": \"\",\n \"readonly\": \"\",\n \"ltag\": \"\",\n \"seismicmeta_guid\": \"\",\n \"sbit\": \"\",\n \"sbit_count\": \"\",\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n }\n }\n ],\n \"nextPageCursor\": \"\"\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid?gtag=>ag=&limit=&cursor=&translate-user-info=true&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "gtag", "value": "" }, { "key": "gtag", "value": "" }, { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "translate-user-info", "value": "true" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid?gtag=>ag=&limit=&cursor=&translate-user-info=true&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "gtag", "value": "" }, { "key": "gtag", "value": "" }, { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "translate-user-info", "value": "true" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid?gtag=>ag=&limit=&cursor=&translate-user-info=true&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "gtag", "value": "" }, { "key": "gtag", "value": "" }, { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "translate-user-info", "value": "true" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid?gtag=>ag=&limit=&cursor=&translate-user-info=true&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "gtag", "value": "" }, { "key": "gtag", "value": "" }, { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "translate-user-info", "value": "true" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Check if list of datasets exists in the subproject.", "request": { "method": "POST", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"datasets\": [\n \"{{seismic_segy_file_name}}\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{base_url}}/{{seismic_api}}/dataset/tenant/{{seismic_project}}/subproject/{{seismic_subproject}}/exist", "description": "
  • Check if the dataset exists.
  • Required roles: subproject.admin, subproject.editor, subproject.viewer
" }, "response": [ { "name": "A list of boolean values for all the input datasets in the request body. If a value is true, then corresponding dataset exists and if it is false, then the dataset does not exist", "originalRequest": { "method": "POST", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/exist?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "exist" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n \"\",\n \"\"\n]" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/exist?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "exist" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/exist?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "exist" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/exist?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "exist" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/exist?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "exist" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Get content list of subproject", "request": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/{{seismic_api}}/dataset/tenant/{{seismic_project}}/subproject/{{seismic_subproject}}/readdsdirfulllist", "host": [ "{{base_url}}" ], "path": [ "{{seismic_api}}", "dataset", "tenant", "{{seismic_project}}", "subproject", "{{seismic_subproject}}", "readdsdirfulllist" ], "query": [ { "key": "path", "value": "", "description": "(Required) The hierarchy path", "disabled": true } ] }, "description": "
  • List datasets and sub-directories for a directory path.
  • Required roles: subproject.admin, subproject.editor, subproject.viewer
" }, "response": [ { "name": "The list of datasets and directories in the requested directory path.", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/readdsdirfulllist?path=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "readdsdirfulllist" ], "query": [ { "key": "path", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "", "description": "(Required) The tenant project name" }, { "key": "subprojectid", "value": "", "description": "(Required) The sub-project name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"datasets\": [\n \"\",\n \"\"\n ],\n \"directories\": [\n \"\",\n \"\"\n ]\n}" } ] }, { "name": "Retrieve the size of datasets", "request": { "method": "POST", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"datasets\": [\n \"{{seismic_segy_file_name}}\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{base_url}}/{{seismic_api}}/dataset/tenant/{{seismic_project}}/subproject/{{seismic_subproject}}/sizes", "description": "
  • Return a list with the sizes of the requested datasets.
  • Required roles: subproject.admin, subproject.editor, subproject.viewer
" }, "response": [ { "name": "The sizes list of all the datasets. If the dataset does not exist, the size would be -1", "originalRequest": { "method": "POST", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/sizes?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "sizes" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n \"\",\n \"\"\n]" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/sizes?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "sizes" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/sizes?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "sizes" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/sizes?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "sizes" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/sizes?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "sizes" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Retrieve the access permissions of a user on a dataset id.", "request": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/{{seismic_api}}/dataset/tenant/{{seismic_project}}/subproject/{{seismic_subproject}}/dataset/{{seismic_segy_file_name}}/permission", "host": [ "{{base_url}}" ], "path": [ "{{seismic_api}}", "dataset", "tenant", "{{seismic_project}}", "subproject", "{{seismic_subproject}}", "dataset", "{{seismic_segy_file_name}}", "permission" ], "query": [ { "key": "path", "value": "a/b/c", "description": "(Required) Hierarchical path for the dataset", "disabled": true } ] }, "description": "
  • Retrieve the access permission of a user on a dataset.
  • Required roles: subproject.admin, subproject.editor, subproject.viewer
" }, "response": [ { "name": "User access permission on the dataset.", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid/permission?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid", "permission" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"read\": \"\",\n \"write\": \"\",\n \"delete\": \"\"\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid/permission?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid", "permission" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid/permission?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid", "permission" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid/permission?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid", "permission" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid/permission?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid", "permission" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Acquire a lock for a dataset", "request": { "method": "PUT", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/{{seismic_api}}/dataset/tenant/{{seismic_project}}/subproject/{{seismic_subproject}}/dataset/{{seismic_segy_file_name}}/lock?openmode=write", "host": [ "{{base_url}}" ], "path": [ "{{seismic_api}}", "dataset", "tenant", "{{seismic_project}}", "subproject", "{{seismic_subproject}}", "dataset", "{{seismic_segy_file_name}}", "lock" ], "query": [ { "key": "path", "value": "a/b/c", "description": "(Required) Hierarchical path of the dataset", "disabled": true }, { "key": "openmode", "value": "write", "description": "Type of the lock which can be set to 'read' (default) or 'write'" }, { "key": "wid", "value": "", "description": "Session identifier issued for a previous write lock acquisition operation", "disabled": true } ] }, "description": "
  • Open a dataset for read or write and lock its state.
  • Required roles open lock for write: subproject.admin, subproject.editor
  • Required roles open lock for read: subproject.admin, subproject.editor, subproject.viewer
" }, "response": [ { "name": "Acquired a lock and the return value is the dataset metadata with session identifier stored in 'sbit' attribute", "originalRequest": { "method": "PUT", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid/lock?path=a/b/c&openmode=&wid=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid", "lock" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "openmode", "value": "" }, { "key": "wid", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"\",\n \"tenant\": \"\",\n \"subproject\": \"\",\n \"path\": \"\",\n \"created_by\": \"\",\n \"created_date\": \"\",\n \"last_modified_date\": \"\",\n \"gcsurl\": \"\",\n \"ctag\": \"\",\n \"filemetadata\": \"\",\n \"metadata\": \"\",\n \"readonly\": \"\",\n \"ltag\": \"\",\n \"seismicmeta_guid\": \"\",\n \"sbit\": \"\",\n \"sbit_count\": \"\",\n \"seismicmeta\": {\n \"kind\": \"\",\n \"data\": \"\"\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "PUT", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid/lock?path=a/b/c&openmode=&wid=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid", "lock" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "openmode", "value": "" }, { "key": "wid", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid/lock?path=a/b/c&openmode=&wid=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid", "lock" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "openmode", "value": "" }, { "key": "wid", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "PUT", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid/lock?path=a/b/c&openmode=&wid=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid", "lock" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "openmode", "value": "" }, { "key": "wid", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "PUT", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid/lock?path=a/b/c&openmode=&wid=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid", "lock" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "openmode", "value": "" }, { "key": "wid", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Locked", "originalRequest": { "method": "PUT", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid/lock?path=a/b/c&openmode=&wid=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid", "lock" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "openmode", "value": "" }, { "key": "wid", "value": "" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Locked (WebDAV) (RFC 4918)", "code": 423, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Remove the lock associated with a dataset", "request": { "method": "PUT", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{base_url}}/{{seismic_api}}/dataset/tenant/{{seismic_project}}/subproject/{{seismic_subproject}}/dataset/{{seismic_segy_file_name}}/unlock", "host": [ "{{base_url}}" ], "path": [ "{{seismic_api}}", "dataset", "tenant", "{{seismic_project}}", "subproject", "{{seismic_subproject}}", "dataset", "{{seismic_segy_file_name}}", "unlock" ], "query": [ { "key": "path", "value": "a/b/c", "description": "(Required) Hierarchical path for the dataset", "disabled": true } ] }, "description": "
  • Removes the lock for a dataset id.
  • Required roles: subproject.admin
" }, "response": [ { "name": "Removed the lock value associated with dataset id", "originalRequest": { "method": "PUT", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid/unlock?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid", "unlock" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Bad request", "originalRequest": { "method": "PUT", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid/unlock?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid", "unlock" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid/unlock?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid", "unlock" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "PUT", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid/unlock?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid", "unlock" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "PUT", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid/unlock?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid", "unlock" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Locked", "originalRequest": { "method": "PUT", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid/unlock?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid", "unlock" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Locked (WebDAV) (RFC 4918)", "code": 423, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Applications", "item": [ { "name": "Register a new application", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/{{seismic_api}}/app?email=test@contoso.com&sdpath=sd://{{seismic_project}}/{{seismic_subproject}}/{{seismic_segy_file_name}}", "host": [ "{{base_url}}" ], "path": [ "{{seismic_api}}", "app" ], "query": [ { "key": "email", "value": "test@contoso.com", "description": "(Required) Service account email of the application" }, { "key": "sdpath", "value": "sd://{{seismic_project}}/{{seismic_subproject}}/{{seismic_segy_file_name}}", "description": "(Required) Seismic store tenant path, sd://tenant" } ] }, "description": "
  • Register a new application in seismic store.
  • Required roles: users.datalake.admin
" }, "response": [ { "name": "Registration of the application was successful.", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/app?email=&sdpath=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "app" ], "query": [ { "key": "email", "value": "" }, { "key": "sdpath", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/app?email=&sdpath=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "app" ], "query": [ { "key": "email", "value": "" }, { "key": "sdpath", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/app?email=&sdpath=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "app" ], "query": [ { "key": "email", "value": "" }, { "key": "sdpath", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/app?email=&sdpath=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "app" ], "query": [ { "key": "email", "value": "" }, { "key": "sdpath", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/app?email=&sdpath=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "app" ], "query": [ { "key": "email", "value": "" }, { "key": "sdpath", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Retrieve the list of registered applications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/{{seismic_api}}/app?sdpath=sd://{{seismic_project}}/{{seismic_subproject}}/{{seismic_segy_file_name}}", "host": [ "{{base_url}}" ], "path": [ "{{seismic_api}}", "app" ], "query": [ { "key": "sdpath", "value": "sd://{{seismic_project}}/{{seismic_subproject}}/{{seismic_segy_file_name}}", "description": "(Required) Seismic store tenant path, sd://tenant" } ] }, "description": "
  • Retrieve the list of the registered application in seismic store.
  • Required roles: users.datalake.admin
" }, "response": [ { "name": "Retrieved list of all the registered applications successfully.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/app?sdpath=sd://common&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "app" ], "query": [ { "key": "sdpath", "value": "sd://common" }, { "key": "key", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n \"\",\n \"\"\n]" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/app?sdpath=sd://common&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "app" ], "query": [ { "key": "sdpath", "value": "sd://common" }, { "key": "key", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/app?sdpath=sd://common&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "app" ], "query": [ { "key": "sdpath", "value": "sd://common" }, { "key": "key", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/app?sdpath=sd://common&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "app" ], "query": [ { "key": "sdpath", "value": "sd://common" }, { "key": "key", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/app?sdpath=sd://common&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "app" ], "query": [ { "key": "sdpath", "value": "sd://common" }, { "key": "key", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Set a registered application as a trusted application", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/{{seismic_api}}/app/trusted?email=test@contoso.com&sdpath=sd://{{seismic_project}}/{{seismic_subproject}}/{{seismic_segy_file_name}}", "host": [ "{{base_url}}" ], "path": [ "{{seismic_api}}", "app", "trusted" ], "query": [ { "key": "email", "value": "test@contoso.com", "description": "(Required) Service account email of the application" }, { "key": "sdpath", "value": "sd://{{seismic_project}}/{{seismic_subproject}}/{{seismic_segy_file_name}}", "description": "(Required) Seismic store tenant path, sd://tenant" } ] }, "description": "
  • Set a registered application as a trusted application in seismic store.
  • Required roles: users.datalake.admin
" }, "response": [ { "name": "Marking the application as a trusted application was successful.", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/app/trusted?email=tester-carbon.slbservice.com@slb.com&sdpath=sd://common&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "app", "trusted" ], "query": [ { "key": "email", "value": "tester-carbon.slbservice.com@slb.com" }, { "key": "sdpath", "value": "sd://common" }, { "key": "key", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/app/trusted?email=tester-carbon.slbservice.com@slb.com&sdpath=sd://common&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "app", "trusted" ], "query": [ { "key": "email", "value": "tester-carbon.slbservice.com@slb.com" }, { "key": "sdpath", "value": "sd://common" }, { "key": "key", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/app/trusted?email=tester-carbon.slbservice.com@slb.com&sdpath=sd://common&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "app", "trusted" ], "query": [ { "key": "email", "value": "tester-carbon.slbservice.com@slb.com" }, { "key": "sdpath", "value": "sd://common" }, { "key": "key", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/app/trusted?email=tester-carbon.slbservice.com@slb.com&sdpath=sd://common&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "app", "trusted" ], "query": [ { "key": "email", "value": "tester-carbon.slbservice.com@slb.com" }, { "key": "sdpath", "value": "sd://common" }, { "key": "key", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/app/trusted?email=tester-carbon.slbservice.com@slb.com&sdpath=sd://common&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "app", "trusted" ], "query": [ { "key": "email", "value": "tester-carbon.slbservice.com@slb.com" }, { "key": "sdpath", "value": "sd://common" }, { "key": "key", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "List the trusted applications in a seismic store tenant", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/{{seismic_api}}/app/trusted?sdpath=sd://{{seismic_project}}/{{seismic_subproject}}/{{seismic_segy_file_name}}", "host": [ "{{base_url}}" ], "path": [ "{{seismic_api}}", "app", "trusted" ], "query": [ { "key": "sdpath", "value": "sd://{{seismic_project}}/{{seismic_subproject}}/{{seismic_segy_file_name}}", "description": "(Required) Seismic store tenant path in the format sd://tenant" } ] }, "description": "
  • Return the list of the trusted application in seismic store tenant.
  • Required roles: users.datalake.admin
" }, "response": [ { "name": "Retrieved the list of all the trusted applications in the tenant", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/app/trusted?sdpath=sd://common&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "app", "trusted" ], "query": [ { "key": "sdpath", "value": "sd://common" }, { "key": "key", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n \"\",\n \"\"\n]" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/app/trusted?sdpath=sd://common&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "app", "trusted" ], "query": [ { "key": "sdpath", "value": "sd://common" }, { "key": "key", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/app/trusted?sdpath=sd://common&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "app", "trusted" ], "query": [ { "key": "sdpath", "value": "sd://common" }, { "key": "key", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/app/trusted?sdpath=sd://common&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "app", "trusted" ], "query": [ { "key": "sdpath", "value": "sd://common" }, { "key": "key", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/app/trusted?sdpath=sd://common&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "app", "trusted" ], "query": [ { "key": "sdpath", "value": "sd://common" }, { "key": "key", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Utility", "item": [ { "name": "Generate a GCS access token", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "", " let sas_url = pm.response.json().access_token;", " pm.variables.set('upload_sas_url', sas_url);", "});", "", "" ], "type": "text/javascript" } }, { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/{{seismic_api}}/utility/gcs-access-token?sdpath=sd://{{seismic_project}}/{{seismic_subproject}}/{{seismic_segy_file_name}}&readonly=false", "host": [ "{{base_url}}" ], "path": [ "{{seismic_api}}", "utility", "gcs-access-token" ], "query": [ { "key": "sdpath", "value": "sd://{{seismic_project}}/{{seismic_subproject}}/{{seismic_segy_file_name}}", "description": "full path for the subproject in the seismic store" }, { "key": "readonly", "value": "false" } ] }, "description": "Create a BLOB SAS URL with write permissions so that the SEGY file can be uploaded directly to the subproject in the seismic storage." }, "response": [] }, { "name": "Retrieve list of datasets and sub-directories inside a seismic store path", "request": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/{{seismic_api}}/utility/ls?sdpath=sd://{{seismic_project}}/{{seismic_subproject}}/{{seismic_segy_file_name}}", "host": [ "{{base_url}}" ], "path": [ "{{seismic_api}}", "utility", "ls" ], "query": [ { "key": "sdpath", "value": "sd://{{seismic_project}}/{{seismic_subproject}}/{{seismic_segy_file_name}}", "description": "(Required) Seismic store path, sd://tenant/sub-project/path" }, { "key": "wmode", "value": "", "description": "Working mode, dirs or datasets or undefined for both", "disabled": true }, { "key": "limit", "value": "", "description": "Limits total number of datasets to be returned", "disabled": true }, { "key": "cursor", "value": "", "description": "Pagination token - this query parameter can be omitted on first call", "disabled": true } ] }, "description": "
  • Return the list of datasets and sub-directories of a seismic store path.
  • Required roles: subproject.admin, subproject.editor, subproject.viewer
" }, "response": [ { "name": "Seismic store path content", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/ls?sdpath=&wmode=&limit=&cursor=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "ls" ], "query": [ { "key": "sdpath", "value": "" }, { "key": "wmode", "value": "" }, { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n \"\",\n \"\"\n]" }, { "name": "Paginated seismic store path content - For documentation purpose if limit or cursor is given status code here is 200", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/ls?sdpath=&wmode=&limit=&cursor=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "ls" ], "query": [ { "key": "sdpath", "value": "" }, { "key": "wmode", "value": "" }, { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"datasets\": [\n \"\",\n \"\"\n ],\n \"nextPageCursor\": \"\"\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/ls?sdpath=&wmode=&limit=&cursor=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "ls" ], "query": [ { "key": "sdpath", "value": "" }, { "key": "wmode", "value": "" }, { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/ls?sdpath=&wmode=&limit=&cursor=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "ls" ], "query": [ { "key": "sdpath", "value": "" }, { "key": "wmode", "value": "" }, { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/ls?sdpath=&wmode=&limit=&cursor=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "ls" ], "query": [ { "key": "sdpath", "value": "" }, { "key": "wmode", "value": "" }, { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/ls?sdpath=&wmode=&limit=&cursor=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "ls" ], "query": [ { "key": "sdpath", "value": "" }, { "key": "wmode", "value": "" }, { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Retrieve the list of supported storage tiers", "request": { "method": "GET", "header": [], "url": "{{base_url}}/{{seismic_api}}/utility/storage-tiers", "description": "
  • Return the list of storage tiers
" }, "response": [ { "name": "Supported storage tiers", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/utility/storage-tiers?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "storage-tiers" ], "query": [ { "key": "key", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/utility/storage-tiers?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "storage-tiers" ], "query": [ { "key": "key", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/utility/storage-tiers?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "storage-tiers" ], "query": [ { "key": "key", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/utility/storage-tiers?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "storage-tiers" ], "query": [ { "key": "key", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/utility/storage-tiers?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "storage-tiers" ], "query": [ { "key": "key", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Copy dataset", "request": { "method": "POST", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/{{seismic_api}}/utility/cp?sdpath_from=sd://{{seismic_project}}/{{seismic_subproject}}/{{seismic_segy_file_name}}&sdpath_to=sd://{{seismic_project}}/{{seismic_subproject}}/{{seismic_segy_file_name}}-copy", "host": [ "{{base_url}}" ], "path": [ "{{seismic_api}}", "utility", "cp" ], "query": [ { "key": "sdpath_from", "value": "sd://{{seismic_project}}/{{seismic_subproject}}/{{seismic_segy_file_name}}", "description": "(Required) Seismic store source dataset path" }, { "key": "sdpath_to", "value": "sd://{{seismic_project}}/{{seismic_subproject}}/{{seismic_segy_file_name}}-copy", "description": "(Required) Seismic store destination dataset path" }, { "key": "lock", "value": "", "description": "Lock source and destination while copying", "disabled": true } ] }, "description": "
  • Copy a seismic store dataset. The source and destination dataset must be in the same sub-project.
  • Required roles: subproject.admin, subproject.editor
" }, "response": [ { "name": "Copy operation succeeded", "originalRequest": { "method": "POST", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/cp?sdpath_from=sd://common/carbon/a/b/c/slb-dataset&sdpath_to=sd://common/carbon/a/b/c/slb-dataset-copy&lock=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "cp" ], "query": [ { "key": "sdpath_from", "value": "sd://common/carbon/a/b/c/slb-dataset" }, { "key": "sdpath_to", "value": "sd://common/carbon/a/b/c/slb-dataset-copy" }, { "key": "lock", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "\"\"" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/cp?sdpath_from=sd://common/carbon/a/b/c/slb-dataset&sdpath_to=sd://common/carbon/a/b/c/slb-dataset-copy&lock=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "cp" ], "query": [ { "key": "sdpath_from", "value": "sd://common/carbon/a/b/c/slb-dataset" }, { "key": "sdpath_to", "value": "sd://common/carbon/a/b/c/slb-dataset-copy" }, { "key": "lock", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/cp?sdpath_from=sd://common/carbon/a/b/c/slb-dataset&sdpath_to=sd://common/carbon/a/b/c/slb-dataset-copy&lock=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "cp" ], "query": [ { "key": "sdpath_from", "value": "sd://common/carbon/a/b/c/slb-dataset" }, { "key": "sdpath_to", "value": "sd://common/carbon/a/b/c/slb-dataset-copy" }, { "key": "lock", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/cp?sdpath_from=sd://common/carbon/a/b/c/slb-dataset&sdpath_to=sd://common/carbon/a/b/c/slb-dataset-copy&lock=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "cp" ], "query": [ { "key": "sdpath_from", "value": "sd://common/carbon/a/b/c/slb-dataset" }, { "key": "sdpath_to", "value": "sd://common/carbon/a/b/c/slb-dataset-copy" }, { "key": "lock", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/cp?sdpath_from=sd://common/carbon/a/b/c/slb-dataset&sdpath_to=sd://common/carbon/a/b/c/slb-dataset-copy&lock=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "cp" ], "query": [ { "key": "sdpath_from", "value": "sd://common/carbon/a/b/c/slb-dataset" }, { "key": "sdpath_to", "value": "sd://common/carbon/a/b/c/slb-dataset-copy" }, { "key": "lock", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Conflict", "originalRequest": { "method": "POST", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/cp?sdpath_from=sd://common/carbon/a/b/c/slb-dataset&sdpath_to=sd://common/carbon/a/b/c/slb-dataset-copy&lock=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "cp" ], "query": [ { "key": "sdpath_from", "value": "sd://common/carbon/a/b/c/slb-dataset" }, { "key": "sdpath_to", "value": "sd://common/carbon/a/b/c/slb-dataset-copy" }, { "key": "lock", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Locked", "originalRequest": { "method": "POST", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/cp?sdpath_from=sd://common/carbon/a/b/c/slb-dataset&sdpath_to=sd://common/carbon/a/b/c/slb-dataset-copy&lock=&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "cp" ], "query": [ { "key": "sdpath_from", "value": "sd://common/carbon/a/b/c/slb-dataset" }, { "key": "sdpath_to", "value": "sd://common/carbon/a/b/c/slb-dataset-copy" }, { "key": "lock", "value": "" }, { "key": "key", "value": "" } ] } }, "status": "Locked (WebDAV) (RFC 4918)", "code": 423, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Generate the upload connection credentials string", "request": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/{{seismic_api}}/utility/upload-connection-string?sdpath=sd://{{seismic_project}}/{{seismic_subproject}}/{{seismic_segy_file_name}}", "host": [ "{{base_url}}" ], "path": [ "{{seismic_api}}", "utility", "upload-connection-string" ], "query": [ { "key": "sdpath", "value": "sd://{{seismic_project}}/{{seismic_subproject}}/{{seismic_segy_file_name}}", "description": "(Required) Seismic store path in the format sd://tenant/subproject (for uniform applied policies) or sd://tenant/subproject/dataset (for dataset applied policies)" } ] }, "description": "
  • Generate the upload connection credential string for a subproject collection or a dataset, depending of the applied access policy (uniform/dataset).
  • These credentials can be used via CSP SDK, on client side, to perform bulk upload.
  • The endpoint response is CSP (Cloud Solution Provider) dependent:

    • Azure: shared access signature (SaS) Url token

      {
            access_token: 'https://{accountName}.blob.core.windows.net/{containerName}?{SASQueryParameters}`'
            expires_in: 3599
            token_type: 'SasUrl'
      }

    • Google: standard access token credential signed and down-scoped by google

      {
            access_token: 'google_signed_access_token'
            expires_in: 3600
            token_type: 'Bearer'
      }

    • AWS: double column separated string containing access key id, the access key secret and the session token

      {
            access_token: 'accessKeyId:secretAccessKey:sessionToken'
            expires_in: 3599
            token_type: 'Bearer'
      }

    • IBM: double column separated string containing access key id, the access key secret and the session token

      {
            access_token: 'accessKeyId:secretAccessKey:sessionToken'
            expires_in: 7200
            token_type: 'Bearer'
      }

  • Required roles: subproject.admin, subproject.editor, subproject.viewer
" }, "response": [ { "name": "The upload connection credential string.", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/upload-connection-string?sdpath=sd://opendes/sandbox&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "upload-connection-string" ], "query": [ { "key": "sdpath", "value": "sd://opendes/sandbox" }, { "key": "key", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"access_token\": \"\",\n \"token_type\": \"\",\n \"expires_in\": \"\"\n}" }, { "name": "Bad request.", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/upload-connection-string?sdpath=sd://opendes/sandbox&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "upload-connection-string" ], "query": [ { "key": "sdpath", "value": "sd://opendes/sandbox" }, { "key": "key", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized.", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/upload-connection-string?sdpath=sd://opendes/sandbox&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "upload-connection-string" ], "query": [ { "key": "sdpath", "value": "sd://opendes/sandbox" }, { "key": "key", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden.", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/upload-connection-string?sdpath=sd://opendes/sandbox&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "upload-connection-string" ], "query": [ { "key": "sdpath", "value": "sd://opendes/sandbox" }, { "key": "key", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found.", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/upload-connection-string?sdpath=sd://opendes/sandbox&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "upload-connection-string" ], "query": [ { "key": "sdpath", "value": "sd://opendes/sandbox" }, { "key": "key", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Generate the download connection credentials string", "request": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/{{seismic_api}}/utility/download-connection-string?sdpath=sd://{{seismic_project}}/{{seismic_subproject}}/{{seismic_segy_file_name}}&readonly=false", "host": [ "{{base_url}}" ], "path": [ "{{seismic_api}}", "utility", "download-connection-string" ], "query": [ { "key": "sdpath", "value": "sd://{{seismic_project}}/{{seismic_subproject}}/{{seismic_segy_file_name}}", "description": "(Required) Seismic store path in the format sd://tenant/subproject (for uniform applied policies) or sd://tenant/subproject/dataset (for dataset applied policies)" }, { "key": "readonly", "value": "false" } ] }, "description": "
  • Generate the download connection credential string for a subproject collection or a dataset, depending of the applied access policy (uniform/dataset).
  • These credentials can be used via CSP SDK, on client side, to perform bulk download.
  • The endpoint response is CSP (Cloud Solution Provider) dependent:

    • Azure: shared access signature (SaS) Url token

      {
            access_token: 'https://{accountName}.blob.core.windows.net/{containerName}?{SASQueryParameters}`'
            expires_in: 3599
            token_type: 'SasUrl'
      }

    • Google: standard access token credential signed and down-scoped by google

      {
            access_token: 'google_signed_access_token'
            expires_in: 3600
            token_type: 'Bearer'
      }

    • AWS: double column separated string containing access key id, the access key secret and the session token

      {
            access_token: 'accessKeyId:secretAccessKey:sessionToken'
            expires_in: 3599
            token_type: 'Bearer'
      }

    • IBM: double column separated string containing access key id, the access key secret and the session token

      {
            access_token: 'accessKeyId:secretAccessKey:sessionToken'
            expires_in: 7200
            token_type: 'Bearer'
      }

  • Required roles: subproject.admin, subproject.editor, subproject.viewer
" }, "response": [ { "name": "The download connection credential string.", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/download-connection-string?sdpath=sd://opendes/sandbox&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "download-connection-string" ], "query": [ { "key": "sdpath", "value": "sd://opendes/sandbox" }, { "key": "key", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"access_token\": \"\",\n \"token_type\": \"\",\n \"expires_in\": \"\"\n}" }, { "name": "Bad request.", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/download-connection-string?sdpath=sd://opendes/sandbox&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "download-connection-string" ], "query": [ { "key": "sdpath", "value": "sd://opendes/sandbox" }, { "key": "key", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized.", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/download-connection-string?sdpath=sd://opendes/sandbox&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "download-connection-string" ], "query": [ { "key": "sdpath", "value": "sd://opendes/sandbox" }, { "key": "key", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden.", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/download-connection-string?sdpath=sd://opendes/sandbox&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "download-connection-string" ], "query": [ { "key": "sdpath", "value": "sd://opendes/sandbox" }, { "key": "key", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found.", "originalRequest": { "method": "GET", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/utility/download-connection-string?sdpath=sd://opendes/sandbox&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "utility", "download-connection-string" ], "query": [ { "key": "sdpath", "value": "sd://opendes/sandbox" }, { "key": "key", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Seismic DDMS: Teardown", "item": [ { "name": "Delete a dataset", "request": { "method": "DELETE", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{base_url}}/{{seismic_api}}/dataset/tenant/{{seismic_project}}/subproject/{{seismic_subproject}}/dataset/{{seismic_segy_file_name}}", "host": [ "{{base_url}}" ], "path": [ "{{seismic_api}}", "dataset", "tenant", "{{seismic_project}}", "subproject", "{{seismic_subproject}}", "dataset", "{{seismic_segy_file_name}}" ], "query": [ { "key": "path", "value": "a/b/c", "description": "(Required) Hierarchical path of the dataset", "disabled": true } ] }, "description": "
  • Delete a dataset in seismic store.
  • Required roles: subproject.admin, subproject.editor
" }, "response": [ { "name": "The resource was deleted successfully.", "originalRequest": { "method": "DELETE", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Bad request", "originalRequest": { "method": "DELETE", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "DELETE", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "The impersonation token context (required only with impersonation token credentials)", "key": "impersonation-token-context", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v3/dataset/tenant/:tenantid/subproject/:subprojectid/dataset/:datasetid?path=a/b/c&key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "dataset", "tenant", ":tenantid", "subproject", ":subprojectid", "dataset", ":datasetid" ], "query": [ { "key": "path", "value": "a/b/c" }, { "key": "key", "value": "" } ], "variable": [ { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" }, { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "datasetid", "value": "slb-dataset", "description": "(Required) Name of the dataset" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Delete a subproject", "request": { "method": "DELETE", "header": [], "url": "{{base_url}}/{{seismic_api}}/subproject/tenant/{{seismic_project}}/subproject/{{seismic_subproject}}", "description": "
  • Delete a subproject in seismic store.
  • Required roles: users.datalake.admin
" }, "response": [ { "name": "Deletion of the subproject completed", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid/subproject/:subprojectid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Bad request", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid/subproject/:subprojectid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid/subproject/:subprojectid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid/subproject/:subprojectid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not found", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/subproject/tenant/:tenantid/subproject/:subprojectid?key=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "subproject", "tenant", ":tenantid", "subproject", ":subprojectid" ], "query": [ { "key": "key", "value": "" } ], "variable": [ { "key": "subprojectid", "value": "carbon", "description": "(Required) Name of the subproject" }, { "key": "tenantid", "value": "common", "description": "(Required) Name of the tenant" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": { "token": "{{access_token}}" } }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "osdu_release", "value": "0.11.0" }, { "key": "vdsTestSubprojectName", "value": "vdstestsubproject", "type": "string" }, { "key": "zgyTestSubprojectName", "value": "zgytestsubproject", "type": "string" }, { "key": "segyTestFileNameForVds", "value": "example-ST10010ZC11_PZ_PSDM_KIRCH_FULL_T.MIG_FIN.POST_STACK.3D.JS-017536.segy", "type": "string" }, { "key": "segyTestFileNameForZgy", "value": "sample-ST10010ZC11_PZ_PSDM_KIRCH_FULL_T.MIG_FIN.POST_STACK.3D.JS-017536.segy", "type": "string" }, { "key": "segyTestFileNameForFileMetadata", "value": "model-ST10010ZC11_PZ_PSDM_KIRCH_FULL_T.MIG_FIN.POST_STACK.3D.JS-017536.segy", "type": "string" }, { "key": "segyTestFileSize", "value": "1050849760", "type": "string" }, { "key": "vds_iteration", "value": "0", "type": "string" }, { "key": "zgy_iteration", "value": "0", "type": "string" } ] }