Querying the General Task List

Function

This API is used to query the general tasks and their important information.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/api/reusable-jobs/list

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: 32-character UUID of a CodeArts project, which must be unique. Constraints: N/A Value range: The value contains 32 characters. Default value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition: Offset where the query starts. Constraints: N/A Value range: The offset value must be no less than 0. Default value: N/A
limit	No	Integer	Definition: Number of records of each query. Constraints: N/A Value range: ≥ 0 Default value: N/A
sort_key	No	String	Definition: Sorting field. Constraints: N/A Value range: N/A Default value: N/A
sort_dir	No	String	Definition: Sorting direction. Constraints: N/A Value range: N/A Default value: N/A
name	No	String	Definition: Name for fuzzy search. Constraints: N/A Value range: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
offset	Integer	Offset.
limit	Integer	Number of records queried at a time.
total	Integer	Total number.
reusable_jobs	Array of reusable_jobs objects	Job list.

**Table 4** reusable_jobs
Parameter	Type	Description
id	String	Job ID.
name	String	Job name.
description	String	Job description.
domain_id	String	Tenant ID.
region	String	Region information.
project_id	String	Project ID.
steps	Array of steps objects	Step list.
deleted	Boolean	Deleted or not.
enabled	Boolean	Enabled or not.
creator_id	String	Creator ID.
updater_id	String	Updater ID.
create_time	Integer	Creation time.
update_time	Integer	Update time.

**Table 5** steps
Parameter	Type	Description
name	String	Step name.
task	String	Task type.

Example Requests

POST https://{endpoint}/v5/0493899d9e6644cba4583c778443fad0/api/reusable-jobs/list

{
  "offset" : 0,
  "limit" : 10,
  "name" : "",
  "sort_key" : "create_time",
  "sort_dir" : "desc"
}

Example Responses

Status code: 200

{
  "offset" : 0,
  "limit" : 10,
  "total" : 2,
  "reusable_jobs" : [ {
    "id" : "35b54cc1cf904fa786233a1f0555a630",
    "name" : "Build",
    "description" : "",
    "domain_id" : "0bc8d446b78010880f2fc009114e92a0",
    "region" : "ru-northwest-201",
    "project_id" : "0493899d9e6644cba4583c778443fad0",
    "deleted" : false,
    "enabled" : true,
    "creator_id" : "URdkP0HZQ3mewZYy5QOIYEJ2909KJvJA",
    "updater_id" : "URdkP0HZQ3mewZYy5QOIYEJ2909KJvJA",
    "creator_name" : "user1",
    "updater_name" : "user1",
    "create_time" : 1742784776000,
    "update_time" : 1742784776000,
    "pipelines" : [ {
      "id" : "ddb7b80a43534f4da7cd49f2f70bd61e",
      "name" : "NewPipeline-20250324105223"
    } ]
  }, {
    "id" : "42a062e332474470a4d6bd9c555fa81a",
    "name" : "Delayed Execution",
    "description" : "",
    "domain_id" : "0bc8d446b78010880f2fc009114e92a0",
    "region" : "ru-northwest-201",
    "project_id" : "0493899d9e6644cba4583c778443fad0",
    "deleted" : false,
    "enabled" : true,
    "creator_id" : "URdkP0HZQ3mewZYy5QOIYEJ2909KJvJA",
    "updater_id" : "URdkP0HZQ3mewZYy5QOIYEJ2909KJvJA",
    "creator_name" : "user1",
    "updater_name" : "user1",
    "create_time" : 1742784260000,
    "update_time" : 1742784260000,
    "pipelines" : [ {
      "id" : "f05ad5f64e7e4594a6ba2fe308101f3b",
      "name" : "NewPipeline-20250324104423"
    } ]
  } ]
}