查询所有团队的标注成员列表
功能介绍
查询所有团队的标注成员列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/workforces/workers
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
用户项目ID。获取方法请参见获取项目ID和名称。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
指定每一页返回的最大条目数,取值范围[1,100],默认为10。 |
|
offset |
否 |
Integer |
分页列表的起始页,默认为0。 |
|
order |
否 |
String |
指定查询的排序顺序。可选值如下:
|
|
role |
否 |
Integer |
根据成员角色过滤查询。可选值如下:
|
|
sort_by |
否 |
String |
指定查询的排序方式。可选值如下:
|
请求参数
无
响应参数
状态码: 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_number |
Integer |
标注团队成员总数。 |
|
workers |
Array of Worker objects |
分页查询到的标注团队成员列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
create_time |
Long |
创建时间。 |
|
description |
String |
标注成员描述,长度为0-256位,不能包含^!<>=&"'特殊字符。 |
|
|
String |
标注成员邮箱。 |
|
role |
Integer |
角色。可选值如下:
|
|
status |
Integer |
标注成员的当前登录状态。可选值如下:
|
|
update_time |
Long |
更新时间。 |
|
worker_id |
String |
标注成员ID。 |
|
workforce_id |
String |
所属标注团队ID。 |
请求示例
查询所有团队的标注管理员
GET https://{endpoint}/v2/{project_id}/workforces/workers??role=2
响应示例
状态码: 200
OK
{
"total_number" : 2,
"workers" : [ {
"email" : "xxx@xxx.com",
"worker_id" : "df40e4afcb793d13f01f6c9022341e6f",
"workforce_id" : "feSUo5NUIUnQAQNNTiS",
"status" : 0,
"role" : 2,
"description" : "",
"create_time" : 1595927749772,
"update_time" : 1595927749772
}, {
"email" : "xxx@xxx.com",
"worker_id" : "27906df1d06c0827b7c24f761d618541",
"workforce_id" : "XiL5RcHmxyIt3aYIOtI",
"status" : 0,
"role" : 2,
"description" : "",
"create_time" : 1590027298717,
"update_time" : 1590027298717
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
错误码
请参见错误码。