Property instances

GET/v1/workspace/{workspaceId}/property-instances

Path parameters

workspaceId*string

Header parameters

Response

200403

Body

application/json

id*string

workspaceId*string

orderIndex*number

descriptionstring

lockedboolean

valuestring

parentBlockId*string

propertyGroupstring

lowerBoundUncertainty*number

upperBoundUncertainty*number

propertyDefinition*ResponsePropertyDefinitionsRto (object)

parentBlockResponseBlockRto (object)

pathstring

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "id": "text",
    "workspaceId": "text",
    "orderIndex": 0,
    "description": "text",
    "locked": false,
    "value": "text",
    "parentBlockId": "text",
    "propertyGroup": "text",
    "lowerBoundUncertainty": 0,
    "upperBoundUncertainty": 0,
    "propertyDefinition": {
      "id": "text",
      "workspaceId": "text",
      "orderIndex": 0,
      "label": "text",
      "description": "text",
      "descriptionLastUpdatedBy": "text",
      "unit": "text",
      "dataType": "text",
      "autoRollupChildren": false,
      "defaultPropertyGroup": "text",
      "autoAdd": false
    },
    "parentBlock": {
      "id": "text",
      "label": "text",
      "description": "text",
      "parentBlock": "text",
      "multiplicity": 0,
      "children": [
        "text"
      ],
      "pdmEnabled": false,
      "propertyGroups": [
        "text"
      ],
      "previewCustomLink": "text",
      "previewSource": "text",
      "figures": [
        "text"
      ],
      "icon": "text",
      "interfaces": [
        "text"
      ],
      "attachments": [
        "text"
      ],
      "externalLinks": [
        "text"
      ],
      "pdmThumbnail": "text",
      "blockStatuses": [
        "text"
      ],
      "orderIndex": 0,
      "path": "text",
      "type": [
        "text"
      ]
    },
    "path": "text"
  }
]

POST/v1/workspace/{workspaceId}/property-instances

Path parameters

workspaceId*string

Header parameters

Body

application/json

idstring

propertyDefinition*string

descriptionstring

lockedboolean

valuestring

parentBlock*string

propertyGroupstring

Response

201403

Body

application/json

id*string

workspaceId*string

orderIndex*number

descriptionstring

lockedboolean

valuestring

parentBlockId*string

propertyGroupstring

lowerBoundUncertainty*number

upperBoundUncertainty*number

propertyDefinition*ResponsePropertyDefinitionsRto (object)

parentBlockResponseBlockRto (object)

pathstring

Request

JavaScriptCurlPython

const response = await fetch('/v1/workspace/{workspaceId}/property-instances', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "propertyDefinition": "df8c6292-3c51-4f1a-8cf8-86fd8b54cf09",
      "parentBlock": "83f12015-c265-40d9-b001-45f250fd4ea6"
    }),
});
const data = await response.json();

Response

201

{
  "id": "text",
  "workspaceId": "text",
  "orderIndex": 0,
  "description": "text",
  "locked": false,
  "value": "text",
  "parentBlockId": "text",
  "propertyGroup": "text",
  "lowerBoundUncertainty": 0,
  "upperBoundUncertainty": 0,
  "propertyDefinition": {
    "id": "text",
    "workspaceId": "text",
    "orderIndex": 0,
    "label": "text",
    "description": "text",
    "descriptionLastUpdatedBy": "text",
    "unit": "text",
    "dataType": "text",
    "autoRollupChildren": false,
    "defaultPropertyGroup": "text",
    "autoAdd": false
  },
  "parentBlock": {
    "id": "text",
    "label": "text",
    "description": "text",
    "parentBlock": "text",
    "multiplicity": 0,
    "children": [
      "text"
    ],
    "pdmEnabled": false,
    "propertyGroups": [
      "text"
    ],
    "previewCustomLink": "text",
    "previewSource": "text",
    "figures": [
      "text"
    ],
    "icon": "text",
    "interfaces": [
      "text"
    ],
    "attachments": [
      "text"
    ],
    "externalLinks": [
      "text"
    ],
    "pdmThumbnail": "text",
    "blockStatuses": [
      "text"
    ],
    "orderIndex": 0,
    "path": "text",
    "type": [
      "text"
    ]
  },
  "path": "text"
}

GET/v1/workspace/{workspaceId}/property-instances/{id}

Path parameters

workspaceId*string

id*string

Header parameters

Response

200403

Body

application/json

id*string

workspaceId*string

orderIndex*number

descriptionstring

lockedboolean

valuestring

parentBlockId*string

propertyGroupstring

lowerBoundUncertainty*number

upperBoundUncertainty*number

propertyDefinition*ResponsePropertyDefinitionsRto (object)

parentBlockResponseBlockRto (object)

