Blocks

get

/v1/workspace/{workspaceId}/blocks

Path parameters

workspaceIdstringrequired

Header parameters

x-api-keystring

An x-api-key required for authentication

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/workspace/{workspaceId}/blocks'

200

403

200

{
  "id": "text",
  "label": "text",
  "description": "text",
  "parentBlock": "text",
  "multiplicity": 1,
  "pdmEnabled": true,
  "previewCustomLink": "text",
  "previewSource": "text",
  "icon": "text",
  "pdmThumbnail": "text",
  "orderIndex": 1,
  "path": "text",
  "children": [
    "text"
  ],
  "propertyGroups": [
    "text"
  ],
  "figures": [
    "text"
  ],
  "interfaces": [
    "text"
  ],
  "attachments": [
    "text"
  ],
  "externalLinks": [
    "text"
  ],
  "blockStatuses": [
    "text"
  ],
  "type": [
    "text"
  ]
}

post

/v1/workspace/{workspaceId}/blocks

Path parameters

workspaceIdstringrequired

Header parameters

x-api-keystring

An x-api-key required for authentication

Body

idstring · default: 91cf8043-cc9b-4c40-ba19-0f9ecb111085

labelstring

descriptionstring

partNumberstring

parentBlockstring · default: 939d9fe2-2746-41a6-9a2e-3f6fb3386bde

multiplicitynumber

pdmEnabledboolean

previewCustomLinkstring

previewSourcestring

iconstring

pdmThumbnailstring

workspacestring · default: 58e7b5af-bab5-4ae2-bd5c-6bb011766978required

propertyGroupsstring[] · default: 154b6052-c858-4635-a720-25477b32a6a9

instancesstring[] · default: c20b3c96-6158-4c74-914a-77ac9d5b2323

figuresstring[]

typestring[]

attachmentsstring[]

externalLinksstring[]

blockStatusesstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/workspace/{workspaceId}/blocks' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "91cf8043-cc9b-4c40-ba19-0f9ecb111085",
    "label": "text",
    "description": "text",
    "partNumber": "text",
    "parentBlock": "939d9fe2-2746-41a6-9a2e-3f6fb3386bde",
    "multiplicity": 1,
    "pdmEnabled": true,
    "previewCustomLink": "text",
    "previewSource": "text",
    "icon": "text",
    "pdmThumbnail": "text",
    "workspace": "58e7b5af-bab5-4ae2-bd5c-6bb011766978",
    "propertyGroups": "154b6052-c858-4635-a720-25477b32a6a9",
    "instances": "c20b3c96-6158-4c74-914a-77ac9d5b2323",
    "figures": [
      "text"
    ],
    "type": [
      "text"
    ],
    "attachments": [
      "text"
    ],
    "externalLinks": [
      "text"
    ],
    "blockStatuses": [
      "text"
    ]
  }'

201

403

201

{
  "id": "text",
  "label": "text",
  "description": "text",
  "parentBlock": "text",
  "multiplicity": 1,
  "pdmEnabled": true,
  "previewCustomLink": "text",
  "previewSource": "text",
  "icon": "text",
  "pdmThumbnail": "text",
  "orderIndex": 1,
  "path": "text",
  "children": [
    "text"
  ],
  "propertyGroups": [
    "text"
  ],
  "figures": [
    "text"
  ],
  "interfaces": [
    "text"
  ],
  "attachments": [
    "text"
  ],
  "externalLinks": [
    "text"
  ],
  "blockStatuses": [
    "text"
  ],
  "type": [
    "text"
  ]
}

The record has been successfully created.

get

/v1/workspace/{workspaceId}/blocks/{id}

Path parameters

workspaceIdstringrequired

idstringrequired

Header parameters

x-api-keystring

An x-api-key required for authentication

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/workspace/{workspaceId}/blocks/{id}'

200

403

200

{
  "id": "text",
  "label": "text",
  "description": "text",
  "parentBlock": "text",
  "multiplicity": 1,
  "pdmEnabled": true,
  "previewCustomLink": "text",
  "previewSource": "text",
  "icon": "text",
  "pdmThumbnail": "text",
  "orderIndex": 1,
  "path": "text",
  "children": [
    "text"
  ],
  "propertyGroups": [
    "text"
  ],
  "figures": [
    "text"
  ],
  "interfaces": [
    "text"
  ],
  "attachments": [
    "text"
  ],
  "externalLinks": [
    "text"
  ],
  "blockStatuses": [
    "text"
  ],
  "type": [
    "text"
  ]
}

delete

/v1/workspace/{workspaceId}/blocks/{id}

Path parameters

workspaceIdstringrequired

idstringrequired

Header parameters

x-api-keystring

An x-api-key required for authentication

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/v1/workspace/{workspaceId}/blocks/{id}'

200

403

200

{
  "id": "text",
  "label": "text",
  "description": "text",
  "parentBlock": "text",
  "multiplicity": 1,
  "pdmEnabled": true,
  "previewCustomLink": "text",
  "previewSource": "text",
  "icon": "text",
  "pdmThumbnail": "text",
  "orderIndex": 1,
  "path": "text",
  "children": [
    "text"
  ],
  "propertyGroups": [
    "text"
  ],
  "figures": [
    "text"
  ],
  "interfaces": [
    "text"
  ],
  "attachments": [
    "text"
  ],
  "externalLinks": [
    "text"
  ],
  "blockStatuses": [
    "text"
  ],
  "type": [
    "text"
  ]
}

patch

/v1/workspace/{workspaceId}/blocks/{id}

Path parameters

workspaceIdstringrequired

idstringrequired

Header parameters

x-api-keystring

An x-api-key required for authentication

Body

typestring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/v1/workspace/{workspaceId}/blocks/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": [
      "text"
    ]
  }'

200

403

200

{
  "type": [
    "text"
  ]
}