AppList

Utilice este recurso para recuperar una lista de aplicaciones de proceso de las que el usuario puede iniciar instancias.

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/AppList	Recupera una lista de aplicaciones de proceso de las que el usuario puede iniciar instancias.

GET/scr/api/AppList

Descripción: Utilice este método para recuperar una lista de aplicaciones de proceso de las que el usuario puede iniciar instancias.

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

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/AppList?version=20110917"

Uso de la ID de servicio OAuth 2 credenciales de cliente:

curl -i -H "Authorization: Bearer access_token" -H "X-On-Behalf-Of:user_name@domain.com" 
    "https://your_server_url/scr/api/AppList?version=20110917"

Resultado de ejemplo

{
  "more": false,
  "apps": [
    {
      "id": "31ea912ac7",
      "new": true,
      "processId": "31ea912ac3",
      "name": "develop process diagram",
      "type": "workflow"
    },
    {
      "id": "9bea79df89",
      "new": true,
      "processId": "9bea79df85",
      "name": "any process app",
      "type": "checklist"
    },
    {
      "id": "1000062ea88cacf",
      "new": true,
      "processId": "1000062ea88cacb",
      "name": "test due date in email",
      "type": "checklist"
    },
    {
      "id": "10000d6400c755d",
      "new": true,
      "processId": "10000d6400c7558",
      "name": "test notification email",
      "type": "workflow"
    },
    {
      "id": "1000062ea88f4cc",
      "new": true,
      "processId": "1000062ea88f4c8",
      "name": "test date on task",
      "type": "workflow"
    },
    {
      "id": "3f37005d",
      "new": true,
      "processId": "3f370019",
      "name": "Submit Process for Review",
      "type": "workflow"
    },
    {
      "id": "100004e3fe76b25",
      "new": true,
      "processId": "100004e3fe76b20",
      "name": "testing 2",
      "type": "workflow"
    },
     {
      "id": "400004cea8bdab9",
      "new": true,
      "processId": "400004cea8bd626",
      "name": "test due date in email",
      "type": "checklist"
    },
    {
      "id": "400004cea8bdacb",
      "new": true,
      "processId": "400004cea8bd625",
      "name": "test date on task",
      "type": "workflow"
    }
  ],
  "favorites": [],
  "version": "20110917"
}

Propiedades de respuesta

version: Versión de la API que se ha utilizado para crear la respuesta.
more: El valor es true si hay más instancias de definición de aplicación de proceso en el servidor y false si la matriz de aplicaciones incluye las definiciones disponibles.
apps: Matriz de las instancias de aplicación de proceso listadas en orden alfabético por nombre.
app.name: Nombre de la aplicación de proceso desde la que se ha iniciado la instancia de trabajo.
app.id: ID de la aplicación de proceso desde la que se ha iniciado la instancia de trabajo.
app.processId: ID del proceso que está relacionado con esta aplicación. Utilice esta propiedad para que las entradas de transferencia de noticias coincidan con una aplicación.
app.type: El tipo de aplicación tiene dos valores posibles, workflow o checklist.
app.new: Esta propiedad sólo está presente si el valor es true. Indica una aplicación de proceso que el usuario no ha visto anteriormente.
favorites: La matriz de aplicaciones que el usuario ha seleccionado como favoritas. El orden coincide con el proporcionado en la llamada anterior a UpdateFavorites. Esta lista puede incluir los ID de aplicación que no se devuelven en la matriz de aplicación. El ID de aplicación no se devuelve en la matriz de aplicación cuando un usuario marca una aplicación como favorita, pero posteriormente la aplicación se deja de compartir. El ID se incluye en la lista de favoritos, por lo tanto, el llamador puede acceder a él incluyéndolo como parte de una llamada a UpdateFavorites.
favorites.id: ID de la aplicación de proceso favorita. Un objeto con este ID aparece en la matriz de aplicación.

Mensajes de respuesta

Código HTTP	Razón
200	La solicitud se ha completado correctamente.
400	Se ha producido 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.