Skip to main content

Geoscience Object API

Version: 1.11.0

Update a geoscience object

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

Update or restore a geoscience object by UUID. Uploading an object to this endpoint will update (replace, i.e. no partial updates) the existing object with a corresponding UUID. If the object was previously deleted, and the deleted parameter is set to false, this operation will attempt to restore the object. You cannot provide an object body when attempting to restore an object. Note that the value of the uuid field in the object must match the value in the URL path. New objects must be uploaded by path.

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

When set to false, the operation will attempt to restore the object.

Responses

201

The geoscience object version has been created.

created_atdate-time
created_byobject | null
deleted_atstring | null
deleted_byobject | null
etagstring
geojson_bounding_boxobject | null
download_urlstring | null
iduuid
namestring
downloadstring
modified_atdate-time
modified_byobject | 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_idstring | null
object_pathstring | null
stageobject | null
version_idstring

204

The geoscience object has been restored. Location of the resource has not changed.

303

The geoscience object has been restored. Location of the resource has changed (e.g., rename on restore).

created_atdate-time
created_byobject | null
deleted_atstring | null
deleted_byobject | null
etagstring
geojson_bounding_boxobject | null
download_urlstring | null
iduuid
namestring
downloadstring
modified_atdate-time
modified_byobject | 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_idstring | null
object_pathstring | null
stageobject | null
version_idstring

400

/geoscienceobject/schemas/invalid-object

Invalid geoscience object. The contents of the object failed to validate with the schema referenced in its schema property. Check the request contents and try again.

/geoscienceobject/data/invalid-key

The object contains data references that are invalid. These must be SHA256 digests or UUIDs.

/geoscienceobject/objects/data-key-not-found

The object contains references to data blobs that do not exist. Upload them and try again.

/geoscienceobject/objects/data-key-not-found

Data blobs referenced in the object were not moved to their intended destination in storage.

/geoscienceobject/objects/invalid-object

The uploaded object must be of the same schema type as the existing object. Additionally, the object filename must have a .json extension.

/geoscienceobject/bad-request

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

detailstring | null
json_pathstring
schema_patharray
Default: []
Default: 400

HTTP status codes and reason phrases

Status codes from the following RFCs are all observed:

* RFC 7231: Hypertext Transfer Protocol (HTTP/1.1), obsoletes 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: "The Geoscience Object Is Invalid."
typestring
Default: "https://seequent.com/error-codes/geoscienceobject/schemas/invalid-object"
detailstring | null
Default: 400

HTTP status codes and reason phrases

Status codes from the following RFCs are all observed:

* RFC 7231: Hypertext Transfer Protocol (HTTP/1.1), obsoletes 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: "Data Key Not Valid."
typestring
Default: "https://seequent.com/error-codes/geoscienceobject/data/invalid-key"
detailstring | null
Default: 400

HTTP status codes and reason phrases

Status codes from the following RFCs are all observed:

* RFC 7231: Hypertext Transfer Protocol (HTTP/1.1), obsoletes 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: "Data Key Not Found."
typestring
Default: "https://seequent.com/error-codes/geoscienceobject/objects/data-key-not-found"
detailstring | null
Default: 400

HTTP status codes and reason phrases

Status codes from the following RFCs are all observed:

* RFC 7231: Hypertext Transfer Protocol (HTTP/1.1), obsoletes 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: "Data Key Not Moved."
typestring
Default: "https://seequent.com/error-codes/geoscienceobject/objects/data-key-not-found"
detailstring | null
Default: 400

HTTP status codes and reason phrases

Status codes from the following RFCs are all observed:

* RFC 7231: Hypertext Transfer Protocol (HTTP/1.1), obsoletes 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 Error."
typestring
Default: "https://seequent.com/error-codes/geoscienceobject/objects/invalid-object"
detailstring | null
Default: 400

HTTP status codes and reason phrases

Status codes from the following RFCs are all observed:

* RFC 7231: Hypertext Transfer Protocol (HTTP/1.1), obsoletes 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"

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 7231: Hypertext Transfer Protocol (HTTP/1.1), obsoletes 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 7231: Hypertext Transfer Protocol (HTTP/1.1), obsoletes 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"

403

/geoscienceobject/auth/insufficient-role

The user lacks the required role to access this endpoint.

detailstring | null
permitted_rolesarray
Default: []
Default: 403

HTTP status codes and reason phrases

Status codes from the following RFCs are all observed:

* RFC 7231: Hypertext Transfer Protocol (HTTP/1.1), obsoletes 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: "Insufficient Role."
typestring
Default: "https://seequent.com/error-codes/geoscienceobject/auth/insufficient-role"
your_rolestring

404

/geoscienceobject/objects/not-found

An object by the requested UUID does not exist.

/geoscienceobject/schemas/not-found

Attempting to request an object schema caused an upstream error.

detailstring | null
Default: 404

HTTP status codes and reason phrases

Status codes from the following RFCs are all observed:

* RFC 7231: Hypertext Transfer Protocol (HTTP/1.1), obsoletes 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"
detailstring | null
Default: 404

HTTP status codes and reason phrases

Status codes from the following RFCs are all observed:

* RFC 7231: Hypertext Transfer Protocol (HTTP/1.1), obsoletes 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: "Failed To Request Geoscience Object Schema."
typestring
Default: "https://seequent.com/error-codes/geoscienceobject/schemas/not-found"

409

/geoscienceobject/objects/already-exists

An object already exists by this path/UUID.

detailstring | null
existing_idstring | null
object_pathstring
Default: 409

HTTP status codes and reason phrases

Status codes from the following RFCs are all observed:

* RFC 7231: Hypertext Transfer Protocol (HTTP/1.1), obsoletes 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: "Geoscience Object Already Exists."
typestring
Default: "https://seequent.com/error-codes/geoscienceobject/objects/already-exists"

412

/geoscienceobject/objects/modified

The object has been modified, making these changes stale.

detailstring | null
Default: 412

HTTP status codes and reason phrases

Status codes from the following RFCs are all observed:

* RFC 7231: Hypertext Transfer Protocol (HTTP/1.1), obsoletes 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 Modified."
typestring
Default: "https://seequent.com/error-codes/geoscienceobject/objects/modified"

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 7231: Hypertext Transfer Protocol (HTTP/1.1), obsoletes 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"

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 7231: Hypertext Transfer Protocol (HTTP/1.1), obsoletes 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"

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 7231: Hypertext Transfer Protocol (HTTP/1.1), obsoletes 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"
Developer Portal

Guides

API Reference

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