Workspace

GET/v1/workspace

Authorization

Public API Key

Query parameters

Response

200403

Body

application/json

id*string

label*string

rootBlock*string

createdAt*string (date-time)

updatedAt*string (date-time)

createdBy*string

blocksarray of string

propertyDefinitionsarray of string

propertyInstancesarray of string

attachmentsarray of string

statusDefinitionsarray of string

statusInstancesarray of string

statusOptionsarray of string

requirementsPagesarray of string

requirementBlocksarray of string

reportsarray of string

reportBlocksarray of string

attributesarray of string

interfacesarray of string

bomTablesarray of string

bomColumnsarray of string

codeBlocksarray of string

codeInputsarray of string

codeOutputsarray of string

Request

JavaScriptCurlPython

const response = await fetch('/v1/workspace', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "label": "text",
  "rootBlock": "text",
  "createdAt": "2024-12-21T12:10:51.669Z",
  "updatedAt": "2024-12-21T12:10:51.669Z",
  "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/v1/workspace

Authorization

Public API Key

Body

application/json

idstring

label*string

publicCanReadEnabledboolean

currentWorkspaceVersionstring

exportsEnabledboolean

guestsEnabledboolean

statusesarray of string

Response

201403

The record has been successfully created.

Body

application/json

id*string

label*string

rootBlock*string

createdAt*string (date-time)

updatedAt*string (date-time)

createdBy*string

blocksarray of string

propertyDefinitionsarray of string

propertyInstancesarray of string

attachmentsarray of string

statusDefinitionsarray of string

statusInstancesarray of string

statusOptionsarray of string

requirementsPagesarray of string

requirementBlocksarray of string

reportsarray of string

reportBlocksarray of string

attributesarray of string

interfacesarray of string

bomTablesarray of string

bomColumnsarray of string

codeBlocksarray of string

codeInputsarray of string

codeOutputsarray of string

Request

JavaScriptCurlPython

const response = await fetch('/v1/workspace', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "label": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": "text",
  "label": "text",
  "rootBlock": "text",
  "createdAt": "2024-12-21T12:10:51.669Z",
  "updatedAt": "2024-12-21T12:10:51.669Z",
  "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"
  ]
}

GET/v1/workspace/{id}

Authorization

Public API Key

Path parameters

id*string

Response

200403

Body

application/json

id*string

label*string

rootBlock*string

createdAt*string (date-time)

updatedAt*string (date-time)

createdBy*string

blocksarray of string

propertyDefinitionsarray of string

propertyInstancesarray of string

attachmentsarray of string

statusDefinitionsarray of string

statusInstancesarray of string

statusOptionsarray of string

requirementsPagesarray of string

requirementBlocksarray of string

reportsarray of string

reportBlocksarray of string

attributesarray of string

interfacesarray of string

bomTablesarray of string

bomColumnsarray of string

codeBlocksarray of string

codeInputsarray of string

codeOutputsarray of string

Request

JavaScriptCurlPython

const response = await fetch('/v1/workspace/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "label": "text",
  "rootBlock": "text",
  "createdAt": "2024-12-21T12:10:51.669Z",
  "updatedAt": "2024-12-21T12:10:51.669Z",
  "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/v1/workspace/{id}

Authorization

Public API Key

Path parameters

id*string

Response

200403

Body

application/json

id*string

label*string

rootBlock*string

createdAt*string (date-time)

updatedAt*string (date-time)

createdBy*string

blocksarray of string

propertyDefinitionsarray of string

propertyInstancesarray of string

attachmentsarray of string

statusDefinitionsarray of string

statusInstancesarray of string

statusOptionsarray of string

requirementsPagesarray of string

requirementBlocksarray of string

reportsarray of string

reportBlocksarray of string

attributesarray of string

interfacesarray of string

bomTablesarray of string

bomColumnsarray of string

codeBlocksarray of string

codeInputsarray of string

codeOutputsarray of string

Request

JavaScriptCurlPython

const response = await fetch('/v1/workspace/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "label": "text",
  "rootBlock": "text",
  "createdAt": "2024-12-21T12:10:51.669Z",
  "updatedAt": "2024-12-21T12:10:51.669Z",
  "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/v1/workspace/{id}

Authorization

Public API Key

Path parameters

id*string

Body

application/json

rootBlockBlock (object)

labelstring

Response

200403

Body

application/json

id*string

label*string

rootBlock*string

createdAt*string (date-time)

updatedAt*string (date-time)

createdBy*string

blocksarray of string

propertyDefinitionsarray of string

propertyInstancesarray of string

attachmentsarray of string

statusDefinitionsarray of string

statusInstancesarray of string

statusOptionsarray of string

requirementsPagesarray of string

requirementBlocksarray of string

reportsarray of string

reportBlocksarray of string

attributesarray of string

interfacesarray of string

bomTablesarray of string

bomColumnsarray of string

codeBlocksarray of string

codeInputsarray of string

codeOutputsarray of string

Request

JavaScriptCurlPython

const response = await fetch('/v1/workspace/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "label": "text",
  "rootBlock": "text",
  "createdAt": "2024-12-21T12:10:51.669Z",
  "updatedAt": "2024-12-21T12:10:51.669Z",
  "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"
  ]
}