Skip to main content

Workspaces API

Version: 1.0

Update workspace

PATCH
/workspace/orgs/{org_id}/workspaces/{workspace_id}

Updates a workspace.

Request

Path parameters
org_iduuid
Required
workspace_iduuid
Required
Body parameters
Required
bounding_boxobject | null
default_coordinate_systemstring | null
descriptionstring | null

A list of labels

namestring | null
(1, 60) chars
{
"bounding_box": {
"coordinates": [
[
[
0,
0
]
]
],
"type": "Polygon"
},
"default_coordinate_system": "string",
"description": "string",
"labels": [
"string"
],
"name": "string"
}

Responses

200

Successful Response

bounding_boxobject | null
created_atdate-time
emailstring | null
iduuid
namestring | null
current_user_role"owner" | "editor" | "viewer"
default_coordinate_systemstring
descriptionstring
iduuid
labelsstring[]
Default: []
ml_enabledboolean

The name of the workspace, unique within an organization and hub

self_linkuri
(1, 2,083) chars
updated_atdate-time
emailstring | null
iduuid
namestring | null
{
"bounding_box": {
"coordinates": [
[
[
0,
0
]
]
],
"type": "Polygon"
},
"created_at": "2024-07-29T15:51:28.071Z",
"created_by": {
"email": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string"
},
"current_user_role": "owner",
"default_coordinate_system": "string",
"description": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"labels": [
"string"
],
"ml_enabled": false,
"name": "string",
"self_link": "string",
"updated_at": "2024-07-29T15:51:28.071Z",
"updated_by": {
"email": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string"
}
}

401

No permission -- see authorization schemes

detailstring | null
invalid-paramsarray | null
statusinteger
titlestring
typestring
{
"detail": "string",
"invalid-params": [
{
"name": "string",
"reason": "string"
}
],
"status": 0,
"title": "string",
"type": "string"
}

403

Request forbidden -- authorization will not help

detailstring | null
invalid-paramsarray | null
statusinteger
titlestring
typestring
{
"detail": "string",
"invalid-params": [
{
"name": "string",
"reason": "string"
}
],
"status": 0,
"title": "string",
"type": "string"
}

404

Resource not found or user lacks access

detailstring | null
invalid-paramsarray | null
statusinteger
titlestring
typestring
{
"detail": "string",
"invalid-params": [
{
"name": "string",
"reason": "string"
}
],
"status": 0,
"title": "string",
"type": "string"
}

405

Specified method is invalid for this resource

detailstring | null
invalid-paramsarray | null
statusinteger
titlestring
typestring
{
"detail": "string",
"invalid-params": [
{
"name": "string",
"reason": "string"
}
],
"status": 0,
"title": "string",
"type": "string"
}

409

Request conflict

detailstring | null
invalid-paramsarray | null
statusinteger
titlestring
typestring
{
"detail": "string",
"invalid-params": [
{
"name": "string",
"reason": "string"
}
],
"status": 0,
"title": "string",
"type": "string"
}

422

Unprocessable Content

detailstring | null
invalid-paramsarray | null
statusinteger
titlestring
typestring
{
"detail": "string",
"invalid-params": [
{
"name": "string",
"reason": "string"
}
],
"status": 0,
"title": "string",
"type": "string"
}