Consulta de la lista de todos los miembros del equipo de etiquetado
Función
Esta API se utiliza para consultar la lista de todos los miembros del equipo de etiquetado.
URI
GET /v2/{project_id}/workforces/workers
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto. Para obtener más información sobre cómo obtener el ID de proyecto, consulte Obtención de un ID de proyecto. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
limit |
No |
Integer |
Número máximo de registros devueltos en cada página. El valor varía de 1 a 100. El valor predeterminado es 10. |
offset |
No |
Integer |
Página de inicio de la lista de paginación. El valor predeterminado es 0. |
order |
No |
String |
Secuencia de clasificación de la consulta. Opciones:
|
role |
No |
Integer |
Filtrado de consulta basado en el rol de miembro. Opciones:
|
sort_by |
No |
String |
Modo de clasificación de la consulta. Opciones:
|
Parámetros de solicitud
Ninguno
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
total_number |
Integer |
Número total de miembros del equipo de etiquetado. |
workers |
Array of Worker objects |
Lista de miembros de equipo de etiquetado consultada por página. |
Parámetro |
Tipo |
Descripción |
---|---|---|
create_time |
Long |
Tiempo de creación. |
description |
String |
Descripción del miembro del equipo de etiquetado. El valor contiene de 0 a 256 caracteres y no admite los siguientes caracteres especiales: ^!<>=&"' |
String |
Dirección de correo electrónico de un miembro del equipo de etiquetado. |
|
role |
Integer |
Rol. Opciones:
|
status |
Integer |
Estado actual de inicio de sesión de un miembro del equipo de etiquetado. Opciones:
|
update_time |
Long |
Tiempo de actualización. |
worker_id |
String |
ID de un miembro del equipo de etiquetado. |
workforce_id |
String |
ID de un equipo de etiquetado. |
Solicitudes de ejemplo
Consulta de todos los administradores de equipos de etiquetado
GET https://{endpoint}/v2/{project_id}/workforces/workers??role=2
Ejemplo de respuestas
Código de estado: 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 } ] }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
Códigos de error
Consulte Códigos de error.