LogoLogo
  • About
  • Quick Start
  • API reference
    • Workspace
      • Dependencies
      • Copy
      • Property definitions
        • Reorder
      • Property instances
        • Reorder
        • Lock
        • Unlock
      • Blocks
      • Comments
        • Parent
      • Data Sinks
    • Webhooks
      • Rotate secret
    • Cloud storage
      • Redirect
      • Thumbnail
      • Upload complete
      • Retry conversion
      • Download
      • Upload link
      • Version list
      • Metadata
Powered by GitBook
On this page

Was this helpful?

  1. API reference
  2. Workspace

Blocks

PreviousUnlockNextComments

Was this helpful?

get
Path parameters
workspaceIdstringRequired
idstringRequired
Header parameters
x-api-keystringOptional

An x-api-key required for authentication

Responses
200Success
application/json
403
Forbidden.
get
GET /v1/workspace/{workspaceId}/blocks/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "label": "text",
  "description": "text",
  "parentBlock": "text",
  "multiplicity": 1,
  "children": [
    "text"
  ],
  "pdmEnabled": true,
  "propertyGroups": [
    "text"
  ],
  "previewCustomLink": "text",
  "previewSource": "text",
  "figures": [
    "text"
  ],
  "icon": "text",
  "interfaces": [
    "text"
  ],
  "attachments": [
    "text"
  ],
  "externalLinks": [
    "text"
  ],
  "pdmThumbnail": "text",
  "blockStatuses": [
    "text"
  ],
  "orderIndex": 1,
  "path": "text",
  "type": [
    "text"
  ]
}
delete
Path parameters
workspaceIdstringRequired
idstringRequired
Header parameters
x-api-keystringOptional

An x-api-key required for authentication

Responses
200Success
application/json
403
Forbidden.
delete
DELETE /v1/workspace/{workspaceId}/blocks/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "label": "text",
  "description": "text",
  "parentBlock": "text",
  "multiplicity": 1,
  "children": [
    "text"
  ],
  "pdmEnabled": true,
  "propertyGroups": [
    "text"
  ],
  "previewCustomLink": "text",
  "previewSource": "text",
  "figures": [
    "text"
  ],
  "icon": "text",
  "interfaces": [
    "text"
  ],
  "attachments": [
    "text"
  ],
  "externalLinks": [
    "text"
  ],
  "pdmThumbnail": "text",
  "blockStatuses": [
    "text"
  ],
  "orderIndex": 1,
  "path": "text",
  "type": [
    "text"
  ]
}
  • GET/v1/workspace/{workspaceId}/blocks
  • POST/v1/workspace/{workspaceId}/blocks
  • GET/v1/workspace/{workspaceId}/blocks/{id}
  • DELETE/v1/workspace/{workspaceId}/blocks/{id}
  • PATCH/v1/workspace/{workspaceId}/blocks/{id}
get
Path parameters
workspaceIdstringRequired
Header parameters
x-api-keystringOptional

An x-api-key required for authentication

Responses
200Success
application/json
403
Forbidden.
get
GET /v1/workspace/{workspaceId}/blocks HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "label": "text",
  "description": "text",
  "parentBlock": "text",
  "multiplicity": 1,
  "children": [
    "text"
  ],
  "pdmEnabled": true,
  "propertyGroups": [
    "text"
  ],
  "previewCustomLink": "text",
  "previewSource": "text",
  "figures": [
    "text"
  ],
  "icon": "text",
  "interfaces": [
    "text"
  ],
  "attachments": [
    "text"
  ],
  "externalLinks": [
    "text"
  ],
  "pdmThumbnail": "text",
  "blockStatuses": [
    "text"
  ],
  "orderIndex": 1,
  "path": "text",
  "type": [
    "text"
  ]
}
post
Path parameters
workspaceIdstringRequired
Header parameters
x-api-keystringOptional

An x-api-key required for authentication

Body
idstringOptionalDefault: 91cf8043-cc9b-4c40-ba19-0f9ecb111085
labelstringOptional
descriptionstringOptional
partNumberstringOptional
parentBlockstringOptionalDefault: 939d9fe2-2746-41a6-9a2e-3f6fb3386bde
multiplicitynumberOptional
pdmEnabledbooleanOptional
propertyGroupsstring[]OptionalDefault: 154b6052-c858-4635-a720-25477b32a6a9
instancesstring[]OptionalDefault: c20b3c96-6158-4c74-914a-77ac9d5b2323
previewCustomLinkstringOptional
previewSourcestringOptional
figuresstring[]Optional
iconstringOptional
typestring[]Optional
attachmentsstring[]Optional
externalLinksstring[]Optional
pdmThumbnailstringOptional
blockStatusesstring[]Optional
workspacestringRequiredDefault: 58e7b5af-bab5-4ae2-bd5c-6bb011766978
Responses
201
The record has been successfully created.
application/json
403
Forbidden.
post
POST /v1/workspace/{workspaceId}/blocks HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 541

{
  "id": "91cf8043-cc9b-4c40-ba19-0f9ecb111085",
  "label": "text",
  "description": "text",
  "partNumber": "text",
  "parentBlock": "939d9fe2-2746-41a6-9a2e-3f6fb3386bde",
  "multiplicity": 1,
  "pdmEnabled": true,
  "propertyGroups": "154b6052-c858-4635-a720-25477b32a6a9",
  "instances": "c20b3c96-6158-4c74-914a-77ac9d5b2323",
  "previewCustomLink": "text",
  "previewSource": "text",
  "figures": [
    "text"
  ],
  "icon": "text",
  "type": [
    "text"
  ],
  "attachments": [
    "text"
  ],
  "externalLinks": [
    "text"
  ],
  "pdmThumbnail": "text",
  "blockStatuses": [
    "text"
  ],
  "workspace": "58e7b5af-bab5-4ae2-bd5c-6bb011766978"
}
{
  "id": "text",
  "label": "text",
  "description": "text",
  "parentBlock": "text",
  "multiplicity": 1,
  "children": [
    "text"
  ],
  "pdmEnabled": true,
  "propertyGroups": [
    "text"
  ],
  "previewCustomLink": "text",
  "previewSource": "text",
  "figures": [
    "text"
  ],
  "icon": "text",
  "interfaces": [
    "text"
  ],
  "attachments": [
    "text"
  ],
  "externalLinks": [
    "text"
  ],
  "pdmThumbnail": "text",
  "blockStatuses": [
    "text"
  ],
  "orderIndex": 1,
  "path": "text",
  "type": [
    "text"
  ]
}
patch
Path parameters
workspaceIdstringRequired
idstringRequired
Header parameters
x-api-keystringOptional

An x-api-key required for authentication

Body
typestring[]Optional
Responses
200Success
application/json
403
Forbidden.
patch
PATCH /v1/workspace/{workspaceId}/blocks/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "type": [
    "text"
  ]
}
{
  "type": [
    "text"
  ]
}