REST Activities

Updated: November 1, 2013

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

The following configuration instructions apply to all activities in this integration pack. Links to this section are included in the configuration instructions for each activity.

Activity Properties

Each activity has a set of required or optional properties that define the configuration of that activity. This includes how it connects to other activities or how the activity performs its actions. You can view or modify activity properties when the activity is placed in the runbook window.

To configure the properties for an activity

  1. Double-click the activity. Alternatively, you can right-click the activity, and then click Properties.

  2. To save your configuration entries, click Finish.

In the activity properties dialog box, several tabs along the left side provide access to general and specific settings for the activity. The number of available tabs for object properties differs between different activities.

General Tab

This tab contains the Name and Description properties for the activity. By default, the Name of the activity is the same as its activity type, and the Description is blank. You can modify these properties to create more descriptive names or provide detailed descriptions of the actions of the activity.

Properties Tab

This tab contains properties that are specific to the activity.

Run Behavior Tab

This tab contains the properties that determine how the activity handles multi-value published data and what notifications will be sent if the activity fails or runs for an excessive period of time.

Multi-Value Published Data Behavior

This does not apply to the Invoke REST Service activity.

Event Notifications

Some activities are expected to take a limited amount of time to complete. If they do not complete within that time they may be stalled or there may be another issue preventing them from completing. You can define the number of seconds to wait for completion of the action. After this period a platform event will be sent and the issue will be reported. You can also choose whether to generate a platform event if the activity returns a failure.

To be notified when the activity takes longer than a specified time to run or fails to run

  1. In the Event Notifications box, enter the number of seconds of run time before a notification is generated.

  2. Select Report if activity fails to run to generate run failure notifications.

Published Data

Published data is the foundation of a working runbook. It is the data produced as a result of the actions of an activity. This data is published to an internal data bus that is unique for each runbook. Subsequent activities in the runbook can subscribe to this data and use it in their configuration. Link conditions also use this information to add decision-making capabilities to runbooks.

An activity can only subscribe to data from the activities that are linked before it in the runbook. You can use published data to automatically populate the property values needed by activities.

To use published data

  1. Right-click the property value box, click Subscribe, and then click Published Data.

  2. Click the Activity drop-down box and select the activity from which you want to obtain the data. To view additional data elements common to all runbooks, select Show Common Published Data.

  3. Click the published data element that you want to use, and then click OK.

For a list of the data elements published by each activity, see the Published Data tables in the activity topic. For information about the common published data items, see Common Published Data.


This integration pack adds the REST category to the Activity pane in the Runbook Designer. This category contains the following activities: