Get Information about Process
Retrieves more information about the state of a process for a given request.
GET /connectr/api/units/{unit}/requests/{requestguid}
Example Request URL: http://connectr.example.org:8080/connectr/api/units/4.1/requests/5037a3b5-7ec5-4281-89a7-1b352c9bfb95
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 request info was successful. See below for the format. |
404 Not found | text/plain | The unit or request could not be found. |
Response format
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="ProcessInfo" type="ProcessInfo"/>
<xs:complexType name="ProcessInfo">
<xs:sequence>
<xs:element name="status" type="xs:string"/>
<xs:element name="flow" type="xs:string"/>
<xs:element name="primaryDocumentGuid" type="xs:string" minOccurs="0"/>
<xs:element name="owner" type="xs:string"/>
<xs:element name="isPackage" type="xs:boolean"/>
<xs:element name="startDate" type="xs:dateTime"/>
<xs:element name="lastModificationDate" type="xs:dateTime"/>
<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:sequence>
</xs:complexType>
</xs:schema>
Response example
<ProcessInfo>
<status>GENERATION_FINISHED</status>
<flow>PDF</flow>
<isPackage>true</isPackage>
<startDate>2015-10-22T14:21:40.497Z</startDate>
<lastModificationDate>2015-10-22T14:21:43.293Z</lastModificationDate>
<ext/>
</ProcessInfo>
Response example with error message returned (available when configured in the workflow)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ProcessInfo>
<status>GENERATION_FAILED</status>
<flow>PDF</flow>
<isPackage>false</isPackage>
<startDate>2018-07-25T14:17:28.887Z</startDate>
<lastModificationDate>2018-07-25T14:17:29.793Z</lastModificationDate>
<ext>
<FLOW xmlns:ns2="be.lettergen.RequestMetaData" xmlns:ns3="http://www.lettergen.com/datastore" xmlns:xmime="http://www.w3.org/2005/05/xmlmime">
<FILES/>
<ERROR component="DirMon">be.btr.lettergen.exception.ProcessingException: Failed to generate document ; nested exception is com.lettergen.generatorextension.v3.GeneratorServiceException: Failed to get input data - Source URI:http://localhost:15220/modelstore/ModelStore/Publish/UnitName/myDocument/nl-NL/compiled.lgp | TimeStamp: 1532528249230http://localhost:15220/modelstore/ModelStore/Publish/UnitName/myDocument/nl-NL/compiled.lgp</ERROR>
</FLOW>
</ext>
</ProcessInfo>