Property definitions

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

Path parameters

workspaceId*string

Header parameters

Response

200

Request

JavaScriptCurlPython

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

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

Path parameters

workspaceId*string

Header parameters

Body

application/json

idstring

labelstring

descriptionstring

unitstring

dataTypestring

autoRollupChildrenboolean

defaultPropertyGroupstring

autoAddboolean

Response

201

Request

JavaScriptCurlPython

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

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

Path parameters

workspaceId*string

id*string

Header parameters

Response

200

Request

JavaScriptCurlPython

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

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

Path parameters

workspaceId*string

id*string

Header parameters

Response

200

Request

JavaScriptCurlPython

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

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

Path parameters

workspaceId*string

id*string

Header parameters

Body

application/json

idstring

labelstring

descriptionstring

unitstring

dataTypestring

autoRollupChildrenboolean

defaultPropertyGroupstring

autoAddboolean

uncertaintyTypenullable enum

relativeabsolute

uncertaintySymmetrynullable enum

symmetricalasymmetrical

changeJustificationstring

Response

200

Request

JavaScriptCurlPython

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