POST
Returns all embedded files from a given PDF document.
The following example returns all embedded files in a given PDF document.
# Request:
curl --location --request POST 'https://trial.dsserver.io/documentprocessing/pdf/embeddedfiles' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer fePFHv8OtIyRSCAdOnn7USc9kKdYB2rg' \
--data-raw '"JVBERi0xLjcNJeLjz[..]"'
# Result:
{
"creationDate": "2021-02-03T12:55:44Z",
"data": "JVBERi0xLjQNJ[..]=",
"dataType": "BASE64BINARY",
"description": "checkboxes.pdf",
"fileName": "checkboxes.pdf",
"lastModificationDate": "2021-02-03T12:55:44Z",
"mimeType": "application/pdf",
"relationship": "",
"metadata": null
}
Type | Value |
---|---|
string | The PDF document encoded as a Base64 string. |
Status | Type | Description |
---|---|---|
200 | Embedded |
On success, the HTTP status code in the response header is 200 (OK). The response body contains an array of Embedded |
Name | Type | Value | Optional |
---|---|---|---|
creation |
Long | Specifies the date of the creation (UNIX EPOCH time). | yes |
data | String | Specifies the data of the embedded file. | yes |
data |
String | Specifies the type of the data. | yes |
description | String | Specifies the description of the embedded file. | yes |
file |
String | Specifies the file name of the embedded file. | yes |
last |
Long | Specifies the last modification date (UNIX EPOCH time). | yes |
MIMEType | String | Specifies the MIME type of the embedded file (for example: "application/pdf"). | yes |
relationship | String | Specifies the relationship string of the embedded file. | yes |
metadata | String | Specifies meta data for the embedded file. | yes |
Status | Description |
---|---|
401 | A 401 (Unauthorized) is returned, if the user is not authorized. |
400 | A 400 (Bad Request) is returned, if DS Server is not licensed or the license is invalid. |
400 | A 400 (Bad Request) is returned, if no document is found in the body. |
400 | A 400 (Bad Request) is returned, if the uploaded document is not valid. |