Skip to main content
API docs by Redocly

OData Service for namespace Default (1.0.1)

Download OpenAPI specification:Download

This OData service is located at https://api.elfsquad.io/data/1

AssociatedFeatureProperties.AssociatedFeatureProperty

Get entities from AssociatedFeatureProperties

query Parameters
$top
integer >= 0
Example: $top=50

Show only the first n items

$skip
integer >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique
Items Enum: "featurePropertyId" "featurePropertyId desc" "featureId" "featureId desc" "id" "id desc" "createdDate" "createdDate desc" "updatedDate" "updatedDate desc" "organizationId" "organizationId desc" "reference" "reference desc" "creatorId" "creatorId desc" "customField1" "customField1 desc" "customField2" "customField2 desc" "customField3" "customField3 desc" "customField4" "customField4 desc" "customField5" "customField5 desc"

Order items by property values

$select
Array of strings unique
Items Enum: "featurePropertyId" "featureId" "id" "createdDate" "updatedDate" "organizationId" "reference" "creatorId" "customField1" "customField2" "customField3" "customField4" "customField5" "feature"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "*" "feature"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Add new entity to AssociatedFeatureProperties

Request Body schema: application/json

New entity

featurePropertyId
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
featureId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
createdDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
updatedDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
organizationId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
reference
string or null
creatorId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
customField1
string or null
customField2
string or null
customField3
string or null
customField4
string or null
customField5
string or null
(Feature (object or null))

Responses

Request samples

Content type
application/json
{
  • "featurePropertyId": "e9c4f4e3-f6f2-4365-9812-52e9cf65ce46",
  • "featureId": "317f79d2-08bf-4d22-9731-b2b5e1f0a085",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "reference": "string",
  • "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "customField4": "string",
  • "customField5": "string",
  • "feature": {
    }
}

Response samples

Content type
application/json
{
  • "featurePropertyId": "e9c4f4e3-f6f2-4365-9812-52e9cf65ce46",
  • "featureId": "317f79d2-08bf-4d22-9731-b2b5e1f0a085",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "reference": "string",
  • "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "customField4": "string",
  • "customField5": "string",
  • "feature": {
    }
}

Get entity from AssociatedFeatureProperties by key

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

key: id of AssociatedFeatureProperty

query Parameters
$select
Array of strings unique
Items Enum: "featurePropertyId" "featureId" "id" "createdDate" "updatedDate" "organizationId" "reference" "creatorId" "customField1" "customField2" "customField3" "customField4" "customField5" "feature"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "*" "feature"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "featurePropertyId": "e9c4f4e3-f6f2-4365-9812-52e9cf65ce46",
  • "featureId": "317f79d2-08bf-4d22-9731-b2b5e1f0a085",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "reference": "string",
  • "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "customField4": "string",
  • "customField5": "string",
  • "feature": {
    }
}

Update entity in AssociatedFeatureProperties

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

key: id of AssociatedFeatureProperty

Request Body schema: application/json

New property values

featurePropertyId
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
featureId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
createdDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
updatedDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
organizationId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
reference
string or null
creatorId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
customField1
string or null
customField2
string or null
customField3
string or null
customField4
string or null
customField5
string or null
(Feature (object or null))

Responses

Request samples

Content type
application/json
{
  • "featurePropertyId": "e9c4f4e3-f6f2-4365-9812-52e9cf65ce46",
  • "featureId": "317f79d2-08bf-4d22-9731-b2b5e1f0a085",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "reference": "string",
  • "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "customField4": "string",
  • "customField5": "string",
  • "feature": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from AssociatedFeatureProperties

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

key: id of AssociatedFeatureProperty

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

AssociatedFeatureProperties.Feature

Get feature from AssociatedFeatureProperties

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

key: id of AssociatedFeatureProperty

query Parameters
$select
Array of strings unique
Items Enum: "name" "articleCode" "type" "salesPrice" "disallowDiscount" "minValue" "maxValue" "stepValue" "packingUnit" "categoryId" "marginPct" "cardImageUrl" "vatId" "unitOfMeasurementId" "tags" "_subcategoryIds" "id" "createdDate" "updatedDate" "organizationId" "reference" "creatorId" "customField1" "customField2" "customField3" "customField4" "customField5" "category"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "*" "category"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "articleCode": "string",
  • "type": "Feature",
  • "salesPrice": 0,
  • "disallowDiscount": true,
  • "minValue": 0,
  • "maxValue": 0,
  • "stepValue": 0,
  • "packingUnit": 0,
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "marginPct": 0,
  • "cardImageUrl": "string",
  • "vatId": "3e4ef591-ea53-40db-9338-be7a122b5f73",
  • "unitOfMeasurementId": "723ea4a6-5172-425f-bb6e-d77ed17fd021",
  • "tags": [
    ],
  • "_subcategoryIds": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "reference": "string",
  • "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "customField4": "string",
  • "customField5": "string",
  • "category": {
    }
}

