Plan_Step Action Status API

The Plan_Step Action Status API provides GET operations to retrieve the overall status of an automation plan action and detailed status for individual step actions from the BES API. Requests require only the URL and responses conform to the SA-REST.xsd schema; exit codes are included only when their value is not "None".

Table 1. Plan_Step Action API
Method Summary
GET

Endpoint: /serverautomation/besplanaction/{plan_action_id}

Description: Retrieves the current state of the automation plan action as per BES API specified by the URL.
Note:
  • This method provides a detailed overall status of the automation plan action Id.
  • For “not reported” endpoints, the response is NOT captured.

Required Request Content: URL is all that is required.

Response Content: Response body with the automation plan action status.

Response Schema: SA-REST.xsd

Sample Response Content: 
<?xml version="1.0" encoding="UTF-8"?> 
<sa-rest xmlns="http://iemfsa.tivoli.ibm.com/REST" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> 
    <status-set state="Expired" action-name="Using Notifications within a Plan"> 
        <status id="266903" overall="( Fixed:1 )" percent="100.00%" state="Expired" issued="2023/09/19 17:42:28">#{IEMPlan 266902,103,O} Send an Email Notification via template</status> 
        <status id="266904" overall="( Fixed:1 )" percent="100.00%" state="Expired" issued="2023/09/19 17:42:43">#{IEMPlan 266902,104,O} Send an Email Notification</status> 
        <status id="266905" overall="( Failed:1 )" percent="0.00%" state="Expired" issued="2023/09/19 17:44:57">#{IEMPlan 266902,105,O} Custom Fixlet to Fail</status> 
        <status id="266906" overall="( Fixed:1 )" percent="100.00%" state="Expired" issued="2023/09/19 17:45:14">#{IEMPlan 266902,105,X} Send an Email Notification via template</status> 
        <status id="266908" overall="( Failed:1 )" percent="0.00%" state="Expired" issued="2023/09/19 17:46:27">#{IEMPlan 266902,106,O} Custom Fixlet to Fail</status> 
        <status id="266909" overall="( Not Relevant:1 )" percent="0.00%" state="Expired" issued="2023/09/19 17:47:59">#{IEMPlan 266902,106,X} Send an Email Notification</status> 
    </status-set> 
</sa-rest>
GET

Endpoint:

Description: Retrieves the current state of the step action as per BES API specified by the URL.
Note:
  • This method provides the in-depth details of the individual step action id.
  • As per the BES API response:
    • The exit code is only returned for actions without “None” as exit code. For any other numerical value, the exit code tag is part of the response.

Required Request Content: URL is all that is required.

Response Content: The individual specific step action details as per the BES API response.

Response Schema: SA-REST.xsd

Sample Response Content: 
<?xml version="1.0" encoding="UTF-8"?> 
    <sa-rest xmlns="http://iemfsa.tivoli.ibm.com/REST" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> 
        <ActionResults Resource="https://localhost:52311/api/action/266908/status"> <ActionID>266908</ActionID> 
            <Status>Expired</Status> 
            <DateIssued>Tue, 19 Sep 2023 12:16:27 +0000</DateIssued> 
            <DateStopped>Tue, 19 Sep 2023 12:17:56 +0000</DateStopped> 
            <StoppedBy UserID="1">Admin</StoppedBy> 
            <Computer ID="1614044993" Name="BLMYCLDDW76861"> 
                <Status>The action failed.</Status> 
                <State IsError="0">4</State> 
                <ApplyCount>1</ApplyCount> 
                <RetryCount>1</RetryCount> 
                <LineNumber>2</LineNumber> 
                <StartTime>Tue, 19 Sep 2023 12:16:31 +0000</StartTime> 
                <EndTime>Tue, 19 Sep 2023 12:16:31 +0000</EndTime> 
            </Computer> 
        </ActionResults> 
    </sa-rest>
Note:
  • For the most recent XML description of all the methods, see SA-REST.xsd
  • In the API, Object ID refers to Plan Action ID.