List Work Orders for a Workflow
Description:
This is a method for external applications to fetch work orders associated with a workflow.
Currently, five conditions can be given with this method:
- From date
- To date
- Maximum results
- Status
- Priority
Usage for a request with XML
response:
http://localhost/aspera/orchestrator/api/work_orders_list/workflow_id.xml?login=admin&password=aspera&from_date=from_date&to_date=to_date&max_results=maximum_results
For
example:
http://localhost/aspera/orchestrator/api/work_orders_list/8738.json?login=admin&password=aspera&from_date='06-27-2015 02:40:59'&to_date='06-29-2015 02:40:59'&max_results=100
The required input parameter is the following:
- workflow_id
- Specifies the workflow from which the work orders are listed.
The optional input parameters are the following:
- from_date=from_date
- Specifies the from date condition.
- to_date=to_date
- Specifies the to date condition.
- max_results=maximum_results
- Specifies the maximum results condition.
Response example
(XML):
<?xml version="1.0" encoding="UTF-8"?>
<work-orders type="array">
<work-order>
<branchedFrom type="integer" nil="true"></branchedFrom>
<branchedFromOrder type="integer" nil="true"></branchedFromOrder>
<cleanup-after-days type="integer" nil="true"></cleanup-after-days>
<comments nil="true"></comments>
<completion-date type="datetime">2015-11-06T19:03:28Z</completion-date>
<created-at type="datetime">2015-11-06T19:03:27Z</created-at>
<derivedFrom type="integer" nil="true"></derivedFrom>
<forkedAt type="integer" nil="true"></forkedAt>
<higherPriority type="boolean" nil="true"></higherPriority>
<id type="integer">491</id>
<initiate-date type="datetime">2015-11-06T19:03:28Z</initiate-date>
<initiatedBy type="integer">1</initiatedBy>
<label nil="true"></label>
<launched-by type="integer">1</launched-by>
<master-id type="integer">491</master-id>
<max-running type="integer">0</max-running>
<monitor-id type="integer" nil="true"></monitor-id>
<name>test</name>
<priority type="integer" nil="true"></priority>
<purge-after-days type="integer" nil="true"></purge-after-days>
<running-as type="integer">2</running-as>
<status>Complete</status>
<statusDetails>WorkOrder ended at Fri Nov 06 13:03:28 CST 2015 with status: In Progress</statusDetails>
<tags></tags>
<updated-at type="datetime">2015-11-06T19:03:28Z</updated-at>
<workflowName>test</workflowName>
<workflow-id type="integer">1</workflow-id>
<workflow-revision-id type="integer">24</workflow-revision-id>
</work-order>
<work-order>
<branchedFrom type="integer" nil="true"></branchedFrom>
<branchedFromOrder type="integer" nil="true"></branchedFromOrder>
<cleanup-after-days type="integer" nil="true"></cleanup-after-days>
<comments nil="true"></comments>
<completion-date type="datetime">2015-11-06T19:46:12Z</completion-date>
<created-at type="datetime">2015-11-06T19:46:10Z</created-at>
<derivedFrom type="integer" nil="true"></derivedFrom>
<forkedAt type="integer" nil="true"></forkedAt>
<higherPriority type="boolean" nil="true"></higherPriority>
<id type="integer">492</id>
<initiate-date type="datetime">2015-11-06T19:46:11Z</initiate-date>
<initiatedBy type="integer">1</initiatedBy>
<label nil="true"></label>
<launched-by type="integer">1</launched-by>
<master-id type="integer">492</master-id>
<max-running type="integer">0</max-running>
<monitor-id type="integer" nil="true"></monitor-id>
<name>test</name>
<priority type="integer" nil="true"></priority>
<purge-after-days type="integer" nil="true"></purge-after-days>
<running-as type="integer">2</running-as>
<status>Complete</status>
<statusDetails>WorkOrder ended at Fri Nov 06 13:46:12 CST 2015 with status: In Progress</statusDetails>
<tags></tags>
<updated-at type="datetime">2015-11-06T19:46:12Z</updated-at>
<workflowName>test</workflowName>
<workflow-id type="integer">1</workflow-id>
<workflow-revision-id type="integer">24</workflow-revision-id>
</work-order>
</work-orders type="array">
Usage for a request with JSON
response:
http://localhost/aspera/orchestrator/api/work_orders_list/workflow_id.json?login=admin&password=aspera&from_date=from_date&to_date=to_date&max_results=maximum_results
Response example
(JSON):
{ "work_orders":[
{
"forkedAt":null,
"workflow_revision_id":24,
"tags":"||",
"created_at":"2015-11-06T19:03:27Z",
"workflow_id":1,
"updated_at":"2015-11-06T19:03:28Z",
"derivedFrom":null,
"comments":null,
"cleanup_after_days":null,
"statusDetails":"WorkOrder ended at Fri Nov 06 13:03:28 CST 2015 with status: In Progress",
"master_id":491,
"label":null,
"initiate_date":"2015-11-06T19:03:28Z",
"higherPriority":null,
"status":"Complete",
"purge_after_days":null,
"monitor_id":null,
"max_running":0,
"branchedFromOrder":null,
"workflowName":"test",
"launched_by":1,
"branchedFrom":null,
"name":"test",
"id":491,
"running_as":2,
"completion_date":"2015-11-06T19:03:28Z",
"priority":null,
"initiatedBy":1
},
{
"forkedAt":null,
"workflow_revision_id":24,
"tags":"||",
"created_at":"2015-11-06T19:46:10Z",
"workflow_id":1,
"updated_at":"2015-11-06T19:46:12Z",
"derivedFrom":null,
"comments":null,
"cleanup_after_days":null,
"statusDetails":"WorkOrder ended at Fri Nov 06 13:46:12 CST 2015 with status: In Progress",
"master_id":492,
"label":null,
"initiate_date":"2015-11-06T19:46:11Z",
"higherPriority":null,
"status":"Complete",
"purge_after_days":null,
"monitor_id":null,
"max_running":0,
"branchedFromOrder":null,
"workflowName":"test",
"launched_by":1,
"branchedFrom":null,
"name":"test",
"id":492,
"running_as":2,
"completion_date":"2015-11-06T19:46:12Z",
"priority":null,
"initiatedBy":1
}
]
}