Consulta de la lista de equipos de etiquetado
Función
Esta API se utiliza para consultar la lista de equipos de etiquetado.
URI
GET /v2/{project_id}/workforces
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:
|
search_content |
No |
String |
Palabra clave de búsqueda difusa. De forma predeterminada, este parámetro se deja en blanco. |
sort_by |
No |
String |
Modo de clasificación de la consulta. Opciones:
|
workforce_task_id |
No |
String |
ID de una tarea de etiquetado de equipo. |
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 equipos de etiquetado. |
workforces |
Array of Workforce objects |
Lista de equipo de etiquetado por página. |
Parámetro |
Tipo |
Descripción |
---|---|---|
create_time |
Long |
Hora en que se crea un equipo de etiquetado. |
description |
String |
Descripción de un equipo de etiquetado. |
update_time |
Long |
Hora en que se actualiza un equipo de etiquetado. |
worker_count |
Integer |
Número total de miembros del equipo de etiquetado. |
workforce_id |
String |
ID de un equipo de etiquetado. |
workforce_name |
String |
Nombre de un equipo de etiquetado. |
workspace_id |
String |
ID del espacio de trabajo. Si no se crea ningún espacio de trabajo, el valor predeterminado es 0. Si se crea y utiliza un espacio de trabajo, utilice el valor real. |
Solicitudes de ejemplo
Consulta de la lista de equipos de etiquetado
GET https://{endpoint}/v2/{project_id}/workforces
Ejemplo de respuestas
Código de estado: 200
OK
{ "total_number" : 2, "workforces" : [ { "workforce_id" : "ZUH8gqkjuaib8pxkDdz", "workforce_name" : "team-123", "description" : "my team", "worker_count" : 0, "create_time" : 1606354772548, "update_time" : 1606354772548 }, { "workforce_id" : "3Ry04NsqvEybuWYLDvC", "workforce_name" : "team-170a", "description" : "", "worker_count" : 1, "create_time" : 1604644946891, "update_time" : 1606238678626 } ] }
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.