TaskList

Mit dieser Ressource kann eine Liste mit offenen Aufgaben, die dem aktuellen Benutzer zugeordnet wurden, und mit den Aufgaben, die bereits abgeschlossen wurden, abgerufen werden.

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/TaskList Ruft eine Liste ab mit offenen Aufgaben, die dem aktuellen Benutzer zugeordnet wurden, und mit den Aufgaben, die bereits abgeschlossen wurden.

GET/scr/api/TaskList

Beschreibung
Mit dieser Methode kann eine Liste mit offenen Aufgaben, die dem aktuellen Benutzer zugeordnet wurden, und mit den Aufgaben, die bereits abgeschlossen wurden, abgerufen werden.
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 zurückzugebenden Liste. Es werden folgende Werte unterstützt: assigned oder completed. Wenn der Wert nicht unterstützt 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 Die maximale Anzahl an zurückzugebenden Aufgaben. Wenn der Parameter nicht angegeben wird, 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 mit Limit. 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/TaskList?type=completed&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/TaskList?type=completed&version=20110917"
Beispielausgabe
{
      "work":[
         {           
            "name":"ProcessApp 1 - Multiple process apps.",        
            "id":"5f501e1345eda"
         },
         {           
            "name":"ProcessApp 2 - Multiple process apps.",        
            "id":"5f500e134a57f"
         },
     ]
}
Antworteigenschaften
version
Die Version der API, mit der die Antwort erstellt wurde.
more
Enthält einen der folgenden möglichen Werte:
  • true, wenn weitere Tasks auf dem Server vorhanden sind.
  • false, wenn der Taskeintrag alle verfügbaren Tasks enthält.
type
Der Typ der Aufgaben in der Liste. Die folgenden Werte sind möglich: assigned oder completed. Diese Werte stimmen mit den Werten überein, die für den Typparameter übergeben werden können.
tasks
Der Bereich von Aufgaben. Die Tasks werden in umgekehrter chronologischer Reihenfolge von dueDate aufgelistet. Elemente mit derselben dueDate werden nach Instanz-ID und Task-ID sortiert.
task.name
Der Name der Task.
task.id
Die ID der Task.
task.workId
Die ID der zugeordneten Arbeit. Diese Eigenschaft entspricht der Eigenschaft "ID" von einem der Einträge im Arbeitsbereich. Auf denselben Arbeitseintrag kann mehr als eine Aufgabe verweisen.
task.dueDate
Optionaler Parameter. Das Fälligkeitsdatum für die Aufgabe. Das Feld wird nicht angezeigt, wenn die Aufgabe kein Fälligkeitsdatum aufweist. Das Fälligkeitstermin wird in Millisekunden seit 'The Epoch' (Unixzeit) angegeben, d. h., seit 1. Januar 1970, Mitternacht, koordinierte Weltzeit (Coordinated Universal Time, UTC).
work
Der Bereich von Arbeitselementen. Die Arbeitselemente sind in keiner bestimmten Reihenfolge angegeben. Es gibt einen Eintrag im Array für jeden eindeutigen Wert von workId im Task-Array.
work.name
Der Name, der der Arbeitsinstanz zugeordnet wurde, als sie gestartet wurde.
work.id
Die ID der Arbeitsinstanz.
Antwortnachrichten
HTTP-Code Grund
200

Die Anforderung wurde erfolgreich ausgeführt.
400

Bei der Verarbeitung der Anforderung ist ein Fehler aufgetreten. Erforderliche Parameter fehlten oder enthielten ungültige Werte.
401

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