Interfejs usług REST dla zasobów związanych z definicją procesu biznesowego-Exposed Process Value Resource-GET Method [ nieaktualne]

Ta funkcja jest nieaktualna. Ta metoda służy do pobierania szczegółowych informacji związanych z ujawnionym wartością procesu.

Przykładowe wywołanie metody

GET /rest/bpm/wle/v1/epv/{epvId}[?snapshotId={string}][&branchId={string}]

Parametry

Uwaga: Aby zidentyfikować poprawny obraz stanu, który ma być używany, należy ustawić jeden z parametrów snapshotId lub branchId .
obowiązują następujące reguły kolejności wykonywania:
1) Jeśli określono parametr snapshotId , używany jest konkretny obraz stanu, a parametr branchId jest ignorowany.
2) Jeśli podano parametr branchId , używany jest obraz stanu najnowszej (bieżącej) gałęzi (ścieżki).
Parametry opcjonalne
NazwaTyp wartościOpis
snapshotId łańcuch
Identyfikator obrazu stanu powiązanego z ujawnionym wartością procesu. Należy ustawić jeden z parametrów snapshotId lub branchId .
branchId łańcuch
Identyfikator gałęzi powiązanej z ujawnionym wartością procesu. Należy ustawić jeden z parametrów snapshotId lub branchId .

Treść żądania

Brak

Treść odpowiedzi

Szczegółowe informacje związane z ujawnionym wartością procesu (RestEpv complexType). Uwaga: Identyfikator zwrócony dla uczestnika może być używany jako wartość teamId w wywołaniach związanych z zespołem.

Domyślny typ treści toapplication/json.

Typ MIME: application/json


Schemat
{
    "status": "200",
    "data": {
        "name":{"type": "string", "description": "The name of the exposed process variable."},
        "desc":{"type": "string", "description": "The description of the exposed process variable."},
        "participantName":{"type": "string", "description": "The name of the participant group to which the exposed process variable is exposed."},
        "participantId":{"type": "string", "description": "The ID of the participant group to which the exposed process variable is exposed."},
        "participantRefSnapshotId": {"type": "string", "description": " Identyfikator obrazu stanu powiązanego z grupą uczestników.
		Należy podać wartość 'snapshotId' lub 'branchId', jeśli parametr participantId ma wartość inną niż null. " },
        "participantRefBranchIdId": {"type": "string", "description": " Identyfikator gałęzi powiązanej z grupą uczestników.
		Należy podać wartość 'snapshotId' lub 'branchId', jeśli parametr participantId ma wartość inną niż null. " },           
        "vars":
        [
            {
                "name":{"type": "string", "description": "The external name of the variable."},
                "extDesc":{"type": "string", "description": "The external description of the variable."},
                "varname":{"type": "string", "description": "The variable name."},
                "defaultValue":{"type": "string", "description": "The default value."},
                "isChgActiveProc":{"type": "boolean", "description": "Indicates whether In-Progress Tasks use a new value."},
                "typeClass":{"type": "string", "description": "The name of the type class for the variable."},
                "typeClassRef": {"type": "string", "description": " Identyfikator odwołania klasy typu, jeśli jest to typ złożony.
				Jest ona pusta, jeśli typeClass jest typem podstawowym. " },
                "typeClassSnapshotId": {"typ": "łańcuch", "opis": " Identyfikator obrazu stanu powiązanego z klasą typu.
        			Parametr 'snapshotId' lub 'branchId' musi być określony, gdy typeClassRef nie ma wartości null. " },
                "typeClassBranchId": {"typ": "łańcuch", "opis": " Identyfikator gałęzi powiązanej z klasą typu.
        			Parametr 'snapshotId' lub 'branchId' musi być określony, gdy typeClassRef nie ma wartości null. " }
                "isChgActiveProc" :false,
            }
        ]
    }
}
Przykładowa treść
{
    "status": "200",
    "data": {
        "desc": "EPV desc",
        "participantName":"GeneralManagers",
        "participantId":"24.eb30156e-52c8-4ec5-9be6-02290d02f827",
        "participantRefSnapshotId":"2064.8b2561f3-5ea4-437f-bd61-3d8c415b12ac",
        "vars": [ {
                "extDesc": "opis zewnętrzny dla varName2",
                "typeClass": "Łańcuch",
                "typeClassSnapshotId" :null,
                "typeClassBranchId" :null,
                "varname": "varName2",
                "defaultValue" :" \" USA \" ",
                "isChgActiveProc" :false,
                "name": "adres"
            },
            {
                "extDesc": "opis zewnętrzny dla varName1",
                "typeClass": "Łańcuch",
                "typeClassSnapshotId" :null,
                "typeClassBranchId" :null,
                "varname": "varName1",
                "defaultValue" :" \" john \" ",
                "isChgActiveProc" :true,
                "name": "nazwa"
            },
            {
                "extDesc": "zewnętrzny opis dla var3",
                "typeClass": "Pozycja",
                "typeClassRef": "12.0ea493a3-08b7-4456-84be-443c8d41bc8b",
                "typeClassSnapshotId":"2064.8b2561f3-5ea4-437f-bd61-3d8c415b12ac",
                "typeClassBranchId" :null,
                "varname": "var3",
                "isChgActiveProc" :false,
                "name": "pozycja"
            }
        ],
        "name": "EPV1"
    }
}

Typ MIME: application/xml


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

    < import schemaLocation= "Common.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/common" />
    < import schemaLocation= "BPMRestData.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/root" />
    
	<complexType name= "RestEpvVar">
		<complexContent>
		    < extension base="pref:NamedElement">        
		        <sequence>
					< element name= "extDesc" type = "string " />
					< element name= "plainExtDesc" type="string " />					
					< element name= "typeClass" type = "string " />
					< element name= "typeClassRef" type="string " />
					<choice>
						< element name= "typeClassSnapshotId" type = "string " />
						< element name= "typeClassBranchId" type = "string " />
					</choice>
					< element name = "varname "type = "łańcuch" />
					< element name= "defaultValue" type = "string " />
					< element name= "isChgActiveProc" type = "boolean" />
				</sequence>
		    </extension>
		</complexContent>		
	</complexType>

	<complexType name= "RestEpv">
		<complexContent>
		    < extension base="pref:NamedElement">        
		        <sequence>
					< element name= "envId" type = "string " />
					< element name = "desc "type = "łańcuch" />
					< element name= "richDesc" type = "łańcuch " />
					< element name= "extDesc" type = "string " />
					< element name = "feedback "type = "string" />
					< element name= "participantName" type = "string " />
					< element name= "participantId" type = "string " />
					< element name= "participantRefSnapshotId" type = "string " />
					< element name= "participantRefBranchId" type = "string " />
					< element name = "vars "type="tns:RestEpvVar" maxOccurs= "unbounded " />
				</sequence>
		    </extension>
		</complexContent>		
	</complexType>
            
</schema>

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ń."
      }
   }
}

Kody statusu

Metoda zwraca jeden z następujących kodów statusu:
KodOpis
200 OK
Pomyślne zakończenie-zwrócono szczegółowy raport.
400 Błędne żądanieParametry są niepoprawne lub nie są one poprawne.
404 Nie znalezionoZasób 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

7.5.1

Temat Nadrzędny: Zasób Wystawiony Do Wartości Procesu



Opinia