REST-Schnittstelle für BPD-bezogene Ressourcen-Ressource für Aktivitätsinstanz (Ad-hoc)-Methode GET

Mit dieser Methode können Sie Details zur Aktivität abrufen.

Beispiel für Methodenaufruf

GET /rest/bpm/wle/v1/activity/{activityInstanceId}

Parameter

Keine

Anforderungsinhalt

Keine

Antwortinhalt

Ad-hoc-Aktivitätsdetails (ActivityDetails complexType).

Der Standardinhaltstyp istapplication/json.

MIME-Typ: application/json

Beispielinhalt
{
   "status": "200",
   "Daten": {
      "dueDate": null,
      "taskId": null,
      "taskOwnerUserId": null,
      "taskOwnerGroupId": null,
      "narrative": null,
      "preconditionType": "SPECIFIC_VARIABLES",
      "preconditionTriggers": {"triggers": [
         "variable1",
         "variable2"
      ]},
      "preconditionExpressions": {"expressions": []},
      "preconditionExpressionsDisplay": {"expressionsDisplay": []},
      "preconditionIsMatchAll": true,
      "id":2118.92011af8-b485-49a0-8b2f-dc6dc087a8a4",
      "name": "Activity2",
      "executionState": "WAITING",
      "activityType": "USER_TASK",
      "executionType": "AUTOMATIC",
      "optionType": "ERFORDERLICH"
      "required": true,
      "repeatable": false,
      "startTime": null,
      "endTime": null,
      "hidden": false,
      "enablingDocumentID": null
   }
}

MIME-Typ: application/xml


