API Calls for Work Orders |
Description:
This API method retrieves statistics about work order performance. You can retrieve daily statistics for up to the past 30 days or hourly statistics for a specific day. The primary data filter is the parameter workflow_id; the label parameter can be added to the request to retrieve a greater level of detail.
Usage:
http://localhost:3000/aspera/orchestrator/api/work_order_stats?login=admin&password=admin&workflow_id=1&label=Test http://localhost:3000/aspera/orchestrator/api/work_order_stats?login=admin&password=admin&date=2017-04-04
Sample Returned XML:
<?xml version="1.0"?> <work_step_stats> <anon> <Date>2017-04-10</Date> <Completed_Steps>48289</Completed_Steps> <Failed_Steps>0</Failed_Steps> <Errored_steps>0</Errored_steps> <Obsolete_Steps>0</Obsolete_Steps> <Last_hour>Mon Apr 10 12:00:00 UTC 2017</Last_hour> <Activating_Steps>3752</Activating_Steps> <In_Progress_Steps>0</In_Progress_Steps> <Paused_Steps>0</Paused_Steps> <Pausing_Steps>0</Pausing_Steps> <Canceling_Steps>0</Canceling_Steps> <Resuming_Steps>0</Resuming_Steps> <Rolling_Back_Steps>0</Rolling_Back_Steps> <Undefined_Steps>0</Undefined_Steps> </anon> <anon> <Date>2017-04-09</Date> <Completed_Steps>92734</Completed_Steps> <Failed_Steps>0</Failed_Steps> <Errored_steps>0</Errored_steps> <Obsolete_Steps>0</Obsolete_Steps> <Last_hour>Sun Apr 09 23:00:00 UTC 2017</Last_hour> <Activating_Steps>4087</Activating_Steps> <In_Progress_Steps>0</In_Progress_Steps> <Paused_Steps>0</Paused_Steps> <Pausing_Steps>0</Pausing_Steps> <Canceling_Steps>0</Canceling_Steps> <Resuming_Steps>0</Resuming_Steps> <Rolling_Back_Steps>0</Rolling_Back_Steps> <Undefined_Steps>0</Undefined_Steps> </anon> <anon> <Date>2017-04-08</Date> <Completed_Steps>99324</Completed_Steps> <Failed_Steps>0</Failed_Steps> <Errored_steps>0</Errored_steps> <Obsolete_Steps>0</Obsolete_Steps> <Last_hour>Sat Apr 08 23:00:00 UTC 2017</Last_hour> <Activating_Steps>3905</Activating_Steps> <In_Progress_Steps>0</In_Progress_Steps> <Paused_Steps>0</Paused_Steps> <Pausing_Steps>0</Pausing_Steps> <Canceling_Steps>0</Canceling_Steps> <Resuming_Steps>0</Resuming_Steps> <Rolling_Back_Steps>0</Rolling_Back_Steps> <Undefined_Steps>0</Undefined_Steps> </anon> <anon> <Date>2017-04-07</Date> <Completed_Steps>98554</Completed_Steps> <Failed_Steps>0</Failed_Steps> <Errored_steps>0</Errored_steps> <Obsolete_Steps>0</Obsolete_Steps> <Last_hour>Fri Apr 07 23:00:00 UTC 2017</Last_hour> <Activating_Steps>4148</Activating_Steps> <In_Progress_Steps>0</In_Progress_Steps> <Paused_Steps>0</Paused_Steps> <Pausing_Steps>0</Pausing_Steps> <Canceling_Steps>0</Canceling_Steps> <Resuming_Steps>0</Resuming_Steps> <Rolling_Back_Steps>0</Rolling_Back_Steps> <Undefined_Steps>0</Undefined_Steps> </anon> <anon> <Date>2017-04-06</Date> <Completed_Steps>69733</Completed_Steps> <Failed_Steps>0</Failed_Steps> <Errored_steps>0</Errored_steps> <Obsolete_Steps>0</Obsolete_Steps> <Last_hour>Thu Apr 06 23:00:00 UTC 2017</Last_hour> <Activating_Steps>4047</Activating_Steps> <In_Progress_Steps>0</In_Progress_Steps> <Paused_Steps>0</Paused_Steps> <Pausing_Steps>0</Pausing_Steps> <Canceling_Steps>0</Canceling_Steps> <Resuming_Steps>0</Resuming_Steps> <Rolling_Back_Steps>0</Rolling_Back_Steps> <Undefined_Steps>0</Undefined_Steps> </anon> </work_step_stats>
Sample Returned JSON:
[ { "Date": "2017-04-10", "Completed_Steps": 48289, "Failed_Steps": 0, "Errored_steps": 0, "Obsolete_Steps": 0, "Last_hour": "Mon Apr 10 12:00:00 UTC 2017", "Activating_Steps": 3752, "In_Progress_Steps": 0, "Paused_Steps": 0, "Pausing_Steps": 0, "Canceling_Steps": 0, "Resuming_Steps": 0, "Rolling_Back_Steps": 0, "Undefined_Steps": 0 }, { "Date": "2017-04-09", "Completed_Steps": 92734, "Failed_Steps": 0, "Errored_steps": 0, "Obsolete_Steps": 0, "Last_hour": "Sun Apr 09 23:00:00 UTC 2017", "Activating_Steps": 4087, "In_Progress_Steps": 0, "Paused_Steps": 0, "Pausing_Steps": 0, "Canceling_Steps": 0, "Resuming_Steps": 0, "Rolling_Back_Steps": 0, "Undefined_Steps": 0 }, { "Date": "2017-04-08", "Completed_Steps": 99324, "Failed_Steps": 0, "Errored_steps": 0, "Obsolete_Steps": 0, "Last_hour": "Sat Apr 08 23:00:00 UTC 2017", "Activating_Steps": 3905, "In_Progress_Steps": 0, "Paused_Steps": 0, "Pausing_Steps": 0, "Canceling_Steps": 0, "Resuming_Steps": 0, "Rolling_Back_Steps": 0, "Undefined_Steps": 0 }, { "Date": "2017-04-07", "Completed_Steps": 98554, "Failed_Steps": 0, "Errored_steps": 0, "Obsolete_Steps": 0, "Last_hour": "Fri Apr 07 23:00:00 UTC 2017", "Activating_Steps": 4148, "In_Progress_Steps": 0, "Paused_Steps": 0, "Pausing_Steps": 0, "Canceling_Steps": 0, "Resuming_Steps": 0, "Rolling_Back_Steps": 0, "Undefined_Steps": 0 }, { "Date": "2017-04-06", "Completed_Steps": 69733, "Failed_Steps": 0, "Errored_steps": 0, "Obsolete_Steps": 0, "Last_hour": "Thu Apr 06 23:00:00 UTC 2017", "Activating_Steps": 4047, "In_Progress_Steps": 0, "Paused_Steps": 0, "Pausing_Steps": 0, "Canceling_Steps": 0, "Resuming_Steps": 0, "Rolling_Back_Steps": 0, "Undefined_Steps": 0 } ]