Extracting Invisible Watermarks
Function
This API is used to extract invisible watermarks from Word (.docx), PPT (.pptx), Excel (.xlsx), and PDF (.pdf) files. You need to pass watermarked formData files to this API, DSC returns extracted text watermarks in JSON format.
URI
POST /v1/{project_id}/sdg/doc/watermark/extract
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
doc_type |
Yes |
String |
Type of the document from which a watermark needs to be extracted. Enumeration values:
|
|
file_password |
No |
String |
Password for opening a file, which can contain a maximum of 256 characters. Opening a watermarked file does not require a password. If an Office Word document requires a password for read or domain control, you need to enter the password to open the file. |
|
file |
Yes |
File |
File to be uploaded for watermark extraction. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
watermark |
String |
Invisible watermark. The length cannot exceed 32 characters. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error Code |
|
error_msg |
String |
Error Message |
Example Requests
Submit the request using the form. The "file" indicates a specified document.
POST /v1/{project_id}/sdg/doc/watermark/extract
{
"file" : "testMarked.doc",
"doc_type" : "WORD"
}
Example Responses
Status code: 200
Request successful.
{
"watermark" : "mark!"
}
Status code: 400
Invalid request.
{
"error_code" : "DSC.00000007",
"error_msg" : "File format error"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Request successful. |
|
400 |
Invalid request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
