Develop > Web Service Interfaces > Tool Execution Web Service Interface

Tool Execution Web Service Interface

The REST- based Tool Execution web service enables integrators to access the following functionality from an external application:

  • Request a list of preconfigured tools that can be applied to a specific CI or in the context of an event.

  • Execute a tool on a set of nodes.

  • Cancel a tool execution.

  • Retrieve the results of a tool execution.

For more information on tools, see Tools. For information on the opr-tool command-line interface, see opr-tool Command-Line Interface.

ClosedHow to Access the Tool Execution Web Service

Your entry point to the web service interface is the service document, using the following base URL and syntax:

https://<serviceURL>/<request>

<serviceURL>

The URL of the Tool Execution web service:

<server>:<port>/opr-web/rest/<version>

where <server> is the name of the OMi server and <version> is the web service interface version (for example: 10.11).
<request>

The service request. For a complete list and syntax of possible service requests, see Tool Execution Web Service request reference.

List of Services in the Service Document

OPR Tool Web Services

URL

Tool Web Service preview POST

https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution_preview/{contextId}

Tool Web Service POST | GET | DELETE

https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution/{contextId}

Tool Web Service query tools POST

https://<server>:<port>/opr-web/rest/10.11/tool_execution

Tool Web Service preparation POST

https://<server>:<port>/opr-web/rest/10.11/tool_execution/preparation

Tool Web Service details GET | DELETE

https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution/{contextId}/{resultId}

ClosedSecurity and Authorization

To be able to access the Tool Execution web service, a user needs to be assigned a role with the correct level of Tools (Execution) permission. This permission can be accessed in the Operations Console category of the permission section of a role. For more information on permissions, see Users, Groups, and Roles.

ClosedError Handling

Error handling for the Tool Execution web service is as follows:

HTTP error codes:

  • HTTP error code 403: authorization problems
  • HTTP error code 409: requested hosts are not in the RTSM or no CIs match the requirements
  • HTTP error code 4xx (other than 403, 409): any form of communication problems with the OMi backend
  • HTTP code 200: at least one requested host is in the RTSM and meets the requirements

Individual return codes per requested host (HTTP code always 200):

  • Return code -404: requested host is not in the RTSM or the CI does not meet the requirements
  • Return code -500: communication problem with the requested host
  • Return code 0: execution succeeded
  • Other return codes (for example, 1): error code from the command to be executed

Send Help Center feedback