ROSE Developers - Web API Reference

Master Data Business Entities | Dimension Combination

A Dimension Combination represents the combination between dimensions and entities such as a party or an item.

Overview


URL api/{tenantKey}/{orgKey}/businessCore/dimensionCombinations
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET DimensionCombinations

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See DimensionCombinationResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /businessCore/dimensionCombinations

GET DimensionCombinations (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 DimensionCombinationResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /businessCore/dimensionCombinations?page={page}&pageSize={pageSize}

GET DimensionCombination 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 DimensionCombinationResource.

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 /businessCore/dimensionCombinations/{id}

GET DimensionCombination by key

Returns the entity record that matches the specified key.

The following elements are required:

dimensionCombinationKey (string) The dimension combination key.

Response:

When successful, the response body contains the entity record. See DimensionCombinationResource.

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 /businessCore/dimensionCombinations/{dimensionCombinationKey}

GET Print DimensionCombination by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

GET /businessCore/dimensionCombinations/{id}/print?template={template}

GET Print DimensionCombination by key

Prints the specified entity record.

The following elements are required:

dimensionCombinationKey (string) The dimension combination key.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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 /businessCore/dimensionCombinations/{dimensionCombinationKey}/print

GET Original Print DimensionCombinationOriginal by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

GET /businessCore/dimensionCombinations/{id}/printOriginal?template={template}

GET Original Print DimensionCombination by key

Prints the specified entity record.

The following elements are required:

dimensionCombinationKey (string) The dimension combination key.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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 /businessCore/dimensionCombinations/{dimensionCombinationKey}/printOriginal

POST Operations

POST DimensionCombinations

Creates a new entity record.

The following elements are required:

dimensionCombinationResource (ApiDimensionCombinationResource) The request body should contain the entity record that should be created.
See ApiDimensionCombinationResource.

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 ApiDimensionCombinationResource.

Response status codes:

201 Created. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /businessCore/dimensionCombinations

POST Dimension Combination

Inserts a new 'Dimension Combination Value' in the 'Dimension Combination'.

The following elements are required:

dimensionCombinationKey (string) The dimension combination key.
value (ApiDimensionCombinationDimensionCombinationValuesResource) The ApiDimensionCombinationDimensionCombinationValuesResource instance.
See ApiDimensionCombinationDimensionCombinationValuesResource.

Response:

When successful, the response body is empty.

Response status codes:

204 NoContent. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /businessCore/dimensionCombinations/{dimensionCombinationKey}/dimensionCombinationValues

PUT Operations

PUT Set Description DimensionCombination

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

dimensionCombinationKey (string) The dimension combination 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 /businessCore/dimensionCombinations/{dimensionCombinationKey}/description

PUT Set Dimension DimensionCombinationValue

Updates the value of attribute 'Dimension' in the specified entity record.

The following elements are required:

dimensionCombinationKey (string) The dimension combination key.
lineId (string) The detail identifier.
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 /businessCore/dimensionCombinations/{dimensionCombinationKey}/dimensionCombinationValues/{lineId}/dimension

PUT Set DimensionCombinationKey DimensionCombination

Updates the value of attribute 'DimensionCombinationKey' in the specified entity record.

The following elements are required:

dimensionCombinationKey (string) The dimension combination 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 /businessCore/dimensionCombinations/{dimensionCombinationKey}/dimensionCombinationKey

PUT Set DimensionSource DimensionCombinationValue

Updates the value of attribute 'DimensionSource' in the specified entity record.

The following elements are required:

dimensionCombinationKey (string) The dimension combination key.
lineId (string) The detail identifier.
value (enum DimensionSource) The request body should contain the new value for the attribute.
See DimensionSource.

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 /businessCore/dimensionCombinations/{dimensionCombinationKey}/dimensionCombinationValues/{lineId}/dimensionSource

PUT Set IsActive DimensionCombination

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

dimensionCombinationKey (string) The dimension combination 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 /businessCore/dimensionCombinations/{dimensionCombinationKey}/isActive

DELETE Operations

DELETE Dimension Combination Value by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

dimensionCombinationKey (string) The dimension combination key.
lineId (string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204 NoContent. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /businessCore/dimensionCombinations/{dimensionCombinationKey}/dimensionCombinationValues/{lineId}

DELETE DimensionCombination 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 /businessCore/dimensionCombinations/{id}

DELETE DimensionCombination by key

Deletes the entity record that matches the specified key.

The following elements are required:

dimensionCombinationKey (string) The dimension combination 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:

DELETE /businessCore/dimensionCombinations/{dimensionCombinationKey}

Resources


ApiDimensionCombinationDimensionCombinationValuesResource

The following elements are required:

dimension (string) The dimension.
dimensionSource (enum DimensionSource) The entity where to get the dimension values.
See DimensionSource.


ApiDimensionCombinationResource

The following elements are required:

dimensionCombinationKey (string) The dimension combination key.

The following elements are optional:

description (string) The description of a dimension combination.
dimensionCombinationValues (List of ApiDimensionCombinationDimensionCombinationValuesResource) The values of a dimension combination.
See ApiDimensionCombinationDimensionCombinationValuesResource.


DimensionCombinationResource

The following elements are required:

dimensionCombinationKey (string) The dimension combination key.

The following elements are optional:

description (string) The description of a dimension combination.
dimensionCombinationValues (List of DimensionCombinationValueResource) The values of a dimension combination.
See DimensionCombinationValueResource.


DimensionCombinationValueResource

The following elements are required:

dimension (string) The dimension.
dimensionSource (enum DimensionSource) The entity where to get the dimension values.
See DimensionSource.


Enumerations


DimensionSource

1 Party
2 PartyGroup
3 Item
4 PettyCash
5 FinancialAccount
6 SalesChannel
7 SalesPerson
8 Warehouse
9 Assortment
10 Brand