Create Workspace
const url = 'https://example.com/taxonomy/v1/organisations/example/workspaces';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"group_id":"example","name":"example","display_name":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/taxonomy/v1/organisations/example/workspaces \ --header 'Content-Type: application/json' \ --data '{ "group_id": "example", "name": "example", "display_name": "example" }'Creates a new workspace within an organisation
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The organisation to create the workspace in
Request Body required
Section titled “Request Body required ”Workspace resource: the resource isolation boundary for all platform services
object
The unique identifier of the workspace
The organisation this workspace belongs to
Optional group (folder) the workspace is placed in. An IAM binding scoped to that group automatically covers this workspace.
The handle of the workspace, e.g. “prod-eu”. Lowercase letters, digits and hyphens; letter-initial; no adjacent hyphens. Parent-scoped-unique. Used to address the workspace by name or id.
A human-readable label for the workspace, e.g. “Production EU”. Free text in any script. Never used to address the workspace. Optional; defaults to the handle (name) when omitted.
Created Timestamp
The timestamp when the workspace was created
Updated Timestamp
Timestamp when the Workspace was last updated
Lifecycle State
This workspace’s own lifecycle state. Changed only through the lifecycle verbs, never by update.
Effective Lifecycle State
The state this workspace actually experiences, accounting for suspension inherited from its group chain or organisation. A workspace whose own state is active reports an effective state of suspended while any ancestor is suspended. An archived workspace always reports archived.
Archived Timestamp
The instant the workspace entered the archived state. Unset unless the workspace is archived.
State Origin
Whether the current state was set directly on this resource or cascaded from an ancestor. Provenance for audit and display.
Responses
Section titled “ Responses ”OK
Taxonomy Operation
An acknowledgment of a mutation request, carrying tracking metadata, errors, and warnings. Follows GCP’s Operations pattern (AIP-151).
object
Operation ID
Unique identifier for this operation.
Resource ID
The ID of the resource affected by this operation. May be empty for async operations where the resource does not yet exist.
Resource Type
The type of resource (e.g., “com.qibdo.cloud.taxonomy:group”).
Operation Type
The kind of mutation that was requested.
Status
Current lifecycle state of the operation.
Insert Time
When the operation was first created.
Start Time
When the operation started executing.
End Time
When the operation completed (either successfully or with errors).
Errors
Business rule errors encountered during the operation.
Operation Error
A structured error returned inside an operation when a business rule fails.
object
Error Code
Numeric identifier following the S_SSS_EEE convention.
Description
Human-readable explanation of the error.
Reason
Machine-readable error identifier in UPPER_SNAKE form — the same dispatch
key google.rpc.ErrorInfo.reason carries on the synchronous error plane.
Warnings
Non-fatal notices about the operation.
Operation Warning
A non-fatal notice attached to an operation.
object
Warning Code
Numeric identifier following the S_SSS_EEE convention.
Description
Human-readable explanation of the warning.
Progress
Percentage of completion (0-100).
Scope Type
The category of scope the operation ran in or was triggered from. TAXONOMY_SCOPE_TYPE_UNSPECIFIED when the operation is not scoped.
Scope ID
The resource this operation was scoped to — for example, when scope_type is TAXONOMY_SCOPE_TYPE_WORKSPACE this is the workspace id. Empty for TAXONOMY_SCOPE_TYPE_PLATFORM, which has no scoped resource, and when unscoped.
Principal ID
Who performed or triggered the operation, whether a person or a machine account. Always populated: platform-driven work records the reserved system principal, so every audit record names an actor.
Trace ID
W3C trace id, for correlating this operation with the traces and log lines of the request that caused it. Empty when the operation ran with no trace context — a scheduled or event-driven action rather than a request.
Origin
Whether this operation was a direct action or a change cascaded from an ancestor’s suspend or resume.
Caused By Operation
For a cascaded (indirect) operation, the id of the direct operation that triggered the cascade. Empty for direct operations.
Example
{ "operation_type": "TAXONOMY_OPERATION_TYPE_UNSPECIFIED", "status": "TAXONOMY_OPERATION_STATUS_UNSPECIFIED", "scope_type": "TAXONOMY_SCOPE_TYPE_UNSPECIFIED", "origin": "TAXONOMY_STATE_CHANGE_ORIGIN_UNSPECIFIED"}default
Section titled “default ”Default error response
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
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
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.
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
object
The type of the serialized message.
Example generated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}