Business Core | Dimension
Service to manage entities of type 'Dimension'.
Overview
| URL | api/{tenantKey}/{orgKey}/businessCore/dimensions |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
GET Dimensions (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 DimensionResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Dimension 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 DimensionResource. |
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 Dimension by key
Returns the entity record that matches the specified key.
The following elements are required:
| dimensionKey | (string) The dimension key. |
Response:
| When successful, the response body contains the entity record. See DimensionResource. |
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 All Dimensions
Custom operation 'GetAllDimensions'.
Response:
| When successful, the response body contains a list of resources of type 'DimensionResource'. See DimensionResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Dimensions
Creates a new entity record.
The following elements are required:
| dimensionResource | (ApiDimensionResource) The request body should contain the entity record that should be created. See ApiDimensionResource. |
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 contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiDimensionResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Description Dimension
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| dimensionKey | (string) The dimension key. |
| value | (string) The request body should contain the new value for the attribute. |
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. |
Resource URL:
PUT Set DimensionKey Dimension
Updates the value of attribute 'DimensionKey' in the specified entity record.
The following elements are required:
| dimensionKey | (string) The dimension key. |
| value | (string) The request body should contain the new value for the attribute. |
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. |
Resource URL:
PUT Set DimensionLength Dimension
Updates the value of attribute 'DimensionLength' in the specified entity record.
The following elements are required:
| dimensionKey | (string) The dimension key. |
| value | (int) The request body should contain the new value for the attribute. |
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. |
Resource URL:
PUT Set IsActive Dimension
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| dimensionKey | (string) The dimension key. |
| value | (bool) The request body should contain the new value for the attribute. |
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:
PUT Set IsAlphanumeric Dimension
Updates the value of attribute 'IsAlphanumeric' in the specified entity record.
The following elements are required:
| dimensionKey | (string) The dimension key. |
| value | (bool) The request body should contain the new value for the attribute. |
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. |
Resource URL:
PUT Set Custom Attribute Dimension
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| dimensionKey | (string) The dimension 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:
DELETE Dimension by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE Dimension by key
Deletes the entity record that matches the specified key.
The following elements are required:
| dimensionKey | (string) The dimension key. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
Resources
ApiDimensionResource
The following elements are required:
| dimensionKey | (string) The dimension key. |
| dimensionLength | (int) The lenght of the dimension values. |
| isAlphanumeric | (bool) Select if the dimension values can contain alhanumeric characters. |
The following elements are optional:
| description | (string) The dimension description. |
DimensionResource
The following elements are required:
| dimensionKey | (string) The dimension key. |
| dimensionLength | (int) The lenght of the dimension values. |
| isAlphanumeric | (bool) Select if the dimension values can contain alhanumeric characters. |
The following elements are optional:
| description | (string) The dimension description. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
| value | (object) The custom attribute value. |