Obtaining Details About a Task for Extracting Watermarks from Industrial Drawings in Batches
Function
This API is used to query the progress or result of a task for extracting watermarks from industrial drawings based on the task ID.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/watermark/extract/tasks/{task_id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. |
|
task_id |
Yes |
String |
Task ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
task_id |
String |
Task ID. |
|
status |
Integer |
Task status. 0: in progress, 1: completed, 2: failed. |
|
total |
Integer |
Total number of files in the task. |
|
completed |
Integer |
Total number of completed files. |
|
remarks |
Array of EngineeringDrawingWmExtractResult objects |
Watermark extraction result. |
|
Parameter |
Type |
Description |
|---|---|---|
|
file_address |
String |
Address where the drawing is stored on OBS. |
|
watermark_exist |
Boolean |
Whether the drawing contains watermarks. |
|
watermark |
String |
Watermark result extracted from the drawing. |
|
status |
String |
Status of the drawing, whether it is pending. |
|
remark |
String |
Remarks of the drawing, which may be the failure cause. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error Code |
|
error_msg |
String |
Error Message |
Example Requests
Query the result of a task for extracting watermarks from industrial drawings based on the task ID.
GET /v1/abcdefghigklmnopqrstuvwxyz123456/watermark/extract/tasks/f84dcc533e864a4e944a4df346601819 HTTP/1.1
Example Responses
Status code: 400
Invalid request.
{
"error_code" : "DSC.00000002",
"error_msg" : "DSC internal error"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Request succeeded. |
|
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