Assets | Equipment

Service to manage entities of type 'EquipmentItem'.

Overview

URL	api/{tenantKey}/{orgKey}/assetManagementCore/equipmentItems
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET EquipmentItems (odata)
  • GET EquipmentItem by identifier
  • GET EquipmentItem by key
  • GET Equipment Item Picture.
  • GET Get Maintenance Notification Template Parameters
• POST:
  • POST EquipmentItems
  • POST Add Routes by keys
  • POST Add Routes by identifiers
  • POST Remove Routes by keys
  • POST Remove Routes by identifiers
  • POST Equipment Item Part
  • POST EquipmentItemCharacteristic
• PUT:
  • PUT Set Custom Attribute EquipmentItem
  • PUT Set Custom Attribute EquipmentItemPart
  • PUT Set IsActive EquipmentItem
  • PUT Set EquipmentKey EquipmentItem
  • PUT Set Description EquipmentItem
  • PUT Set OnServiceDate EquipmentItem
  • PUT Set ExternalReferenceID EquipmentItem
  • PUT Set Serial EquipmentItem
  • PUT Set Picture EquipmentItem
  • PUT Set PurchaseDate EquipmentItem
  • PUT Set PurchasePrice EquipmentItem
  • PUT Set Remarks EquipmentItem
  • PUT Set Keyword EquipmentItem
  • PUT Set Manufacturer EquipmentItem
  • PUT Set Barcode EquipmentItem
  • PUT Set ExchangeRateDate EquipmentItem
  • PUT Set ExchangeRate EquipmentItem
  • PUT Set Location EquipmentItem
  • PUT Set Criticality EquipmentItem
  • PUT Set Currency EquipmentItem
  • PUT Set Owner EquipmentItem
  • PUT Set Brand EquipmentItem
  • PUT Set BrandModel EquipmentItem
  • PUT Set ParentEquipment EquipmentItem
  • PUT Set Family EquipmentItem
  • PUT Set Company EquipmentItem
  • PUT Set Routes EquipmentItem
  • PUT Set WorkingTime EquipmentItem
  • PUT Set IsUpTime EquipmentItem
  • PUT Set IsDisposed EquipmentItem
  • PUT Set Responsible EquipmentItem
  • PUT Set Supplier EquipmentItem
  • PUT Set Customer EquipmentItem
  • PUT Set WarrantyStartDate EquipmentItem
  • PUT Set WarrantyEndDate EquipmentItem
  • PUT Set WarrantyExtensionEndDate EquipmentItem
  • PUT Set FromApi EquipmentItem
  • PUT Set Part EquipmentItemPart
  • PUT Set Quantity EquipmentItemPart
  • PUT Set Remarks EquipmentItemPart
  • PUT Set Characteristic EquipmentItemCharacteristic
  • PUT Set Value EquipmentItemCharacteristic
  • PUT Set CharacteristicEnumValueId EquipmentItemCharacteristic
  • PUT Set Unit EquipmentItemCharacteristic
  • PUT Set CharacteristicValueType EquipmentItemCharacteristic
  • PUT Set CharacteristicValueTypeValue EquipmentItemCharacteristic
  • PUT Set CharacteristicEnumValue EquipmentItemCharacteristic
• DELETE:
  • DELETE Equipment Item Part by identifier
  • DELETE EquipmentItemCharacteristic by identifier
  • DELETE EquipmentItem by identifier
  • DELETE EquipmentItem by key

All Resources

This service uses the following resources:

• ApiEquipmentItemEquipmentItemCharacteristicsResource
• ApiEquipmentItemEquipmentItemPartResource
• ApiEquipmentItemResource
• EquipmentItemResource
• EquipmentMaintenanceNotificationTemplateParameter
• MoneyResource
• ExtensibilityCustomAttributeValueResource

GET Operations

