Operation: Read Data
The operation Read Data
retrieves a list of all stored documents (with their ID) for a given process ID or PUID
to view the history of documents associated with this specific process and access the information stored in the documents. The operation is able to handle documents of various types and formats. This operation expects a PID
or PUID
as input from the operation Log Data
.
Input
The adapter expects the following XML structure as input:
Example for Input
<Element>
<ID></ID>
<PID></PID>
<PUID>900444F6-11BB-429D-83D5-D3A5B8BD67A0</PUID>
</Element>
The following elements can be included in the input:
Attribute | Description |
---|---|
ID | ID of the document to be retrieved The document ID is generated with the output. After receiving the output, the document ID can be used to retrieve the content of the document. |
PID | ID of the process for which the document is retrieved |
PUID | PUID of the process for which the document is retrieved |
Output
The adapter generates an XML file as output with a list of all stored documents with ID for that process:
Example for Output
<Data>
<OperationReadData>
<ID>7</ID>
<PID>1676987395858400882</PID>
<PUID>900444F6-11BB-429D-83D5-D3A5B8BD67A0</PUID>
<Timestamp>2023-02-21 14:51:57.700</Timestamp>
<Name>Capture.png</Name>
<Data>iVBORw0KGgoAAAANSUhEUgAAAyEAAAEBCAYAAABv3arsAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAAEuYSURBVHhe7b39Sxzn/v///Z8G3jAQiTRETjjxQBN/sJZI5JxwpNIFISJEGk6tnKCcIpa3lTepHloNRAPBhZYtLVsI2m/DlpK1NNYWa0plAwsLCwv+sCuXV1ZqPCXuuQEZODclWZV8ZiZVgvmtdc6MWRyR9T/833V460x9bXWOerIuQ0G8n7gOfjvQOgomBAAAAAAAOsqpNCEIIYQQQgihV1ud5qWaEAAAAAAAgDiYEAAAAAAA6CiYEAAAAAAA6CiYEAAAAAAA6CiYEAAAAAAA6CiYEAAAAAAA6CiYEAAAAAAA6CiYEAAAAAAA6CiYEAAAAAAA6CiYEAAAAAAA6CiYEAAAAAAA6CiYEAAAAAAA6CiYEAAAAAAA6CiYEAAAAAAA6CAi/w8jDYkjkPrTRQAAAABJRU5ErkJggg==</Data>
<MimeType>image/png</MimeType>
<Size>19459</Size>
</OperationReadData>
<OperationReadData>
<ID>8</ID>
<PID>1676987395858400882</PID>
<PUID>900444F6-11BB-429D-83D5-D3A5B8BD67A0</PUID>
<Timestamp>2023-02-21 14:51:57.756</Timestamp>
<Name>LogData.xml</Name>
<Data>PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxSb290RWxlbWVudD4NCnRoaXMgaXMgYSB0ZXN0IExvZ0RhdGEgdHJhbnNpdGlvbg0KPC9Sb290RWxlbWVudD4gDQo8IS0tQ3JlYXRlZCBieSBYNCBEZXNpZ25lciwgQ29weXJpZ2h0IMKpIFNvZnRQcm9qZWN0IEdtYkguIEFsbCByaWdodHMgcmVzZXJ2ZWQuLS0+</Data> <MimeType>application/xml</MimeType>
<Size>189</Size>
</OperationReadData>
</Data>
The following elements can be included in the output:
Attribute | Description |
---|---|
ID | ID of the document generated with the output |
PID | ID of the process from which the document is retrieved |
PUID | PUID of the process from which the document is retrieved |
Timestamp | Creation date of the document |
Name | Name of the document |
Data | Content of the document in Base64 format |
MimeType | Type of the document |
Size | Size of the document in bytes |
Retrieving the data
In the output, the document ID is given that can then be used in a further process to the retrieve the data of the document with this ID.
The adapter with the operation Read Data
expects the following XML input structure to get the document:
Example for Input
<Element>
<ID>7</ID>
<PID></PID>
<PUID>900444F6-11BB-429D-83D5-D3A5B8BD67A0</PUID>
</Element>