Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com> Co-committed-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
9.9 KiB
Deleting Labeling Team Members in Batches
Function
This API is used to delete labeling team members in batches.
Debugging
You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.
URI
POST /v2/{project_id}/workforces/{workforce_id}/workers/batch-delete
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. |
workforce_id |
Yes |
String |
ID of a labeling team. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
workers |
Yes |
Array of strings |
Team member ID list. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
results |
Array of BatchResponse objects |
Result of deleting team members in batches. |
success |
Boolean |
Check whether the operation is successful. Options:
|
Example Requests
Deleting Labeling Team Members in Batches
{ "workers" : [ "89d4ae38431b8905449821605abdc3a9", "a2abd3f27b4e92c593c15282f8b6bd29" ] }
Example Responses
Status code: 200
OK
{ "success" : true, "results" : [ { "success" : true }, { "success" : true } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
Error Codes
See Error Codes.