GET EquipmentItems (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 EquipmentItemResource.

Response status codes:

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

Resource URL:

GET EquipmentItem 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 EquipmentItemResource.

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

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
equipmentKey	(string) Equipment.

Response:

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

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 Equipment Item Picture.

Returns the value of attribute 'Picture' of the specified entity record.

The following elements are required:

id	(string) The record identifier.
fileName	(string) The file name.

Response:

When successful, the response is a stream with the image 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 Get Maintenance Notification Template Parameters

Custom operation 'GetMaintenanceNotificationTemplateParameters'.

The following elements are required:

companyKey	(string) CompanyKey.
equipmentItemKey	(string) EquipmentItemKey.
cultureKey	(string) CultureKey.

Response:

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

Response status codes:

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

Resource URL:

POST Operations

POST EquipmentItems

Creates a new entity record.

The following elements are required:

equipmentItemResource

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

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

Response status codes:

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

Resource URL:

POST Add Routes by keys

Adds the specified 'Routes' to the 'Equipment Item' (by specifying its keys).

The following elements are required:

equipmentKey	(string) Equipment.
value	(Array of string) A list of record keys to be added.

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 is empty.

Response status codes:

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

Resource URL:

POST Add Routes by identifiers

Adds the specified 'Routes' to the 'Equipment Item' (by specifying its identifiers).

The following elements are required:

equipmentKey	(string) Equipment.
value	(Array of string) A list of record identifiers to be added.

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 is empty.

Response status codes:

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

Resource URL:

POST Remove Routes by keys

Removes the specified 'Routes' to the 'Equipment Item' (by specifying its keys).

The following elements are required:

equipmentKey	(string) Equipment.
value	(Array of string) A list of record keys to be removed.

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 is empty.

Response status codes:

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

Resource URL:

POST Remove Routes by identifiers

Removes the specified 'Routes' to the 'Equipment Item' (by specifying its identifiers).

The following elements are required:

equipmentKey	(string) Equipment.
value	(Array of string) A list of record identifiers to be removed.

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 is empty.

Response status codes:

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

Resource URL:

POST Equipment Item Part

Inserts a new 'Equipment Item Part' in the 'Equipment Item'.

The following elements are required:

equipmentKey	(string) Equipment.
companyKey	(string) The company key.
value	(ApiEquipmentItemEquipmentItemPartResource) The ApiEquipmentItemEquipmentItemPartResource instance. See ApiEquipmentItemEquipmentItemPartResource.

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 is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST EquipmentItemCharacteristic

Inserts a new 'EquipmentItemCharacteristic' in the 'Equipment Item'.

The following elements are required:

equipmentKey	(string) Equipment.
companyKey	(string) The company key.
value	(ApiEquipmentItemEquipmentItemCharacteristicsResource) The ApiEquipmentItemEquipmentItemCharacteristicsResource instance. See ApiEquipmentItemEquipmentItemCharacteristicsResource.

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 is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Operations

PUT Set Barcode EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 Brand EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 BrandModel EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 Characteristic EquipmentItemCharacteristic

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

The following elements are required:

equipmentKey	(string) Equipment.
lineId	(string) The detail identifier.
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 CharacteristicEnumValue EquipmentItemCharacteristic

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

The following elements are required:

equipmentKey	(string) Equipment.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(int) 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 CharacteristicEnumValueId EquipmentItemCharacteristic

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

The following elements are required:

equipmentKey	(string) Equipment.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(Guid) 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 CharacteristicValueType EquipmentItemCharacteristic

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

The following elements are required:

equipmentKey	(string) Equipment.
lineId	(string) The detail identifier.
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 CharacteristicValueTypeValue EquipmentItemCharacteristic

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

The following elements are required:

equipmentKey	(string) Equipment.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(int) 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 EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 Criticality EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 Customer EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 Description EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 EquipmentKey EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 ExchangeRate EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 ExchangeRateDate EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 ExternalReferenceID EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 Family EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 FromApi EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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.

Resource URL:

PUT Set IsActive EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 IsDisposed EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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.

Resource URL:

PUT Set IsUpTime EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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.

Resource URL:

PUT Set Keyword EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 Location EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 Manufacturer EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 OnServiceDate EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 Owner EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 ParentEquipment EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 Part EquipmentItemPart

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

The following elements are required:

equipmentKey	(string) Equipment.
lineId	(string) The detail identifier.
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 Picture EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 PurchaseDate EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 PurchasePrice EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 Quantity EquipmentItemPart

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

The following elements are required:

equipmentKey	(string) Equipment.
lineId	(string) The detail identifier.
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 Remarks EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 Remarks EquipmentItemPart

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

The following elements are required:

equipmentKey	(string) Equipment.
lineId	(string) The detail identifier.
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 Responsible EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 Routes EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
companyKey	(string) The company key.
value	(Route) 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 Serial EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 Supplier EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 Unit EquipmentItemCharacteristic

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

The following elements are required:

equipmentKey	(string) Equipment.
lineId	(string) The detail identifier.
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 Value EquipmentItemCharacteristic

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

The following elements are required:

equipmentKey	(string) Equipment.
lineId	(string) The detail identifier.
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 WarrantyEndDate EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 WarrantyExtensionEndDate EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 WarrantyStartDate EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
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 WorkingTime EquipmentItem

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

The following elements are required:

equipmentKey	(string) Equipment.
companyKey	(string) The company key.
value	(TimeSpan) 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 EquipmentItem

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

The following elements are required:

companyKey	(string) The company key.
equipmentKey	(string) Equipment
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 Set Custom Attribute EquipmentItemPart

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

The following elements are required:

companyKey	(string) The company key.
equipmentKey	(string) Equipment
lineId	(string) The detail identifier.
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 Equipment Item Part by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

equipmentKey	(string) Equipment.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE EquipmentItemCharacteristic by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

equipmentKey	(string) Equipment.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

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

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
equipmentKey	(string) Equipment.

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

ApiEquipmentItemEquipmentItemCharacteristicsResource

The following elements are required:

characteristic

(string) Characteristic.

The following elements are optional:

value	(string) Value.
characteristicEnumValueId	(Guid) Characteristic Enum Value Id.
unit	(string) Unit.
characteristicValueType	(string) Value Type.
characteristicValueTypeValue	(int) Characteristic Value Type Value.
characteristicEnumValue	(int) Enum Value.

ApiEquipmentItemEquipmentItemPartResource

The following elements are required:

part	(string) Part.
quantity	(decimal) Quantity.

The following elements are optional:

remarks

(string) Remarks.

ApiEquipmentItemResource

The following elements are required:

equipmentKey	(string) Equipment.
description	(string) Description.
purchasePrice	(MoneyResource) Price. See MoneyResource .
isTool	(bool) Is Tool.
company	(string) Company.
isDisposed	(bool) Is Disposed.
fromApi	(bool) From Api.

The following elements are optional:

onServiceDate	(DateTime) On Service.
externalReferenceID	(string) External Reference.
serial	(string) Serial.
picture	(string) Picture.
purchaseDate	(DateTime) Date.
remarks	(string) Remarks.
keyword	(string) Keyword.
manufacturer	(string) Manufacturer.
barcode	(string) Tag.
exchangeRateDate	(DateTime) Exchange Rate Date.
exchangeRate	(decimal) Exchange Rate.
location	(string) Location.
criticality	(string) Criticality.
currency	(string) Currency.
owner	(string) Owner.
brand	(string) Brand.
brandModel	(string) Model.
parentEquipment	(string) Parent Equipment.
family	(string) Family.
routes	(Route) Routes.
workingTime	(TimeSpan) Working Time.
isUpTime	(bool) Is Available.
responsible	(string) Responsible.
supplier	(string) Supplier.
customer	(string) Customer.
warrantyStartDate	(DateTime) Start Date.
warrantyEndDate	(DateTime) End Date.
warrantyExtensionEndDate	(DateTime) Extension End Date.
equipmentItemPart	(List of ApiEquipmentItemEquipmentItemPartResource) Equipment Item Part. See ApiEquipmentItemEquipmentItemPartResource.
equipmentItemCharacteristics	(List of ApiEquipmentItemEquipmentItemCharacteristicsResource) Equipment Item Characteristics. See ApiEquipmentItemEquipmentItemCharacteristicsResource.

EquipmentItemResource

The following elements are required:

equipmentKey	(string) Equipment.
description	(string) Description.
purchasePrice	(MoneyResource) Price. See MoneyResource .
isTool	(bool) Is Tool.
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
isDisposed	(bool) Is Disposed.
fromApi	(bool) From Api.

The following elements are optional:

onServiceDate	(DateTime) On Service.
externalReferenceID	(string) External Reference.
serial	(string) Serial.
picture	(string) Picture.
purchaseDate	(DateTime) Date.
remarks	(string) Remarks.
keyword	(string) Keyword.
manufacturer	(string) Manufacturer. (fk) Allowed value: the natural key of a record of type SupplierParty. These records are accessibly through the SupplierParties service.
barcode	(string) Tag.
exchangeRateDate	(DateTime) Exchange Rate Date.
exchangeRate	(decimal) Exchange Rate.
location	(string) Location. (fk) Allowed value: the natural key of a record of type Location. These records are accessibly through the Locations service.
criticality	(string) Criticality. (fk) Allowed value: the natural key of a record of type Criticality. These records are accessibly through the Criticalities service.
currency	(string) Currency. (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
owner	(string) Owner. (fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
brand	(string) Brand. (fk) Allowed value: the natural key of a record of type Brand. These records are accessibly through the Brands service.
brandModel	(string) Model. (fk) Allowed value: the natural key of a record of type BrandModel. These records are accessibly through the BrandModels service.
parentEquipment	(string) Parent Equipment. (fk) Allowed value: the natural key of a record of type EquipmentItem. These records are accessibly through the EquipmentItems service.
family	(string) Family. (fk) Allowed value: the natural key of a record of type Family. These records are accessibly through the Families service.
routes	(Route) Routes.
workingTime	(TimeSpan) Working Time.
isUpTime	(bool) Is Available.
responsible	(string) Responsible. (fk) Allowed value: the natural key of a record of type Employee. These records are accessibly through the Employees service.
supplier	(string) Supplier. (fk) Allowed value: the natural key of a record of type SupplierParty. These records are accessibly through the SupplierParties service.
customer	(string) Customer. (fk) Allowed value: the natural key of a record of type CustomerParty. These records are accessibly through the CustomerParties service.
warrantyStartDate	(DateTime) Start Date.
warrantyEndDate	(DateTime) End Date.
warrantyExtensionEndDate	(DateTime) Extension End Date.
equipmentItemPart	(List of EquipmentItemPartResource) Equipment Item Part. See EquipmentItemPartResource.
equipmentItemCharacteristics	(List of EquipmentItemCharacteristicResource) Equipment Item Characteristics. See EquipmentItemCharacteristicResource.

EquipmentMaintenanceNotificationTemplateParameter

The following elements are required:

name	(string) Name.

The following elements are optional:

value

(string) Value.

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.