Interfejs usług REST dla zasobów związanych z definicją procesu biznesowego-zmienne instancji procesu (aktualizacja masowa)-metoda PUT

Ta metoda służy do aktualizowania wartości wielu zmiennych w instancji definicji BPD. Tę metodę można uruchomić tylko przez administratora aplikacji systemu lub procesu.
Uwaga: Ten interfejs API nie może być używany do aktualizowania podprocesów ani powiązanych zmiennych procesu. Aby zaktualizować te zmienne, należy użyć Process Inspector w produkcie IBM Process Designer lub interfejsu API REST "Update Instance All Variables" (Aktualizuj instancję wszystkich zmiennych).
Uwaga: użycie terminu "items" jako nazwy zmiennej nie jest zalecane, ponieważ jest to słowo zastrzeżone używane do oznaczania list obiektów w procesie. Jeśli jednak termin ten został już użyty jako nazwa zmiennej, wartość nadal może zostać zaktualizowana. Przykład można znaleźć w sekcji "Żądanie treści".
Uwaga: Podczas aktualizowania zmiennej o złożonym typie danych, cała zmienna jest aktualizowana dokładnie zgodnie z podanymi danymi. Dlatego należy określić wszystkie pola, które mają być ustawione dla zmiennej typu złożonego danych. Zmienne zmienne, które nie zostały określone, są traktowane jako nieustawione, a ich istniejące wartości są nadpisywane.

Przykładowe wywołanie metody

PUT /rest/bpm/wle/v1/process/{instanceId}/variables

Parametry

Brak

Treść żądania

Wartość zmiennej w formacie JSON. Na przykład:

{"items": {"items": [{"itemId":1074488}, {"itemId":123456}] } }.

Uwaga: Pierwsze wystąpienie "elementów" oznacza listę obiektów. Drugie wystąpienie "elementów" oznacza nazwę zmiennej definiowanej przez użytkownika.

Domyślny typ treści toapplication/json.

Typ MIME: application/json


Schemat
{"description": "Zmienne w formacie JSON jako zestaw par klucz-wartość",
   "type": "obiekt"
}
Przykładowa treść
{
	"input1": {
		"name": "Tester1",
		"address": {
			"ulica": "aaa",
			"miasto": "bbb",
			"@metadata": {
				"objectID": "b7acfa93-b2f9-49db-b115-e5f559555ab8",
				"dirty": false,
				"shared": false,
				"rootVersionContextID": "2064.24b617ae-13c5-4cdd-9072-a1622fedb66dT",
				"className": "Adres"
			}
		},
		"@metadata": {
			"objectID": "766cfedb-21ae-493b-a5a9-43302a0e040b",
			"dirty": false,
			"shared": false,
			"rootVersionContextID": "2064.24b617ae-13c5-4cdd-9072-a1622fedb66dT",
			"className": "Osoba"
		}
	},
	"input2": {
		"wybrane": [],
		"items": [ {
			"field1": "f1",
			"field2": "f2",
			"@metadata": {
				"objectID": "018f12c2-c4e9-47d3-b48f-86180d9f7c7f",
				"dirty": false,
				"shared": false,
				"rootVersionContextID": "2064.24b617ae-13c5-4cdd-9072-a1622fedb66dT",
				"className": "BO1"
			}
		}],
		"@metadata": {
			"objectID": "ad1b5ff4-5efa-491a-9679-6cd49e01a22e",
			"dirty": false,
			"shared": fałsz
		}
	},
	"var1": "defaultValue",
	"var2": {
		"wybrane": [],
		"pozycje": [ "test"],
		"@metadata": {
			"objectID": "6ca39563-abf8-42fe-8664-c042ce612945",
			"dirty": false,
			"shared": fałsz
		}
	},
	"var3": "2014-07-23T01:15:40Z",
	"var4": {
		"wybrane": [],
		"items": [ "2014-07-23T01:15:40Z"],
		"@metadata": {
			"objectID": "eb75581a-0248-4970-a58b-881131514eb2",
			"dirty": false,
			"shared": fałsz
		}
	},
	"var5": 0,
	"var6": 1.2
}

Treść odpowiedzi

Status wykonania interfejsu REST API.

Domyślny typ treści toapplication/json.

Typ MIME: application/json


Schemat
{
	"description": "Status wykonania interfejsu API usług REST",
	"type":"object",
	"właściwości": {
		"status": "200",
		"data" : {
			"type": Obiekt,
			"właściwości": {
				"message": {
					"type":"string",
					"description": "Wskazuje, że interfejs API został pomyślnie zakończony."
				}
			}
		}
	}
}
Przykładowa treść
{
   "status": "200",
   "data" : {
      "message": "Pomyślnie zaktualizowano."
   }
}

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 OK
Żądanie zostało pomyślnie zakończone.
400 Błędne żądanie
Brak parametru instanceId lub jest on niepoprawny, albo treść żądania nie jest obiektem JSON lub nie jest zgodna ze schematem obiektu biznesowego.
401 Unauthorized
Program wywołujący nie jest autoryzowany dla tego żądania.
404 Nie znaleziono
Serwer instanceId nie istnieje na serwerze.
406 NieakceptowalneŻądany typ treści lub kodowanie treści nie jest obsługiwane.
409 Konflikt
Status instancji definicji procesu biznesowego (Business Process Definition-BPD) nie jest aktywny, zawieszony lub Niepowodzenie. Tego interfejsu API można użyć tylko w celu zaktualizowania zmiennych instancji definicji BPD aktywnej, zawieszonej lub zakończonej niepowodzeniem.
415 Nieobsługiwany typ nośnikaTyp treści lub kodowanie treści żądania nie jest obsługiwane.
500 Wewnętrzny błąd serwera
Wystąpił poważny problem.

Dostępne od

8.5.6

Temat Nadrzędny: Zasób Instancji Procesu (aktualizacja masowa)