Master Data Business Entities | Dimension

A Dimension represents a tag which goes along with each transaction. It is used for reporting and its purpose is to compartmentalize transactions for each sector, such as a cost center or sales region.

Overview

api/{tenantKey}/{orgKey}/businessCore/dimensions

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

All Operations

This service includes the following operations:

GET:
POST:
- POST Dimensions
PUT:
DELETE:
- DELETE Dimension by identifier
- DELETE Dimension by key

All Resources

This service uses the following resources:

ApiDimensionResource
DimensionResource

GET Operations

GET Dimensions

Returns the list of all the entity records available.

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:

api/{tenantKey}/{orgKey}/businessCore/dimensions

GET /businessCore/dimensions

GET Dimensions (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 DimensionResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/dimensions?page={page}&pageSize={pageSize}

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

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:

api/{tenantKey}/{orgKey}/businessCore/dimensions/{id}

GET /businessCore/dimensions/{id}

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:

api/{tenantKey}/{orgKey}/businessCore/dimensions/{dimensionKey}

GET /businessCore/dimensions/{dimensionKey}

GET Print Dimension 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:

api/{tenantKey}/{orgKey}/businessCore/dimensions/{id}/print?template={template}

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

GET Print Dimension by key

Prints the specified entity record.

The following elements are required:

dimensionKey

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

api/{tenantKey}/{orgKey}/businessCore/dimensions/{dimensionKey}/print

GET /businessCore/dimensions/{dimensionKey}/print

GET Original Print DimensionOriginal 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:

api/{tenantKey}/{orgKey}/businessCore/dimensions/{id}/printOriginal?template={template}

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

GET Original Print Dimension by key

Prints the specified entity record.

The following elements are required:

dimensionKey

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

api/{tenantKey}/{orgKey}/businessCore/dimensions/{dimensionKey}/printOriginal

GET /businessCore/dimensions/{dimensionKey}/printOriginal

GET Get All Dimensions

The service is used to get a list of all dimensions.

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:

api/{tenantKey}/{orgKey}/businessCore/dimensions/getAllDimensions

GET /businessCore/dimensions/getAllDimensions

POST Operations

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.

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:

api/{tenantKey}/{orgKey}/businessCore/dimensions

POST /businessCore/dimensions

PUT Operations

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:

api/{tenantKey}/{orgKey}/businessCore/dimensions/{dimensionKey}/description

PUT /businessCore/dimensions/{dimensionKey}/description

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:

api/{tenantKey}/{orgKey}/businessCore/dimensions/{dimensionKey}/dimensionKey

PUT /businessCore/dimensions/{dimensionKey}/dimensionKey

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:

api/{tenantKey}/{orgKey}/businessCore/dimensions/{dimensionKey}/dimensionLength

PUT /businessCore/dimensions/{dimensionKey}/dimensionLength

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:

api/{tenantKey}/{orgKey}/businessCore/dimensions/{dimensionKey}/isActive

PUT /businessCore/dimensions/{dimensionKey}/isActive

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:

api/{tenantKey}/{orgKey}/businessCore/dimensions/{dimensionKey}/isAlphanumeric

PUT /businessCore/dimensions/{dimensionKey}/isAlphanumeric

DELETE Operations

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:

api/{tenantKey}/{orgKey}/businessCore/dimensions/{id}

DELETE /businessCore/dimensions/{id}

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:

api/{tenantKey}/{orgKey}/businessCore/dimensions/{dimensionKey}

DELETE /businessCore/dimensions/{dimensionKey}

Resources

ApiDimensionResource

The following elements are required:

dimensionKey	(string) The dimension key.
dimensionLength	(int) The lenght of the dimension values.
isAlphanumeric	(bool) Defines if the dimension values can contain alphanumeric 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) Defines if the dimension values can contain alphanumeric characters.

The following elements are optional:

description	(string) The dimension description.
originalDimensionLength	(int) Original Dimension Length.