Check the Status of a Specific Step

Description:

A method to poll the status of a specific step, identified by its work order ID and step name. If the work order includes sub-workflows, only the sub-workflow status is displayed, not the status for the steps within the sub-workflow. The response can be in either XML or JSON format.

Usage for a request with an XML response:

http://Orchestrator_IP_address/aspera/orchestrator/api/work_step_status/work_order.xml?login=admin&password=aspera&work_order_id=work_order_id&step_name=step_name

For example:

http://localhost/aspera/orchestrator/api/work_step_status/work_order.xml?login=admin&password=aspera&work_order_id=8461&step_name=Create faspex package

Response example (XML):

<?xml version="1.0"?>
<Work-step-status>
   <inputs type="array"/>
   <carry-thrus type="array">
      <carry-thru>
         <name>myfiles</name>
         <id type="integer">60067</id>
         <type>string</type>
         <value>/root/chris/data_for_demos/shiporder.cmd</value>
      </carry-thru>
   </carry-thrus>
   <work-step>
      <workOrder-id type="integer">8461</workOrder-id>
      <preProcessing nil="true"/>
      <group type="integer">8461</group>
      <executionTimeout type="integer">0</executionTimeout>
      <activable-date type="datetime">2014-11-24T16:48:39Z</activable-date>
      <stepName nil="true"/>
      <created-at type="datetime">2014-11-24T16:48:37Z</created-at>
      <updated-at type="datetime">2014-11-24T16:48:39Z</updated-at>
      <timeout nil="true"/>
      <on-timeout nil="true"/>
      <step-type>FaspexDelivery</step-type>
      <attempt type="integer">1</attempt>
      <step-id type="integer">3810</step-id>
      <statusDetails>FASPEX Authorization received</statusDetails>
      <rank type="integer">1</rank>
      <id type="integer">46756</id>
      <activation-date type="datetime">2014-11-24T16:48:39Z</activation-date>
      <workflow-id type="integer">256</workflow-id>
      <synch-filter type="integer">0</synch-filter>
      <completion-date type="datetime">2014-11-24T16:48:39Z</completion-date>
      <action-id type="integer">2</action-id>
      <status>Complete</status>
      <running-as type="integer">2</running-as>
      <original-activation-date type="datetime">2014-11-24T16:48:39Z</original-activation-date>
      <workStepName>Create faspex package</workStepName>
      <postProcessing nil="true"/>
   </work-step>
   <outputs type="array">
      <output>
         <name>package_id</name>
         <id type="integer">60070</id>
         <type>string</type>
         <value>5e0f9336-5e58-46a5-b944-a8253a956041</value>
      </output>
      <output>
         <name>package_post_url</name>
         <id type="integer">60071</id>
         <type>string</type>        
<value><![CDATA[fasp://faspex@testchris2.sl.dev.asperacloud.net:33001/Transcoded - 5e0f9336-5e58-46a5-b944-a8253a956041.aspera-package/PKG - Transcoded?token=ATM3_ACsvFz3yt1byrRDQ7cEtFKg0wxWS6ubjsWnkA8IAxSlbKoAAEWHQkLFXfeLjDz5Eq8uDH7_3MTA&cookie=aspera.faspex20:u:90ce20d7]]></value>
      </output>
   </outputs>
</Work-step-status>

Usage for a request with a JSON response:

http://Orchestrator_IP_address/aspera/orchestrator/api/work_step_status/work_order.json?login=admin&password=aspera&work_order_id=work_order_id&step_name=step_name

For example:

http://localhost/aspera/orchestrator/api/work_step_status/work_order.json?login=admin&password=aspera&work_order_id=8461&step_name=Create faspex package

Response example (JSON):

{
   "inputs": [],
   "carry_thrus": [   {
      "name": "myfiles",
      "id": 60067,
      "type": "string",
      "value": "/root/chris/data_for_demos/shiporder.cmd"
   }],
   "work_step":    {
      "workOrder_id": 8461,
      "preProcessing": null,
      "group": 8461,
      "executionTimeout": 0,
      "activable_date": "2014-11-24T16:48:39Z",
      "stepName": null,
      "created_at": "2014-11-24T16:48:37Z",
      "updated_at": "2014-11-24T16:48:39Z",
      "timeout": null,
      "on_timeout": null,
      "step_type": "FaspexDelivery",
      "attempt": 1,
      "step_id": 3810,
      "statusDetails": "FASPEX Authorization received",
      "rank": 1,
      "id": 46756,
      "activation_date": "2014-11-24T16:48:39Z",
      "workflow_id": 256,
      "synch_filter": 0,
      "completion_date": "2014-11-24T16:48:39Z",
      "action_id": 2,
      "status": "Complete",
      "running_as": 2,
      "original_activation_date": "2014-11-24T16:48:39Z",
      "workStepName": "Create faspex package",
      "postProcessing": null
   },
   "outputs":    [
            {
         "name": "package_id",
         "id": 60070,
         "type": "string",
         "value": "5e0f9336-5e58-46a5-b944-a8253a956041"
      },
            {
         "name": "package_post_url",
         "id": 60071,
         "type": "string",
         "value": "fasp://faspex@testchris2.sl.dev.asperacloud.net:33001/Transcoded - 5e0f9336-5e58-46a5-b944-a8253a956041.aspera-package/PKG - Transcoded?token=ATM3_ACsvFz3yt1byrRDQ7cEtFKg0wxWS6ubjsWnkA8IAxSlbKoAAEWHQkLFXfeLjDz5Eq8uDH7_3MTA&cookie=aspera.faspex20:u:90ce20d7-17c3-4672"
      }
   ]
}

The following API call returns only the step status:

http://Orchestrator_IP_address/aspera/orchestrator/api/work_order.xml?login=admin&password=aspera&work_order_id=work_order_id&step_name=step_name&status_only=true

For example:

https://localhost/aspera/orchestrator/api/work_step_status/work_order.xml?login=admin&password=aspera&work_order_id=8461&step_name=Create faspex package&status_only=true

Response example (XML):

Complete

Note: An output value can be obtained from the step ID. The step ID can be obtained with the previous call. For example, the following is an example of a returned output value (XML):

<id type="integer">46756</id>

Usage for a request with text response:

http://Orchestrator_IP_address/aspera/orchestrator/api/work_step_status/step_id.txt?login=admin&password=aspera&output_name=output_name

For example:

http://localhost/aspera/orchestrator/api/work_step_status/46756.txt?login=admin&password=aspera&output_name=package_id

Response example (XML):

5e0f9336-5e58-46a5-b944-a8253a956041

Usage for a request with an XML response:

http://localhost/aspera/orchestrator/api/work_step_status/252158.xml?login=admin&password=aspera&output_name=IndexedTable

Response example for <value> (XML):

<?xml version="1.0"?>
<Work_step_output>
   <name>IndexedTable</name>
   <id type="integer">301979</id>
   <value>{'Transcode server' => {"node_id"=>"transcoder", "node"=>"Transcode server", "capacity_kb"=>"30000"}, 'Mac' => {"node_id"=>"localhost", "node"=>"Mac", "capacity_kb"=>"20000"}}</value>
   <type>hash</type>
</Work_step_output>

Usage for a request with a JSON response:

http://localhost/aspera/orchestrator/api/work_step_status/252158.json?login=admin&password=aspera&output_name=IndexedTable

Response example for value:

{"Mac":{"capacity_kb":"20000","node":"Mac","node_id":"localhost"},"Transcode server":{"capacity_kb":"30000","node":"Transcode server","node_id":"transcoder"}}