Viewing Equipment Components

You use this API to view the components of a system.

Request

  • HTTP Method: GET

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

  • Query Parameters: status and immediate

    Description: Use the URL with STATUS of the system 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 URI/ain/services/api/v1/systems(E0B15BE85E2B41FBA06069B8D61CEB09)/components?status=2

  • Authorization: You must have the roles SYSTEM_READ, SYSTEM_EDIT or SYSTEM_DELETE assigned to your user ID in the SAP Cloud Platform account.

Response

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

For more information, see https://help.sap.com/doc/85c7e55a3d214e05843cb996a3ba1700/1902/en-US/systems.html#systems__systemId___components_get.

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

For more information, see https://help.sap.com/doc/85c7e55a3d214e05843cb996a3ba1700/1902/en-US/systems.html#systems__systemId___components_get.