ROSE Developers - Web API Reference

Assets | Depreciation Area

The Depreciation Area represents the value of fixed assets for a specific purpose.

Overview


URL api/{tenantKey}/{orgKey}/assetsCore/depreciationAreas
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 DepreciationAreas

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /assetsCore/depreciationAreas

GET DepreciationAreas (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 DepreciationAreaResource.

Response status codes:

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

Resource URL:

GET /assetsCore/depreciationAreas?page={page}&pageSize={pageSize}

GET DepreciationArea 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 DepreciationAreaResource.

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

GET DepreciationArea by key

Returns the entity record that matches the specified key.

The following elements are required:

depreciationAreaKey (string) The key for the depreciation area.

Response:

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

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 /assetsCore/depreciationAreas/{depreciationAreaKey}

GET Print DepreciationArea 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 /assetsCore/depreciationAreas/{id}/print?template={template}

GET Print DepreciationArea by key

Prints the specified entity record.

The following elements are required:

depreciationAreaKey (string) The key for the depreciation area.

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 /assetsCore/depreciationAreas/{depreciationAreaKey}/print

GET Original Print DepreciationAreaOriginal 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 /assetsCore/depreciationAreas/{id}/printOriginal?template={template}

GET Original Print DepreciationArea by key

Prints the specified entity record.

The following elements are required:

depreciationAreaKey (string) The key for the depreciation area.

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 /assetsCore/depreciationAreas/{depreciationAreaKey}/printOriginal

GET Get Depreciation Areas

Returns all depreciation areas.

Response:

When successful, the response body contains a list of resources of type 'DepreciationAreaResource'. See DepreciationAreaResource.

Response status codes:

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

Resource URL:

GET /assetsCore/depreciationAreas/getAllDepreciationAreas

POST Operations

POST DepreciationAreas

Creates a new entity record.

The following elements are required:

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

The following elements are optional:

customAttributes (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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

Response status codes:

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

Resource URL:

POST /assetsCore/depreciationAreas

PUT Operations

PUT Set DepreciationAreaKey DepreciationArea

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

The following elements are required:

depreciationAreaKey (string) The key for the depreciation area.
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 /assetsCore/depreciationAreas/{depreciationAreaKey}/depreciationAreaKey

PUT Set Description DepreciationArea

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

The following elements are required:

depreciationAreaKey (string) The key for the depreciation area.
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 /assetsCore/depreciationAreas/{depreciationAreaKey}/description

PUT Set IsActive DepreciationArea

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

The following elements are required:

depreciationAreaKey (string) The key for the depreciation area.
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 /assetsCore/depreciationAreas/{depreciationAreaKey}/isActive

PUT Set Custom Attribute DepreciationArea

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

depreciationAreaKey (string) The key for the depreciation area
customAttributeName (string) The custom attribute name.
value (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute.
See ExtensibilityCustomAttributeValueResource.

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 /assetsCore/depreciationAreas/{depreciationAreaKey}/{customAttributeName}

DELETE Operations

DELETE DepreciationArea 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 /assetsCore/depreciationAreas/{id}

DELETE DepreciationArea by key

Deletes the entity record that matches the specified key.

The following elements are required:

depreciationAreaKey (string) The key for the depreciation area.

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 /assetsCore/depreciationAreas/{depreciationAreaKey}

Resources


ApiDepreciationAreaResource

The following elements are required:

depreciationAreaKey (string) The key for the depreciation area.
currency (string) The currency where the values of the depreciation area are posted.

The following elements are optional:

description (string) The description of the depreciation area.


DepreciationAreaResource

The following elements are required:

depreciationAreaKey (string) The key for the depreciation area.
currency (string) The currency where the values of the depreciation area are posted.

The following elements are optional:

description (string) The description of the depreciation area.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.