WorkList

Utilizar este recurso para recuperar una lista de elementos de trabajo abiertos o cerrados iniciados por el usuario.

Nota: La documentación de la API se ha migrado a IBM API Hub El enlace externo abre una nueva ventana o pestaña. Encuentre las últimas actualizaciones y documentación sobre Blueworks Live API en API Hub.

Resumen del método

Método HTTP Vía de acceso Descripción
GET /scr/api/WorkList Recupera una lista de elementos de trabajo abiertos o cerrados iniciados por el usuario.

GET/scr/api/WorkList

Descripción
Utilizar este método para recuperar una lista de elementos de trabajo abiertos o cerrados iniciados por el usuario.
Información de recursos
Requisitos Descripción
Formato de la respuesta JSON
Requiere autenticación Sí
Permite credenciales de cliente de OAuth 2 Sí utilizando un ID de servicio de usuario que contiene la categoría de gestión de trabajo
Velocidad limitada Aún no
Parámetros
Nombre Ubicación Descripción Obligatorio Tipo
X-On-Behalf-Of Cabecera El contexto de usuario. El valor debe ser un nombre de usuario en la cuenta. El usuario debe tener permiso para realizar la acción en la cuenta y en el espacio padre especificado, si lo hay. Necesario si se utilizan credenciales de ID de servicio OAuth. No es necesario cuando se utiliza la credencial de ID de servicio de usuario OAuth. Serie
type Consulta El tipo de lista a devolver con los siguientes valores posibles:
  • open
  • closed
Si el valor no está soportado o si no se proporciona ningún valor, se devuelve el código de respuesta 400.		 Sí Serie
version Consulta Versión de la API solicitada. El único valor permitido es 20110917. Sí Serie
limit Consulta Si se proporciona este parámetro, establece el número máximo de tareas a devolver. De lo contrario, se usa el valor predeterminado de 100. Nee Entero
startFrom Consulta Si se proporciona este parámetro, la lista devuelta empieza con la tarea en este índice en la lista (basada en cero). Utilice este parámetro si el número de tareas disponibles es mayor que el número de tareas devueltas en una llamada anterior. Nee Entero
Respuesta
Entrada de ejemplo
  • Uso de la ID de servicio de usuario OAuth 2 credenciales de cliente:
    curl -i -H "Authorization: Bearer access_token"
    "https://your_server_url/scr/api/WorkList?type=open&version=20110917"
  • Uso de la ID de servicio OAuth 2 credenciales de cliente con contexto de usuario:
    curl -i -H "Authorization: Bearer access_token" -H "X-On-Behalf-Of:user_name@domain.com"
    "https://your_server_url/scr/api/WorkList?type=open&version=20110917"
Resultado de ejemplo
{
  "apps": [
  ],
  "more": false,
  "type": "open",
  "version": "20110917",
  "work": [
    {
      "appId": "3d5213c8",
      "dueDate": 1347595199781,
      "id": "3d522280",
      "name": "Followed - Process App - Simple Workflow - Followed - Process App - Simple Workflow - work1",
      "remainingTasks": 5,
      "status": "Active"
    },
    {
      "appId": "5f600081603a8",
      "id": "5f600081d0b46",
      "name": "Request for Policy Review - open project",
      "remainingTasks": 2,
      "status": "Active"
    }
  ]
}
Propiedades de respuesta
more
Contiene uno de los siguientes valores posibles:
  • true si hay más instancias de trabajo en el servidor.
  • false si la entrada de trabajo incluye todas las instancias disponibles.
type
El tipo de instancias de trabajo incluidas en la lista con los siguientes valores posibles:
  • open
  • closed
Estos valores coinciden con los valores posible para el parámetro type que se ha pasado a la solicitud.
work
La matriz de instancias de trabajo listadas por dueDate en orden cronológico inverso. Los elementos con el mismo dueDate se ordenan por ID de instancia.
work.name
Nombre asignado a la instancia de trabajo cuando se inició.
work.id
ID de la instancia de trabajo de la que forma parte la tarea.
work.status
El estado de la instancia de trabajo contiene uno de los siguientes valores posibles:
  • Active
  • Completed
  • Cancelled
  • Overdue
work.remainingTasks
El número de tareas que deben completarse para la instancia de trabajo específica.
work.dueDate
Propiedad opcional. La fecha de vencimiento de la tarea que tiene el dueDate más pequeño en la instancia, es decir, la tarea que vence primero. Si las tareas de la instancia no tienen fechas de vencimiento, este campo no está presente. El valor se expresa en milisegundos desde epoch, es decir, 1 de enero de 1970 a medianoche, hora universal coordinada (UTC).
work.appId
El ID de la entrada relacionada en la matriz de aplicaciones.
apps
La matriz de instancias de aplicación que listan una entrada para cada valor appId exclusivo en la matriz de trabajo.
app.id
El ID de la aplicación desde la que se ha iniciado la instancia de trabajo.
app.type
The type of application contains one of the following possible values:
  • Workflow
  • Checklist
Mensajes de respuesta
Código HTTP Razón
200

La solicitud se ha completado correctamente.
400 Debe proporcionarse la especificación del parámetro type necesario.
401

El usuario no está autorizado a realizar la petición.