Get mutation status

开发环境

GET

/mutationStatus/{requestId}

Miscellaneous

Get the status for an asynchronous mutation to know whether or not it has been completed. Each API endpoint that mutates a document will return a request id that you can pass to this endpoint to check the completion status. Status information is not guaranteed to be available for more than one day after the mutation was completed. It is intended to be used shortly after the request was made.

请求示例

Python

Shell

JavaScript

Java

curl --location --request GET 'http://dev-cn.your-api-server.com/mutationStatus/abc-123-def-456'

响应示例

200 - 示例 1

{
  "completed": true,
  "warning": "Initial page HTML was invalid."
}

请求参数

Path 参数

requestId

string

必需

ID of the request.

示例值:

abc-123-def-456

返回响应

🟢200Info about the mutation.

application/json

Body

The status of an asynchronous mutation.

completed

boolean

必需

Returns whether the mutation has completed.

示例值:

true

warning

string

可选

A warning if the mutation completed but with caveats.

示例值:

Initial page HTML was invalid.

🟠401401

🟠404404

🟠429429

修改于 2024-03-20 08:13:15

Resolve browser link

Trigger automation