File List
Scope
Retrieve a list of files in a file processing session.
Description
1. Returns information about files stored in the file processing session:
1.1. If the session files are not yet signed, a list of all files is returned;
1.2. If the session files are signed, the signed file (EDOC / PDF) is returned.
Request
The Service provider's application sends the following GET request using TLS:
GET /api-storage/v1.0/{sessionId}/list
| Property | Type | Usage | Description |
|---|---|---|---|
sessionId | String (64) | Mandatory | File processing session identifier |
Authorization
The request must contain an Authorization header with an OAuth Introspect access token obtained via Integration Platform a Service provider's credentials grant flow.
Example
GET /api-storage/v1.0/77740b301f0880ef498cb1e474e8060b3e538cfeea8ebf508c2bad4b72b56a87/list HTTP/1.1 Authorization: Bearer a477b3a3366768c07e4c458f518711b4b351e8d2c2f0f78a1524e4d3efd00603 Host: signapi-prep.eparaksts.lv
Response
JSON object:
{
"data": {
"includedDocuments": [
{
"id": {String},
"name": {String},
"size": {Number},
"type": {String}
}
],
"id": {String},
"name": {String},
"size": {Number},
"type": {String}
}
}
| Property | Type | Description |
|---|---|---|
data | Object | Data Object |
data.includedDocuments | Array | Files included in signed container |
data.includedDocuments.id | String | Included file Identifier (documentId) |
data.includedDocuments.name | String | Included file name |
data.includedDocuments.size | Integer | Included file size in bytes |
data.includedDocuments.type | String | Processed file type: "file" - In case of file or ASICE container "hash" - In case if file digest and file name is added to session |
data.id | String | File Identifier (documentId) |
data.name | String | File name File size in bytes |
data.size | String | File size in bytes |
data.type | String | Processed file type: "file" - In case of file or ASICE container "hash" - In case if file digest and file name is added to session |
Examples
Example of ASICE container containing one file
{
"data": {
"includedDocuments": [
{
"id": "3cbc266934776e581bcb406f15bb5ffd",
"name": "Receipt.doc",
"size": 22528,
"type": "file"
}
],
"id": "23a3abe0a211478ae55554649178568e",
"name": "Receipt.edoc",
"size": 14805,
"type": "file"
}
}
Example of ASICE container when file digest and name is signed
{
"data": [
{
"includedDocuments": [
{
"id": "dc7a737f0d3dcb288902ed1df4942ee3",
"name": "Report.docx",
"size": 0,
"type": "hash"
}
],
"id": "592ad9f0c4f9356db0d0d3716a87d5f1",
"name": "DigestEdoc.edoc",
"size": 8891,
"type": "file"
}
]
}
