Skip to main content

Geoscience Object API

Version: 1.21.2

Download a geoscience object by UUID

GET
/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/{object_id}

Download a geoscience object with the provided UUID. If required, the object can be compressed, currently gzip compression is supported. To receive a compressed payload set header Accept-Encoding: gzip.

Request

Path parameters

Example: "355fa5a6-f37d-11ed-93c1-00155d19a71b"

UUID of a geoscience object.

Example: "b208a6c9-6881-4b97-b02d-acb5d81299bb"

The customer's organisation ID

workspace_iduuid
Required

Example: "032806a8-dcd7-11ed-8d5c-00155d8f28b5"

Query parameters

Example: "1746593470905878783"

The (timestamp) version of the object to retrieve. Defaults to the latest version if not specified.

Whether to return all versions of the object

When true, only objects that have been deleted will be returned

Responses

200

The requested geoscience object and metadata

created_atdate-time
created_byUser | null
deleted_atdate-time | null
deleted_byUser | null
etagstring
geojson_bounding_boxBoundingBox | null
geojson_bounding_box_from_workspace_crsboolean
download_urlstring | null
iduuid
namestring
downloadstring
modified_atdate-time
modified_byUser | null

The geoscience object with the additional required schema properties.

This object is largely defined by the schemas in the geoscience-object-schemas repository. There are some default, required values listed here explicitly.

The geoscience object schema.

Unique object UUID.

