WorkAction

Mit dieser Ressource kann eine Aktion für ein Arbeitselement ausgeführt 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
POST /scr/api/WorkAction Führt eine Aktion für ein Arbeitselement aus.

POST /scr/api/WorkAction

Beschreibung
Mit dieser Methode kann eine Aktion für ein Arbeitselement ausgeführt werden.
Wichtig: Führen Sie WorkDetail zunächst aus, um Informationen über das Workitem abzurufen, für das Sie eine Aktion ausführen möchten. Verwenden Sie die Ausgabe dieser API, um die Parameter für WorkAction auszufüllen.
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
action Query Die Informationen zur auszuführenden Aktion. Das Format für diesen Parameter wird im Beispiel dargestellt. Je nach angefordertem Aktionstyp müssen in einigen Feldern Eingaben erfolgen. Ja Siehe Aktionsparameter unten
version Query Die Version der angeforderten API. Es ist nur ein Wert zulässig: 20110917. Ja Zeichenfolge
Aktionsparameter
Name Beschreibung Datentyp
action.subject Das Thema zu einer neuen Arbeitsinstanz. Zeichenfolge
action.runtimeVersion Die Reihe von Werten, die von WorkDetail. bereitgestellt werden. Zeichenfolge
action.workId Die ID des Arbeitselements, für das die Aktion ausgeführt werden soll. Verwenden Sie dieselbe ID wie für den Aufruf von WorkDetails. Zeichenfolge
action.appId Die ID der Anwendung, auf die sich diese Arbeit bezieht. Diese ID wird beim Ausführen von WorkDetails bereitgestellt. Zeichenfolge
action.timeZoneId Die Zeitzone, in der die Instanz gestartet werden soll. Wenn die Zeitzone nicht angegeben wird, wird der Wert aus den aktuellen Einstellungen des Benutzers verwendet. Wenn auch die Zeitzoneneinstellung des Benutzers nicht festgelegt wurde, wird der Standardwert des Servers verwendet. Zeichenfolge
action.type Der Typ der auszuführenden Aktion. Über diesen Parameter wird festgelegt, welche zusätzlichen Felder benötigt werden. Die folgenden Aktionstypen sind verfügbar:
COMPLETE
Abschließen der aktuellen Aufgabe.
APPROVE
Freigeben der aktuellen Aufgabe. Ist nur zulässig, wenn es sich bei der Aufgabe um einen Genehmigungsschritt handelt. Erfordert den Parameter action.task.id.
REJECT
Ablehnen der aktuellen Aufgabe. Ist nur zulässig, wenn es sich bei der Aufgabe um einen Genehmigungsschritt handelt. Erfordert den Parameter action.task.id.
ADD_TASK
Aktuelle Aufgabe ausführen und eine neue Aufgabe hinzufügen. Erfordert die Parameter action.task.id, action.task.assignedTo, action.task.name, action.task.approvalStep (optional) und action.task.dueDateExpression (optional).
REASSIGN
Neu zuweisen der Aufgabe. Erfordert die Parameter action.task.id und action.task.assignedTo.
CHANGE_SUBJECT
Ändern des Arbeitsthemas. Erfordert den Parameter action.subject.
CANCEL_INSTANCE
Abbrechen des Arbeitselements.
REMOVE_ATTACHMENT
Entfernen von Anhängen aus der Instanz. Erfordert den Parameter action.attachmentId.
 Zeichenfolge
