#Dimensions
GET /Dimensions Get all dimensions added to the system
[
{
"Uid": "7c445beb-dc95-4c81-a791-caa242c3c99e",
"Alias": "Dimension 1",
"Segments": [
{
"Uid": "7565c8d0-7f0e-4762-a88d-30b5dc1817ef",
"Identifier": "Dimension 1 segment 1",
"Name": "Dimension 1 segment 1"
},
{
"Uid": "e105d145-3797-4d0a-880d-055a05e82b1c",
"Identifier": "Dimension 1 segment 2",
"Name": "Dimension 1 segment 2"
}
]
},
{
"Uid": "f788b37a-680c-4321-933c-3b0145c8e7cf",
"Alias": "Dimension 2",
"Segments": [
{
"Uid": "735bcd57-9386-4658-b3ec-7ab586e26264",
"Identifier": "Dimension 2 segment 1",
"Name": "Dimension 2 segment 1"
},
{
"Uid": "d6eaa46d-18c6-404e-8aad-66e5d20043c4",
"Identifier": "Dimension 2 segment 2",
"Name": "Dimension 2 segment 2"
}
]
},
{
"Uid": "3411b0bc-d7e3-4ef9-9c8a-15185ea9d66e",
"Alias": "Dimension 3",
"Segments": [
{
"Uid": "ee734e2b-319c-4348-9dc8-06ac8ad6f164",
"Identifier": "Dimension 3 segment 1",
"Name": "Dimension 3 segment 1"
},
{
"Uid": "0e33aac7-779f-441a-94d1-6d40a7aeb4d3",
"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": "93035e4f-a9c3-4338-a9e8-1e3e9728af33",
"Alias": "Dimension 1",
"Segments": [
{
"Uid": "6f493c0e-13fd-411a-80c8-ccd5ddefbafe",
"Identifier": "Dimension 1 segment 1",
"Name": "Dimension 1 segment 1"
},
{
"Uid": "39341bda-5d1f-4f49-b39c-94019690b43d",
"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": "80da6f76-0249-4427-87da-cfe8587ec2f8",
"Alias": "Dimension 1",
"Segments": [
{
"Uid": "f14c7b68-577f-4601-85be-8fc6f083c0dd",
"Identifier": "Dimension 1 segment 1",
"Name": "Dimension 1 segment 1"
},
{
"Uid": "68ddc717-402c-43d5-b0e4-4b0c211b14f0",
"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": "a75a9d46-71b1-4df5-b3bd-e8936f414947",
"Alias": "Dimension 1",
"Segments": [
{
"Uid": "bbfcdc8d-d7c8-41da-b5f6-3db984493fd8",
"Identifier": "Dimension 1 segment 1",
"Name": "Dimension 1 segment 1"
},
{
"Uid": "de301edb-70d1-4d7f-a33f-b6c4823472d3",
"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 |