# Dimensions
GET /Dimensions Get all dimensions added to the system
[
{
"Uid": "ccd4adb6-6e45-47fe-b8d6-6cfb5652d07f",
"Alias": "Dimension 1",
"Segments": [
{
"Uid": "41ccaa8f-270b-45f7-b89d-51f14ecc06ad",
"Identifier": "Dimension 1 segment 1",
"Name": "Dimension 1 segment 1"
},
{
"Uid": "3362fbbc-b05d-48e4-a15a-ca7b3b2b91cd",
"Identifier": "Dimension 1 segment 2",
"Name": "Dimension 1 segment 2"
}
]
},
{
"Uid": "7560dc72-9b81-410d-b5ac-ebd2cf9d4224",
"Alias": "Dimension 2",
"Segments": [
{
"Uid": "b75f0759-de19-4dfb-a4e3-55d734612584",
"Identifier": "Dimension 2 segment 1",
"Name": "Dimension 2 segment 1"
},
{
"Uid": "efaf70e0-a9cf-4b9b-a211-1fe26328c8f8",
"Identifier": "Dimension 2 segment 2",
"Name": "Dimension 2 segment 2"
}
]
},
{
"Uid": "a1c28d6f-4ba4-4e8c-a9d0-3800bff45095",
"Alias": "Dimension 3",
"Segments": [
{
"Uid": "d6a65fdd-1ff7-4621-a107-0c6eba0194fc",
"Identifier": "Dimension 3 segment 1",
"Name": "Dimension 3 segment 1"
},
{
"Uid": "03d53b55-6559-484c-bf6a-52d07742075b",
"Identifier": "Dimension 3 segment 2",
"Name": "Dimension 3 segment 2"
}
]
}
]
Response status OK (200)
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 |
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": "d8a0f9de-9564-40a1-b970-077a33815474",
"Alias": "Dimension 1",
"Segments": [
{
"Uid": "4612ed6b-8164-44b6-92c9-f04f428cf317",
"Identifier": "Dimension 1 segment 1",
"Name": "Dimension 1 segment 1"
},
{
"Uid": "5b1d7fab-4330-40f6-a07d-76c5e2478050",
"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 |
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 |
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)
POST /Dimensions Add dimension to system
{
"Uid": "c7a78989-d03e-41ea-8320-c0039eb6bfcb",
"Alias": "Dimension 1",
"Segments": [
{
"Uid": "be45a0dd-b1e0-402f-bfbd-47d4254ae07e",
"Identifier": "Dimension 1 segment 1",
"Name": "Dimension 1 segment 1"
},
{
"Uid": "f9e2a7cc-2380-43d3-b5a3-1ca67f7780b0",
"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 |
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 |
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)
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 |
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)
GET /Dimensions/{uid} Get a specific dimension in the system
{
"Uid": "26af5586-1a59-4fdc-8a4b-aaf2f75e51b5",
"Alias": "Dimension 1",
"Segments": [
{
"Uid": "cf58c71e-ea7f-4ce2-9027-5bbc7a2fdbf8",
"Identifier": "Dimension 1 segment 1",
"Name": "Dimension 1 segment 1"
},
{
"Uid": "80951489-35ce-409e-8931-078f5f1f1619",
"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)
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 |
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 |