Plan Action API

Use the Plan Action API to retrieve the current state of an automation plan action and the statuses of its step actions. Send a GET request to /serverautomation/planaction/{plan action id} to receive XML conforming to SA-REST.xsd; other HTTP methods are not supported.

Table 1. Plan Action API
Method Summary
GET

Endpoint: /serverautomation/planaction/{plan action id}

Description: Retrieves the current state of the automation plan action specified by the URL as well as the statuses of all step actions on the system created by the plan action. The information returned is comparable to that displayed on the Automation Plan Actions Status dashboard on the BigFix console.

Required Request Content: N/A.

Response Content: Plan action status XML.

Response Schema: SA-REST.xsd

Sample Response Content: 
<?xml version="1.0" encoding="UTF-8"?>
<status-set action-name="MyPlan" state="Open">
        <status id="123"
                overall="Fixed"
                percent="100"
                state="Stopped" 
                issued="30 August 2013 00:00:00">#{IEMPlan {plan action id},1,O} My First Step
        </status>
        <status id="456" 
                overall="Running"
                percent="50" 
                state="Open" 
                issued="30 August 2013 01:00:00">#{IEMPlan {plan action id},2,O} My Second Step
        </status>
</status-set>
PUT

Not supported for this resource.
POST

Not supported for this resource.
DELETE

Not supported for this resource.