Help Center/ ModelArts/ API Reference/ Historical APIs/ Data Management (Old Version)/ Querying Details About Labeling Team Members
Updated on 2024-05-30 GMT+08:00

Querying Details About Labeling Team Members

Function

This API is used to query details about labeling team members.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

worker_id

Yes

String

ID of a labeling team member.

workforce_id

Yes

String

ID of a labeling team.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

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: annotator

  • 1: reviewer

  • 2: team manager

  • 3: dataset owner

status

Integer

Current login status of a labeling team member. Options:

  • 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 Details About Labeling Team Members

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

Example Responses

Status code: 200

OK

{
  "email" : "xxx@xxx.com",
  "worker_id" : "b1e4054407ecb36a7bcde70f52ba37f2",
  "workforce_id" : "gyb7IaAvkLc5IhEY2dv",
  "status" : 0,
  "role" : 2,
  "description" : "",
  "create_time" : 1606356324223,
  "update_time" : 1606356324223
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.