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
200Success
application/json
403
Forbidden.
get
GET /v1/workspace/{workspaceId}/property-instances/{id} HTTP/1.1
Host: 
Accept: */*

{
  "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
200Success
application/json
403
Forbidden.
delete
DELETE /v1/workspace/{workspaceId}/property-instances/{id} HTTP/1.1
Host: 
Accept: */*

{
  "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
200Success
application/json
403
Forbidden.
get
GET /v1/workspace/{workspaceId}/property-instances HTTP/1.1
Host: 
Accept: */*

[
  {
    "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
idstringOptionalDefault: 9dc501f4-20aa-43fb-b4c5-f64d4937ef29
propertyDefinitionstringRequiredDefault: df8c6292-3c51-4f1a-8cf8-86fd8b54cf09
descriptionstringOptional
lockedbooleanOptional
valuestringOptional
parentBlockstringRequiredDefault: 83f12015-c265-40d9-b001-45f250fd4ea6
propertyGroupstringOptionalDefault: b052d79a-1ab9-4e85-b460-86ffaceb27cb
Responses
201Success
application/json
403
Forbidden.
post
POST /v1/workspace/{workspaceId}/property-instances HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 263

{
  "id": "9dc501f4-20aa-43fb-b4c5-f64d4937ef29",
  "propertyDefinition": "df8c6292-3c51-4f1a-8cf8-86fd8b54cf09",
  "description": "text",
  "locked": true,
  "value": "text",
  "parentBlock": "83f12015-c265-40d9-b001-45f250fd4ea6",
  "propertyGroup": "b052d79a-1ab9-4e85-b460-86ffaceb27cb"
}
{
  "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
idstringOptionalDefault: 9dc501f4-20aa-43fb-b4c5-f64d4937ef29
propertyDefinitionstringOptionalDefault: df8c6292-3c51-4f1a-8cf8-86fd8b54cf09
descriptionstringOptional
lockedbooleanOptional
valuestringOptional
parentBlockstringOptionalDefault: 83f12015-c265-40d9-b001-45f250fd4ea6
propertyGroupstringOptionalDefault: b052d79a-1ab9-4e85-b460-86ffaceb27cb
lowerBoundUncertaintynumberOptional
upperBoundUncertaintynumberOptional
changeJustificationstringOptional
Responses
200Success
application/json
403
Forbidden.
patch
PATCH /v1/workspace/{workspaceId}/property-instances/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 344

{
  "id": "9dc501f4-20aa-43fb-b4c5-f64d4937ef29",
  "propertyDefinition": "df8c6292-3c51-4f1a-8cf8-86fd8b54cf09",
  "description": "text",
  "locked": true,
  "value": "text",
  "parentBlock": "83f12015-c265-40d9-b001-45f250fd4ea6",
  "propertyGroup": "b052d79a-1ab9-4e85-b460-86ffaceb27cb",
  "lowerBoundUncertainty": 1,
  "upperBoundUncertainty": 1,
  "changeJustification": "text"
}
{
  "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"
}