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
Path parameters
workspaceIdstringRequired
idstringRequired
Header parameters
x-api-keystringOptional

An x-api-key required for authentication

Responses
200Success
get
GET /v1/workspace/{workspaceId}/property-definitions/{id} HTTP/1.1
Host: 
Accept: */*
200Success
No content
delete
Path parameters
workspaceIdstringRequired
idstringRequired
Header parameters
x-api-keystringOptional

An x-api-key required for authentication

Responses
200Success
delete
DELETE /v1/workspace/{workspaceId}/property-definitions/{id} HTTP/1.1
Host: 
Accept: */*
200Success
No content
  • 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}
get
Path parameters
workspaceIdstringRequired
Header parameters
x-api-keystringOptional

An x-api-key required for authentication

Responses
200Success
get
GET /v1/workspace/{workspaceId}/property-definitions HTTP/1.1
Host: 
Accept: */*
200Success
No content
post
Path parameters
workspaceIdstringRequired
Header parameters
x-api-keystringOptional

An x-api-key required for authentication

Body
idstringOptionalDefault: a20e8887-c2e0-4e2b-a5c2-a7ac2e581789
labelstringOptional
descriptionstringOptional
unitstringOptional
dataTypestringOptional
autoRollupChildrenbooleanOptional
defaultPropertyGroupstringOptional
autoAddbooleanOptional
Responses
201Success
post
POST /v1/workspace/{workspaceId}/property-definitions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 184

{
  "id": "a20e8887-c2e0-4e2b-a5c2-a7ac2e581789",
  "label": "text",
  "description": "text",
  "unit": "text",
  "dataType": "text",
  "autoRollupChildren": true,
  "defaultPropertyGroup": "text",
  "autoAdd": true
}
201Success
No content
patch
Path parameters
workspaceIdstringRequired
idstringRequired
Header parameters
x-api-keystringOptional

An x-api-key required for authentication

Body
idstringOptionalDefault: a20e8887-c2e0-4e2b-a5c2-a7ac2e581789
labelstringOptional
descriptionstringOptional
unitstringOptional
dataTypestringOptional
autoRollupChildrenbooleanOptional
defaultPropertyGroupstringOptional
autoAddbooleanOptional
uncertaintyTypestring · enum | nullableOptionalPossible values:
uncertaintySymmetrystring · enum | nullableOptionalPossible values:
changeJustificationstringOptional
Responses
200Success
patch
PATCH /v1/workspace/{workspaceId}/property-definitions/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 278

{
  "id": "a20e8887-c2e0-4e2b-a5c2-a7ac2e581789",
  "label": "text",
  "description": "text",
  "unit": "text",
  "dataType": "text",
  "autoRollupChildren": true,
  "defaultPropertyGroup": "text",
  "autoAdd": true,
  "uncertaintyType": "relative",
  "uncertaintySymmetry": "symmetrical",
  "changeJustification": "text"
}
200Success
No content