Schema
<?xml version="1.0" encoding="UTF-8"?>
< schema targetNamespace= "http://rest.bpm.ibm.com/v1/data/activity"
        elementFormDefault= "unqualified" xmlns= "http://www.w3.org/2001/XMLSchema"
        xmlns:tns = "http://rest.bpm.ibm.com/v1/data/activity"
        xmlns:pref = "http://rest.bpm.ibm.com/v1/data/root"
        xmlns:common = "http://rest.bpm.ibm.com/v1/data/common"
        xmlns:execution = "http://rest.bpm.ibm.com/v1/data/execution"
        xmlns:task = "http://rest.bpm.ibm.com/v1/data/task">

    < import schemaLocation= "BPMRestData.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/root" />
    < import schemaLocation= "Common.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/common" />
    < import schemaLocation= "Task.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/task"/>


    <!--
        Dieser Typ enthält Details zu einer Aktivitätsinstanz.
    -->
    <complexType name="Activity">
        <complexContent>
            < extension base= " pref :Daten">
                <sequence>

                    <! -- ID der Aktivitätsinstanz -- >
                    < element name = "id "type = "zeichenfolge"/>

                    <! -- Name der Aktivität -- >
                    < element name = "name "type = "string" />

                    <! -- Aktueller Status der Aktivitätsinstanz 
                         Gültige Werte sind:
                          "BEREIT",
                          "ARBEITEN",
                          "Waiting",
                          "INAKTIVIERT"
                          "STARTEN",
                          "ÜBERSPRUNGEN",
                          "ABGESCHLOSSEN",
                          "FEHLGESCHLAGEN",
                          "NICHT VERWENDET"->
                    < element name= "executionState" type = "zeichenfolge " />

                    <! -- Tasktyp der Aktivitätsinstanz 
                         Gültige Werte sind:
                          "BENUTZERTASK",
                          "PROZESS AUFRUFEN",
                          "UNTERPROZESS" -- >
                    < element name= "activityType" type = "string " />

                    <! -- Ausführungstyp der Aktivitätsinstanz 
                         Gültige Werte sind:
                          "AUTOMATISCH",
                          "MANUELL",
                          "NONE" -- >
                    < element name= "executionType" type = "string " />

                    <! -- Optionstyp der Aktivitätsinstanz 
                         Gültige Werte sind:
                          "ERFORDERLICH",
                          "OPTIONAL" -- >
                    < element name= "optionType" type = "string " />

                    <! -- Gibt an, ob die Aktivität abgeschlossen werden muss. -- >
                    < element name = "required "type =" boolean " />

                    <! -- Gibt an, ob die Aktivität wiederholt anwendbar ist -- >
                    < element name = "wiederholbar "type =" boolesch " />

                    <! -- Die Zeitmarke für den Start der Aktivitätsinstanz. -- >
                    < element name= "startTime" type= "dateTime" nillable = "true " />
                    
                    <! -- Die Zeitmarke, zu der die Aktivitätsinstanz einen Endstatus erreicht hat. -- >
                    < element name= "endTime" type= "dateTime" nillable = "true " />

                    <! -- Gibt an, ob die Aktivität ausgeblendet ist -- >
                    < element name = "hidden "type =" boolean " />
                    
                    <! -- Die ID des Dokuments, das diese Aktivität aktiviert hat (falls vorhanden) -- >
                    < element name= "enablingDocumentID" type = "string "nillable = "true" />
                    
                    <! -- Der Servername des Dokuments, das diese Aktivität aktiviert hat (falls vorhanden) -- >
                    < element name= "enablingDocumentServerName" type = "string "nillable = "true" />
                    
                </sequence>
            </extension>
        </complexContent>
    </complexType>

    <!--
        Dieser Typ enthält Details zu einer Aktivitätsinstanz.
    -->
    <complexType name= "ActivityDetails">
        <complexContent>
            < extension base="tns: Aktivität">
                <sequence>

                    <! -- Fälligkeitsdatum, das der Aktivität zugeordnet ist -- >
                    < element name= "dueDate" type= "dateTime" nillable = "true " />
                    
                    <! -- ID der zugehörigen Task (nur mit Benutzertaskimplementierung) -- >
                    < element name= "taskId" type = "string "nillable = "true" />
                    
                    <! -- Benutzer-ID des Eigners der zugehörigen Task (nur mit Benutzertaskimplementierung) -- >
                    < element name= "taskOwnerUserId" type = "string "nillable = "true" />
                    
                    <! -- Gruppen-ID des Eigners der zugehörigen Task (nur mit Benutzertaskimplementierung) -- >
                    < element name= "taskOwnerGroupId" type = "string "nillable = "true" />

                    <! -- Beschreibung der Aktivität -- >
                    < element name = "narrative "type = "string" nillable = "true " />
                    
                    <! -- Typ der Vorbedingung -- >
                    < element name= "preconditionType" type = "string "nillable = "true" />
                    
                    <! -- Auslöser für Vorbedingung -- >
                    < element name= "preconditionTriggers" type="tns:PreconditionTriggers"nillable = "true"/>
                    
                    <! -- Vorbedingungsausdrücke -- >
                    < element name= "preconditionExpressions" type="tns:PreconditionExpressions"nillable = "true"/>
                    
                    <! -- Vorbedingungsausdrücke werden angezeigt -- >
                    < element name= "preconditionExpressionsDisplay" type="tns:PreconditionExpressionsDisplay "nillable="true" />

                    <! -- Vorbedingungsausdrücke werden angezeigt -- >
                    < element name= "preconditionIsMatchAll" type = "boolean" nillable = "true " />                    
                    
                </sequence>
            </extension>
        </complexContent>
    </complexType>

    <! -- Eine Liste mit Aktionsnamen. -- >
    <complexType name= "AvailableActions">
        <complexContent>
            < extension base= " pref :Daten">
                <sequence>
                    < element name = "actions "type="string" minOccurs= "0 " maxOccurs= "unbounded" />
                </sequence>
            </extension>
        </complexContent>
    </complexType>
    
    <! -- Eine Liste der aktuellen Tasks. -- >
    <complexType name= "CurrentTasks">
        <complexContent>
            < extension base= " pref :Daten">
                <sequence>
                    < element name = "tasks "type="task:TaskDetails" minOccurs= "0 " maxOccurs= "unbounded" />
                </sequence>
            </extension>
        </complexContent>
    </complexType>
    
    <! -- Eine Liste von Vorbedingungsauslösern. -- >
    <complexType name= "PreconditionTriggers">
        <complexContent>
            < extension base= " pref :Daten">
                <sequence>
                    < element name = "triggers "type="string" minOccurs= "0" maxOccurs= "unbounded " />
                </sequence>
            </extension>
        </complexContent>
    </complexType>
    
        <! -- Eine Liste mit Vorbedingungsausdrücken -- >
    <complexType name= "PreconditionExpressions">
        <complexContent>
            < extension base= " pref :Daten">
                <sequence>
                    < element name = "expressions "type="string" minOccurs= "0 " maxOccurs= "unbounded" />
                </sequence>
            </extension>
        </complexContent>
    </complexType>
    
        <! -- Eine Liste mit Aktionsnamen. -- >
    <complexType name= "PreconditionExpressionsDisplay">
        <complexContent>
            < extension base= " pref :Daten">
                <sequence>
                    < element name= "expressionsDisplay" type="string " minOccurs= "0" maxOccurs= "unbounded " />
                </sequence>
            </extension>
        </complexContent>
    </complexType>
    
</schema>
Beispielinhalt
< ?xml version="1.0 "encoding="UTF-8" standalone="yes " ?>
< bpm:ResponseData xmlns:bpm = "http://rest.bpm.ibm.com/v1/data">
    <status>200</status>
    < data xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:ns8="http://rest.bpm.ibm.com/v1/data/activity" xsi:type = "ns8:ActivityDetails">
        <activityType> USER_TASK </activityType>
        <dueDate null="true "/>
        <enablingDocumentID null="true "/>
        <endTime null="true "/>
        <executionState> WAITING </executionState>
        <executionType> AUTOMATIC </executionType>
        < hidden> false < /hidden>
        <id>2118.92011af8-b485-49a0-8b2f-dc6dc087a8a4</id>
        <name>Activity2</name>
        < narrative null="true " />
        <optionType> ERFORDERLICH </optionType>
        <preconditionExpressions>
           < Ausdruck/>
        </preconditionExpressions>
        <preconditionExpressionsAnzeige >
           <expressionsDisplay/>
        </preconditionExpressionsAnzeige >
        <preconditionIsMatchAll> true </preconditionIsMatchAll>
        <preconditionTriggers>
           < Trigger>
              <e>variable1</e>
              <e>variable2</e>
           < /Trigger>
        </preconditionTriggers>
        <preconditionType> SPECIFIC_VARIABLES </preconditionType>
        < wiederholbar> false < /wiederholbar>
        < erforderlich> true < /erforderlich>
        <startTime null="true "/>
        <taskId null="true "/>
        <taskOwnerGroupId null="true " />
        <taskOwnerUserId null="true " />
    </data>
