Common REST API data endpoints
Get service
Obtains a list of services that are registered to work with the API
/(% style="color: rgb(23,43,77);" %)serviceGateway/services
For more details, see Logging-in-to-a-service-using-the-Common-REST-API.
Update or add service
Updates or adds services to the configurations.json file
{{status subtle="false" colour="Green" title="POST"/}}
/serviceGateway/services///<serviceName>///update
For more details, see Registering-services-with-the-Common-REST-API.
Delete service
Deletes a service
(% style="color: rgb(59,65,81);" %)/serviceGateway/services///<serviceName>///delete
For more details, see To delete a service.
Login
Logs into a service
Use one of the following URLs:
POST /serviceGateway/services/<serviceName>/login
POST /serviceGateway/services/<serviceName>/logon
For more details, see To log in to a BMC AMI Ops service.
Get view definition
Retrieves the definition for a specific view and returns the details as a JSON
GET
/serviceGateway/services/products/<productName>/views/<viewName>/definitionFor more details, see Retrieving-a-view-definition-using-the-Common-REST-API.
Retrieve data
Retrieves the data for a specific view and returns the details as a JSON
GET /serviceGateway/services/products/<productName>/views/<viewName>/data
For more details, see Retrieving-view-data-using-the-Common-REST-API.
Get product
Retrieves the view data from the PLEXMGR/PLEX view and extracts the fields from the data to form the JSON returned by a successful request
/serviceGateway/services/products
For more details, see Retrieving-a-list-of-installed-products-using-the-Common-REST-API.
Get server details
Retrieves the server details and returns a JSON
{{status colour="Blue" title="GET"/}} /serviceGateway/services/products/<productName>/servers
For more details, see Retrieving-server-details-using-the-Common-REST-API.
Get system details
Retrieves the system details and returns a JSON
{{status colour="Blue" title="GET"/}} /serviceGateway/services/products/<productName>/systems
For more details, see Retrieving-system-details-using-the-Common-REST-API.
Get target details
Retrieves the target details and returns a JSON
/serviceGateway/services/products///<productName>///targets
For more details, see Retrieving-target-details-using-the-Common-REST-API.
Get view
Retrieves the views for a specific product
/serviceGateway/services/products///<productName>///views
For more details, see Retrieving-a-list-of-product-views-using-the-Common-REST-API.
Get action list
Retrieves the actions available for a specific view and returns the details as a JSON
/serviceGateway/services/products///<productName>///views///<viewName>///getActTbl
For more details, see Retrieving-view-actions-using-the-Common-REST-API.
Do action
Invokes an action for a view
{{status subtle="false" colour="Green" title="POST"/}}
/serviceGateway/services/doAction?parms=<parms>
For more details, see Invoking-actions-using-the-Common-REST-API.
Logout
Logs out of CRA
(% style="color: rgb(23,43,77);" %)/serviceGateway/services/Logoff
For more details, see Logging-out-of-the-Common-REST-API.
Send BRC event
Sends BRC events that trigger BRC rules in BMC AMI Ops Automation
/opsa
For more details, see Triggering-BMC-AMI-Ops-Automation-using-the-Common-REST-API.
Get View definition (deprecated)
Retrieves a MainView view definition
POST /serviceGateway/services/getView?product=<productName>&view=<viewName>
For more details, see Retrieving-MainView-data-using-the-Common-REST-API-deprecated.
Retrieve data (deprecated)
Retrieve data
/cra/serviceGateway/services/getData?product=//<productName>//&select=//<select_statement>//
For more details, see Retrieving-MainView-data-using-the-Common-REST-API-deprecated.