Master Data Business Entities | Dimension Value

A Dimension Value represents a specific dimension such as (e.g.) 'Financial' or 'Accounting if the dimension were to be 'Department'.

Overview

api/{tenantKey}/{orgKey}/businessCore/dimensionValues

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

All Operations

This service includes the following operations:

GET:
POST:
- POST DimensionValues
PUT:
DELETE:
- DELETE DimensionValue by identifier
- DELETE DimensionValue by key

All Resources

This service uses the following resources:

ApiDimensionValueResource
DimensionValueResource

GET Operations

GET DimensionValues

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/dimensionValues

GET /businessCore/dimensionValues

GET DimensionValues (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 DimensionValueResource.

Response status codes:

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

Resource URL:

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

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

GET DimensionValue 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 DimensionValueResource.

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

GET /businessCore/dimensionValues/{id}

GET DimensionValue by key

Returns the entity record that matches the specified key.

The following elements are required:

dimension	(string) The dimension.
dimensionValueKey	(string) The dimension value key.

Response:

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

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/dimensionValues/{dimension}/{dimensionValueKey}

GET /businessCore/dimensionValues/{dimension}/{dimensionValueKey}

GET Print DimensionValue 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/dimensionValues/{id}/print?template={template}

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

GET Print DimensionValue by key

Prints the specified entity record.

The following elements are required:

dimension	(string) The dimension.
dimensionValueKey	(string) The dimension value 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/dimensionValues/{dimension}/{dimensionValueKey}/print

GET /businessCore/dimensionValues/{dimension}/{dimensionValueKey}/print

GET Original Print DimensionValueOriginal 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/dimensionValues/{id}/printOriginal?template={template}

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

GET Original Print DimensionValue by key

Prints the specified entity record.

The following elements are required:

dimension	(string) The dimension.
dimensionValueKey	(string) The dimension value 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/dimensionValues/{dimension}/{dimensionValueKey}/printOriginal

GET /businessCore/dimensionValues/{dimension}/{dimensionValueKey}/printOriginal

POST Operations

POST DimensionValues

Creates a new entity record.

The following elements are required:

dimensionValueResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/dimensionValues

POST /businessCore/dimensionValues

PUT Operations

PUT Set Description DimensionValue

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

The following elements are required:

dimension	(string) The dimension.
dimensionValueKey	(string) The dimension value 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/dimensionValues/{dimension}/{dimensionValueKey}/description

PUT /businessCore/dimensionValues/{dimension}/{dimensionValueKey}/description

PUT Set Dimension DimensionValue

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

The following elements are required:

dimension	(string) The dimension.
dimensionValueKey	(string) The dimension value 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/dimensionValues/{dimension}/{dimensionValueKey}/dimension

PUT /businessCore/dimensionValues/{dimension}/{dimensionValueKey}/dimension

PUT Set DimensionValueKey DimensionValue

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

The following elements are required:

dimension	(string) The dimension.
dimensionValueKey	(string) The dimension value 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/dimensionValues/{dimension}/{dimensionValueKey}/dimensionValueKey

PUT /businessCore/dimensionValues/{dimension}/{dimensionValueKey}/dimensionValueKey

PUT Set IsActive DimensionValue

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

The following elements are required:

dimension	(string) The dimension.
dimensionValueKey	(string) The dimension value 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/dimensionValues/{dimension}/{dimensionValueKey}/isActive

PUT /businessCore/dimensionValues/{dimension}/{dimensionValueKey}/isActive

DELETE Operations

DELETE DimensionValue 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/dimensionValues/{id}

DELETE /businessCore/dimensionValues/{id}

DELETE DimensionValue by key

Deletes the entity record that matches the specified key.

The following elements are required:

dimension	(string) The dimension.
dimensionValueKey	(string) The dimension value 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/dimensionValues/{dimension}/{dimensionValueKey}

DELETE /businessCore/dimensionValues/{dimension}/{dimensionValueKey}

Resources

ApiDimensionValueResource

The following elements are required:

dimension	(string) The dimension.
dimensionValueKey	(string) The dimension value key.

The following elements are optional:

description

(string) The description of the dimension value.

DimensionValueResource

The following elements are required:

dimension	(string) The dimension. (fk) Allowed value: the natural key of a record of type Dimension. These records are accessibly through the Dimensions service.
dimensionValueKey	(string) The dimension value key.

The following elements are optional:

description

(string) The description of the dimension value.