Querying Custom Jobs

Function

This API is used to query custom jobs.

Constraints

Only the custom job list of the current account can be queried.

URI

GET /v1/documents

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition: Pagination parameter, which indicates the maximum number of records returned on each page. Constraints: N/A. Value range: N/A. Default value: N/A.
offset	No	String	Definition: Offset. Constraints: N/A. Value range: N/A. Default value: N/A.
name_like	No	String	Definition: Job name (fuzzy). Constraints: N/A. Value range: N/A. Default value: N/A.
creator	No	String	Definition: Creator. Constraints: N/A. Value range: N/A. Default value: N/A.
enterprise_project_id	No	String	Definition: Enterprise project ID. Constraints: N/A. Value range: N/A. Default value: N/A.
document_type	No	String	Definition: Type of the job to be executed. Constraints: N/A Value range: PRIVATE: private PUBLIC: public Default value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
total	Long	Definition: Total number of records. Value range: N/A.
data	Array of DocumentListVo objects	Definition: Data in the job list. Value range: N/A.

**Table 3** DocumentListVo
Parameter	Type	Description
document_id	String	Definition: Job UUID Value range: N/A.
name	String	Definition: Job name. Value range: N/A.
create_time	String	Definition: Creation time. Value range: N/A.
update_time	String	Definition: Update time. Value range: N/A.
version	String	Definition: Job version, for example, v1 Value range: N/A.
creator	String	Definition: Creator. Value range: N/A.
modifier	String	Definition: Modifier. Value range: N/A.
enterprise_project_id	String	Definition: Enterprise project ID. Value range: N/A.

Example Requests

Query the custom job list.

GET https://{Endpoint}/v1/documents?offset=0&limit=2

Example Responses

Status code: 200

Custom jobs are successfully queried.

{
  "data" : [ {
    "document_id" : "DM2025063021170101xxxxx",
    "name" : "qweqwe",
    "create_time" : 1751289421846,
    "update_time" : 1751289421846,
    "version" : "v1",
    "creator" : "COC-xxxxx",
    "modifier" : null,
    "enterprise_project_id" : "0"
  }, {
    "document_id" : "DM20250604143026019xxxxx",
    "name" : "cfm-job-new-0604001",
    "create_time" : 1749018626043,
    "update_time" : 1751075577067,
    "version" : "v3",
    "creator" : "COC-xxxxx",
    "modifier" : "COC-xxxxx",
    "enterprise_project_id" : "0"
  } ],
  "total" : 74
}