Downloading a Positive Selection Report
GET https://<votiro_appliance>/disarmer/api/disarmer/v4/report/<ID>
Generates a report that details which engines were executed on each item and sub-item during the positive selection process.
Request Data
Request URL Parameters
Request parameters are case sensitive.
Parameter | Description | Type | Required/Optional |
|---|---|---|---|
ID | Upload request ID | string | Required |
Request Header Parameters
Request parameters are case sensitive.
Parameter | Description | Type | Required/Optional |
|---|---|---|---|
Authorization | Bearer <token> is used for authentication | string | Required. |
Request Example
GET https://api.votiro.com/disarmer/api/disarmer/v4/report/ c94f00a4-7a36-4152-977d-dda71cccfb95
Authorization: "Bearer <token>"
Response Data
The download response is a JSON object.
Response Body
Parameter | Description | Type | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ID | Upload request ID. | string | ||||||||||||
| relativePath | Relative path of the child from the root item. | string | ||||||||||||
originalFileName | Relative path of artifact file. | string | ||||||||||||
sanitizedFileName | Relative path of artifact file. | string | ||||||||||||
| originalSize | File size in bytes of the original file. | number | ||||||||||||
| sanitizedSize | File size in bytes of the processed file. | number | ||||||||||||
| originalPublishStatus | Publish status of the original file. | number | ||||||||||||
| sanitizedPublishStatus | Publish status of the processed file. | number | ||||||||||||
FileType | File type information for the current artifact as determined by Votiro File Type Discoverer. | object | ||||||||||||
FileType.Code | File type code. | number | ||||||||||||
FileType.Type | Artifact file type description. | string | ||||||||||||
FileType.Family | Artifact file type family description. | string | ||||||||||||
| queueTime | Always zero, positive selection process starts immediately. | string | ||||||||||||
| processStartTime | Time Votiro started the file processing. | string | ||||||||||||
| processEndTime | Time Votiro processing ended. | string | ||||||||||||
| status | Positive selection status. | string | ||||||||||||
Events | Events for the current artifact. | array of Events objects | ||||||||||||
Events.date | The date and time of the event. | string | ||||||||||||
Events.id | Event code. See the following table. | number | ||||||||||||
| Events.name | Event name. | string | ||||||||||||
Events.message | Event textual description message. Subject to changes. | string | ||||||||||||
Events.severity | Urgency of the event: The valid integer values are 0-6, where 6 is the most severe. | number | ||||||||||||
Events.category | Category name and value. Can be one of:
See the following Report Events table. | number | ||||||||||||
Events.subCategory | The subCategory name and value are unique within the category it belongs to. See the following Report Events table. | number | ||||||||||||
children | Sub-objects that were processed separately from the processed file, for example, a ZIP archive file or nested Office document. | array | ||||||||||||
| hash | File hash code. | string | ||||||||||||
| extendedInfo | Email metadata, if delivered. | object |
Response Example
{
"id": "0bafef86-41e0-4ccc-a69f-00b812cb5602",
"relativePath": "",
"originalFileName": "bar.json",
"sanitizedFileName": "bar.json",
"originalSize": 450,
"sanitizedSize": 0,
"originalPublishStatus": 0,
"sanitizedPublishStatus": 0,
"fileType": {
"code": 125,
"type": "Unknown Text",
"family": "Unknown Text Files"
},
"queueTime": "00:00:00",
"processStartTime": "2020-07-13T09:33:51.8399432Z",
"processEndTime": "2020-07-13T09:33:56.855111Z",
"status": "OK",
"events": [
{
"date": "0001-01-01T00:00:00",
"id": 10020100,
"name": "File Uploaded",
"message": "File bar.json upload for sanitization started. Item Id: 0bafef86-41e0-4ccc-a69f-00b812cb5602",
"severity": 2,
"category": 10000000,
"subCategory": 10020000
}
],
"children": [],
"hash": "d598b34dc6d5e1556a00ff9df852f390fef6bc9a390ca744f12cd88ee89299f7",
"extendedInfo": {
"email": {
"headers": [],
"from": {
"address": null,
"displayName": null
},
"to": [],
"envelopeRecipients": [],
"cc": [],
"bcc": [],
"subject": null,
"body": null,
"date": "2020-07-13T13:08:08.1473082+00:00",
"attachments": [],
"embeddedResources": []
}
}
}
Comments
0 comments
Please sign in to leave a comment.