Platform | Unit Dimension

Service to manage entities of type 'UnitDimension'.

Overview

api/{tenantKey}/{orgKey}/corePatterns/unitDimensions

URL	api/{tenantKey}/{orgKey}/corePatterns/unitDimensions
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST UnitDimensions
PUT:
DELETE:
- DELETE UnitDimension by identifier
- DELETE UnitDimension by key

All Resources

This service uses the following resources:

ApiUnitDimensionResource
UnitDimensionResource

GET Operations

GET UnitDimensions

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/unitDimensions

GET /corePatterns/unitDimensions

GET UnitDimensions (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 UnitDimensionResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/unitDimensions?page={page}&pageSize={pageSize}

GET /corePatterns/unitDimensions?page={page}&pageSize={pageSize}

GET UnitDimension 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 UnitDimensionResource.

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

GET /corePatterns/unitDimensions/{id}

GET UnitDimension by key

Returns the entity record that matches the specified key.

The following elements are required:

dimensionKey

(string) The key for the unit dimension.

Response:

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

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}/corePatterns/unitDimensions/{dimensionKey}

GET /corePatterns/unitDimensions/{dimensionKey}

GET Print UnitDimension 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}/corePatterns/unitDimensions/{id}/print?template={template}

GET /corePatterns/unitDimensions/{id}/print?template={template}

GET Print UnitDimension by key

Prints the specified entity record.

The following elements are required:

dimensionKey

(string) The key for the unit dimension.

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}/corePatterns/unitDimensions/{dimensionKey}/print

GET /corePatterns/unitDimensions/{dimensionKey}/print

GET Original Print UnitDimensionOriginal 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}/corePatterns/unitDimensions/{id}/printOriginal?template={template}

GET /corePatterns/unitDimensions/{id}/printOriginal?template={template}

GET Original Print UnitDimension by key

Prints the specified entity record.

The following elements are required:

dimensionKey

(string) The key for the unit dimension.

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}/corePatterns/unitDimensions/{dimensionKey}/printOriginal

GET /corePatterns/unitDimensions/{dimensionKey}/printOriginal

POST Operations

POST UnitDimensions

Creates a new entity record.

The following elements are required:

unitDimensionResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/unitDimensions

POST /corePatterns/unitDimensions

PUT Operations

PUT Set BaseUnit UnitDimension

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

The following elements are required:

dimensionKey	(string) The key for the unit dimension.
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}/corePatterns/unitDimensions/{dimensionKey}/baseUnit

PUT /corePatterns/unitDimensions/{dimensionKey}/baseUnit

PUT Set Description UnitDimension

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

The following elements are required:

dimensionKey	(string) The key for the unit dimension.
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}/corePatterns/unitDimensions/{dimensionKey}/description

PUT /corePatterns/unitDimensions/{dimensionKey}/description

PUT Set DimensionKey UnitDimension

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

The following elements are required:

dimensionKey	(string) The key for the unit dimension.
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}/corePatterns/unitDimensions/{dimensionKey}/dimensionKey

PUT /corePatterns/unitDimensions/{dimensionKey}/dimensionKey

PUT Set IsActive UnitDimension

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

The following elements are required:

dimensionKey	(string) The key for the unit dimension.
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}/corePatterns/unitDimensions/{dimensionKey}/isActive

PUT /corePatterns/unitDimensions/{dimensionKey}/isActive

DELETE Operations

DELETE UnitDimension 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}/corePatterns/unitDimensions/{id}

DELETE /corePatterns/unitDimensions/{id}

DELETE UnitDimension by key

Deletes the entity record that matches the specified key.

The following elements are required:

dimensionKey

(string) The key for the unit dimension.

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}/corePatterns/unitDimensions/{dimensionKey}

DELETE /corePatterns/unitDimensions/{dimensionKey}

Resources

ApiUnitDimensionResource

The following elements are required:

dimensionKey

(string) The key for the unit dimension.

The following elements are optional:

description	(string) The description for the unit dimension.
baseUnit	(string) The base unit for the unit dimension.

UnitDimensionResource

The following elements are required:

dimensionKey

(string) The key for the unit dimension.

The following elements are optional:

description	(string) The description for the unit dimension.
baseUnit	(string) The base unit for the unit dimension. (fk) Allowed value: the natural key of a record of type Unit. These records are accessibly through the Units service.