AppList

Utilizzare questa risorsa per richiamare un elenco di app del processo di cui l'utente può avviare le istanze.

Nota: la documentazione API è stata trasferita su IBM API Hub Il link esterno apre una nuova finestra o scheda

. Trova gli ultimi aggiornamenti e la documentazione relativa Blueworks Live alle API nell'API Hub.

Riepilogo del metodo

Metodo HTTP	Percorso	Descrizione
GET	/scr/api/AppList	Richiama un elenco di app processo di cui l'utente può avviare le istanze.

GET /scr/api/AppList

Descrizione: Utilizzare questo metodo per richiamare un elenco di app del processo di cui l'utente può avviare le istanze.

Informazioni risorsa

Requisiti	Descrizione
Formato della risposta	JSON
Richiede l'autenticazione	Vero
Supporta le credenziali client OAuth 2	Sì utilizzando un ID servizio utente contenente la categoria di gestione lavoro
Limitato dalla frequenza	Non ancora

Parametri

Nome	Ubicazione	Descrizione	Obbligatorio	Tipo
X-On-Behalf-Of	Intestazione	Il contesto utente. Il valore deve essere un nome utente nell'account. L'utente deve disporre dell'autorizzazione per eseguire l'azione nell'account e nello spazio parent specificato, se presente.	Richiesto se si utilizzano credenziali ID servizio OAuth. Non richiesto quando si utilizzano le credenziali dell'ID servizio utente OAuth.	Stringa
version	Interroga	La versione dell'API richiesta. L'unico valore consentito è `20110917`.	Vero	Stringa

Risposta

Input di esempio

Utilizzo dell'ID servizio utente OAuth 2 credenziali client:

curl -i -H "Authorization: Bearer access_token" 
"https://your_server_url/scr/api/AppList?version=20110917"

Utilizzo dell'ID servizio OAuth 2 credenziali client:

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"

Output di esempio

{
  "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"
}

Proprietà della risposta

version: La versione dell'API utilizzata per creare la risposta.
more: Il valore è true se ci sono più istanze di definizione dell'applicazione del processo sul server e false se l'array di app include le definizioni disponibili.
apps: L'array delle istanze dell'applicazione del processo elencate in ordine alfabetico per nome.
app.name: Il nome dell'app processo da cui è stata avviata l'istanza di lavoro.
app.id: L'ID dell'app processo da cui è stata avviata l'istanza di lavoro.
app.processId: L'ID del processo correlato a questa app. Utilizzare questa proprietà per mettere in corrispondenza le voci del feed notizie con un'app.
app.type: Il tipo di app ha due valori possibili, workflow o checklist.
app.new: Questa proprietà è presente solo se il valore è true. Indica un'applicazione del processo che l'utente non ha visualizzato prima.
favorites: L'array di app che l'utente ha selezionato come preferiti. L'ordine corrisponde a quello fornito nella precedente chiamata a UpdateFavorites. Questo elenco potrebbe includere ID app che non sono restituiti nell'array di applicazioni. L'ID app non viene restituito nell'array di app quando un utente contrassegna un'applicazione come preferita, ma in un secondo momento l'app diventa non condivisa. L'ID è incluso nell'elenco dei preferiti, quindi il chiamante può accedervi includendo l'ID come parte di una chiamata a UpdateFavorites.
favorites.id: L'ID dell'app del processo preferita. Un oggetto con questo ID viene visualizzato nell'array di applicazioni.

Messaggi di risposta

Codice HTTP	Motivo
200	La richiesta è stata completata correttamente.
400	Si è verificato un errore durante l'elaborazione della richiesta. I parametri richiesti non sono presenti o contengono valori non validi.
401	L'utente non è autorizzato a effettuare la richiesta.