List Tasks
Retrieves a list of all outstanding tasks for a request. This can only be used if the process status is set to WAITING. Also note that the request’s FLOW parameter in the METADATA needs to be set to an agreed-upon value to mark that these tasks are not to be handled through DataManager.
GET /connectr/api/units/{unit}/requests/{requestguid}/tasks
Example Request URL:
Template parameter | Value | Description |
---|---|---|
unit (Mandatory) | String | Unit code as used in Data Manager. This is currently defined in the Publish Store settings. |
requestguid (Mandatory) | String | Request guid as seen in the output of the request creation. |
Response status code | Content type | Description |
---|---|---|
200 OK | application/xml | Retrieval of the task list was successful. See below for the format. |
400 Not found | text/plain | The unit or request could not be found. |
409 Conflict | text/plain | The process associated with the request was not in status waiting or the FLOW code was not valid. |
Response format
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" version="1.0">
<xs:element name="TaskList" type="TaskListResponse"/>
<xs:complexType name="TaskListResponse">
<xs:sequence>
<xs:element minOccurs="0" name="ext">
<xs:complexType>
<xs:sequence>
<xs:any maxOccurs="unbounded" minOccurs="0" namespace="##other" processContents="lax"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="Tasks">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" name="TaskInfo" type="TaskInfo"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="TaskInfo">
<xs:sequence>
<xs:element minOccurs="0" name="ext">
<xs:complexType>
<xs:sequence>
<xs:any maxOccurs="unbounded" minOccurs="0" namespace="##other" processContents="lax"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="TaskGuid" type="xs:string"/>
<xs:element minOccurs="0" name="RequestGuid" type="xs:string"/>
<xs:element minOccurs="0" name="DocumentGuid" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:schema>
Response example
<?xml version="1.0"?>
<TaskList>
<ext/>
<Tasks>
<TaskInfo>
<ext/>
<TaskGuid>84aef09f-7301-48bf-af06-e7d3ccf95acc</TaskGuid>
<RequestGuid>08c69e27-e0de-4656-8f8a-4749e98ce069</RequestGuid>
<DocumentGuid>a16cfef8-f338-411d-a65c-3eb140bdbc83</DocumentGuid>
</TaskInfo>
</Tasks>
</TaskList>