WorkDetail

Utilice este recurso para recuperar información sobre un trabajo determinado.

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/WorkDetail Recupera información sobre un trabajo determinado.

GET/scr/api/WorkDetail

Descripción
Utilice este método para recuperar información sobre un trabajo determinado.
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
version Consulta Versión de la API solicitada. El único valor permitido es 20110917. Sí Serie
workId Consulta ID del trabajo que desea recuperar. Sí Serie
Respuesta
Entrada de ejemplo
  • Utilizando las credenciales de cliente OAuth 2:
    curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/scr/api/WorkDetail?workId=a0713&version=20110917"
Resultado de ejemplo
{  
   "work":{  
      "runtimeVersion":[  
         "ede1c9df-61be-4774-99ab-196ec6742d57",
         "5f501e134c6bf",
         2
      ],
      "details":"my sample details",
      "canManageWork":true,
      "name":"ProcessApp 1 approval task - New for test.",
      "subject":"New for test.",
      "tasks":[  
         {  
            "isApproved":false,
            "status":"Completed",
            "assignedTo":"7f0002",
            "name":"toBeApproved\/Rejected",
            "id":"5f501e134c6ce",
            "approvalStep":true
         },
         {  
            "status":"NotStarted",
            "dueDate":2554358399278,
            "assignedTo":"7f0002",
            "name":"New task.",
            "id":"5f501e134c6e2",
            "approvalStep":false
         }
      ],
      "attachments":[  
         {  
            "size":3.0,
            "uploadedBy":"7f0002",
            "type":9,
            "name":"foo.txt",
            "id":"5f500e1349358",
            "canDelete":true,
            "uploadedOn":1441206442048
         }
      ],
      "status":"Active",
      "comments":[  

      ],
      "startedAt":1441219222958,
      "startedBy":"7f0002",
      "id":"5f501e134c6bf",
      "appId":"5f500e1349338"
   },
   "app":{  
      "detailsTitle":null,
      "type":"workflow",
      "name":"ProcessApp 1 approval task",
      "id":"5f500e1349338",
      "subjectTitle":null
   },
   "version":"20110917",
   "users":[  
      {  
         "avatarId":"5f500e1260203",
         "name":"admin",
         "id":"7f0002"
      }
   ]
}
Propiedades de respuesta
version
Versión de la API que se ha utilizado para crear la respuesta.
work
Objeto de trabajo.
work.runtimeVersion
Matriz que identifica la versión de la instancia de trabajo. Trate este valor como un elemento de datos opacos. El work.runtimeVersion es necesario para el WorkAction.
work.name
Nombre a mostrar para la instancia de trabajo.
work.id
ID de la instancia de trabajo.
work.subject
Asunto especificado por el usuario que ha creado la instancia.
work.details
Detalles especificados por el usuario que ha creado la instancia.
work.status
El estado del trabajo incluye uno de los valores siguientes:
  • Active
  • Completed
  • Cancelled
  • Overdue
work.startedBy
ID del usuario que ha creado la instancia. Un objeto con este ID aparece en la matriz del usuario.
work.startedAt
Fecha y hora en que la instancia se ha iniciado. El valor se expresa en milisegundos desde epoch, es decir, 1 de enero de 1970 a medianoche, hora universal coordinada (UTC).
work.completedBy
ID del usuario que ha completado o cancelado la instancia. Solo está presente si el estado es Completed o Cancelled. Un objeto con este ID aparece en la matriz del usuario.
work.completedAt
Fecha y hora en que la instancia se ha completado o cancelado. El valor se expresa en milisegundos desde epoch, es decir, 1 de enero de 1970 a medianoche, hora universal coordinada (UTC). Solo está presente si el estado es Completed o Cancelled.
work.appId
ID de aplicación desde la que se ha iniciado la instancia. Esta aplicación aparece en el objeto de aplicación.
work.canManageWork
Indica si el usuario tiene permisos para cancelar trabajo, modificar asunto o reasignar tareas.
work.tasks
Matriz de tareas asociadas a la instancia.
work.tasks.name
Nombre de la tarea.
work.tasks.id
El ID de la tarea.
work.tasks.assignedTo
ID del usuario a quien se le asigna la tarea. Un objeto con este ID aparece en la matriz del usuario.
work.tasks.actioner
ID del usuario que no es el propietario de la tarea y que ha creado el último cambio en el estado de la tarea. Un objeto con este ID aparece en la matriz del usuario. Cuando se reasigna una tarea, work.tasks.actioner hace referencia al ID del usuario que ha hecho la reasignación, mientras que el usuario assignedTo es el usuario al que se ha asignado originalmente la tarea.
work.tasks.dueDate
Fecha en que vence la tarea. Esta propiedad sólo está presente si se ha establecido dueDate para la tarea.
work.tasks.status
Contiene uno de los siguientes valores posibles:
  • Pending
  • NotStarted
  • InProgress
  • Completed
  • Reassigned
