DOCUMENTATIONAPI REFERENCEAI-Link
DownloadsSupport
Loading search results...
Dimensions

Dimensions

Create

Create a dimension. The UUID for the dimension element will be automatically assigned if you do not generate one. UUIDs for elements inside the dimension element must be specified (hierarchy, level, attribute-ref).

HTTP REQUEST: POST 

POST/api/1.0/org/{orgId}/project/{projectId}/dimension
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
projectIdstringThe Project ID (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if calling user does not have access right for the API.
500A server error occurred. Check the logs for more details.
503This error will occur if Design Center APIs are not enabled.
Request Body
{
  "description": "",
  "name": "Postal code dimension",
  "caption": "Postal code dimension",
  "datasetId": "97ebf1ef-9cb3-48a6-6e66-80f70c4d43c7",
  "levelName": "Postal code dimension",
  "keyColumns": [
    "postalcode"
  ],
  "valueColumn": "country",
  "type": "Other",
  "unique": false,
  "visible": true,
  "cubeId": "001529c1-cb00-4900-7699-116591eee845"
}
200 Response Body
{
  "status": {
    "code": 200,
    "i18n_message": "response.ok",
    "message": "ok"
  },
  "response": {
    "id": "abc123"
  },
  "time_to_process": "1.1 seconds"
}

Update

In-place update a dimension by passing in a new JSON representation of the Dimension.

HTTP REQUEST: PUT 

PUT/api/1.0/org/{orgId}/project/{projectId}/dimension/{dimensionId}
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
projectIdstringThe Project ID (UUID) for which you are querying.
dimensionIdstringThe Dimension ID (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if calling user does not have access right for the API.
500A server error occurred. Check the logs for more details.
503This error will occur if Design Center APIs are not enabled.
200 Response Body
{
  "status": {
    "code": 200,
    "i18n_message": "response.ok",
    "message": "ok"
  },
  "response": {
    "id": "abc123"
  },
  "time_to_process": "1.1 seconds"
}

Read from both Global and All Cubes

This API call searches across the entire global space and across all defined cubes to find the Dimension.

HTTP REQUEST: GET 

GET/api/1.0/org/{orgId}/project/{projectId}/dimension/{dimensionId}/all
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
projectIdstringThe Project ID (UUID) for which you are querying.
dimensionIdstringThe Dimension ID (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if calling user does not have access right for the API.
500A server error occurred. Check the logs for more details.
503This error will occur if Design Center APIs are not enabled.
200 Response Body
{
  "status": {
    "code": 200,
    "i18n_message": "response.ok",
    "message": "ok"
  },
  "response": {
    "id": "abc123"
  },
  "time_to_process": "1.1 seconds"
}

Read from Global Scope

HTTP REQUEST: GET 

GET/api/1.0/org/{orgId}/project/{projectId}/dimension/{dimensionId}/global
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
projectIdstringThe Project ID (UUID) for which you are querying.
dimensionIdstringThe Dimension ID (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if calling user does not have access right for the API.
500A server error occurred. Check the logs for more details.
503This error will occur if Design Center APIs are not enabled.
200 Response Body
{
  "status": {
    "code": 200,
    "i18n_message": "response.ok",
    "message": "ok"
  },
  "response": {
    "id": "abc123"
  },
  "time_to_process": "1.1 seconds"
}

Read from Cube Scope

HTTP REQUEST: GET 

GET/api/1.0/org/{orgId}/project/{projectId}/dimension/{dimensionId}/cube/{cubeId}
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
projectIdstringThe Project ID (UUID) for which you are querying.
dimensionIdstringThe Dimension ID (UUID) for which you are querying.
cubeIdstringThe Cube ID (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if calling user does not have access right for the API.
500A server error occurred. Check the logs for more details.
503This error will occur if Design Center APIs are not enabled.
200 Response Body
{
  "status": {
    "code": 200,
    "i18n_message": "response.ok",
    "message": "ok"
  },
  "response": {
    "id": "abc123"
  },
  "time_to_process": "1.1 seconds"
}