Geoscience Object API

Version: 1.17.0

Preview

Update metadata for an Object

PATCH

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

Preview API

This endpoint is marked as a preview API. 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 endpoint.

Update metadata for a geoscience object version. If a version is not specified, the latest version of the object will be used. Setting the metadata property to null will remove the metadata from the object version.

Request

Path parameters

object_iduuid

Required

org_iduuid

Required

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

The customer's organisation ID

workspace_iduuid

Required

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

Query parameters

version_idinteger

Example: "1706583776404684724"

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

Body parameters

Required

stage_idstring | null

Example body

{
  "stage_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Responses

204

Successful Response

422

Validation Error

Response schema

detailobject[]

loc(string | integer)[]

Any of:

string

integer

msgstring

typestring

Example response

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}