work.tasks.reassignmentReason
Esta propiedad sólo está presente si el estado es Reassigned. Contiene uno de los siguientes valores posibles:
  • TaskReassigned
  • OwnerDowngraded
  • OwnerArchived
work.tasks.approvalStep
El valor es true o false.
work.tasks.isApproved
Si la tarea es un paso de aprobación, es decir, si approvalStep es true y la tarea se completa, es decir, si el valor de status es Completed, entonces isApproved está presente y el valor es true o false.
work.attachments
Matriz de archivos adjuntos asociados a la instancia o la aplicación desde la que se ha iniciado.
work.attachments.name
El nombre del adjunto.
work.attachments.id
ID del archivo adjunto.
work.attachments.uploadedBy
ID del usuario que ha subido el archivo adjunto. Un objeto con este ID aparece en la matriz del usuario.
work.attachments.uploadedOn
Fecha y hora en que se ha subido el archivo adjunto. El valor se expresa en milisegundos desde epoch, es decir, 1 de enero de 1970 a medianoche, hora universal coordinada (UTC).
work.attachments.size
Tamaño del archivo adjunto en bytes.
work.attachments.type
Tipo de archivo adjunto con el valor numérico asociado.
Tipo de conexión Descripción
1 Documento genérico. Se utiliza si el archivo no corresponde a ninguno de los otros valores.
2 Archivo de Microsoft Excel
3 Image
4 Documento PDF
5 Documento de Microsoft PowerPoint
6 Documento de Microsoft Project
7 Documento de Microsoft Visio
8 Documento de Microsoft Word
work.attachments.canDelete
Indica si el usuario tiene permisos para suprimir el archivo adjunto.
work.attachments.deletedOn
Fecha y hora en que se ha suprimido el archivo adjunto. El valor se expresa en milisegundos desde epoch, es decir, 1 de enero de 1970 a medianoche, hora universal coordinada (UTC). Este campo sólo está presente si el archivo se ha suprimido de la cuenta mediante las páginas de administración. En este caso, no puede descargar el archivo utilizando FileDownload.
work.attachments.deletedBy
Nombre del usuario que ha suprimido el archivo adjunto. Este campo sólo está presente si el archivo se ha suprimido de la cuenta mediante las páginas de administración.
work.comments
Matriz de comentarios en la instancia.
work.comments.from
ID del usuario que ha creado el comentario. Un objeto con este ID aparece en la matriz del usuario.
work.comments.id
ID del comentario.
work.comments.commentDate
Fecha en que se ha creado el comentario.
work.comments.text
El texto del comentario.
work.comments.canDelete
Indica si el usuario puede suprimir el comentario.
work.comments.replies
Lista de las respuestas al comentario padre.
app
Información sobre la aplicación desde la que se ha iniciado la instancia.
app.name
Nombre de la aplicación desde la que se ha iniciado la instancia de trabajo.
app.id
ID de la aplicación desde la que se ha iniciado la instancia de trabajo.
app.subjectTitle
Título del área de edición en la que el usuario ha especificado el asunto de la instancia.
app.detailsTitle
Título del área de edición en la que el usuario ha especificado detalles de la instancia.
app.type
Tipo de la aplicación que contiene uno de los siguientes valores posibles:
  • workflow
  • checklist
users
Matriz de usuarios a cuyos ID se hace referencia desde otras ubicaciones en JSON.
users.name
Nombre completo del usuario.
users.id
El ID del usuario.
users.avatarId
ID del avatar que ha establecido el usuario. Esta propiedad sólo está presente si el usuario ha establecido un avatar.
Mensajes de respuesta
Código HTTP Razón
200

La solicitud se ha completado correctamente.
400

Hay un error al procesar la solicitud. Faltaban algunos parámetros obligatorios o contenían valores no válidos.
401

El usuario no está autorizado a realizar la petición.
404 No se ha encontrado el trabajo especificado.