Interfejs REST dla zasobów związanych z definicją BPD-Instancja działania (Ad Hoc)-metoda PUT

Ta metoda służy do wykonywania działań związanych z działaniem.

Przykładowe wywołanie metody

PUT /rest/bpm/wle/v1/activity/{activityInstanceId}?action={string}[&assignTo={string}]

Parametry

Wymagane parametry
NazwaTyp wartościOpis
działanie łańcuch
Działanie, które jest wykonywane w instancji działania. Wykonaj komendę v1/activity/{activityInstanceId}/availableActions , aby pobrać listę aktualnie poprawnych wartości parametrów.
Parametry opcjonalne
NazwaTyp wartościOpis
assignTo łańcuch
Nazwa użytkownika, do którego ma zostać przypisana instancja działania.

Treść żądania

Brak

Treść odpowiedzi

Szczegóły działania ad hoc (ActivityDetails complexType).

Domyślny typ treści toapplication/json.

Typ MIME: application/json

Przykładowa treść
{
   "status": "200",
   "data" : {
      "dueDate": null,
      "taskId": null,
      "taskOwnerUserId": null,
      "taskOwnerGroupId": null,
      "narrative": null,
      "preconditionType": "SPECIFIC_VARIABLES",
      "preconditionTriggers": {"wyzwalacze": [
         "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": "REQUIRED",
      "required": true,
      "powtarzalne": fałsz,
      "startTime": null,
      "endTime": null,
      "hidden": false,
      "enablingDocumentID": null
   }
}

Typ MIME: application/xml


Schemat
<?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" />


    <!--
        Ten typ zawiera szczegóły związane z instancją działania.
    -->
    <complexType name="Activity">
        <complexContent>
            < extension base= " pref :Data">
                <sequence>

                    <! -- Identyfikator instancji działania -- >
                    < element name = "id "type = "łańcuch" />

                    <! -- Nazwa działania -- >
                    < element name = "nazwa "type = "łańcuch" />

                    <! -- Bieżący status instancji działania 
                         Poprawne wartości:
                          "ready",
                          "WORKING",
                          "OCZEKIWANIE",
                          "WYŁĄCZONE",
                          "URUCHAMIANIE",
                          "POMINIĘTO",
                          "ZAKOŃCZONE",
                          "failed",
                          "NIEUŻYWANE" -- >
                    < element name= "executionState" type = "string " />

                    <! -- Typ czynności instancji działania 
                         Poprawne wartości:
                          "USER_TASK",
                          "WYWOŁANY_PROCES",
                          "PODPROCES" -- >
                    < element name= "activityType" type = "string " />

                    <! -- Typ wykonania instancji działania. 
                         Poprawne wartości:
                          "AUTOMATIC",
                          "MANUAL",
                          "BRAK" -- >
                    < element name= "executionType" type = "string " />

                    <! -- Typ opcji instancji działania 
                         Poprawne wartości:
                          "WYMAGANE",
                          "OPCJONALNE" -- >
                    < element name= "optionType" type = "string " />

                    <! -- Wskazuje, czy działanie jest wymagane do zakończenia. -- >
                    < element name = "required "type =" boolean " />

                    <! -- Wskazuje, czy działanie jest powtarzalne. -- >
                    < element name = "repeatable "type =" boolean " />

                    <! -- Znacznik czasu, w którym uruchomiono instancję działania. -- >
                    < element name= "startTime" type= "dateTime" nillable = "true " />
                    
                    <! -- Znacznik czasu wskazujący, że instancja działania osiągnęła stan końcowy. -- >
                    < element name= "endTime" type= "dateTime" nillable = "true " />

                    <! -- Wskazuje, czy działanie jest ukryte. -- >
                    < element name = "hidden "type =" boolean " />
                    
                    <! -- Identyfikator dokumentu, który aktywował to działanie, jeśli istnieje. -- >
                    < element name= "enablingDocumentID" type = "string "nillable = "true" />
                    
                    <! -- Nazwa serwera dokumentu, który aktywował to działanie (jeśli istnieje). -- >
                    < element name= "enablingDocumentServerName" type = "string "nillable = "true" />
                    
                </sequence>
            </extension>
        </complexContent>
    </complexType>

    <!--
        Ten typ zawiera szczegóły związane z instancją działania.
    -->
    <complexType name= "ActivityDetails">
        <complexContent>
            < extension base="tns: Działanie ">
                <sequence>

                    <! -- Data zakończenia powiązana z działaniem -- >
                    < element name= "dueDate" type= "dateTime" nillable = "true " />
                    
                    <! -- Identyfikator pokrewnego zadania (tylko z implementacją zadania użytkownika) -- >
                    < element name= "taskId" type = "string "nillable = "true" />
                    
                    <! -- Identyfikator użytkownika właściciela zadania pokrewnego (tylko z implementacją zadania użytkownika) -- >
                    < element name= "taskOwnerUserId" type = "string "nillable = "true" />
                    
                    <! -- Identyfikator grupy właściciela zadania pokrewnego (tylko z implementacją zadania użytkownika) -- >
                    < element name= "taskOwnerGroupId" type = "string "nillable = "true" />

                    <! -- Narracja działania -- >
                    < element name = "narrative "type = "string" nillable = "true " />
                    
                    <! -- Typ warunku wstępnego -- >
                    < element name= "preconditionType" type = "string "nillable = "true" />
                    
                    <! -- Wyzwalacze warunku wstępnego -- >
                    < element name= "preconditionTriggers" type="tns:PreconditionTriggers"nillable = "true" />
                    
                    <! -- Wyrażenia warunku wstępnego -- >
                    < element name= "preconditionExpressions" type="tns:PreconditionExpressions"nillable = "true" />
                    
                    <! -- Wyśw. wyrażenia warunku wstępnego -- >
                    < element name= "preconditionExpressionsDisplay" type="tns:PreconditionExpressionsDisplay "nillable="true" />

                    <! -- Wyśw. wyrażenia warunku wstępnego -- >
                    < element name= "preconditionIsMatchAll" type = "boolean" nillable = "true " />                    
                    
                </sequence>
            </extension>
        </complexContent>
    </complexType>

    <! -- Lista nazw działań. -- >
    <complexType name= "AvailableActions">
        <complexContent>
            < extension base= " pref :Data">
                <sequence>
                    < element name = "actions "type="string" minOccurs= "0 " maxOccurs= "unbounded" />
                </sequence>
            </extension>
        </complexContent>
    </complexType>
    
    <! -- Lista bieżących zadań. -- >
    <complexType name= "CurrentTasks">
        <complexContent>
            < extension base= " pref :Data">
                <sequence>
                    < element name = "tasks "type="task:TaskDetails" minOccurs= "0 " maxOccurs= "unbounded" />
                </sequence>
            </extension>
        </complexContent>
    </complexType>
    
    <! -- Lista wyzwalaczy warunku wstępnego. -- >
    <complexType name= "PreconditionTriggers">
        <complexContent>
            < extension base= " pref :Data">
                <sequence>
                    < element name = "triggers "type="string" minOccurs= "0 " maxOccurs= "unbounded" />
                </sequence>
            </extension>
        </complexContent>
    </complexType>
    
        <! -- Lista wyrażeń warunku wstępnego. -- >
    <complexType name= "PreconditionExpressions">
        <complexContent>
            < extension base= " pref :Data">
                <sequence>
                    < element name = "Wyrażenia "type="string" minOccurs= "0 " maxOccurs= "unbounded" />
                </sequence>
            </extension>
        </complexContent>
    </complexType>
    
        <! -- Lista nazw działań. -- >
    <complexType name= "PreconditionExpressionsDisplay">
        <complexContent>
            < extension base= " pref :Data">
                <sequence>
                    < element name= "expressionsDisplay" type="string " minOccurs= "0" maxOccurs= "unbounded " />
                </sequence>
            </extension>
        </complexContent>
    </complexType>
    
</schema>
Przykładowa treść
<?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> REQUIRED </optionType>
        <preconditionExpressions>
           < wyrażenie/>
        </preconditionExpressions>
        <preconditionExpressionsDisplay >
           <expressionsDisplay/>
        Wyświetlanie </preconditionExpressions>
        <preconditionIsMatchAll> true </preconditionIsMatchAll>
        <preconditionTriggers>
           < triggers>
              <e>variable1</e>
              <e>variable2</e>
           < /triggers>
        </preconditionTriggers>
        <preconditionType> SPECIFIC_VARIABLES </preconditionType>
        < repeatable> false < /repeatable>
        < required> true < /required>
        <startTime null="true " />
        <taskId null="true " />
        <taskOwnerGroupId null="true " />
        <taskOwnerUserId null="true " />
    < /data>
< /bpm:ResponseData>

Typ MIME: application/x-javascript

Treść odpowiedzi o błędzie

Szczegółowe informacje o błędzie.

Domyślny typ treści toapplication/json.

Typ MIME: application/json


Schemat
{"description": "Odpowiedź na błąd WLE", 
   "type":"object",
   "właściwości":
   {"status": {"typ": "łańcuch",
         "description": "Status poprzedniego wywołania funkcji API."
      },
      "exceptionType": {"typ": "łańcuch",
         "description": "Nazwa klasy powiązana z wyjątkiem."
      },
      "errorNumber": {"typ": "łańcuch",
         "description": "Identyfikator komunikatu wyjątku."
      },
      "errorMessage": {"type": "string",
         "description": "Tekst komunikatu wyjątku."
      },
      "errorMessageParametry": {"type": [ "string"], "optional": true,
         "description": "Parametry tekstu komunikatu wyjątku."
      },
      "programmersDetails": {"type": "obiekt", "opcjonalny": true,
         "description": "Dodatkowe szczegóły wyjątku, na przykład stos wywołań."
      }
   }
} 

Typ MIME: application/xml


Schemat
<?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" />
    
    <!--
	Ten typ reprezentuje odpowiedź na błąd.
    -->    
    < element name= "RestRuntimeException">
	<complexType>
	    <sequence>
		< element name = "status "type="string" />
		< element name="Data " type="tns:ExceptionData">
    		</element>
	    </sequence>
	</complexType>
    </element>

    <!-- 
	 Ten typ zawiera szczegółowe informacje o błędach powiązane z wyjątkiem.
    -->
    <complexType name= "ExceptionData">
	<sequence>
	    < element name = "status "type="string" />

	    <! -- Ta opcja określa nazwę klasy języka Java dla wyjątku -- >
	    < element name= "exceptionType" type="string " />

	    <! -- Identyfikator komunikatu o błędzie -- >
	    < element name= "errorNumber" type="string " minOccurs= "0" />

	    <! -- kompletny komunikat o błędzie -- >
	    < element name= "errorMessage" type="string " />

	    <! -- Lista łańcuchów wstawionych do komunikatu o błędzie -- >
	    < element name= "errorMessageParameters" type="string " minOccurs= "0" maxOccurs= "unbounded " />

	    <!-- 
		 Stos wywołań powiązany z wyjątkiem.
		 Należy pamiętać, że zostanie pominięta, chyba że właściwość "server-stacktrace-enabled"
		 jest włączona w pliku 100Custom.xml serwera.
	    -->     
	    < element name= "programmersDetails" type="string"> < /element>
	    
	    <! -- Wcześniejsze odpowiedzi.  Ustaw, jeśli użyto komendy masowej -- >
	    < element name = "responses "type="dat:BulkCommandOdpowiedzi" minOccurs= "0"> < /element>

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

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

Typ MIME: application/x-javascript

Kody statusu

Metoda zwraca jeden z następujących kodów statusu:
KodOpis
200 OKZakończenie powiodło się.
400 Błędne żądanieParametry są niepoprawne lub nie są one poprawne.
401 UnauthorizedProgram wywołujący nie jest autoryzowany dla tego żądania.
404 Nie znaleziono
Instancja działania nie istnieje.
406 NieakceptowalneŻądany typ treści lub kodowanie treści nie jest obsługiwane.
500 Wewnętrzny błąd serweraWystąpił poważny problem. Szczegółowe informacje o programiście są dostępne.

Dostępne od

8.5.5

Temat Nadrzędny: Zasób Instancji Działania (Ad Hoc)