Viewing Work Orders

You use this API to view the list of work orders related to an equipment or location.

Request

  • HTTP Method: GET

  • URL: Application_URL/services/api/v1/equipment({equipmentId})/workorders

  • Query parameter: $filter

    $filter: allows you to specify a search text using which you can filter the items of equipment or location

    Description: Where FILTER_VALUE is the parameter to search the text or a substring of the text and <PROPERTY_NAME> is the attribute that contains the text.

    For filters, this API follows ODATA URI conventions. For more information, see http://www.odata.org/documentation/odata-version-3-0/url-conventionsInformation published on non-SAP site.

  • Example URL: Application_URL/ain/services/api/v1/equipment({equipmentId})/workorders ?$filter=substringof('Sample Workorder',internalID)

  • Authorization: You must have the roles EQUIPMENT_READ assigned to your user ID in the SAP HANA Cloud Platform account.

Response

If work orders exist for an equipment or location, and you have appropriate authorizations to view the work orders, system returns the array of work order details. Otherwise, system returns an empty array.

For more information, see https://help.sap.com/doc/040d5297b6804c3b903ee307cfcbf13c/1902/en-US/equipment.html#equipment__equipmentId___workorders_get.