Workspace
Was this helpful?
Was this helpful?
curl -L \
--url '/v1/workspace' \
--header 'x-api-key: YOUR_API_KEY'
{
"id": "text",
"label": "text",
"rootBlock": "text",
"createdAt": "2025-03-20T17:11:19.624Z",
"updatedAt": "2025-03-20T17:11:19.624Z",
"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"
]
}
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"
]
}'
{
"id": "text",
"label": "text",
"rootBlock": "text",
"createdAt": "2025-03-20T17:11:19.624Z",
"updatedAt": "2025-03-20T17:11:19.624Z",
"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.
curl -L \
--url '/v1/workspace/{id}' \
--header 'x-api-key: YOUR_API_KEY'
{
"id": "text",
"label": "text",
"rootBlock": "text",
"createdAt": "2025-03-20T17:11:19.624Z",
"updatedAt": "2025-03-20T17:11:19.624Z",
"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"
]
}
curl -L \
--request DELETE \
--url '/v1/workspace/{id}' \
--header 'x-api-key: YOUR_API_KEY'
{
"id": "text",
"label": "text",
"rootBlock": "text",
"createdAt": "2025-03-20T17:11:19.624Z",
"updatedAt": "2025-03-20T17:11:19.624Z",
"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"
]
}
curl -L \
--request PATCH \
--url '/v1/workspace/{id}' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"rootBlock": {},
"label": "text"
}'
{
"id": "text",
"label": "text",
"rootBlock": "text",
"createdAt": "2025-03-20T17:11:19.624Z",
"updatedAt": "2025-03-20T17:11:19.624Z",
"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"
]
}