Submit a Task
This endpoint submits a task.
You can submit a task as one of these user roles:
- User
- Admin on behalf of a user, with the input_provider parameter:
The required path parameter is task_id.
Note: The default format for the response is XML format. To return a response in JSON format,
add &format=json to the request.
Submitting as a User
Request:
http://Orchestrator_IP_address/aspera/orchestrator/api/submit_task/task_id.format?login=admin&outputs[Filename]=output_paramFor example:
http://Orchestrator_IP_address/aspera/orchestrator/api/submit_task/1.xml?login=admin&outputs[Filename]=tron.avi Example response
(XML):
<?xml version="1.0" encoding="UTF-8"?>
<User_task>
<input_provider>admin</input_provider>
<task>
<userInput_id>2</userInput_id>
<state_id>2626</state_id>
<created_at>Fri Dec 04 03:38:23 UTC 2015</created_at>
<updated_at>Fri Dec 04 06:01:55 UTC 2015</updated_at>
<role_id>1</role_id>
<status>Complete</status>
<completedBy>1</completedBy>
<user_id />
<id>1</id>
</task>
<user_inputs>Filenametron.avi</user_inputs>
</User_task>
Submitting as an Admin on Behalf of a User
An admin can submit a task on behalf of a user by passing the input_provider parameter.
Request:
http://Orchestrator_IP_address/aspera/orchestrator/api/submit_task/task_id.format?login=admin&input_provider=<user>&outputs[Filename]=<output_param>
For
example:
http://Orchestrator_IP_address/aspera/orchestrator/api/submit_task/55.xml?login=admin&input_provider='lola'&outputs[Filename]=tron.aviExample response
(JSON):
{
"input_provider":"lola",
"task":{
"active_assignment":{
"userInput_id":2,
"state_id":2626,
"created_at":"2015-12-04T03:38:23Z",
"updated_at":"2015-12-04T06:01:55Z",
"role_id":1,
"status":"Complete",
"completedBy":1,
"user_id":null,
"id":1
}
},
"user_inputs":{
"Filename":"tron.avi"
}
}