Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

Update Workspace

PATCH
/taxonomy/v1/organisations/{organisation}/workspaces/{id}
 
curl --request PATCH \
  --url https://example.com/taxonomy/v1/organisations/example/workspaces/example \
  --header 'Content-Type: application/json' \
  --data '{ "group_id": "example", "name": "example" }'

Updates an existing workspace

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
organisation
required
string

The organisation the workspace belongs to

id
required
string

The unique identifier of the workspace to update

Query Parameters

Section titled “Query Parameters ”
update_mask
string format: field-mask

The set of fields to update. If omitted, all mutable fields are overwritten. See AIP-134 for field mask semantics.

Request Body required

Section titled “Request Body required ”
Media type application/json

Workspace resource — the resource isolation boundary for all platform services

object
id

The unique identifier of the workspace

stringOutput only
organisation_id

The organisation this workspace belongs to

stringOutput only
group_id

Optional group (folder) the workspace is placed in. An IAM binding scoped to that group automatically covers this workspace.

string
name
required

The display name of the workspace

string
created

Created Timestamp

The timestamp when the workspace was created

string format: date-time Output only
updated

Updated Timestamp

Timestamp when the Workspace was last updated

string format: date-time Output only
Example generated
{
  "group_id": "example",
  "name": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Workspace Operation

An acknowledgment of a mutation request, carrying tracking metadata, errors, and warnings. Follows GCP’s Operations pattern (AIP-151).

object
id

Operation ID

Unique identifier for this operation.

stringOutput only
resource_id

Resource ID

The ID of the resource affected by this operation. May be empty for async operations where the resource does not yet exist.

stringOutput only
resource_type

Resource Type

The type of resource (e.g., “Group”, “Organisation”, “Workspace”).

stringOutput only
operation_type

Operation Type

The kind of mutation that was requested.

string format: enum Output only
Allowed values: TAXONOMY_OPERATION_TYPE_UNSPECIFIED TAXONOMY_OPERATION_TYPE_CREATE TAXONOMY_OPERATION_TYPE_UPDATE TAXONOMY_OPERATION_TYPE_DELETE TAXONOMY_OPERATION_TYPE_MOVE
status

Status

Current lifecycle state of the operation.

string format: enum Output only
Allowed values: TAXONOMY_OPERATION_STATUS_UNSPECIFIED TAXONOMY_OPERATION_STATUS_PENDING TAXONOMY_OPERATION_STATUS_RUNNING TAXONOMY_OPERATION_STATUS_DONE TAXONOMY_OPERATION_STATUS_ERROR
insert_time

Insert Time

When the operation was first created.

string format: date-time Output only
start_time

Start Time

When the operation started executing.

string format: date-time Output only
end_time

End Time

When the operation completed (either successfully or with errors).

string format: date-time Output only
errors

Errors

Business rule errors encountered during the operation.

Array<object>Output only

Operation Error

A structured error returned inside an operation when a business rule fails.

object
code

Error Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only
description

Description

Human-readable explanation of the error.

stringOutput only
warnings

Warnings

Non-fatal notices about the operation.

Array<object>Output only

Operation Warning

A non-fatal notice attached to an operation.

object
code

Warning Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only
description

Description

Human-readable explanation of the warning.

stringOutput only
progress

Progress

Percentage of completion (0-100).

integer format: int32 Output only
Example 
{
  "operation_type": "TAXONOMY_OPERATION_TYPE_UNSPECIFIED",
  "status": "TAXONOMY_OPERATION_STATUS_UNSPECIFIED"
}

default

Section titled “default ”

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}