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

Property instances

PreviousReorderNextReorder

Was this helpful?

get
Path parameters
workspaceIdstringrequired
idstringrequired
Header parameters
x-api-keystringoptional

An x-api-key required for authentication

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/workspace/{workspaceId}/property-instances/{id}'
200
403
{
  "id": "text",
  "workspaceId": "text",
  "orderIndex": 1,
  "description": "text",
  "locked": true,
  "value": "text",
  "parentBlockId": "text",
  "propertyGroup": "text",
  "lowerBoundUncertainty": 1,
  "upperBoundUncertainty": 1,
  "propertyDefinition": {
    "id": "text",
    "workspaceId": "text",
    "orderIndex": 1,
    "label": "text",
    "description": "text",
    "descriptionLastUpdatedBy": "text",
    "unit": "text",
    "dataType": "text",
    "autoRollupChildren": true,
    "defaultPropertyGroup": "text",
    "autoAdd": true
  },
  "parentBlock": {
    "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"
    ]
  },
  "path": "text"
}
delete
Path parameters
workspaceIdstringrequired
idstringrequired
Header parameters
x-api-keystringoptional

An x-api-key required for authentication

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url '/v1/workspace/{workspaceId}/property-instances/{id}'
200
403
{
  "id": "text",
  "workspaceId": "text",
  "orderIndex": 1,
  "description": "text",
  "locked": true,
  "value": "text",
  "parentBlockId": "text",
  "propertyGroup": "text",
  "lowerBoundUncertainty": 1,
  "upperBoundUncertainty": 1,
  "propertyDefinition": {
    "id": "text",
    "workspaceId": "text",
    "orderIndex": 1,
    "label": "text",
    "description": "text",
    "descriptionLastUpdatedBy": "text",
    "unit": "text",
    "dataType": "text",
    "autoRollupChildren": true,
    "defaultPropertyGroup": "text",
    "autoAdd": true
  },
  "parentBlock": {
    "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"
    ]
  },
  "path": "text"
}
  • GET/v1/workspace/{workspaceId}/property-instances
  • POST/v1/workspace/{workspaceId}/property-instances
  • GET/v1/workspace/{workspaceId}/property-instances/{id}
  • DELETE/v1/workspace/{workspaceId}/property-instances/{id}
  • PATCH/v1/workspace/{workspaceId}/property-instances/{id}
get
Path parameters
workspaceIdstringrequired
Header parameters
x-api-keystringoptional

An x-api-key required for authentication

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/workspace/{workspaceId}/property-instances'
200
403
[
  {
    "id": "text",
    "workspaceId": "text",
    "orderIndex": 1,
    "description": "text",
    "locked": true,
    "value": "text",
    "parentBlockId": "text",
    "propertyGroup": "text",
    "lowerBoundUncertainty": 1,
    "upperBoundUncertainty": 1,
    "propertyDefinition": {
      "id": "text",
      "workspaceId": "text",
      "orderIndex": 1,
      "label": "text",
      "description": "text",
      "descriptionLastUpdatedBy": "text",
      "unit": "text",
      "dataType": "text",
      "autoRollupChildren": true,
      "defaultPropertyGroup": "text",
      "autoAdd": true
    },
    "parentBlock": {
      "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"
      ]
    },
    "path": "text"
  }
]
post
Path parameters
workspaceIdstringrequired
Header parameters
x-api-keystringoptional

An x-api-key required for authentication

Body
idstring · default: "9dc501f4-20aa-43fb-b4c5-f64d4937ef29"optional
propertyDefinitionstring · default: "df8c6292-3c51-4f1a-8cf8-86fd8b54cf09"required
descriptionstringoptional
lockedbooleanoptional
valuestringoptional
parentBlockstring · default: "83f12015-c265-40d9-b001-45f250fd4ea6"required
propertyGroupstring · default: "b052d79a-1ab9-4e85-b460-86ffaceb27cb"optional
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/v1/workspace/{workspaceId}/property-instances' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "propertyDefinition": "text",
    "description": "text",
    "locked": true,
    "value": "text",
    "parentBlock": "text",
    "propertyGroup": "text"
  }'
201
403
{
  "id": "text",
  "workspaceId": "text",
  "orderIndex": 1,
  "description": "text",
  "locked": true,
  "value": "text",
  "parentBlockId": "text",
  "propertyGroup": "text",
  "lowerBoundUncertainty": 1,
  "upperBoundUncertainty": 1,
  "propertyDefinition": {
    "id": "text",
    "workspaceId": "text",
    "orderIndex": 1,
    "label": "text",
    "description": "text",
    "descriptionLastUpdatedBy": "text",
    "unit": "text",
    "dataType": "text",
    "autoRollupChildren": true,
    "defaultPropertyGroup": "text",
    "autoAdd": true
  },
  "parentBlock": {
    "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"
    ]
  },
  "path": "text"
}
patch
Path parameters
workspaceIdstringrequired
idstringrequired
Header parameters
x-api-keystringoptional

An x-api-key required for authentication

Body
idstring · default: "9dc501f4-20aa-43fb-b4c5-f64d4937ef29"optional
propertyDefinitionstring · default: "df8c6292-3c51-4f1a-8cf8-86fd8b54cf09"optional
descriptionstringoptional
lockedbooleanoptional
valuestringoptional
parentBlockstring · default: "83f12015-c265-40d9-b001-45f250fd4ea6"optional
propertyGroupstring · default: "b052d79a-1ab9-4e85-b460-86ffaceb27cb"optional
lowerBoundUncertaintynumberoptional
upperBoundUncertaintynumberoptional
changeJustificationstringoptional
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request PATCH \
  --url '/v1/workspace/{workspaceId}/property-instances/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "propertyDefinition": "text",
    "description": "text",
    "locked": true,
    "value": "text",
    "parentBlock": "text",
    "propertyGroup": "text",
    "lowerBoundUncertainty": 1,
    "upperBoundUncertainty": 1,
    "changeJustification": "text"
  }'
200
403
{
  "id": "text",
  "workspaceId": "text",
  "orderIndex": 1,
  "description": "text",
  "locked": true,
  "value": "text",
  "parentBlockId": "text",
  "propertyGroup": "text",
  "lowerBoundUncertainty": 1,
  "upperBoundUncertainty": 1,
  "propertyDefinition": {
    "id": "text",
    "workspaceId": "text",
    "orderIndex": 1,
    "label": "text",
    "description": "text",
    "descriptionLastUpdatedBy": "text",
    "unit": "text",
    "dataType": "text",
    "autoRollupChildren": true,
    "defaultPropertyGroup": "text",
    "autoAdd": true
  },
  "parentBlock": {
    "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"
    ]
  },
  "path": "text"
}