WorkList

Mit dieser Ressource lässt sich eine Liste offener oder geschlossener Arbeitselemente abrufen, die vom Benutzer gestartet wurden.

Hinweis: Die API-Dokumentation wurde zu IBM API Hub Externer Link öffnet ein neues Fenster oder einen neuen Tabmigriert. Die neuesten Updates und Dokumentationen für Blueworks Live APIs finden Sie im API Hub.

Methodenübersicht

HTTP-Methode Pfad Beschreibung
GET /scr/api/WorkList Ruft eine Liste offener oder geschlossener Arbeitselemente ab, die vom Benutzer gestartet wurden.

GET/scr/api/WorkList

Beschreibung
Mit dieser Methode lässt sich eine Liste offener oder geschlossener Arbeitselemente abrufen, die vom Benutzer gestartet wurden.
Ressourceninformationen
Anforderungen Beschreibung
Antwortformat JSON
Erfordert Authentifizierung Ja
Unterstützt OAuth 2-Clientberechtigungsnachweise Ja, es wird eine Benutzer-Service-ID verwendet, die die Ablaufsteuerungskategorie enthält
Begrenzte Rate Noch nicht
Parameter
Name Standort Beschreibung Erforderlich Typ
X-On-Behalf-Of Header Der Benutzerkontext. Der Wert muss ein Benutzername im Account sein. Der Benutzer muss über die Berechtigung zum Ausführen der Aktion im Account und im angegebenen übergeordneten Speicherbereich verfügen, sofern vorhanden. Erforderlich, wenn Anmeldeinformationen für die Dienst-ID „ OAuth “ verwendet werden. Nicht erforderlich bei Verwendung der Anmeldeinformationen „User Service ID OAuth “. Zeichenfolge
type Query Der Typ der Liste, die mit den folgenden möglichen Werten zurückgegeben wird:
  • open
  • closed
Wenn der Wert nicht unterstützt wird oder kein Wert angegeben wird, wird der Antwortcode 400 zurückgegeben.		 Ja Zeichenfolge
version Query Die Version der angeforderten API. Es ist nur ein Wert zulässig: 20110917. Ja Zeichenfolge
limit Query Wenn dieser Parameter angegeben wird, handelt es sich hierbei um die maximale Anzahl an Aufgaben, die zurückgegeben werden soll. Andernfalls wird der Standardwert 100 verwendet. Nein Integer
startFrom Query Wenn dieser Parameter angegeben wird, beginnt die zurückgegebene Liste mit der Aufgabe an diesem Index in der Liste (nullbasiert). Verwenden Sie diesen Parameter, wenn die Anzahl der verfügbaren Aufgaben höher ist als die Anzahl der zurückgegebenen Aufgaben in einem früheren Aufruf. Nein Integer
Antwort
Beispieleingabe
  • Verwendung der Client-Anmeldeinformationen der Benutzer-Service-ID OAuth 2:
    curl -i -H "Authorization: Bearer access_token"
    "https://your_server_url/scr/api/WorkList?type=open&version=20110917"
  • Verwendung der Service-ID OAuth 2 Client-Anmeldeinformationen mit Benutzerkontext:
    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"
Beispielausgabe
{
  "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"
    }
  ]
}
Antworteigenschaften
more
Enthält einen der folgenden möglichen Werte:
  • true, wenn weitere Arbeitsinstanzen auf dem Server vorhanden sind.
  • false, wenn der Arbeitseintrag alle verfügbaren Instanzen enthält.
type
Der Typ der Arbeitsinstanzen in der Liste mit den folgenden möglichen Werten:
  • open
  • closed
Diese Werte stimmen mit den möglichen Werten für den Parameter type überein, der an die Anforderung übergeben wurde.
work
Das Array der Arbeitsinstanzen, die von dueDate in umgekehrter chronologischer Reihenfolge aufgelistet werden. Elemente mit derselben dueDate werden nach Instanz-ID sortiert.
work.name
Der Name, der der Arbeitsinstanz zugeordnet wurde, als sie gestartet wurde.
work.id
Die ID der Arbeitsinstanz, zu der die Aufgabe gehört.
work.status
Der Status der Arbeitsinstanz enthält einen der folgenden möglichen Werte:
  • Active
  • Completed
  • Cancelled
  • Overdue
work.remainingTasks
Die Anzahl der Aufgaben, die für die betreffende Arbeitsintsanz ausgeführt werden müssen.
work.dueDate
Optionale Eigenschaft. Das Fälligkeitsdatum für die Task mit der kleinsten dueDate in der Instanz, d. h. die Task, die zuerst fällig ist. Wenn die Aufgaben in der Instanz keinen Fälligkeitstermin aufweisen, ist dieses Feld nicht vorhanden. Der Wert wird in Millisekunden seit 'The Epoch' (Unixzeit) angegeben, d. h., seit 1. Januar 1970, Mitternacht, koordinierte Weltzeit (Coordinated Universal Time, UTC).
work.appId
Die ID des zugehörigen Eintrags im Apps-Bereich.
apps
Das Array der Anwendungsinstanzen, die einen Eintrag für jeden eindeutigen appId -Wert im Arbeitsarray auflisten.
app.id
Die ID der Anwendung, von der die Arbeitsinstanz gestartet wurde.
app.type
The type of application contains one of the following possible values:
  • Workflow
  • Checklist
Antwortnachrichten
HTTP-Code Grund
200

Die Anforderung wurde erfolgreich ausgeführt.
400 Der erforderliche Parameter type muss angegeben werden.
401

Der Benutzer ist nicht berechtigt, diese Anforderung auszuführen.