doc-exports/docs/modelarts/api-ref/ListWorkers.html

Querying the List of Labeling Team Members

Function

This API is used to query the list of labeling team members.

URI

GET /v2/{project_id}/workforces/{workforce_id}/workers

Table 1 Path Parameters

Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
workforce_id	Yes	String	ID of a labeling team.

Table 2 Query Parameters

Parameter	Mandatory	Type	Description
limit	No	Integer	Maximum number of records returned on each page. The value ranges from 1 to 100. The default value is 10.
offset	No	Integer	Start page of the paging list. The default value is 0.
order	No	String	Sorting sequence. The options are as follows: asc: ascending order desc: descending order (default value)
sort_by	No	String	Sorting mode of the query. The options are as follows: create_time: Sort by creation time. (Default value) email: Sort by email.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter	Type	Description
total_number	Integer	Total number of labeling team members.
workers	Array of Worker objects	Labeling team members list queried by page.

Table 4 Worker

Parameter	Type	Description
create_time	Long	Creation time.
description	String	Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'
email	String	Email address of a labeling team member.
role	Integer	Role. The options are as follows: 0: labeling personnel 1: reviewer 2: team administrator 3: dataset owner
status	Integer	Current login status of a labeling team member. The options are as follows: 0: The invitation email has not been sent. 1: The invitation email has been sent but the user has not logged in. 2: The user has logged in. 3: The labeling team member has been deleted.
update_time	Long	Update time.
worker_id	String	ID of a labeling team member.
workforce_id	String	ID of a labeling team.

Example Requests

Querying the List of Labeling Team Members

GET https://{endpoint}/v2/{project_id}/workforces/{workforce_id}/workers

Example Responses

Status code: 200

OK

{
  "total_number" : 3,
  "workers" : [ {
    "email" : "xxx@xxx.com",
    "worker_id" : "b1e4054407ecb36a7bcde70f52ba37f2",
    "workforce_id" : "gyb7IaAvkLc5IhEY2dv",
    "status" : 0,
    "role" : 2,
    "description" : "",
    "create_time" : 1606356324223,
    "update_time" : 1606356324223
  }, {
    "email" : "xxx@xxx.com",
    "worker_id" : "8c15ad080d3eabad14037b4eb00d6a6f",
    "workforce_id" : "gyb7IaAvkLc5IhEY2dv",
    "status" : 0,
    "role" : 0,
    "description" : "",
    "create_time" : 1591783804629,
    "update_time" : 1591783804629
  }, {
    "email" : "xxx@xxx.com",
    "worker_id" : "2880f38d660dd68ca6ab578b5a1d9558",
    "workforce_id" : "gyb7IaAvkLc5IhEY2dv",
    "status" : 0,
    "role" : 0,
    "description" : "",
    "create_time" : 1575104629439,
    "update_time" : 1575104629439
  } ]
}

Status Codes

Status Code	Description
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

Error Codes

See Error Codes.

Parent topic: Labeling Team Member Management