< /bpm:ResponseData>

MIME-Typ: application/x-javascript

Fehlerantwortinhalt

Detaillierte Fehlerinformationen

Der Standardinhaltstyp istapplication/json.

MIME-Typ: application/json


Schema
{"description": "WLE-Fehlerantwort", 
   "type": "Objekt",
   "Eigenschaften":
   {"status": {"type": "zeichenfolge",
         "description": "Der Status des vorherigen API-Aufrufs."
      },
      "exceptionType": {"type": "Zeichenfolge",
         "description": "Der der Ausnahmebedingung zugeordnete Klassenname."
      },
      "errorNumber": {"type": "zeichenfolge",
         "description": "Message ID of the exception."
      },
      "errorMessage": {"Typ": "Zeichenfolge",
         "description": "Message text of the exception."
      },
      "errorMessageParameter": {"type": ["string"], "optional": true,
         "description": "Nachrichtentextparameter der Ausnahmebedingung."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description": "Zusätzliche Ausnahmebedingungsdetails, z. B. ein Stack-Trace"
      }
   }
} 

MIME-Typ: application/xml


Schema
<?xml version="1.0" encoding="UTF-8"?>
< schema targetNamespace= "http://rest.bpm.ibm.com/v1/data/exception"
	elementFormDefault= "unqualified" xmlns= "http://www.w3.org/2001/XMLSchema"
	xmlns:tns = "http://rest.bpm.ibm.com/v1/data/exception"
	xmlns:dat = "http://rest.bpm.ibm.com/v1/data/root">

    < import schemaLocation= "BPMRestData.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/root" />
    
    <!--
	Dieser Typ stellt eine Fehlerantwort dar.
    -->    
    < element name= "RestRuntimeException">
	<complexType>
	    <sequence>
		< element name = "status "type="string" />
		< element name=" Data " type="tns:ExceptionData">
    		</element>
	    </sequence>
	</complexType>
    </element>

    <!-- 
	 Dieser Typ enthält detaillierte Fehlerinformationen zu einer Ausnahmebedingung.
    -->
    <complexType name= "ExceptionData">
	<sequence>
	    < element name = "status "type="string" />

	    <! -- Gibt den Java-Klassennamen der Ausnahme an -- >
	    < element name= "exceptionType" type="string " />

	    <! -- Nachrichten-ID der Fehlernachricht -- >
	    < element name= "errorNumber" type= "string" minOccurs= "0 " />

	    <! -- Vollständige Fehlernachricht -- >
	    < element name= "errorMessage" type="string " />

	    <! -- Liste der in die Fehlernachricht eingefügten Zeichenfolgen -- >
	    < element name= "errorMessageParameters" type="string " minOccurs= "0" maxOccurs= "unbounded " />

	    <!-- 
		 Der der Ausnahmebedingung zugeordnete Stack-Trace.
		 Beachten Sie, dass dieser Wert weggelassen wird, es sei denn, die Eigenschaft "server-stacktrace-enabled"
		 ist in der Datei 100Custom.xml des Servers aktiviert.
	    -->     
	    < element name= "programmersDetails" type="string"> < /element>
	    
	    <! -- A-priori-Antworten.  Festlegen, wenn ein Massenbefehl verwendet wurde -- >
	    < element name = "responses "type="dat:BulkCommandResponses" minOccurs= "0"> < /element>

            < element name= "errorData" type="tns:ErrorData" minOccurs= "0"/>
	</sequence>
    </complexType>

    <complexType name= "ErrorData">
        <sequence>
            < element name = "code "type = "zeichenfolge" />
            < element name = "data "type="string" minOccurs= "0 " />
        </sequence>
    </complexType>
    
</schema>

MIME-Typ: application/x-javascript

Statuscodes

Die Methode gibt einen der folgenden Statuscodes zurück:
CodeBeschreibung
200 OKErfolgreiche Ausführung.
400 Bad Request (Ungültige Anforderung)Die Parameter sind ungültig oder fehlen.
401 Nicht autorisiertDer Aufrufende ist für diese Anforderung nicht berechtigt.
404 Nicht gefunden
Die Aktivität ist nicht vorhanden.
406 Not AcceptableDer angeforderte Inhaltstyp oder die Codierung des Inhalts wird nicht unterstützt.
500 Interner ServerfehlerEin schwerwiegendes Problem ist aufgetreten. Die Details des Programmierers werden bereitgestellt.

Verfügbar seit

8.5.5

Übergeordnetes Thema: Ressource Aktivitätsinstanz (Ad-hoc)