pathstring

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "workspaceId": "text",
  "orderIndex": 0,
  "description": "text",
  "locked": false,
  "value": "text",
  "parentBlockId": "text",
  "propertyGroup": "text",
  "lowerBoundUncertainty": 0,
  "upperBoundUncertainty": 0,
  "propertyDefinition": {
    "id": "text",
    "workspaceId": "text",
    "orderIndex": 0,
    "label": "text",
    "description": "text",
    "descriptionLastUpdatedBy": "text",
    "unit": "text",
    "dataType": "text",
    "autoRollupChildren": false,
    "defaultPropertyGroup": "text",
    "autoAdd": false
  },
  "parentBlock": {
    "id": "text",
    "label": "text",
    "description": "text",
    "parentBlock": "text",
    "multiplicity": 0,
    "children": [
      "text"
    ],
    "pdmEnabled": false,
    "propertyGroups": [
      "text"
    ],
    "previewCustomLink": "text",
    "previewSource": "text",
    "figures": [
      "text"
    ],
    "icon": "text",
    "interfaces": [
      "text"
    ],
    "attachments": [
      "text"
    ],
    "externalLinks": [
      "text"
    ],
    "pdmThumbnail": "text",
    "blockStatuses": [
      "text"
    ],
    "orderIndex": 0,
    "path": "text",
    "type": [
      "text"
    ]
  },
  "path": "text"
}

DELETE/v1/workspace/{workspaceId}/property-instances/{id}

Path parameters

workspaceId*string

id*string

Header parameters

Response

200403

Body

application/json

id*string

workspaceId*string

orderIndex*number

descriptionstring

lockedboolean

valuestring

parentBlockId*string

propertyGroupstring

lowerBoundUncertainty*number

upperBoundUncertainty*number

propertyDefinition*ResponsePropertyDefinitionsRto (object)

parentBlockResponseBlockRto (object)

pathstring

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "workspaceId": "text",
  "orderIndex": 0,
  "description": "text",
  "locked": false,
  "value": "text",
  "parentBlockId": "text",
  "propertyGroup": "text",
  "lowerBoundUncertainty": 0,
  "upperBoundUncertainty": 0,
  "propertyDefinition": {
    "id": "text",
    "workspaceId": "text",
    "orderIndex": 0,
    "label": "text",
    "description": "text",
    "descriptionLastUpdatedBy": "text",
    "unit": "text",
    "dataType": "text",
    "autoRollupChildren": false,
    "defaultPropertyGroup": "text",
    "autoAdd": false
  },
  "parentBlock": {
    "id": "text",
    "label": "text",
    "description": "text",
    "parentBlock": "text",
    "multiplicity": 0,
    "children": [
      "text"
    ],
    "pdmEnabled": false,
    "propertyGroups": [
      "text"
    ],
    "previewCustomLink": "text",
    "previewSource": "text",
    "figures": [
      "text"
    ],
    "icon": "text",
    "interfaces": [
      "text"
    ],
    "attachments": [
      "text"
    ],
    "externalLinks": [
      "text"
    ],
    "pdmThumbnail": "text",
    "blockStatuses": [
      "text"
    ],
    "orderIndex": 0,
    "path": "text",
    "type": [
      "text"
    ]
  },
  "path": "text"
}

PATCH/v1/workspace/{workspaceId}/property-instances/{id}

Path parameters

workspaceId*string

id*string

Header parameters

Body

application/json

idstring

propertyDefinitionstring

descriptionstring

lockedboolean

valuestring

parentBlockstring

propertyGroupstring

lowerBoundUncertaintynumber

upperBoundUncertaintynumber

changeJustificationstring

Response

200403

Body

application/json

id*string

workspaceId*string

orderIndex*number

descriptionstring

lockedboolean

valuestring

parentBlockId*string

propertyGroupstring

lowerBoundUncertainty*number

upperBoundUncertainty*number

propertyDefinition*ResponsePropertyDefinitionsRto (object)

parentBlockResponseBlockRto (object)

pathstring

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "workspaceId": "text",
  "orderIndex": 0,
  "description": "text",
  "locked": false,
  "value": "text",
  "parentBlockId": "text",
  "propertyGroup": "text",
  "lowerBoundUncertainty": 0,
  "upperBoundUncertainty": 0,
  "propertyDefinition": {
    "id": "text",
    "workspaceId": "text",
    "orderIndex": 0,
    "label": "text",
    "description": "text",
    "descriptionLastUpdatedBy": "text",
    "unit": "text",
    "dataType": "text",
    "autoRollupChildren": false,
    "defaultPropertyGroup": "text",
    "autoAdd": false
  },
  "parentBlock": {
    "id": "text",
    "label": "text",
    "description": "text",
    "parentBlock": "text",
    "multiplicity": 0,
    "children": [
      "text"
    ],
    "pdmEnabled": false,
    "propertyGroups": [
      "text"
    ],
    "previewCustomLink": "text",
    "previewSource": "text",
    "figures": [
      "text"
    ],
    "icon": "text",
    "interfaces": [
      "text"
    ],
    "attachments": [
      "text"
    ],
    "externalLinks": [
      "text"
    ],
    "pdmThumbnail": "text",
    "blockStatuses": [
      "text"
    ],
    "orderIndex": 0,
    "path": "text",
    "type": [
      "text"
    ]
  },
  "path": "text"
}