Get ref of feature from AssociatedFeatureProperties

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

key: id of AssociatedFeatureProperty

Responses

Response samples

Content type
application/json
"string"

Update the ref of navigation property feature in AssociatedFeatureProperties

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

key: id of AssociatedFeatureProperty

Request Body schema: application/json

New navigation property ref values

String

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete ref of navigation property feature for AssociatedFeatureProperties

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

key: id of AssociatedFeatureProperty

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

AssociatedFeatureProperties.Actions

Invoke action BulkDelete

Request Body schema: application/json

Action parameters

identifiers
Array of strings <uuid>

Responses

Request samples

Content type
application/json
{
  • "identifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invoke action BulkInsert

Request Body schema: application/json

Action parameters

Array of objects (AssociatedFeatureProperty)
Array
featurePropertyId
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
featureId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
createdDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
updatedDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
organizationId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
reference
string or null
creatorId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
customField1
string or null
customField2
string or null
customField3
string or null
customField4
string or null
customField5
string or null
(Feature (object or null))

Responses

Request samples

Content type
application/json
{
  • "entities": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invoke action BulkUpdate

Request Body schema: application/json

Action parameters

Array of objects (AssociatedFeatureProperty)
Array
featurePropertyId
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
featureId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
createdDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
updatedDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
organizationId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
reference
string or null
creatorId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
customField1
string or null
customField2
string or null
customField3
string or null
customField4
string or null
customField5
string or null
(Feature (object or null))

Responses

Request samples

Content type
application/json
{
  • "entities": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

CameraPositions.CameraPosition

Get entities from CameraPositions

query Parameters
$top
integer >= 0
Example: $top=50

Show only the first n items

$skip
integer >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique
Items Enum: "state" "state desc" "featureModelNodeId" "featureModelNodeId desc" "stepId" "stepId desc" "id" "id desc" "createdDate" "createdDate desc" "updatedDate" "updatedDate desc" "organizationId" "organizationId desc" "reference" "reference desc" "creatorId" "creatorId desc" "customField1" "customField1 desc" "customField2" "customField2 desc" "customField3" "customField3 desc" "customField4" "customField4 desc" "customField5" "customField5 desc"

Order items by property values

$select
Array of strings unique
Items Enum: "state" "featureModelNodeId" "stepId" "id" "createdDate" "updatedDate" "organizationId" "reference" "creatorId" "customField1" "customField2" "customField3" "customField4" "customField5"

Select properties to be returned

$expand
Array of strings unique
Items Value: "*"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Add new entity to CameraPositions

Request Body schema: application/json

New entity

state
string or null
featureModelNodeId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
stepId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
createdDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
updatedDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
organizationId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
reference
string or null
creatorId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
customField1
string or null
customField2
string or null
customField3
string or null
customField4
string or null
customField5
string or null

Responses

Request samples

Content type
application/json
{
  • "state": "string",
  • "featureModelNodeId": "fd1b88e2-396c-47dc-aac2-ee7e5b668f17",
  • "stepId": "50e29fb7-490e-4a88-b2f4-2fde4d70423d",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "reference": "string",
  • "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "customField4": "string",
  • "customField5": "string"
}

Response samples

Content type
application/json
{
  • "state": "string",
  • "featureModelNodeId": "fd1b88e2-396c-47dc-aac2-ee7e5b668f17",
  • "stepId": "50e29fb7-490e-4a88-b2f4-2fde4d70423d",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "reference": "string",
  • "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "customField4": "string",
  • "customField5": "string"
}

Get entity from CameraPositions by key

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

key: id of CameraPosition

query Parameters
$select
Array of strings unique
Items Enum: "state" "featureModelNodeId" "stepId" "id" "createdDate" "updatedDate" "organizationId" "reference" "creatorId" "customField1" "customField2" "customField3" "customField4" "customField5"

Select properties to be returned

$expand
Array of strings unique
Items Value: "*"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "state": "string",
  • "featureModelNodeId": "fd1b88e2-396c-47dc-aac2-ee7e5b668f17",
  • "stepId": "50e29fb7-490e-4a88-b2f4-2fde4d70423d",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "reference": "string",
  • "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "customField4": "string",
  • "customField5": "string"
}

Update entity in CameraPositions

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

key: id of CameraPosition

Request Body schema: application/json

New property values

state
string or null
featureModelNodeId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
stepId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
createdDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
updatedDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
organizationId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
reference
string or null
creatorId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
customField1
string or null
customField2
string or null
customField3
string or null
customField4
string or null
customField5
string or null

Responses

Request samples

Content type
application/json
{
  • "state": "string",
  • "featureModelNodeId": "fd1b88e2-396c-47dc-aac2-ee7e5b668f17",
  • "stepId": "50e29fb7-490e-4a88-b2f4-2fde4d70423d",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "reference": "string",
  • "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "customField4": "string",
  • "customField5": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from CameraPositions

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

key: id of CameraPosition

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

CameraPositions.Actions

Invoke action BulkDelete

Request Body schema: application/json

Action parameters

identifiers
Array of strings <uuid>

Responses

Request samples

Content type
application/json
{
  • "identifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invoke action BulkInsert

Request Body schema: application/json

Action parameters

Array of objects (CameraPosition)
Array
state
string or null
featureModelNodeId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
stepId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
createdDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
updatedDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
organizationId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
reference
string or null
creatorId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
customField1
string or null
customField2
string or null
customField3
string or null
customField4
string or null
customField5
string or null

Responses

Request samples

Content type
application/json
{
  • "entities": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invoke action BulkUpdate

Request Body schema: application/json

Action parameters

Array of objects (CameraPosition)
Array
state
string or null
featureModelNodeId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
stepId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
createdDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
updatedDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
organizationId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
reference
string or null
creatorId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
customField1
string or null
customField2
string or null
customField3
string or null
customField4
string or null
customField5
string or null

Responses

Request samples

Content type
application/json
{
  • "entities": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Categories.Category

Get entities from Categories

query Parameters
$top
integer >= 0
Example: $top=50

Show only the first n items

$skip
integer >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique
Items Enum: "name" "name desc" "parentId" "parentId desc" "order" "order desc" "id" "id desc" "createdDate" "createdDate desc" "updatedDate" "updatedDate desc" "organizationId" "organizationId desc" "reference" "reference desc" "creatorId" "creatorId desc" "customField1" "customField1 desc" "customField2" "customField2 desc" "customField3" "customField3 desc" "customField4" "customField4 desc" "customField5" "customField5 desc"

Order items by property values

$select
Array of strings unique
Items Enum: "name" "parentId" "order" "id" "createdDate" "updatedDate" "organizationId" "reference" "creatorId" "customField1" "customField2" "customField3" "customField4" "customField5"

Select properties to be returned

$expand
Array of strings unique
Items Value: "*"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Add new entity to Categories

Request Body schema: application/json

New entity

name
string or null
parentId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
order
integer <int32> [ -2147483648 .. 2147483647 ]
id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
createdDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
updatedDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
organizationId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
reference
string or null
creatorId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
customField1
string or null
customField2
string or null
customField3
string or null
customField4
string or null
customField5
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "order": -2147483648,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "reference": "string",
  • "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "customField4": "string",
  • "customField5": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "order": -2147483648,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "reference": "string",
  • "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "customField4": "string",
  • "customField5": "string"
}

Get entity from Categories by key

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

key: id of Category

query Parameters
$select
Array of strings unique
Items Enum: "name" "parentId" "order" "id" "createdDate" "updatedDate" "organizationId" "reference" "creatorId" "customField1" "customField2" "customField3" "customField4" "customField5"

Select properties to be returned

$expand
Array of strings unique
Items Value: "*"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "order": -2147483648,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "reference": "string",
  • "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "customField4": "string",
  • "customField5": "string"
}

Update entity in Categories

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

key: id of Category

Request Body schema: application/json

New property values

name
string or null
parentId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
order
integer <int32> [ -2147483648 .. 2147483647 ]
id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
createdDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
updatedDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
organizationId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
reference
string or null
creatorId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
customField1
string or null
customField2
string or null
customField3
string or null
customField4
string or null
customField5
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "order": -2147483648,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "reference": "string",
  • "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "customField4": "string",
  • "customField5": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from Categories

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

key: id of Category

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Categories.Actions

Invoke action BulkDelete

Request Body schema: application/json

Action parameters

identifiers
Array of strings <uuid>

Responses

Request samples

Content type
application/json
{
  • "identifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invoke action BulkInsert

Request Body schema: application/json

Action parameters

Array of objects (Category)
Array
name
string or null
parentId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
order
integer <int32> [ -2147483648 .. 2147483647 ]
id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
createdDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
updatedDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
organizationId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
reference
string or null
creatorId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
customField1
string or null
customField2
string or null
customField3
string or null
customField4
string or null
customField5
string or null

Responses

Request samples

Content type
application/json
{
  • "entities": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invoke action BulkUpdate

Request Body schema: application/json

Action parameters

Array of objects (Category)
Array
name
string or null
parentId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
order
integer <int32> [ -2147483648 .. 2147483647 ]
id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
createdDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
updatedDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
organizationId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
reference
string or null
creatorId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
customField1
string or null
customField2
string or null
customField3
string or null
customField4
string or null
customField5
string or null

Responses

Request samples

Content type
application/json
{
  • "entities": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

CategoryTexts.CategoryText

Get entities from CategoryTexts

query Parameters
$top
integer >= 0
Example: $top=50

Show only the first n items

$skip
integer >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique
Items Enum: "value" "value desc" "languageIso" "languageIso desc" "categoryId" "categoryId desc" "id" "id desc" "createdDate" "createdDate desc" "updatedDate" "updatedDate desc" "organizationId" "organizationId desc" "reference" "reference desc" "creatorId" "creatorId desc" "customField1" "customField1 desc" "customField2" "customField2 desc" "customField3" "customField3 desc" "customField4" "customField4 desc" "customField5" "customField5 desc"

Order items by property values

$select
Array of strings unique
Items Enum: "value" "languageIso" "categoryId" "id" "createdDate" "updatedDate" "organizationId" "reference" "creatorId" "customField1" "customField2" "customField3" "customField4" "customField5"

Select properties to be returned

$expand
Array of strings unique
Items Value: "*"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Add new entity to CategoryTexts

Request Body schema: application/json

New entity

value
string or null
languageIso
string or null <= 3 characters
categoryId
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
createdDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
updatedDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
organizationId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
reference
string or null
creatorId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
customField1
string or null
customField2
string or null
customField3
string or null
customField4
string or null
customField5
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "languageIso": "str",
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "reference": "string",
  • "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "customField4": "string",
  • "customField5": "string"
}

Response samples

Content type
application/json
{
  • "value": "string",
  • "languageIso": "str",
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "reference": "string",
  • "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "customField4": "string",
  • "customField5": "string"
}

Get entity from CategoryTexts by key

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

key: id of CategoryText

query Parameters
$select
Array of strings unique
Items Enum: "value" "languageIso" "categoryId" "id" "createdDate" "updatedDate" "organizationId" "reference" "creatorId" "customField1" "customField2" "customField3" "customField4" "customField5"

Select properties to be returned

$expand
Array of strings unique
Items Value: "*"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": "string",
  • "languageIso": "str",
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "reference": "string",
  • "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "customField4": "string",
  • "customField5": "string"
}

Update entity in CategoryTexts

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

key: id of CategoryText

Request Body schema: application/json

New property values

value
string or null
languageIso
string or null <= 3 characters
categoryId
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
createdDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
updatedDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
organizationId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
reference
string or null
creatorId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
customField1
string or null
customField2
string or null
customField3
string or null
customField4
string or null
customField5
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "languageIso": "str",
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "reference": "string",
  • "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "customField4": "string",
  • "customField5": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from CategoryTexts

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

key: id of CategoryText

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

CategoryTexts.Actions

Invoke action BulkDelete

Request Body schema: application/json

Action parameters

identifiers
Array of strings <uuid>

Responses

Request samples

Content type
application/json
{
  • "identifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invoke action BulkInsert

Request Body schema: application/json

Action parameters

Array of objects (CategoryText)
Array
value
string or null
languageIso
string or null <= 3 characters
categoryId
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
createdDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
updatedDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
organizationId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
reference
string or null
creatorId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
customField1
string or null
customField2
string or null
customField3
string or null
customField4
string or null
customField5
string or null

Responses

Request samples

Content type
application/json
{
  • "entities": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invoke action BulkUpdate

Request Body schema: application/json

Action parameters

Array of objects (CategoryText)
Array
value
string or null
languageIso
string or null <= 3 characters
categoryId
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
createdDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
updatedDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
organizationId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
reference
string or null
creatorId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
customField1
string or null
customField2
string or null
customField3
string or null
customField4
string or null
customField5
string or null

Responses

Request samples

Content type
application/json
{
  • "entities": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Configurations.Configuration

Get entities from Configurations

query Parameters
$top
integer >= 0
Example: $top=50

Show only the first n items

$skip
integer >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique
Items Enum: "code" "code desc" "currencyIso" "currencyIso desc" "languageIso" "languageIso desc" "preview" "preview desc" "featureModelId" "featureModelId desc" "featureModelVersion" "featureModelVersion desc" "id" "id desc" "createdDate" "createdDate desc" "updatedDate" "updatedDate desc" "organizationId" "organizationId desc" "reference" "reference desc" "creatorId" "creatorId desc" "customField1" "customField1 desc" "customField2" "customField2 desc" "customField3" "customField3 desc" "customField4" "customField4 desc" "customField5" "customField5 desc"

Order items by property values

$select
Array of strings unique
Items Enum: "code" "currencyIso" "languageIso" "preview" "featureModelId" "featureModelVersion" "id" "createdDate" "updatedDate" "organizationId" "reference" "creatorId" "customField1" "customField2" "customField3" "customField4" "customField5"

Select properties to be returned

$expand
Array of strings unique
Items Value: "*"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Add new entity to Configurations

Request Body schema: application/json

New entity

code
string or null
currencyIso
string or null
languageIso
string or null
preview
boolean
featureModelId
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
featureModelVersion
integer <int32> [ -2147483648 .. 2147483647 ]
id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
createdDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
updatedDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
organizationId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
reference
string or null
creatorId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
customField1
string or null
customField2
string or null
customField3
string or null
customField4
string or null
customField5
string or null

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "currencyIso": "string",
  • "languageIso": "string",
  • "preview": true,
  • "featureModelId": "dca67d0e-800b-4b38-bcd8-52fb8456a446",
  • "featureModelVersion": -2147483648,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "reference": "string",
  • "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "customField4": "string",
  • "customField5": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "currencyIso": "string",
  • "languageIso": "string",
  • "preview": true,
  • "featureModelId": "dca67d0e-800b-4b38-bcd8-52fb8456a446",
  • "featureModelVersion": -2147483648,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "reference": "string",
  • "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "customField4": "string",
  • "customField5": "string"
}

Get entity from Configurations by key

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

key: id of Configuration

query Parameters
$select
Array of strings unique
Items Enum: "code" "currencyIso" "languageIso" "preview" "featureModelId" "featureModelVersion" "id" "createdDate" "updatedDate" "organizationId" "reference" "creatorId" "customField1" "customField2" "customField3" "customField4" "customField5"

Select properties to be returned

$expand
Array of strings unique
Items Value: "*"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "currencyIso": "string",
  • "languageIso": "string",
  • "preview": true,
  • "featureModelId": "dca67d0e-800b-4b38-bcd8-52fb8456a446",
  • "featureModelVersion": -2147483648,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "reference": "string",
  • "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "customField4": "string",
  • "customField5": "string"
}

Update entity in Configurations

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

key: id of Configuration

Request Body schema: application/json

New property values

code
string or null
currencyIso
string or null
languageIso
string or null
preview
boolean
featureModelId
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
featureModelVersion
integer <int32> [ -2147483648 .. 2147483647 ]
id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
createdDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
updatedDate
string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
organizationId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
reference
string or null
creatorId
string or null <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
customField1
string or null
customField2
string or null
customField3
string or null
customField4
string or null
customField5
string or null

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "currencyIso": "string",
  • "languageIso": "string",
  • "preview": true,
  • "featureModelId": "dca67d0e-800b-4b38-bcd8-52fb8456a446",
  • "featureModelVersion": -2147483648,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "reference": "string",
  • "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "customField4": "string",
  • "customField5": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from Configurations

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

key: id of Configuration

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Countries.Country

Get entities from Countries

query Parameters
$top
integer >= 0
Example: $top=50

Show only the first n items

$skip
integer >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique
Items Enum: "iso" "iso desc" "name" "name desc" "active" "active desc" "englishName" "englishName desc" "phonePrefix" "phonePrefix desc" "capital" "capital desc"

Order items by property values

$select
Array of strings unique
Items Enum: "iso" "name" "active" "englishName" "phonePrefix" "capital"

Select properties to be returned

$expand
Array of strings unique
Items Value: "*"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Add new entity to Countries

Request Body schema: application/json

New entity

iso
string
name
string or null
active
boolean
englishName
string or null
phonePrefix
string or null
capital
string or null

Responses

Request samples

Content type
application/json
{
  • "iso": "string",
  • "name": "string",
  • "active": true,
  • "englishName": "string",
  • "phonePrefix": "string",
  • "capital": "string"
}

Response samples

Content type
application/json
{
  • "iso": "string",
  • "name": "string",
  • "active": true,
  • "englishName": "string",
  • "phonePrefix": "string",
  • "capital": "string"
}

Get entity from Countries by key

path Parameters
iso
required
string

key: iso of Country

query Parameters
$select
Array of strings unique
Items Enum: "iso" "name" "active" "englishName" "phonePrefix" "capital"

Select properties to be returned

$expand
Array of strings unique
Items Value: "*"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "iso": "string",
  • "name": "string",
  • "active": true,
  • "englishName": "string",
  • "phonePrefix": "string",
  • "capital": "string"
}

Update entity in Countries

path Parameters
iso
required
string

key: iso of Country

Request Body schema: application/json

New property values

iso
string
name
string or null
active
boolean
englishName
string or null
phonePrefix
string or null
capital
string or null

Responses

Request samples

Content type
application/json
{
  • "iso": "string",
  • "name": "string",
  • "active": true,
  • "englishName": "string",
  • "phonePrefix": "string",
  • "capital": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from Countries

path Parameters
iso
required
string

key: iso of Country

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

CrmAccountProperties.CrmAccountProperty

Get entities from CrmAccountProperties

query Parameters
$top
integer >= 0
Example: $top=50

Show only the first n items

$skip
integer >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique
Items Enum: "description" "description desc" "isRequired" "isRequired desc" "isReadonly" "isReadonly desc" "type" "type desc" "order" "order desc" "id" "id desc" "createdDate" "createdDate desc" "updatedDate" "updatedDate desc" "organizationId" "organizationId desc" "reference" "reference desc" "creatorId" "creatorId desc" "customField1" "customField1 desc" "customField2" "customField2 desc" "customField3" "customField3 desc" "customField4" "customField4 desc" "customField5" "customField5 desc"

Order items by property values

$select
Array of strings unique
Items Enum: "description" "isRequired" "isReadonly" "type" "order" "id" "createdDate" "updatedDate" "organizationId" "reference" "creatorId" "customField1" "customField2" "customField3" "customField4" "customField5"

Select properties to be returned

$expand
Array of strings unique
Items Value: "*"