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 definitions

PreviousCopyNextReorder

Was this helpful?

get

/v1/workspace/{workspaceId}/property-definitions

Path parameters
workspaceIdstringrequired
Header parameters
x-api-keystring

An x-api-key required for authentication

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/workspace/{workspaceId}/property-definitions'
200
No body
post

/v1/workspace/{workspaceId}/property-definitions

Path parameters
workspaceIdstringrequired
Header parameters
x-api-keystring

An x-api-key required for authentication

Body
idstring · default: a20e8887-c2e0-4e2b-a5c2-a7ac2e581789
labelstring
descriptionstring
unitstring
dataTypestring
autoRollupChildrenboolean
defaultPropertyGroupstring
autoAddboolean
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/v1/workspace/{workspaceId}/property-definitions' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "a20e8887-c2e0-4e2b-a5c2-a7ac2e581789",
    "label": "text",
    "description": "text",
    "unit": "text",
    "dataType": "text",
    "autoRollupChildren": true,
    "defaultPropertyGroup": "text",
    "autoAdd": true
  }'
201
No body
get

/v1/workspace/{workspaceId}/property-definitions/{id}

Path parameters
workspaceIdstringrequired
idstringrequired
Header parameters
x-api-keystring

An x-api-key required for authentication

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/workspace/{workspaceId}/property-definitions/{id}'
200
No body
delete

/v1/workspace/{workspaceId}/property-definitions/{id}

Path parameters
workspaceIdstringrequired
idstringrequired
Header parameters
x-api-keystring

An x-api-key required for authentication

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url '/v1/workspace/{workspaceId}/property-definitions/{id}'
200
No body
patch

/v1/workspace/{workspaceId}/property-definitions/{id}

Path parameters
workspaceIdstringrequired
idstringrequired
Header parameters
x-api-keystring

An x-api-key required for authentication

Body
idstring · default: a20e8887-c2e0-4e2b-a5c2-a7ac2e581789
labelstring
descriptionstring
unitstring
dataTypestring
autoRollupChildrenboolean
defaultPropertyGroupstring
autoAddboolean
changeJustificationstring
uncertaintyTypestring · enum | nullable
Options: relative, absolute
uncertaintySymmetrystring · enum | nullable
Options: symmetrical, asymmetrical
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request PATCH \
  --url '/v1/workspace/{workspaceId}/property-definitions/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "a20e8887-c2e0-4e2b-a5c2-a7ac2e581789",
    "label": "text",
    "description": "text",
    "unit": "text",
    "dataType": "text",
    "autoRollupChildren": true,
    "defaultPropertyGroup": "text",
    "autoAdd": true,
    "changeJustification": "text",
    "uncertaintyType": "relative",
    "uncertaintySymmetry": "symmetrical"
  }'
200
No body
  • GET/v1/workspace/{workspaceId}/property-definitions
  • POST/v1/workspace/{workspaceId}/property-definitions
  • GET/v1/workspace/{workspaceId}/property-definitions/{id}
  • DELETE/v1/workspace/{workspaceId}/property-definitions/{id}
  • PATCH/v1/workspace/{workspaceId}/property-definitions/{id}