Specifying equipment worked on

Equipment asset is a model/device/unit installed in a customer location.
Equipment is an equipment asset linked to a work order.

Apart from installed equipment assets, there are other equipment types:

• New equipment installed - no equipment asset is linked to a work order
• Equipment worked on is not in the list
• Work is not related to specific equipment - no equipment is applied.
  For more information on how to use them, see to Adding a new piece of equipment.

Equipment asset attribute and Equipment attribute are properties, such as Manufacturer, Voltage, or Serial number. When an equipment is specified, you can change values for its attributes.
The system may track changes of attributes, and you can review the history of an attribute by calling the GET /api/equipment/history method.

Adding a new piece of equipment

Specify a standard piece of equipment worked on as follows:

1. Retrieve a list of available equipment assets by calling the GET /api/equipment/available.

📘

Note

GET /api/equipment/available returns equipment assets already linked to a given work order.
To retrieve a summary about equipment already added to a work order, call GET /api/equipment method.

2. Add a new piece of equipment to a work order by calling the POST /api/equipment method.
   • If you want to add an existing equipment asset, Equipment.Type request value must be set to "Existing", and Equipment.EquipmentAssetId must be equal to a selected asset ID.
   • If a necessary asset is not available in a list of equipment assets, you can add basic information to it by calling the POST /api/equipment method with empty Equipment.EquipmentAssetId, and Equipment.Type value set to Unknown.
   • If a new piece of equipment is installed, you can add basic information to it by calling POST /api/equipment method with empty Equipment.EquipmentAssetId, and Equipment.Type value set to New.
   • If equipment worked on is mandatory, but work is not related to any equipment, specify a single piece of equipment with Equipment.Type value set to Excluding.

A successful API response to this request operation means that a piece of equipment is added. If a response is unsuccessful, see Error Codes for troubleshooting.

❗️

Important

If equipment with Type set to Excluding is added to a work order, you cannot enter any other equipment related information.

If any equipment with Type other than Excluding is added to a work order, you cannot add a new record with Type set to Excluding.

Modifying a piece of equipment

When a piece of equipment is added to a work order, you can update its attributes.
A common update flow includes the following steps:

1. Retrieve the current state of a particular piece of equipment by calling the GET /api/equipmen/detailst method.
   Unlike GET /api/equipment, it returns detailed information about a single piece of equipment.
2. Modify a comment text, and attributes - in accordance with their descriptors returned in the previous step. An attribute descriptor defines value type, and can optionally specify a list of available values, so free text input is not allowed.
3. Send the updated attribute state back by calling the PUT /api/equipment method.

🚧

Warning

Equipment asset attributes are related to equipment assets, and not to equipment. Thus, any equipment attribute update will be reflected in all other usages of a corresponding equipment asset!

A successful API response to this operation means that a piece of equipment is updated. If the response is unsuccessful, see Error Codes for troubleshooting details.

Deleting a piece of equipment

If a piece of equipment was added by mistake, you can remove it by calling the DELETE /api/equipment method.

❗️

Important

Deleting a piece of equipment does not roll back any changes you made to its attributes!

A successful API response to this operation means that a piece of equipment is deleted. If the response is unsuccessful, see Error Codes for troubleshooting details.