Updated on 2025-02-28 GMT+08:00

Obtaining the Job List

Function

This API is used to obtain the job list.

URI

GET /v1/{project_id}/infer/tasks

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

title

No

String

Algorithm name

camera_name

No

String

Camera name

Minimum: 1

Maximum: 255

task_state

No

String

Job status

task_name

No

String

Job name

page_size

No

Integer

Number of items displayed on each page

Minimum: 5

Maximum: 50

Default: 10

page

No

Integer

Offset

Default: 1

sort_dir

No

String

Sorting rule for displaying service jobs

Default: desc

batch_id

No

String

Batch configuration ID

video_group_id

No

String

Video group ID. Multiple values are separated by commas (,).

company

No

String

Vendor name. Multiple values are separated by commas (,).

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Number of records displayed on the current page

tasks

Array of taskInfoInList objects

Obtained jobs

page

Integer

Current page number

page_size

Integer

Maximum number of records displayed on a page

Table 5 taskInfoInList

Parameter

Type

Description

id

String

Job ID

name

String

Job name

created_at

String

Job creation time

state

String

Status of a job

video_source_name

String

Video source name

title

String

Algorithm name

company

String

Vendor name

type

String

Job type

group_name

String

Group name. Multiple values are separated by commas (,).

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Normal

Error Codes

See Error Codes.