Help Center/ModelArts/API Reference/Historical APIs/Data Management (Old Version)/Updating a Team Labeling Task
Updated on 2025-05-30 GMT+08:00
View PDF

Updating a Team Labeling Task

Function

This API is used to update a team labeling task.

Debugging

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

URI

PUT /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

dataset_id

Yes

String

Dataset ID.

project_id

Yes

String

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

workforce_task_id

Yes

String

ID of a team labeling task.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

dataset_id

No

String

Dataset ID.

description

No

String

Team labeling task description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'

task_id

No

String

ID of a team labeling task.

task_name

No

String

Team labeling task name. The value contains 1 to 64 characters and only letters, digits, underscores (_), and hyphens (-) are allowed.

workforces_config

No

WorkforcesConfig object

Team labeling task information: Tasks can be assigned by the team administrator or a specified team.

Table 3 WorkforcesConfig

Parameter

Mandatory

Type

Description

agency

No

String

Administrator

workforces

No

Array of WorkforceConfig objects

List of teams that execute labeling tasks.

Table 4 WorkforceConfig

Parameter

Mandatory

Type

Description

workers

No

Array of Worker objects

List of labeling team members.

workforce_id

No

String

ID of a labeling team.

workforce_name

No

String

Name of a labeling team. The value contains 0 to 1024 characters and does not support the following special characters: !<>=&"'

Table 5 Worker

Parameter

Mandatory

Type

Description

create_time

No

Long

Creation time.

description

No

String

Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'

email

No

String

Email address of a labeling team member.

role

No

Integer

Role. Options:

  • 0: labeling personnel

  • 1: reviewer

  • 2: team administrator

  • 3: dataset owner

status

No

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

No

Long

Update time.

worker_id

No

String

ID of a labeling team member.

workforce_id

No

String

ID of a labeling team.

Response Parameters

None

Example Requests

Updating a Team Labeling Task

{
  "workforces_config" : {
    "workforces" : [ {
      "workforce_id" : "3frbQ90hb8ZKksAhyR8",
      "workers" : [ {
        "email" : "xxx@xxx.com"
      }, {
        "email" : "xxx@xxx.com"
      } ]
    } ]
  }
}

Example Responses

Status code: 200

OK

{ }

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.