Master Data Business Entities | Dimension Set
A Dimension Set represents a set of dimensions defined for a particular company.
Overview
| URL | api/{tenantKey}/{orgKey}/businessCore/dimensionSets |
| Methods Supported | GET, POST |
All Operations
This service includes the following operations:
- GET:
- POST:
All Resources
This service uses the following resources:
GET DimensionSets
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See DimensionSetResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET DimensionSets (paged)
Returns a page of the list of all the entity records available.
The following elements are optional:
| page | (int) The index of the page of the list that should be returned. This is a query string parameter. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter. |
Response:
| When successful, the response body contains the list of records available. See DimensionSetResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET DimensionSet by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body contains the entity record. See DimensionSetResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
GET DimensionSet by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| dimensionSetKey | (string) The dimension set key. |
Response:
| When successful, the response body contains the entity record. See DimensionSetResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
POST Update Company Dimension Set Activity Status
(Internal use only) This service is used to update the state of a dimension set for a given company.
The following elements are required:
| company | (string) The company key. |
| selectedIndexs | (string) selectedIndexs. |
| unselectedIndexs | (string) unselectedIndexs. |
Response:
| When successful, the response body is empty. |
Resource URL:
POST Update Company Dimension Sets
(Internal use only) This service is used to update all dimension set with the new dimension value.
The following elements are required:
| company | (string) The company key. |
| dimensionSetExtension | (string) DimensionSetExtension. |
Response:
| When successful, the response body is empty. |
Resource URL:
Resources
DimensionSetResource
The following elements are required:
| company | (string) The company of the dimension set. |
| dimensionSetKey | (string) The dimension set key. |
The following elements are optional:
| dimensionSetJson | (string) The json representation of the dimension set (Internal). |
| description | (string) The dimension set description. |