Cancel a Work Order

Description:

An API method to cancel a specific work order, identified by its work order ID. The result includes both the overall status for the work order, as well as the individual status for each of its steps.

Adding the force option will ensure that the work order is cancelled even if it is not responding to a cancel request (work_order_cancel) to cancel itself. If the force option is not provided, the work order status is Failed.

Note: If the work order was already complete (or it failed), then the returned status will indicate the actual status.

Usage:

http://Orchestrator_IP_address/aspera/orchestrator/api/work_order_cancel/work_order_id?login=admin&password=aspera

For example, the user could receive one of the following:

http://localhost/aspera/orchestrator/api/work_order_cancel/3109?login=admin&password=aspera
http://localhost/aspera/orchestrator/api/work_order_cancel/3109?login=admin&password=aspera&force=true

The required input parameter is the following:

workflow_reporter/work_order_cancel/work_order_id

Response example (XML):

<?xml version="1.0"?>
<work_order time="2012-03-02 03:45:05 UTC" action="cancel" id="3109" master_id="5309">
  <name>test after-end</name>
  <workflow id="22" revision_id="7">test after-end</workflow>
  <status state="Canceled">Canceled at Thu Mar 01 19:45:05 -0800 2012</status>
  <comments></comments>
  <ownership>
    <initiated_by>admin</initiated_by>
    <running_as>admin</running_as>
    <launched_by>admin</launched_by>
  </ownership>
  <priority dedicated_worker="false">2</priority>
  <timestamps>
    <created_at>2012-03-02 03:44:48 UTC</created_at>
    <initiated_at>2012-03-02 03:44:50 UTC</initiated_at>
    <updated_at>2012-03-02 03:45:05 UTC</updated_at>
    <completed_at>2012-03-02 03:45:05 UTC</completed_at>
  </timestamps>
  <work_steps>
        <work_step id="37601">
          <name>never</name>
          <status state="Inactive" attempt="0"></status>
          <action type="MergePoint" id="1"/>
          <created_at>2012-03-02 03:44:48 UTC</created_at>
          <initiated_at></initiated_at>
          <updated_at>2012-03-02 03:44:48 UTC</updated_at>
          <completed_at></completed_at>
        </work_step>
        <work_step id="37602">
          <name>gnarp</name>
          <status state="Obsolete" attempt="1">Work Order Processing is finished</status>
          <action type="CustomRuby" id="12"/>
          <created_at>2012-03-02 03:44:48 UTC</created_at>
          <initiated_at>2012-03-02 03:44:50 UTC</initiated_at>
          <updated_at>2012-03-02 03:45:05 UTC</updated_at>
          <completed_at></completed_at>
        </work_step>       
  </work_steps>
</work_order>