action.subject Erforderlich für die Aktion CHANGE_SUBJECT. Ein neues Thema für das Arbeitselement. Zeichenfolge
action.attachmentId Erforderlich für die Aktion REMOVE_ATTACHMENT. Die ID des Anhangs, der aus der Instanz entfernt werden soll. Zeichenfolge
action.task.id Erforderlich für die Aktionen ADD_TASK, REASSIGN, APPROVE, COMPLETEund REJECT. Die ID der Aufgabe, für die die Aktion ausgeführt wird. Wenn eine ADD_TASK -Aktion ausgeführt wird, wird diese Task-ID abgeschlossen und eine neue erstellt. Zeichenfolge
action.task.assignedTo Erforderlich für die Aktionen REASSIGN und ADD_TASK. Die ID des Benutzers, dem diese Aufgabe zugeordnet wurde. Zeichenfolge
action.task.name Erforderlich für die Aktion ADD_TASK. Der Name der Task. Zeichenfolge
action.task.approvalStep Optional für die Aktion ADD_TASK und nur für Arbeitselemente des Typs workflow erforderlich. Gibt an, ob diese Aufgabe ein Genehmigungsschritt ist. Es wird der Wert "false" angenommen, wenn für den Parameter kein Wert gefunden werden kann. Boolesch
action.task.dueDateExpression Optional für die Aktion ADD_TASK. Gibt das Fälligkeitsdatum für diese Task im Format YYYY/MM/DD an. Zeichenfolge
Antwort
Beispieleingabe
  • Verwendung der Client-Anmeldeinformationen der Benutzer-Service-ID OAuth 2:
    curl -i -X POST
  'https://your_server_url/scr/api/WorkAction?&version=20110917' 
  --data-urlencode 'action={"action":{"runtimeVersion":["34c2522c-fda6-40f3-abe8-d98cf8e46e65","a0713",1],"workId":"a0713","appId":"80038","type":"CANCEL_INSTANCE","timeZoneId":"America/Los_Angeles"}}' 
  --header 'Accept: application/json' 
  --header 'Authorization: Bearer access_token'
  • Verwendung der Service-ID OAuth 2 Client-Anmeldeinformationen mit Benutzerkontext:
    curl -i -X POST
  'https://your_server_url/scr/api/WorkAction?&version=20110917' 
  --data-urlencode 'action={"action":{"runtimeVersion":["34c2522c-fda6-40f3-abe8-d98cf8e46e65","a0713",1],"workId":"a0713","appId":"80038","type":"CANCEL_INSTANCE","timeZoneId":"America/Los_Angeles"}}' 
  --header 'Accept: application/json' 
  --header 'Authorization: Bearer access_token'
Beispiele für Aktionsparameter
{
   "action": {
     "runtimeVersion":[
       "037ee4bb-30c8-40e7-b083-0946e750f889",
       "b0059",
       0
     ],
     "workId":"b0059",
     "appId":"87654",
     "type":"CANCEL_INSTANCE",
     "timeZoneId":"America/Los_Angeles"
 }
}
{
   "action": {
     "runtimeVersion":[
       "037ee4bb-30c8-40e7-b083-0946e750f889",
       "b0059",
       0
     ],
     "attachmentId":"32345",
     "workId":"b0059",
     "appId":"87654",
     "type":"REMOVE_ATTACHMENT",
     "timeZoneId":"America/Los_Angeles"
 }
}
{
   "action": {
     "runtimeVersion":[
       "037ee4bb-30c8-40e7-b083-0946e750f889",
       "b0059",
       0
     ],
     "workId":"b0059",
     "appId":"453c78",
     "type":"APPROVE", /* COMPLETE or REJECT */
     "timeZoneId":"America/Los_Angeles",
     "task": {
       "id":"947593"
     }
 }
}
{
   "action": {
     "runtimeVersion":[
       "037ee4bb-30c8-40e7-b083-0946e750f889",
       "b0059",
       0
     ],
     "workId":"b0059",
     "appId":"98765",
     "type":"ADD_TASK",
     "timeZoneId":"America/Los_Angeles",
     "task": {
       "id":"", /* Id of existing task to close and replace with this one */
       "assignedTo":"94837",
       "name":"New task",
       "dueDateExpression":"2011/09/12",
       "approvalStep":true
     }
 }
}
{
   "action": {
     "runtimeVersion":[
       "037ee4bb-30c8-40e7-b083-0946e750f889",
       "b0059",
       0
     ],
     "workId":"b0059",
     "appId":"c67890",
     "type":"REASSIGN",
     "timeZoneId":"America/Los_Angeles",
     "task": {
       "id":"97c456",
       "assignedTo":"8654a"
     }
 }
}
{
   "action": {
     "runtimeVersion":[
       "037ee4bb-30c8-40e7-b083-0946e750f889",
       "b0059",
       0
     ],
     "workId":"b0059",
     "appId":"9a3456",
     "type":"CHANGE_SUBJECT",
     "timeZoneId":"America/Los_Angeles",
     "subject":"New subject for this work."
 }
}
Beispielausgabe
*entspricht WorkDetail*
{
   "app": {
      "detailsTitle": "myCustomDetails",
      "id": "5f6000838003c",
      "name": "Detailed ProcessApp with 1 task A",
      "subjectTitle": "myCustomWorkSubject",
      "type": "workflow"
   },
   "users": [
      {
         "avatarId": "5f60008340006",
         "id": "170351",
         "name": "admin"
      }
   ],
   "version": "20110917",
   "work": {
      "appId": "5f6000838003c",
      "attachments": [
      ],
      "canManageWork": true,
      "comments": [
      ],
      "completedAt": 1730704963179,
      "completedBy": "170351",
      "details": "my sample details",
      "id": "5f6000d14000c",
      "name": "Detailed ProcessApp with 1 task A - New for test.",
      "runtimeVersion": [
         "6e711bd6-6718-4aae-96d5-d2b3ea620758",
         "5f6000d14000c",
         2
      ],
      "startedAt": 1730701215969,
      "startedBy": "170351",
      "status": "Completed",
      "subject": "New for test.",
      "tasks": [
         {
            "approvalStep": false,
            "assignedTo": "170351",
            "id": "5f6000d140015",
            "name": "Subject matter expert review",
            "status": "Completed"
         }
      ]
   }
}
Antworteigenschaften
version
Die Version der API, mit der eine Antwort erstellt wurde.
work
Das Arbeitsobjekt.
work.runtimeVersion
Der Bereich, der die Version der Arbeitsinstanz identifiziert. Dieser Wert muss als nicht transparentes Datenelement behandelt werden. Das work.runtimeVersion ist für das WorkActionerforderlich.
work.name
Der Name, der für die Arbeitsinstanz angezeigt werden soll.
work.id
Die ID der Arbeitsinstanz.
work.subject
Das vom Benutzer, der die Instanz erstellt hat, eingegebene Thema.
work.details
Die vom Benutzer, der die Instanz erstellt hat, eingegebenen Details.
work.status
Der Status der Arbeit beinhaltet einen der folgenden Werte:
  • Active
  • Completed
  • Cancelled
  • Overdue
