# Dimensions
GET /Dimensions Get all dimensions added to the system
[
{
"Uid": "ad285601-b244-41b7-b552-43537f667a8e",
"Alias": "Dimension 1",
"Segments": [
{
"Uid": "81997ec7-76f0-425b-920f-ff293ec363e5",
"Identifier": "Dimension 1 segment 1",
"Name": "Dimension 1 segment 1"
},
{
"Uid": "ba527ce2-ce8f-494d-9f1d-d8903c788b36",
"Identifier": "Dimension 1 segment 2",
"Name": "Dimension 1 segment 2"
}
]
},
{
"Uid": "edb4831f-f6c2-4e5d-a15d-323361e54db2",
"Alias": "Dimension 2",
"Segments": [
{
"Uid": "608aa45c-3921-4755-8584-fe3f801e5d5b",
"Identifier": "Dimension 2 segment 1",
"Name": "Dimension 2 segment 1"
},
{
"Uid": "30ae0dea-8424-4ad5-82ca-d681c3100779",
"Identifier": "Dimension 2 segment 2",
"Name": "Dimension 2 segment 2"
}
]
},
{
"Uid": "eeffed02-4d54-4d55-a567-b5630e16ad1b",
"Alias": "Dimension 3",
"Segments": [
{
"Uid": "e395a1a8-3cd8-4821-8170-9beceb6e0014",
"Identifier": "Dimension 3 segment 1",
"Name": "Dimension 3 segment 1"
},
{
"Uid": "14d52d18-55a0-4458-a3d0-5361051d2e79",
"Identifier": "Dimension 3 segment 2",
"Name": "Dimension 3 segment 2"
}
]
}
]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
{
"Uid": "998d52c1-8b43-45cd-938c-c210400d7631",
"Alias": "Dimension 1",
"Segments": [
{
"Uid": "6328e553-4a7d-49ce-89fc-a9464dffbfac",
"Identifier": "Dimension 1 segment 1",
"Name": "Dimension 1 segment 1"
},
{
"Uid": "f82a1e10-1575-4449-80d3-35ec74fd69ec",
"Identifier": "Dimension 1 segment 2",
"Name": "Dimension 1 segment 2"
}
]
}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
{
"Uid": "1e697300-f6f0-49f2-9497-7d1fbc4c1f94",
"Alias": "Dimension 1",
"Segments": [
{
"Uid": "9fde6337-dc3f-405c-96d1-dd3cd3c7fb38",
"Identifier": "Dimension 1 segment 1",
"Name": "Dimension 1 segment 1"
},
{
"Uid": "e396b01b-c2bd-4de5-9400-c4f04eb32762",
"Identifier": "Dimension 1 segment 2",
"Name": "Dimension 1 segment 2"
}
]
}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
{
"Uid": "cf0a98de-8714-407e-9e01-4dbc9879d892",
"Alias": "Dimension 1",
"Segments": [
{
"Uid": "f60348d7-ad1b-48ca-8e65-e6e8eb68d09c",
"Identifier": "Dimension 1 segment 1",
"Name": "Dimension 1 segment 1"
},
{
"Uid": "0208214b-8651-4860-8a85-6d6100a4a79b",
"Identifier": "Dimension 1 segment 2",
"Name": "Dimension 1 segment 2"
}
]
}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 |