List Documents
Retrieves a list of all documents associated with a given request.
GET /connectr/api/units/{unit}/requests/{requestguid}/documents
Example Request URL:
http://connectr.example.org:8080/connectr/api/units/4.1/requests/f4dc0da49ad14e768f84afb953807e04
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 document list was successful. See below for the format. |
404 Not found | text/plain | The unit or request could not be found. |
409 Conflict | text/plain | The process associated with the request has not finished yet so the list cannot be built at this time. |
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="DocumentList" type="DocumentListResponse"/>
<xs:complexType name="DocumentListResponse">
<xs:sequence>
<xs:element name="ext" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:any processContents="lax" namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="documentInfo" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="documentInfo" type="DocumentInfo" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="DocumentInfo">
<xs:sequence>
<xs:element name="documentGuid" type="xs:string"/>
<xs:element name="infoItems" type="InfoItem" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="InfoItem">
<xs:sequence>
<xs:element name="type" type="docInfoType"/>
<xs:element name="value" type="xs:string"/>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="docInfoType">
<xs:restriction base="xs:string">
<xs:enumeration value="CONTENTTYPE"/>
<xs:enumeration value="MODELTYPE"/>
<xs:enumeration value="DESCRIPTION"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
Response example
<DocumentList>
<ext/>
<documentInfo>
<documentInfo>
<documentGuid>5aabfa2f-7a8d-4fed-99b4-83807e4a1c85</documentGuid>
<infoItems>
<type>DESCRIPTION</type>
<value>Template_7.3_3.3.0</value>
</infoItems>
<infoItems>
<type>CONTENTTYPE</type>
<value>application/pdf</value>
</infoItems>
<infoItems>
<type>MODELTYPE</type>
</infoItems>
</documentInfo>
</documentInfo>
</DocumentList>