System Center 2012 - Orchestrator Web Service

Applies To: System Center 2012 - Orchestrator, System Center 2012 R2 Orchestrator, System Center 2012 SP1 - Orchestrator

The System Center 2012 - Orchestrator web service is a REST based service that exposes Orchestrator resources and relationships through Open Data Protocol (OData). You can access the web service using programming languages such as C# or scripting languages such as Windows PowerShell to automate Orchestrator functionality including the following:

  • List runbooks and their details.

  • Start a runbook.

  • View the running jobs created by a runbook.

  • Stop a job.

  • View events

You can interact with the Orchestrator web service using URL syntax. This can be directly typed into the address bar of a browser or more commonly in a script or programming code in order to automate Orchestrator functionality. You use a GET request method to retrieve data from the Orchestrator database and a POST request method to update data. Data is returned in XML according to the AtomPub standard.

Two sources that you can reference for more information on OData are and Open Data Protocol by Example. The following sections provide an overview of the data available from the Orchestrator web service and examples of common scenarios for those not familiar with OData.

To install the Orchestrator web service, see How to Install the Orchestrator web service.

For more information on building custom solutions with Orchestrator, see System Center 2012 Integration Guide - Orchestrator

In This Section

The following topics describe how to use the Orchestrator web service: