Assets | Inactivation

Service to manage entities of type 'AssetInactivationHistoric'.

Overview

URL	api/{tenantKey}/{orgKey}/assetManagement/assetInactivationHistorics
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET AssetInactivationHistorics (odata)
  • GET AssetInactivationHistoric by identifier
  • GET AssetInactivationHistoric by key
  • GET Get Inactivation Actions
• POST:
  • POST AssetInactivationHistorics
• PUT:
  • PUT Set Custom Attribute AssetInactivationHistoric
  • PUT Set IsActive AssetInactivationHistoric
  • PUT Set AssetInactivationHistoricKey AssetInactivationHistoric
  • PUT Set InactivationCost AssetInactivationHistoric
  • PUT Set InactivationDate AssetInactivationHistoric
  • PUT Set Company AssetInactivationHistoric
  • PUT Set Remarks AssetInactivationHistoric
  • PUT Set Currency AssetInactivationHistoric
  • PUT Set Employee AssetInactivationHistoric
  • PUT Set InactivationActionId AssetInactivationHistoric
  • PUT Set InactivationActionDescription AssetInactivationHistoric
• DELETE:
  • DELETE AssetInactivationHistoric by identifier
  • DELETE AssetInactivationHistoric by key

All Resources

This service uses the following resources:

• ApiAssetInactivationHistoricResource
• AssetInactivationHistoricResource
• InactivationActionResource
• MoneyResource
• ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

• InactivateAssetAction
• ReportAssetType

GET Operations

GET AssetInactivationHistorics (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 AssetInactivationHistoricResource.

Response status codes:

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

Resource URL:

GET AssetInactivationHistoric 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 AssetInactivationHistoricResource.

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 AssetInactivationHistoric by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
assetInactivationHistoricKey	(string) Inactivation.

Response:

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

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 Get Inactivation Actions

Custom operation 'GetInactivationActions'.

Response:

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

Response status codes:

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

Resource URL:

POST Operations

POST AssetInactivationHistorics

Creates a new entity record.

The following elements are required:

assetInactivationHistoricResource

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

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

Response status codes:

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

Resource URL:

PUT Operations

PUT Set AssetInactivationHistoricKey AssetInactivationHistoric

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

The following elements are required:

assetInactivationHistoricKey	(string) Inactivation.
companyKey	(string) The company 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:

PUT Set Company AssetInactivationHistoric

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

The following elements are required:

assetInactivationHistoricKey	(string) Inactivation.
companyKey	(string) The company 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:

PUT Set Currency AssetInactivationHistoric

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

The following elements are required:

assetInactivationHistoricKey	(string) Inactivation.
companyKey	(string) The company 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:

PUT Set Employee AssetInactivationHistoric

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

The following elements are required:

assetInactivationHistoricKey	(string) Inactivation.
companyKey	(string) The company 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:

PUT Set InactivationActionDescription AssetInactivationHistoric

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

The following elements are required:

assetInactivationHistoricKey	(string) Inactivation.
companyKey	(string) The company 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:

PUT Set InactivationActionId AssetInactivationHistoric

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

The following elements are required:

assetInactivationHistoricKey	(string) Inactivation.
companyKey	(string) The company 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:

PUT Set InactivationCost AssetInactivationHistoric

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

The following elements are required:

assetInactivationHistoricKey	(string) Inactivation.
companyKey	(string) The company key.
value	(decimal) 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 Set InactivationDate AssetInactivationHistoric

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

The following elements are required:

assetInactivationHistoricKey	(string) Inactivation.
companyKey	(string) The company key.
value	(DateTime) 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 Set IsActive AssetInactivationHistoric

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

The following elements are required:

assetInactivationHistoricKey	(string) Inactivation.
companyKey	(string) The company 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:

PUT Set Remarks AssetInactivationHistoric

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

The following elements are required:

assetInactivationHistoricKey	(string) Inactivation.
companyKey	(string) The company 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:

PUT Set Custom Attribute AssetInactivationHistoric

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

The following elements are required:

companyKey	(string) The company key.
assetInactivationHistoricKey	(string) Inactivation
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:

DELETE Operations

DELETE AssetInactivationHistoric 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 AssetInactivationHistoric by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
assetInactivationHistoricKey	(string) Inactivation.

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:

Resources

ApiAssetInactivationHistoricResource

The following elements are required:

assetInactivationHistoricKey	(string) Inactivation.
action	(enum InactivateAssetAction) Action. See InactivateAssetAction.
inactivationCost	(MoneyResource) Inactivation Cost. See MoneyResource .
company	(string) Company.
currency	(string) Currency.
assetType	(enum ReportAssetType) Asset Type. See ReportAssetType.
employee	(string) Employee.

The following elements are optional:

equipment	(string) Equipment.
moveToLocation	(string) Move To Location.
tool	(string) Tool.
location	(string) Location.
inactivationDate	(DateTime) Inactivation Date.
remarks	(string) Remarks.
inactivationActionId	(string) Action.
inactivationActionDescription	(string) Action.

AssetInactivationHistoricResource

The following elements are required:

assetInactivationHistoricKey	(string) Inactivation.
action	(enum InactivateAssetAction) Action. See InactivateAssetAction.
inactivationCost	(MoneyResource) Inactivation Cost. See MoneyResource .
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
currency	(string) Currency. (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
assetType	(enum ReportAssetType) Asset Type. See ReportAssetType.
employee	(string) Employee. (fk) Allowed value: the natural key of a record of type Employee. These records are accessibly through the Employees service.

The following elements are optional:

equipment	(string) Equipment. (fk) Allowed value: the natural key of a record of type EquipmentItem. These records are accessibly through the EquipmentItems service.
moveToLocation	(string) Move To Location. (fk) Allowed value: the natural key of a record of type Location. These records are accessibly through the Locations service.
tool	(string) Tool. (fk) Allowed value: the natural key of a record of type EquipmentItem. These records are accessibly through the EquipmentItems service.
location	(string) Location. (fk) Allowed value: the natural key of a record of type Location. These records are accessibly through the Locations service.
inactivationDate	(DateTime) Inactivation Date.
remarks	(string) Remarks.
inactivationActionId	(string) Action.
inactivationActionDescription	(string) Action.

InactivationActionResource

The following elements are optional:

inactivationActionId	(string) Inactivation Action Id.
inactivationActionDescription	(string) Inactivation Action Description.

MoneyResource

The following elements are required:

amount

(decimal) The amount.

The following elements are optional:

baseAmount	(decimal) The base amount.
reportingAmount	(decimal) The reporting amount.
fractionDigits	(int) The fraction digits.
symbol	(string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

InactivateAssetAction

1	InactivateEverything
2	MoveAssets
3	InactivateAssetsOnly
4	Reactivate

ReportAssetType

1	Location
2	Equipment
3	Tool