object_iduuid
object_pathstring | null
stageStageResponse | null
version_idstring
versionsGeoscienceObjectVersion[] | null
{
  "created_at": "2024-07-29T15:51:28.071Z",
  "created_by": {
    "email": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "deleted_at": "2024-07-29T15:51:28.071Z",
  "deleted_by": {
    "email": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "etag": "string",
  "geojson_bounding_box": {
    "coordinates": [
      [
        [
          0
        ]
      ]
    ],
    "type": "Polygon"
  },
  "geojson_bounding_box_from_workspace_crs": true,
  "links": {
    "data": [
      {
        "download_url": "string",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string"
      }
    ],
    "download": "string"
  },
  "modified_at": "2024-07-29T15:51:28.071Z",
  "modified_by": {
    "email": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "object": {
    "schema": "string",
    "uuid": "string",
    "additionalProp1": "string",
    "additionalProp2": "number",
    "additionalProp3": "boolean"
  },
  "object_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "object_path": "string",
  "stage": {
    "name": "string",
    "stage_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "version_id": "string",
  "versions": [
    {
      "created_at": "2024-07-29T15:51:28.071Z",
      "created_by": {
        "email": "string",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string"
      },
      "etag": "string",
      "links": {
        "download": "string"
      },
      "stage": {
        "name": "string",
        "stage_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      },
      "version_id": "string"
    }
  ]
}

304

Not Modified. The requested object version ID matches the latest version of the object.

400

/geoscienceobject/bad-request

Bad request. The server cannot or will not process the request due to a client error.

detailstring | null
Default: 400

HTTP status codes and reason phrases

Status codes from the following RFCs are all observed:

* RFC 9110: HTTP Semantics, obsoletes 7231, which obsoleted 2616
* RFC 6585: Additional HTTP Status Codes
* RFC 3229: Delta encoding in HTTP
* RFC 4918: HTTP Extensions for WebDAV, obsoletes 2518
* RFC 5842: Binding Extensions to WebDAV
* RFC 7238: Permanent Redirect
* RFC 2295: Transparent Content Negotiation in HTTP
* RFC 2774: An HTTP Extension Framework
* RFC 7725: An HTTP Status Code to Report Legal Obstacles
* RFC 7540: Hypertext Transfer Protocol Version 2 (HTTP/2)
* RFC 2324: Hyper Text Coffee Pot Control Protocol (HTCPCP/1.0)
* RFC 8297: An HTTP Status Code for Indicating Hints
* RFC 8470: Using Early Data in HTTP
titlestring
Default: "Bad Request."
typestring
Default: "https://seequent.com/error-codes/geoscienceobject/bad-request"
upstream_typestring | null
{
  "detail": "string",
  "status": 400,
  "title": "Bad Request.",
  "type": "https://seequent.com/error-codes/geoscienceobject/bad-request",
  "upstream_type": "string"
}

401

/geoscienceobject/auth/missing-token

Unauthorized. The client request has not been completed as the provided credentials are invalid.

/geoscienceobject/auth/invalid-token

Forbidden. The client credentials are valid but do not permit access to this resource.

detailstring | null
Default: 401

HTTP status codes and reason phrases

Status codes from the following RFCs are all observed:

* RFC 9110: HTTP Semantics, obsoletes 7231, which obsoleted 2616
* RFC 6585: Additional HTTP Status Codes
* RFC 3229: Delta encoding in HTTP
* RFC 4918: HTTP Extensions for WebDAV, obsoletes 2518
* RFC 5842: Binding Extensions to WebDAV
* RFC 7238: Permanent Redirect
* RFC 2295: Transparent Content Negotiation in HTTP
* RFC 2774: An HTTP Extension Framework
* RFC 7725: An HTTP Status Code to Report Legal Obstacles
* RFC 7540: Hypertext Transfer Protocol Version 2 (HTTP/2)
* RFC 2324: Hyper Text Coffee Pot Control Protocol (HTCPCP/1.0)
* RFC 8297: An HTTP Status Code for Indicating Hints
* RFC 8470: Using Early Data in HTTP
titlestring
Default: "Access Denied."
typestring
Default: "https://seequent.com/error-codes/geoscienceobject/auth/missing-token"
detailstring | null
Default: 401

HTTP status codes and reason phrases

Status codes from the following RFCs are all observed:

* RFC 9110: HTTP Semantics, obsoletes 7231, which obsoleted 2616
* RFC 6585: Additional HTTP Status Codes
* RFC 3229: Delta encoding in HTTP
* RFC 4918: HTTP Extensions for WebDAV, obsoletes 2518
* RFC 5842: Binding Extensions to WebDAV
* RFC 7238: Permanent Redirect
* RFC 2295: Transparent Content Negotiation in HTTP
* RFC 2774: An HTTP Extension Framework
* RFC 7725: An HTTP Status Code to Report Legal Obstacles
* RFC 7540: Hypertext Transfer Protocol Version 2 (HTTP/2)
* RFC 2324: Hyper Text Coffee Pot Control Protocol (HTCPCP/1.0)
* RFC 8297: An HTTP Status Code for Indicating Hints
* RFC 8470: Using Early Data in HTTP
titlestring
Default: "Access Denied."
typestring
Default: "https://seequent.com/error-codes/geoscienceobject/auth/invalid-token"
upstream_typestring | null
{
  "detail": "string",
  "status": 401,
  "title": "Access Denied.",
  "type": "https://seequent.com/error-codes/geoscienceobject/auth/missing-token"
}

404

/geoscienceobject/objects/not-found

No object exists in the workspace by the requested UUID.

detailstring | null
object_idstring | null
Default: 404

HTTP status codes and reason phrases

Status codes from the following RFCs are all observed:

* RFC 9110: HTTP Semantics, obsoletes 7231, which obsoleted 2616
* RFC 6585: Additional HTTP Status Codes
* RFC 3229: Delta encoding in HTTP
* RFC 4918: HTTP Extensions for WebDAV, obsoletes 2518
* RFC 5842: Binding Extensions to WebDAV
* RFC 7238: Permanent Redirect
* RFC 2295: Transparent Content Negotiation in HTTP
* RFC 2774: An HTTP Extension Framework
* RFC 7725: An HTTP Status Code to Report Legal Obstacles
* RFC 7540: Hypertext Transfer Protocol Version 2 (HTTP/2)
* RFC 2324: Hyper Text Coffee Pot Control Protocol (HTCPCP/1.0)
* RFC 8297: An HTTP Status Code for Indicating Hints
* RFC 8470: Using Early Data in HTTP
titlestring
Default: "Object Not Found."
typestring
Default: "https://seequent.com/error-codes/geoscienceobject/objects/not-found"
upstream_typestring | null
{
  "detail": "string",
  "object_id": "string",
  "status": 404,
  "title": "Object Not Found.",
  "type": "https://seequent.com/error-codes/geoscienceobject/objects/not-found",
  "upstream_type": "string"
}

422

/geoscienceobject/validation

The request was invalid and will not be processed due to a client error.

detailstring | null
Default: 422

HTTP status codes and reason phrases

Status codes from the following RFCs are all observed:

* RFC 9110: HTTP Semantics, obsoletes 7231, which obsoleted 2616
* RFC 6585: Additional HTTP Status Codes
* RFC 3229: Delta encoding in HTTP
* RFC 4918: HTTP Extensions for WebDAV, obsoletes 2518
* RFC 5842: Binding Extensions to WebDAV
* RFC 7238: Permanent Redirect
* RFC 2295: Transparent Content Negotiation in HTTP
* RFC 2774: An HTTP Extension Framework
* RFC 7725: An HTTP Status Code to Report Legal Obstacles
* RFC 7540: Hypertext Transfer Protocol Version 2 (HTTP/2)
* RFC 2324: Hyper Text Coffee Pot Control Protocol (HTCPCP/1.0)
* RFC 8297: An HTTP Status Code for Indicating Hints
* RFC 8470: Using Early Data in HTTP
titlestring
Default: "Validation Error."
typestring
Default: "https://seequent.com/error-codes/geoscienceobject/validation"
{
  "detail": "string",
  "status": 422,
  "title": "Validation Error.",
  "type": "https://seequent.com/error-codes/geoscienceobject/validation"
}

500

/geoscienceobject/api-errors

A server error has occurred.

detailstring | null
Default: 500

HTTP status codes and reason phrases

Status codes from the following RFCs are all observed:

* RFC 9110: HTTP Semantics, obsoletes 7231, which obsoleted 2616
* RFC 6585: Additional HTTP Status Codes
* RFC 3229: Delta encoding in HTTP
* RFC 4918: HTTP Extensions for WebDAV, obsoletes 2518
* RFC 5842: Binding Extensions to WebDAV
* RFC 7238: Permanent Redirect
* RFC 2295: Transparent Content Negotiation in HTTP
* RFC 2774: An HTTP Extension Framework
* RFC 7725: An HTTP Status Code to Report Legal Obstacles
* RFC 7540: Hypertext Transfer Protocol Version 2 (HTTP/2)
* RFC 2324: Hyper Text Coffee Pot Control Protocol (HTCPCP/1.0)
* RFC 8297: An HTTP Status Code for Indicating Hints
* RFC 8470: Using Early Data in HTTP
titlestring
Default: "An Error Occurred."
typestring
Default: "https://seequent.com/error-codes/geoscienceobject/api-errors"
{
  "detail": "string",
  "status": 500,
  "title": "An Error Occurred.",
  "type": "https://seequent.com/error-codes/geoscienceobject/api-errors"
}

502

/geoscienceobject/bad-gateway

Bad gateway. A response required to handle the request is invalid.

detailstring | null
Default: 502

HTTP status codes and reason phrases

Status codes from the following RFCs are all observed:

* RFC 9110: HTTP Semantics, obsoletes 7231, which obsoleted 2616
* RFC 6585: Additional HTTP Status Codes
* RFC 3229: Delta encoding in HTTP
* RFC 4918: HTTP Extensions for WebDAV, obsoletes 2518
* RFC 5842: Binding Extensions to WebDAV
* RFC 7238: Permanent Redirect
* RFC 2295: Transparent Content Negotiation in HTTP
* RFC 2774: An HTTP Extension Framework
* RFC 7725: An HTTP Status Code to Report Legal Obstacles
* RFC 7540: Hypertext Transfer Protocol Version 2 (HTTP/2)
* RFC 2324: Hyper Text Coffee Pot Control Protocol (HTCPCP/1.0)
* RFC 8297: An HTTP Status Code for Indicating Hints
* RFC 8470: Using Early Data in HTTP
titlestring
Default: "Bad Gateway."
typestring
Default: "https://seequent.com/error-codes/geoscienceobject/bad-gateway"
upstream_typestring | null
{
  "detail": "string",
  "status": 502,
  "title": "Bad Gateway.",
  "type": "https://seequent.com/error-codes/geoscienceobject/bad-gateway",
  "upstream_type": "string"
}

What is the reason for your feedback?

Developer Portal

Guides

API reference

Get in touch

Explore more about Seequent and Evo or reach out to our team for enquiries.

Cookie policy•Developer terms of service•Terms of use•Privacy policy
© Seequent, The Bentley Subsurface Company