Business Core | Dimension Set
Service to manage entities of type 'DimensionSet'.
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 (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
| opts | (ODataQueryOptions) OData query option. |
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:
GET Get Dimension Sets By Budget Group
Custom operation 'GetDimensionSetsByBudgetGroup'.
The following elements are required:
| company | (string) Company. |
| budgetGroup | (string) BudgetGroup. |
| pageSize | (int) PageSize. |
| pageNumber | (int) PageNumber. |
Response:
| When successful, the response body contains a list of resources of type 'BudgetGroupDimensionSet'. See BudgetGroupDimensionSet. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Update Company Dimension Sets
Custom operation 'UpdateCompanyDimensionSets'.
The following elements are required:
| company | (string) Company. |
| dimensionSetExtension | (string) DimensionSetExtension. |
The following elements are optional:
| customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
| When successful, the response body is empty. |
Resource URL:
POST Update Company Dimension Set Activity Status
Custom operation 'UpdateCompanyDimensionSetActivityStatus'.
The following elements are required:
| company | (string) Company. |
| index | (int) Index. |
| dimensionLength | (int) DimensionLength. |
| isActive | (bool) IsActive. |
The following elements are optional:
| customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
| When successful, the response body is empty. |
Resource URL:
PUT Set Custom Attribute DimensionSet
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| dimensionSetKey | (string) The dimension set key. |
| customAttributeName | (string) The custom attribute name. |
| value | (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource. |
Response:
| When successful, the response body is empty. |
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:
Resources
BudgetGroupDimensionSet
The following elements are optional:
| dimensionSetId | (Guid) Dimension Set Id. |
| dimensionSetNaturalKey | (string) Dimension Set Natural Key. |
| dimensionSetDescription | (string) Dimension Set Description. |
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) Dimension Set Json. |