# Dimensions

GET /Dimensions Get all dimensions added to the system

Response status OK (200)

array : DimensionModel
DimensionModel
Property name Data type Description
Uid string

Unique id of dimension

Alias string

Unique alias of dimension

Segments array : DimensionSegmentModel

Segments available to this dimension

DimensionSegmentModel
Property name Data type Description
Uid string

Unique id of segment

Identifier string

Unique human readable identifier for segment

Name string

Display name for segment


PUT /Dimensions Update a dimension in the system

Request parameters

Property name Parameter type Data type Description
model body object : DimensionModel

Updated dimension

DimensionModel
Property name Data type Description
Uid string

Unique id of dimension

Alias string

Unique alias of dimension

Segments array : DimensionSegmentModel

Segments available to this dimension

DimensionSegmentModel
Property name Data type Description
Uid string

Unique id of segment

Identifier string

Unique human readable identifier for segment

Name string

Display name for segment

Response status OK (200)

No body message is returned

POST /Dimensions Add dimension to system

Request parameters

Property name Parameter type Data type Description
model body object : DimensionModel

Dimension to add

DimensionModel
Property name Data type Description
Uid string

Unique id of dimension

Alias string

Unique alias of dimension

Segments array : DimensionSegmentModel

Segments available to this dimension

DimensionSegmentModel
Property name Data type Description
Uid string

Unique id of segment

Identifier string

Unique human readable identifier for segment

Name string

Display name for segment

Response status OK (200)

object : DimensionModel
DimensionModel
Property name Data type Description
Uid string

Unique id of dimension

Alias string

Unique alias of dimension

Segments array : DimensionSegmentModel

Segments available to this dimension

DimensionSegmentModel
Property name Data type Description
Uid string

Unique id of segment

Identifier string

Unique human readable identifier for segment

Name string

Display name for segment


DELETE /Dimensions Delete a dimension in the system

Request parameters

Property name Parameter type Data type Description
uid query string

Uid of dimension

Response status OK (200)

No body message is returned

GET /Dimensions/{uid} Get a specific dimension in the system

Request parameters

Property name Parameter type Data type Description
uid path string

Uid of dimension

Response status OK (200)

object : DimensionModel
DimensionModel
Property name Data type Description
Uid string

Unique id of dimension

Alias string

Unique alias of dimension

Segments array : DimensionSegmentModel

Segments available to this dimension

DimensionSegmentModel
Property name Data type Description
Uid string

Unique id of segment

Identifier string

Unique human readable identifier for segment

Name string

Display name for segment