Jasmin Developers - Web API Reference

Platform | Unit Dimension

Service to manage entities of type 'UnitDimension'.

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

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

Response status codes:

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

Resource URL:

GET /corePatterns/unitDimensions/odata

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:

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:

GET /corePatterns/unitDimensions/{dimensionKey}

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:

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:

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:

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:

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:

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:

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:

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.