Workspace

get

Authorizations

Query parameters

filtersstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/workspace' \
  --header 'x-api-key: YOUR_API_KEY'

200

403

200

{
  "id": "text",
  "label": "text",
  "rootBlock": "text",
  "createdAt": "2025-04-03T06:12:07.159Z",
  "updatedAt": "2025-04-03T06:12:07.159Z",
  "createdBy": "text",
  "blocks": [
    "text"
  ],
  "propertyDefinitions": [
    "text"
  ],
  "propertyInstances": [
    "text"
  ],
  "attachments": [
    "text"
  ],
  "statusDefinitions": [
    "text"
  ],
  "statusInstances": [
    "text"
  ],
  "statusOptions": [
    "text"
  ],
  "requirementsPages": [
    "text"
  ],
  "requirementBlocks": [
    "text"
  ],
  "reports": [
    "text"
  ],
  "reportBlocks": [
    "text"
  ],
  "attributes": [
    "text"
  ],
  "interfaces": [
    "text"
  ],
  "bomTables": [
    "text"
  ],
  "bomColumns": [
    "text"
  ],
  "codeBlocks": [
    "text"
  ],
  "codeInputs": [
    "text"
  ],
  "codeOutputs": [
    "text"
  ]
}

post

Authorizations

Body

idstring · default: "1c8a9171-67a8-45b7-ac2f-1e0b9b0ad9ad"optional

labelstringrequired

publicCanReadEnabledbooleanoptional

currentWorkspaceVersionstring · default: "2ed1cc49-a15f-4c61-8d68-e8e0001af62c"optional

exportsEnabledbooleanoptional

guestsEnabledbooleanoptional

statusesstring[]optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/workspace' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "label": "text",
    "publicCanReadEnabled": true,
    "currentWorkspaceVersion": "text",
    "exportsEnabled": true,
    "guestsEnabled": true,
    "statuses": [
      "text"
    ]
  }'

201

403

201

{
  "id": "text",
  "label": "text",
  "rootBlock": "text",
  "createdAt": "2025-04-03T06:12:07.159Z",
  "updatedAt": "2025-04-03T06:12:07.159Z",
  "createdBy": "text",
  "blocks": [
    "text"
  ],
  "propertyDefinitions": [
    "text"
  ],
  "propertyInstances": [
    "text"
  ],
  "attachments": [
    "text"
  ],
  "statusDefinitions": [
    "text"
  ],
  "statusInstances": [
    "text"
  ],
  "statusOptions": [
    "text"
  ],
  "requirementsPages": [
    "text"
  ],
  "requirementBlocks": [
    "text"
  ],
  "reports": [
    "text"
  ],
  "reportBlocks": [
    "text"
  ],
  "attributes": [
    "text"
  ],
  "interfaces": [
    "text"
  ],
  "bomTables": [
    "text"
  ],
  "bomColumns": [
    "text"
  ],
  "codeBlocks": [
    "text"
  ],
  "codeInputs": [
    "text"
  ],
  "codeOutputs": [
    "text"
  ]
}

The record has been successfully created.

get

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/workspace/{id}' \
  --header 'x-api-key: YOUR_API_KEY'

200

403

200

{
  "id": "text",
  "label": "text",
  "rootBlock": "text",
  "createdAt": "2025-04-03T06:12:07.159Z",
  "updatedAt": "2025-04-03T06:12:07.159Z",
  "createdBy": "text",
  "blocks": [
    "text"
  ],
  "propertyDefinitions": [
    "text"
  ],
  "propertyInstances": [
    "text"
  ],
  "attachments": [
    "text"
  ],
  "statusDefinitions": [
    "text"
  ],
  "statusInstances": [
    "text"
  ],
  "statusOptions": [
    "text"
  ],
  "requirementsPages": [
    "text"
  ],
  "requirementBlocks": [
    "text"
  ],
  "reports": [
    "text"
  ],
  "reportBlocks": [
    "text"
  ],
  "attributes": [
    "text"
  ],
  "interfaces": [
    "text"
  ],
  "bomTables": [
    "text"
  ],
  "bomColumns": [
    "text"
  ],
  "codeBlocks": [
    "text"
  ],
  "codeInputs": [
    "text"
  ],
  "codeOutputs": [
    "text"
  ]
}

delete

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/v1/workspace/{id}' \
  --header 'x-api-key: YOUR_API_KEY'

200

403

200

{
  "id": "text",
  "label": "text",
  "rootBlock": "text",
  "createdAt": "2025-04-03T06:12:07.159Z",
  "updatedAt": "2025-04-03T06:12:07.159Z",
  "createdBy": "text",
  "blocks": [
    "text"
  ],
  "propertyDefinitions": [
    "text"
  ],
  "propertyInstances": [
    "text"
  ],
  "attachments": [
    "text"
  ],
  "statusDefinitions": [
    "text"
  ],
  "statusInstances": [
    "text"
  ],
  "statusOptions": [
    "text"
  ],
  "requirementsPages": [
    "text"
  ],
  "requirementBlocks": [
    "text"
  ],
  "reports": [
    "text"
  ],
  "reportBlocks": [
    "text"
  ],
  "attributes": [
    "text"
  ],
  "interfaces": [
    "text"
  ],
  "bomTables": [
    "text"
  ],
  "bomColumns": [
    "text"
  ],
  "codeBlocks": [
    "text"
  ],
  "codeInputs": [
    "text"
  ],
  "codeOutputs": [
    "text"
  ]
}

patch

Authorizations

Path parameters

idstringrequired

Body

rootBlockobjectoptional

labelstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/v1/workspace/{id}' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "rootBlock": {},
    "label": "text"
  }'

200

403

200

{
  "id": "text",
  "label": "text",
  "rootBlock": "text",
  "createdAt": "2025-04-03T06:12:07.159Z",
  "updatedAt": "2025-04-03T06:12:07.159Z",
  "createdBy": "text",
  "blocks": [
    "text"
  ],
  "propertyDefinitions": [
    "text"
  ],
  "propertyInstances": [
    "text"
  ],
  "attachments": [
    "text"
  ],
  "statusDefinitions": [
    "text"
  ],
  "statusInstances": [
    "text"
  ],
  "statusOptions": [
    "text"
  ],
  "requirementsPages": [
    "text"
  ],
  "requirementBlocks": [
    "text"
  ],
  "reports": [
    "text"
  ],
  "reportBlocks": [
    "text"
  ],
  "attributes": [
    "text"
  ],
  "interfaces": [
    "text"
  ],
  "bomTables": [
    "text"
  ],
  "bomColumns": [
    "text"
  ],
  "codeBlocks": [
    "text"
  ],
  "codeInputs": [
    "text"
  ],
  "codeOutputs": [
    "text"
  ]
}