Viewing Equipment Components

You use this API to view the components of an equipment.

Request

  • HTTP Method: GET

  • URL: Application_URL/services/api/v1/equipment({equipmentId})/components?status={status}<STATUS>>&immediate=<IMMEDIATE>

  • Query Parameters: status and immediate

    Description: Use the URL with STATUS of the equipment and the IMMEDIATE Boolean flag. Possible values for immediate flag are ‘true’, ‘false’. When the immediate flag is ‘true’, the API returns only the immediate children of the equipment. If it is ‘false’, the API returns the complete hierarchy.
  • Example URL: Application_URL/services/api/v1/equipment(E0B15BE85E2B41FBA06069B8D61CEB09)/components?status=2

  • Authorization: You must have the roles EQUIPMENT_READ, EQUIPMENT_EDIT or EQUIPMENT_DELETE assigned to your user IDin the SAP Cloud Platform account.

Response

The system returns the equipment components for the specified equipment ID and status.

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

If the equipment with the specified ID does not exist, or you do not have appropriate authorizations to view the equipment components, system returns an error message.

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