Property definitions

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
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
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
PreviousCopyNextReorder

Was this helpful?