Introduction

Orchestrator exposes the endpoints of web services; this allows third-party applications to programmatically control some of its functions, such as launching and monitoring work orders.

All API calls have JSON and XML response support. The data format in the responses can be XML or JSON. The response format can be controlled by submitting a parameter format with a value of xml or json or by adding extensions to the id parameter. Detailed examples are provided throughout this guide.

The status code in the HTTP responses is 200 for success and 400 and greater for failures. These error codes include 400 (Bad request), 401 (Access Denied), 403 (Authentication failure) and 404 (Method not found).

The HTTP GET method is supported for all requests. The HTTP POST method is also supported for the process of initiating a work order with user-defined data in the POST body (for example, XML data).

The Orchestrator API is REST-based. Developers can use HTTP or HTTPS as the transport protocol.