Get Workflow History Details
Business applications can use this service API to get the details of an action performed in the document. The action is identified by the log_id provided in the resource URL. The package ID is provided in the resource URL.
|
https://api.signinghub.com/v3/packages/{package_id}/log/{log_id}/details |
|||
|
HTTP Verb |
GET |
||
|
Accept |
application/json |
||
|
Authorization |
Bearer {access_token} |
||
| x-base64 | true | ||
|
Request Body |
|
||
|
Status Code |
Message |
Response Body |
|
|
200 |
OK
|
{ "data": [ { "data": [ ], "key": "LOG_ACTIVITY_DOCUMENT_NAMES", "key_label": "Document Name", "value": "Test-document", "value_label": "Test-document", "visible": false, "order": 0, "certificate_base64": null, "certificate_base64_url": "https://api_link_to_resource", "type": "" }, { "data": [ ], "key": "IP_ADDRESS", "key_label": "IP Address", "value": "192.168.0.168", "value_label": "192.168.0.168", "visible": false, "order": 0, "certificate_base64": null, "certificate_base64_url": "https://api_link_to_resource", "type": "" } ], "key": "", "key_label": "", "value": "", "value_label": "", "visible": false, "order": 0, "certificate_base64": null, "certificate_base64_url": "https://api_link_to_resource", "type": ""} |
|
|
401 |
Unauthorized |
{ "Message": "Request authorization denied"} |
|
{ "Message": "User authentication required"} |
|||
|
403 |
Forbidden |
{ "Message": "Document does not belong to user"} |
|
{ "Message": "Account is disabled"} |
|||
{ "Message": "You are not allowed to perform the requested operation"} |
|||
|
404 |
Not Found |
{ "Message": "Document not found"} |
|
|
500 |
Internal Server Error |
{ "Message": "An internal server error occurred while processing the request"} |
|
| Item Details | |
| Names |
Description |
| Request Parameters |
|
| access_token | The access token obtained as a result of successful authentication. If "scope" parameter was used in authentication request, then this service requires the access token to be obtained using the credentials of an Enterprise admin whose enterprise role has the application integration privileges. |
| x-base64 |
True if response should have images in base64 format. False will only return the resource URLs in response. |
| package_id |
The ID of the package for which log is required. |
| log_id | The ID of the log action for which the details are requested. |
| Response Parameters | |
| data | An Array of all the data attributes related to the action for the log details are requested. |
| data > data | A nested array for all the attributes related to the current key in the data. |
| key |
A string identifier to identify the type of information related to the action. |
| key_label |
Language translation for the key attribute, if the key value is translatable. |
| value |
Value of the attribute against the key. |
| value_label | Language translation for the value attribute, if the value is translatable. |
| visible | True, if the key is to be visible for the end user in the UI. |
| order |
Display order for the key in the UI. |
| certificate_base64 | Certificate bytes which is used to sign the document. Value returns only if the action involves a certificate, otherwise null. |
| certificate_base64_url | API endpoint to access the resource |
| type | Type of action values can be DOCUMENT, USER, ALL or null. |
| Message | The service specific error message returned by the API. This message provides useful information about why the service has returned an error response. |