work.startedBy
Die ID des Benutzers, der die Instanz erstellt hat. Ein Objekt mit dieser ID wird im Bereich des Benutzers angezeigt.
work.startedAt
Datum/Uhrzeit, an dem/zu der die Instanz gestartet wurde. Der Wert wird in Millisekunden seit 'The Epoch' (Unixzeit) angegeben, d. h., seit 1. Januar 1970, Mitternacht, koordinierte Weltzeit (Coordinated Universal Time, UTC).
work.completedBy
Die ID des Benutzers, der die Instanz abgeschlossen oder abgebrochen hat. Nur vorhanden, wenn der Status Completed oder Cancelled ist. Ein Objekt mit dieser ID wird im Bereich des Benutzers angezeigt.
work.completedAt
Datum/Uhrzeit, an dem/zu der die Instanz abgeschlossen oder abgebrochen wurde. Der Wert wird in Millisekunden seit 'The Epoch' (Unixzeit) angegeben, d. h., seit 1. Januar 1970, Mitternacht, koordinierte Weltzeit (Coordinated Universal Time, UTC). Nur vorhanden, wenn der Status Completed oder Cancelled ist.
work.appId
Die ID der Anwendung, über die die Instanz gestartet wurde. Diese Anwendung erscheint im Anwendungsobjekt.
work.canManageWork
Gibt an, ob der Benutzer berechtigt ist, die Arbeit abzubrechen, das Thema zu ändern oder Aufgaben erneut zuzuordnen.
work.tasks
Der Bereich von Aufgaben, die der Instanz zugeordnet sind.
work.tasks.name
Der Name der Task.
work.tasks.id
Die ID der Task.
work.tasks.assignedTo
Die ID des Benutzers, dem die Aufgabe zugeordnet wurde. Ein Objekt mit dieser ID wird im Bereich des Benutzers angezeigt.
work.tasks.actioner
Die ID des Benutzers, der nicht der Aufgabenbesitzer ist und der die letzte Änderung am Aufgabenstatus vorgenommen hat. Ein Objekt mit dieser ID wird im Bereich des Benutzers angezeigt. Wenn eine Aufgabe neu zugewiesen wird, bezieht sich work.tasks.actioner auf die ID des Benutzers, der die Neuzuweisung vorgenommen hat, während der Benutzer assignedTo der Benutzer ist, dem die Aufgabe ursprünglich zugewiesen war.
work.tasks.dueDate
Das Fälligkeitsdatum der Aufgabe. Diese Eigenschaft ist nur vorhanden, wenn dueDate für die Task festgelegt ist.
work.tasks.status
Enthält einen der folgenden möglichen Werte:
  • Pending
  • NotStarted
  • InProgress
  • Completed
  • Reassigned
work.tasks.reassignmentReason
Diese Eigenschaft ist nur vorhanden, wenn der Status Reassignedlautet. Enthält einen der folgenden möglichen Werte:
  • TaskReassigned
  • OwnerDowngraded
  • OwnerArchived
