Geoscience Object API

Preview

List geoscience objects by org

GET

/geoscience-object/orgs/{org_id}/objects

Preview API

This API functionality is currently in preview. Preview APIs may be unstable within the preview period: they may change without notice. You must set the header API-Preview: opt-in to opt into using this functionality.

The response will list geoscience objects for the provided organisation ID.

Request

Path parameters

org_iduuid

Required

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

The customer's organisation ID

Query parameters

offsetinteger

Number of results to skip before returning limit number of results.

limitinteger

Example: 10

Default: 5000

Max number of results per page.

deletedboolean | null

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

permitted_workspaces_onlyboolean | null

Only return objects in workspaces the user is permitted to access.

order_bystring | null

Example: "object_name,desc:created_by,asc:object.a.b.c"

A comma separated list of fields to order by, where the default sort order is ascending. To specify the sort order, prefix the field name with either asc: or desc: for ascending or descending respectively. Field names can either be arbitrary, representing a field nested inside the data, or one of the following known sort fields: created_at, created_by, modified_at, modified_by, object_name, deleted_at

created_by(uuid | string)[]

Example: "00000000-0000-0000-0000-000000000000"

The UUID of the user that created an object

Any of:

string

created_atstring[]

Example: "gte:2023-03-10T22:56:53Z"

A date or dates (max 2) to filter objects by. Dates may contain operator prefixes, in the form <operator>:<datetime>. The following operators are available (lt=less than, lte=less than or equal to, gt=greater than, gte=greater than or equal to). If you omit the operator, then it is assumed the operator is 'equal to'. In this case you may only supply one date. The dates must also be in a valid ISO 8601 format. Dates may include a UTC offset. If the offset is omitted, the timezone is assumed to be UTC.

modified_by(uuid | string)[]

Example: "00000000-0000-0000-0000-000000000000"

The UUID of the user that modified an object

Any of:

string

modified_atstring[]

Example: "gte:2023-03-10T22:56:53Z"

object_namestring[]

Examples: "object.json", "eq:path/to/object.json"

The name of the object to filter on. For backwards compatibility, when no operators are supplied, this will perform a case sensitive prefix match of the object file name. The query object_name=gold will match an object with the name goldcolumns.json. Providing an operator will query over the entire path to and including the file name.

schema_idstring[]

Examples: "/objects/variogram/0.1.0/variogram.schema.json", "like:*variogram*"

The type of schema you want to filter by.

geojson_bounding_boxstring[]

Example: "geointersects:(171.6,-44.5),(173.7,-44.5),(173.7,-42.9),(171.6,-42.9),(171.6,-44.5)"

The coordinates of the data to spatially search on. The value may optionally include one of two spatial operators, geowithin or geointersects. If an operator is not defined, then geointersects will be used by default. The coordinates must be 5 pairs of longitude and latitude, representing a closed polygon. The first and last coordinates must be the same to close the polygon.

deleted_by(uuid | string)[]

Example: "00000000-0000-0000-0000-000000000000"

The UUID of the user that deleted an object

Any of:

string

deleted_atstring[]

Example: "gte:2023-03-10T22:56:53Z"

Responses

200

Successful Response

Response schema

countinteger

limitinteger

linksListObjectsResponseLinks

nextstring | null

prevstring | null

objectsOrgListedObject[]

created_atdate-time

created_byUser | null

deleted_atdate-time | null

deleted_byUser | null

geojson_bounding_boxBoundingBox | null

modified_atdate-time

modified_byUser | null

namestring

object_iduuid

schemastring

stageStageResponse | null

workspace_access"owner" | "editor" | "viewer" | null

workspace_iduuid

workspace_namestring | null

offsetinteger

totalinteger

Example response

{
  "count": 0,
  "limit": 0,
  "links": {
    "next": "string",
    "prev": "string"
  },
  "objects": [
    {
      "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"
      },
      "geojson_bounding_box": {
        "coordinates": [
          [
            [
              0
            ]
          ]
        ],
        "type": "Polygon"
      },
      "modified_at": "2024-07-29T15:51:28.071Z",
      "modified_by": {
        "email": "string",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string"
      },
      "name": "string",
      "object_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "schema": "string",
      "stage": {
        "name": "string",
        "stage_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      },
      "workspace_access": "owner",
      "workspace_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "workspace_name": "string"
    }
  ],
  "offset": 0,
  "total": 0
}

400 /geoscienceobject/bad-request

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

Response schema

detailstring | null

status100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 226 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 413 | 414 | 414 | 415 | 416 | 416 | 417 | 418 | 421 | 422 | 422 | 423 | 424 | 425 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 510 | 511

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

Example response

{
  "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.

Response schema

Any of:

MissingTokenErrorobject

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"

InvalidTokenErrorobject

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

Example response

{
  "detail": "string",
  "status": 401,
  "title": "Access Denied.",
  "type": "https://seequent.com/error-codes/geoscienceobject/auth/missing-token"
}

422 /geoscienceobject/filtering/invalid-params

The provided filter parameters are invalid.

/geoscienceobject/sorting/invalid-params

The provided sort parameters are invalid.

/geoscienceobject/validation

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

Response schema

Any of:

InvalidFilterParamsobject

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: "Invalid Filter Params."

typestring

Default: "https://seequent.com/error-codes/geoscienceobject/filtering/invalid-params"

InvalidSortParamsobject

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: "Invalid Sorting Parameters"

typestring

Default: "https://seequent.com/error-codes/geoscienceobject/sorting/invalid-params"

EvoRequestValidationErrorobject

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"

Example response

{
  "detail": "string",
  "status": 422,
  "title": "Invalid Filter Params.",
  "type": "https://seequent.com/error-codes/geoscienceobject/filtering/invalid-params"
}

500 /geoscienceobject/api-errors

A server error has occurred.

Response schema

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"

Example response

{
  "detail": "string",
  "status": 500,
  "title": "An Error Occurred.",
  "type": "https://seequent.com/error-codes/geoscienceobject/api-errors"
}

502 /geoscienceobject/objects/storage

Attempting an operation within the object store caused an upstream error.

/geoscienceobject/bad-gateway

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

Response schema

Any of:

ObjectStoreErrorobject

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: "Geoscience Object Storage Operation Failed."

typestring

Default: "https://seequent.com/error-codes/geoscienceobject/objects/storage"

BadGatewayobject

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

Example response

{
  "detail": "string",
  "status": 502,
  "title": "Geoscience Object Storage Operation Failed.",
  "type": "https://seequent.com/error-codes/geoscienceobject/objects/storage"
}