Returns a document metadata with given ID in JSON format.
Service specification:
| URL | https://apidev.okdokument.com/JSON/document/metadata/{{documentId}} |
| Method | GET |
| Authentication | Header x-api-key |
| Response Type | application/json |
Request description #
Request parameters:
| Key | Type | Description |
| documentId | path | Unique document id |
HTTP- Click to view HTTP code snippet
GET /JSON/document/metadata/00h2dY9Zo8KN-MXBFTX1SeJrJqTWrNwzBsFiNJEmM0OUr3Qje3tjuNyP91dyBGMlV4qFYITYqzzIlYb9b6lyI0rLZh7pWscYcJIgpGCAs6U HTTP/1.1
Host: localhost:8080
x-api-key: 7796b696_bd2b1aaf7ef4f09be9f52ce2d8d599674d81aa9d6a4421696dc4d93dd0619d682ce56b4d64a9ef097761ced99e0f67265b5f76085e5b0ee7ca4696b2ad6fe2b2Response description #
| Status code | Description |
| 200 OK | Document metadata |
| 401 Unauthorized | When user is not authenticated |
| 403 Forbidden | When user lacks required permissions |
| 404 Not Found | If the document with the specified id does not exist. |
| 500 Internal Server Error | Server processing error |
Properties of the item:
| filename | Name of the item. (*.pdf) |
| id | Unique identification of the document (used to send acknowledgments) |
| url | Link to download (for document) or to list the contents |
| state | State of the document: “tosign”, “signed” |
Example of success response
{
"filename": "cec00479-5669-491d-ae52-47d3b690efd7.pdf",
"state": "tosign",
"modification": "2022-06-21 14:30:44",
"id": "y7Ki_u1mrUwijfb-o_S1JiphSsoXya8iypH380F",
"date": 1655814644472,
"number": "1655814644463"
}Example of error response
{
"message": "err.not.found",
"value": "00h2dY9Zo8KN-MXBFTX1SW-ICkKkmV-1KwsfT6V_og8wPw8rOxkqPFWMOYP-17BWyLU_PVTt19HPLwkI9WF5izCdQJMD2ZBRIy0E36ToS3Y22"
}