work.tasks.approvalStep
Der Wert ist entweder true oder false.
work.tasks.isApproved
Wenn es sich bei der Aufgabe um einen Genehmigungsschritt handelt, d. h. approvalStep ist trueund die Aufgabe abgeschlossen ist, d. h. der status -Wert ist Completed, dann ist isApproved vorhanden und der Wert ist true oder false.
work.attachments
Der Bereich von Anhängen, die zu dieser Instanz oder der Anwendung gehören, von der sie gestartet wurden.
work.attachments.name
Der Name des Anhangs.
work.attachments.id
Die ID des Anhangs.
work.attachments.uploadedBy
Die ID des Benutzers, der den Anhang hochgeladen hat. Ein Objekt mit dieser ID wird im Bereich des Benutzers angezeigt.
work.attachments.uploadedOn
Datum/Uhrzeit, an dem/zu der der Anhang hochgeladen wurde. Der Wert wird in Millisekunden seit 'The Epoch' (Unixzeit) angegeben, d. h., seit 1. Januar 1970, Mitternacht, koordinierte Weltzeit (Coordinated Universal Time, UTC).
work.attachments.size
Die Größe des hochgeladenen Anhangs in Byte.
work.attachments.type
Der Typ der angehängten Datei mit dem zugehörigen numerischen Wert.
Zuordnungstyp Beschreibung
1 Allgemeines Dokument. Dieser Typ wird verwendet, wenn für die Datei keiner der anderen Werte zutrifft.
2 Microsoft Excel-Datei
3 Image
4 PDF-Dokument
5 Microsoft PowerPoint-Dokument
6 Microsoft Project-Dokument
7 Microsoft Visio-Dokument
8 Microsoft Word-Dokument
work.attachments.canDelete
Gibt an, ob der Benutzer berechtigt ist, den Anhang zu löschen.
work.attachments.deletedOn
Datum/Uhrzeit, an dem/zu der der Anhang gelöscht wurde. Der Wert wird in Millisekunden seit 'The Epoch' (Unixzeit) angegeben, d. h., seit 1. Januar 1970, Mitternacht, koordinierte Weltzeit (Coordinated Universal Time, UTC). Dieses Feld wird nur angezeigt, wenn die Datei über die Administratorseiten aus dem Account gelöscht wurde. In diesem Fall können Sie die Datei nicht mit Hilfe von FileDownload herunterladen.
work.attachments.deletedBy
Der Name des Benutzers, der den Anhang gelöscht hat. Dieses Feld wird nur angezeigt, wenn die Datei über die Administratorseiten aus dem Account gelöscht wurde.
work.comments
Der Bereich der Kommentare zu der Instanz.
work.comments.from
Die ID des Benutzers, der den Kommentar erstellt hat. Ein Objekt mit dieser ID wird im Bereich des Benutzers angezeigt.
work.comments.id
Die ID des Kommentars.
work.comments.commentDate
Der Zeitpunkt, zu dem der Kommentar erstellt wurde.
work.comments.text
Der Text des Kommentars.
work.comments.canDelete
Gibt an, ob der Benutzer den Kommentar löschen kann.
work.comments.replies
Die Liste der Antworten auf den übergeordneten Kommentar.
app
Die Informationen zur Anwendung, von der die Arbeitsinstanz gestartet wurde.
app.name
Der Name der Anwendung, von der die Arbeitsinstanz gestartet wurde.
app.id
Die ID der Anwendung, von der die Arbeitsinstanz gestartet wurde.
app.subjectTitle
Der Titel des Editierbereichs, in dem der Benutzer ein Thema für die Instanz eingegeben hat.
app.detailsTitle
Der Titel des Editierbereichs, in den der Benutzer die Details für die Instanz eingegeben hat.
app.type
Der Typ der Anwendung, der einen der folgenden möglichen Werte enthält:
  • workflow
  • checklist
users
Der Bereich der Benutzer, auf deren IDs von anderen Positionen in JSON verwiesen wird.
users.name
Der vollständige Name des Benutzers.
users.id
Die ID des Benutzers.
users.avatarId
Die ID des Avatars, der vom Benutzer festgelegt wurde. Diese Eigenschaft ist nur vorhanden, wenn der Benutzer einen Avatar festgelegt hat.
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.
403
Zugriff ist verboten. Die Ausgabe dieser Nachricht kann einen der folgenden Gründe haben:
  • Die angegebenen Berechtigungsnachweise sind ungültig.
  • Dieser Benutzer hat keinen Zugriff auf diese Arbeit.
  • APIs sind vom Administrator nicht aktiviert. APIs müssen auf der Registerkarte Accountinformationen aktiviert werden.
  • Der Administrator hat die Bedingungen dieses Service nicht akzeptiert.