REST-Schnittstelle für BPD-bezogene Ressourcen-Ressource für Prozessinstanzabfrageattribute-Methode GET [veraltet]

Diese Funktion wird nicht weiter unterstützt. Verwenden Sie die GET-Methode für die Ausführungs-API für gespeicherte Suchen. /rest/bpm/wle/v1/tasks
Verwenden Sie dieses Verfahren, um eine Liste der Attribute einer Abfrage für Prozessinstanzdaten abzurufen.

Beispiel für Methodenaufruf

GET /rest/bpm/wle/v1/processes/query/{queryName}/attributes[?processAppName={string}][&includeTaskData={boolean}]

Parameter

Optionale Parameter
NameWerttypBeschreibung
processAppName Zeichenfolge
Der Name der Prozessanwendung, die für zusätzliche Filterungsoperationen verwendet wird. Dieser Parameter ist für die zukünftige Verwendung gedacht und wirkt sich momentan nicht auf die zurückgegebenen Abfragemetadaten aus.
includeTaskData boolesch
Dieser Parameter ist ein Flag, das angibt, ob Taskdetails in die Antwort eingeschlossen werden. Die Standardeinstellung ist false.

Anforderungsinhalt

Keine

Antwortinhalt

Liste der Abfrageattribute (QueryAttributes complexType).

Der Standardinhaltstyp istapplication/json.

MIME-Typ: application/json


Schema
{"description": "WLE-Abfrageattributliste", 
   "type": "object",
   "Eigenschaften":
   {"identifier": {"type": "string"},
      "query": {"type": "zeichenfolge",
         "description": "Abfragename."
      },
      "displayName": {"type": "Zeichenfolge",
         "description": "Anzeigename der Abfrage (lokalisiert)."
      },
      "description": {"Typ": "Zeichenfolge",
         "description": "Abfragebeschreibung (lokalisiert)".
      },
      "kind": {"type": "Zeichenfolge",
         "description": "Art der Abfrage"., 
         "Aufzählung":
         [
            "GESPEICHERTE SUCHE"
         ]
      },
      "authorizationType": {"type": "Zeichenfolge",
         "description": "Typ der Berechtigung, die für die Ausführung von Abfragen mit dieser Abfrage erforderlich ist.",
         "Aufzählung":
         [
            "INSTANZBASIERT",
	    "ROLE_BASED"
         ]
      },
      "entityTypeName": {"type": "string",
         "description": "Typ der Entitäten, die als Ergebnis der Abfrage zurückgegeben werden."
      },
      "keyAttribute": {"type": "Zeichenfolge",
         "description": "Name des Attributs, das eine Entität eindeutig identifiziert."
      },
      "locales": {"Typ": ["Zeichenfolge"],
         "description": "Liste der für die Anzeigenamen und Beschreibungen dieser Abfrage definierten Ländereinstellungen."
      },
      "sortAttributes": {
         [  
            {  
               "name": {"type": "string",
                "description": "Attributname sortieren."
               },
               "sortOrder": {"type": "string",
                  "description": "Sortierreihenfolge.",,
                  "Aufzählung":
                  [
                     "ASC",
                     "desc"
                  ]
               }
            }
         ], "optional": true,
         "description": "Angeordnete Liste der Standardnamen von Sortierattributen."
      },
      "size": {"type" = "Ganzzahl", "optional": true
         "description": "Standardanzahl der Entitäten, die als Ergebnis der Abfrage zurückgegeben werden."
      },      
      "items":        
      [
         {"name": {"type": "zeichenfolge"
               "description": "Attributname."
            },
            "displayName": {"type": "Zeichenfolge",
               "description": "Anzeigename des Attributs (lokalisiert)."
            },
            "description": {"Typ": "Zeichenfolge",
               "description": "Attributbeschreibung (lokalisiert)".
            },
            "type": {"type": "zeichenfolge",
               "description": "Attributtyp."
            },
            "isArray": {"type": "boolean",
               "description": "Gibt an, ob das Attribut einen Wertebereich hat."
            },            
            "isFilterable": {"type": "boolean", "optional": true                                                 
               "description": " Gibt an, ob das Attribut als Filterattribut verwendet werden kann (Standardwert: true).
            },                                                                                                    
            "isSortable": {"type": "boolean", "optional": true,                                                   
               "description": "Gibt an, ob das Attribut als Sortierattribut verwendet werden kann (Standardwert: true)."  
            },                                                                                                                                                    
            "sourceAttribute": {"type": "string",
               "description": "Die zugehörige Abfrage und das zugehörige Attribut, das die Informationen dieses Attributs bereitstellt."
            },
            "content": {"type": "zeichenfolge",
               "description": "Eine Zeichenfolge, die Attribute mit einem WKT-Wertebereich identifiziert."
            },
            "sourceQueryTableIdentifier": {"type": "string", "optional": true,
               "description": "Die ID der Tabelle des Quellenattributs, wie in der Abfragetabellendefinition definiert."
            }
         }
      ]
   }
}
Beispielinhalt
{
   "status": "200",
   "Daten": {
      "identifier": "Name",
      "query": "IBM.DEFAULTALLPROCESSLIST_75",
      "displayName": "Alle",
      "description": "",
      "kind": "SAVED_SEARCH",
      "authorizationType": "INSTANZBASIERT"
      "entityTypeName": "PROCESS_INSTANCE",
      "keyAttribute":"PROCESS_INSTANCE.PIID",
      "Ländereinstellungen": [

      ],
      "sortAttributes":[

      ],
      "Größe": 20,
      "items": [
         {
            "name": "SNAPSHOTNAME",
            "displayName": "Momentaufnahme",
            "description": "",
            "type":"String",
            "isArray" :false,
            "sourceAttribute":"IBM.DEFAULTALLPROCESSLIST_75.instanceSnapshot",
            "content":PROCESS_INSTANCE.SNAPSHOT_NAME",
            "sourceQueryTableIdentifier": "n/a"
         },
         {
            "name": "PI_STATUS",
            "displayName": "Instanzstatus",
            "description": "",
            "type":"String",
            "isArray" :false,
            "sourceAttribute":"IBM.DEFAULTALLPROCESSLIST_75.instanceStatus",
            "content": "PROCESS_INSTANCE.STATUS",
            "sourceQueryTableIdentifier": "n/a"
         },
         {
            "name": "PROCESS_APP_ACRONYM",
            "displayName": "Akronym der Prozessanwendung",
            "description": "",
            "type":"String",
            "isArray" :false,
            "sourceAttribute":"IBM.DEFAULTALLPROCESSLIST_75.instanceProcessApp",
            "content": "PROCESS_INSTANCE.PROCESS_APP_ACRONYM",
            "sourceQueryTableIdentifier": "n/a"
         },
         {
            "name": "PI_PIID",
            "displayName": "Instanz-ID",
            "description": "",
            "type": "ID"
            "isArray" :false,
            "sourceAttribute":"IBM.DEFAULTALLPROCESSLIST_75.instanceId",
            "content": "PROCESS_INSTANCE.PIID",
            "sourceQueryTableIdentifier": "n/a"
         },
         {
            "name": "PTNAME",
            "displayName": "Prozessdefinition",
            "description": "",
            "type":"String",
            "isArray" :false,
            "sourceAttribute":"IBM.DEFAULTALLPROCESSLIST_75.bpdName",
            "content": "PROCESS_INSTANCE.NAME",
            "sourceQueryTableIdentifier": "n/a"
         },
         {
            "name": "PI_DISPLAY_NAME",
            "displayName": "Beschreibender Name",
            "description": "",
            "type":"String",
            "isArray" :false,
            "sourceAttribute":"IBM.DEFAULTALLPROCESSLIST_75.instanceName",
            "content": "PROCESS_INSTANCE.DISPLAY_NAME",
            "sourceQueryTableIdentifier": "n/a"
         },
         {
            "name": "PI_NAME",
            "displayName": "Instanzname",
            "description": "",
            "type":"String",
            "isArray" :false,
            "sourceAttribute":"IBM.DEFAULTALLPROCESSLIST_75.instanceName",
            "content": "PROCESS_INSTANCE.NAME",
            "sourceQueryTableIdentifier": "n/a"
         },
         {
            "name": "PT_PTID",
            "displayName": "Prozessdefinitions-ID",
            "description": "",
            "type": "ID"
            "isArray" :false,
            "sourceAttribute":"IBM.DEFAULTALLPROCESSLIST_75.bpdId",
            "content": "PROCESS_INSTANCE.PTID"
            "sourceQueryTableIdentifier": "n/a"
         },
         {
            "name": "SNAPSHOT_ID",
            "displayName": "Momentaufnahme-ID",
            "description": "",
            "type":"String",
            "isArray" :false,
            "sourceAttribute":"IBM.DEFAULTALLPROCESSLIST_75.instanceSnapshotId",
            "content": "PROCESS_INSTANCE.SNAPSHOT_ID",
            "sourceQueryTableIdentifier": "n/a"
         },
         {
            "name": "PT-Anzeigename",
            "displayName": "Prozessdefinitionsname",
            "description": "",
            "type":"String",
            "isArray" :false,
            "sourceAttribute":"IBM.DEFAULTALLPROCESSLIST_75.bpdName",
            "content": "PROCESS_INSTANCE.DISPLAY_NAME",
            "sourceQueryTableIdentifier": "n/a"
         },
         {
            "name": "PI_STATE",
            "displayName": "Instanzstatus (zugeordnet)",
            "description": "",
            "type":"String",
            "isArray" :false,
            "sourceAttribute":"IBM.DEFAULTALLPROCESSLIST_75.instanceStatus",
            "content":PROCESS_INSTANCE.STATE",
            "sourceQueryTableIdentifier": "n/a"
         }
      ]
   }
}

MIME-Typ: application/xml


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

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

	<! -- Dieser Typ wird verwendet, um eine Liste gespeicherter Abfragen zurückzugeben. -- >
	<complexType name= "QueryList">
		<complexContent>
			< extension base= " pref :Daten">
				<sequence>
					< element name = "kennung "type = "zeichenfolge" />

					<! -- Dies ist eine Liste mit null oder mehr gespeicherten Abfragen -- >
					< element name = "items "type=QueryItem" minOccurs= "0 "
						maxOccurs="unbounded" />
				</sequence>
			</extension>
		</complexContent>
	</complexType>

	<! -- Dieser Typ stellt eine einzelne gespeicherte Abfrage dar. -- >
	<complexType name= "QueryItem">
		<sequence>

			<! -- Name der Abfrage -- >
			< element name = "name "type = "string" />

			<! -- Der Anzeigename, der der Abfrage zugeordnet ist; dieser enthält die 
				denselben Wert wie der Name -- >
			< element name= "displayName" type = "string " />

			<! -- Beschreibung der Abfrage -- >
			< element name = "description "type = "string"/>

			<! -- Die "Art", die der Abfrage zugeordnet ist; sie wird auf "SAVED_SEARCH" gesetzt -- >
			< element name = "kind "type = "string" />

			<! -- Die ID-Nummer, die einer gespeicherten Suche zugeordnet ist -- >
			< element name= "savedSearchID" type = "long "nillable = "true" />

			<! -- Der Autorisierungstyp, der der Abfrage zugeordnet ist; dieser wird festgelegt 
				in "INSTANCE_BASED" -- >
			< element name= "authorizationType" type = "string " />

			<! -- Dieses Feld gibt den Typ der Objekte an, die von der Abfrage zurückgegeben werden. 
				Dies ist eine der Optionen "PROCESS_INSTANCE", "TASK", "TASK_TEMPL". -- >
			< element name= "entityTypeName" type="string " />

			<! -- Dieses Feld gibt den Namen des Attributs an, das als 
				Schlüssel für die von dieser Abfrage zurückgegebenen Objekte. -- >
			< element name= "keyAttribute" type = "string " />

			<! -- nicht verwendet -- >
			< element name = "locales "type="string" minOccurs= "0"
				maxOccurs="unbounded" />

			<! -- Die vorausgewählten Sortierattribute für die Abfrage. -- >
			< element name= "sortAttributes" type="tns:SortAttribute"
				minOccurs= "0 " maxOccurs= "unbounded" />

			<! -- Die vordefinierte Größe der Elemente, die abgerufen werden sollen. -- >
			< element name = "size "type = "integer" nillable = "true " />
		</sequence>
	</complexType>
	
	<! -- Dieser Typ wird verwendet, um die Statistik für Zeilen (Elemente) im Ergebnis zurückzugeben 
		Gruppe, die durch die Ausführung einer bestimmten gespeicherten Abfrage zurückgegeben wird. -- >
	<complexType name= "QueryStats">
		<sequence>

			<! -- Größe der Ergebnismenge (Anzahl der Zeilen) -- >
			< element name = "total "type = "integer"/>
			< element name = "open "type = "integer" />
			< element name= "onTrack" type = "integer " />
			< element name= "atRisk" type = "integer " />
			< element name = "overdue "type = "integer" />
<! -- setzen Sie diese beiden Elemente auf Kommentar, da sie von keinem Code verwendet werden, d. h., sie sind nicht Teil von 
     Antwort seit dem ersten Tag.
			< element name = "active "type = "integer"/>
			< element name = "completed "type = "integer" />
 -->			
		</sequence>
	</complexType>

	<! -- Dieser Typ wird verwendet, um die Gruppe von Attributen (Datenspalten) zurückzugeben, die 
		wird als Ergebnis der Ausführung einer bestimmten gespeicherten Abfrage zurückgegeben. -- >
	<complexType name= "QueryAttributes">
		<complexContent>
			< extension base= " pref :Daten">
				<sequence>
					< element name = "kennung "type = "zeichenfolge" />

					<! -- Name der Abfrage, die dieser Attributgruppe zugeordnet ist -- >
					< element name = "query "type = "zeichenfolge"/>

					<! -- Der diplay-Name der Abfrage; dieser Wert ist mit dem Namen identisch -- >
					< element name= "displayName" type = "string " />

					<! -- nicht verwendet -- >
					< element name = "description "type = "string"/>

					<! -- Die "Art", die der Abfrage zugeordnet ist; sie wird auf "SAVED_SEARCH" gesetzt -- >
					< element name = "kind "type = "string" />

					<! -- Der Autorisierungstyp, der der Abfrage zugeordnet ist Dies wird festgelegt 
						zu einem der folgenden Werte: "INSTANCE_BASED", "ROLE_BASED" -- >
					< element name= "authorizationType" type = "string " />

					<! -- Dieses Feld gibt den Typ der von dieser Abfrage zurückgegebenen Objekte an. 
						Dies ist eine der Optionen "PROCESS_INSTANCE", "TASK", "TASK_TEMPL". -- >
					< element name= "entityTypeName" type="string " />

					<! -- Dieses Feld gibt den Namen des Attributs an, das als 
						Der Schlüssel für die von dieser Abfrage zurückgegebenen Objekte. -- >
					< element name= "keyAttribute" type = "string " />

					<! -- nicht verwendet -- >
					< element name = "locales "type="string" minOccurs= "0"
						maxOccurs="unbounded" />

					<! -- Die vorausgewählten Sortierattribute für die Abfrage. -- >
					< element name= "sortAttributes" type="tns:SortAttribute"
						minOccurs= "0 " maxOccurs= "unbounded" />

					<! -- Die vordefinierte Größe der Elemente, die abgerufen werden sollen. -- >
					< element name = "size "type = "integer" nillable = "true " />

					<! -- Liste mit null oder mehr Attributen -- >
					< element name = "items "type="tns:QueryAttributeItem"
						minOccurs= "0 " maxOccurs= "unbounded" />

				</sequence>
			</extension>
		</complexContent>
	</complexType>

	<! -- Dieser Typ beschreibt ein einzelnes Attribut, das als 
		Ergebnis der Ausführung einer bestimmten gespeicherten Abfrage. -- >
	<complexType name= "QueryAttributeItem">
		<sequence>

			<! -- Attributname -- >
			< element name = "name "type = "string" />

			<! -- Lokalisierter Anzeigename für das Attribut -- >
			< element name= "displayName" type = "string " />

			<! -- nicht verwendet -- >
			< element name = "description "type = "string"/>

			<! -- Datentyp des Attributs -- >
			< element name = "type "type = "string"/>

			<! -- nicht verwendet; auf ' false' setzen -- >
			< element name= "isArray" type = "boolean" />

			<! -- Die zugehörige Abfrage und das zugehörige Attribut, die diese Attributinformationen -- >
			< element name= "sourceAttribute" type = "string " />

			<! -- Eine Zeichenfolge, die Attribute mit einem bekannten Wertebereich -- >
			< element name = "content "type = "string" />

			<! -- Die ID der Tabelle des Quellenattributs, wie in der Abfragetabelle definiert 
				Definition -- >
			< element name= "sourceQueryTableIdentifier" type = "string " />

			<! -- Gibt an, ob das Attribut als Sortierattribut verwendet werden kann. -- >
			< element name= "isSortable" type= "boolean" minOccurs= "0"
				maxOccurs= "1 "default="true" />

			<! -- Gibt an, ob das Attribut als Filterattribut verwendet werden kann -- >
			< element name= "isFilterable" type= "boolean" minOccurs= "0"
				maxOccurs= "1 "default="true" />

		</sequence>
	</complexType>


	<! -- Dieser Typ wird verwendet, um die Ergebnisse der Ausführung eines bestimmten gespeicherten 
		Abfrage. -- >
	<complexType name= "QueryResultSet ">
		<complexContent>
			< extension base= " pref :Daten">
				<sequence>

					<! -- Schlüsselattribut, das dieser Gruppe von Abfrageergebnissen zugeordnet ist. Diese 
						hängt vom Typ der Objekte ab, die von der Abfrage zurückgegeben werden, und 
						einer der folgenden Werte sein: "TASK.TKIID","TASK_TEMPL.TKTID","PROCESS_INSTANCE.PIID" -- >
					< element name = "kennung "type = "zeichenfolge" />

					<! -- Name der gespeicherten Abfrage, für die diese Ergebnisse generiert wurden -- >
					< element name = "query "type = "zeichenfolge"/>

					<! -- Dieses Feld gibt den Typ der Objekte an, die von der Abfrage zurückgegeben werden. 
						Dies ist eine der Optionen "PROCESS_INSTANCE", "TASK", "TASK_TEMPL". -- >
					< element name= "entityTypeName" type="string " />

					<! -- Liste der Attribute (Spalten), die von dieser Abfrage zurückgegeben werden -- >
					< element name= "attributeInfo" type="tns:AttributeInfo"
						minOccurs= "0 " maxOccurs= "unbounded" />

					<! -- Der Offsetwert, der in der ursprünglichen Anforderung angegeben wurde. Diese 
						value stellt den Index (innerhalb der Gesamtergebnisgruppe der Abfrage) der ersten 
						Artikel, der zurückgegeben wird. -- >
					< element name = "offset "type = "integer" />

					<! -- Anzahl der zurückgegebenen Elemente -- >
					< element name = "size "type = "integer"/>

					<! -- Anzahl der in der ursprünglichen Anforderung angeforderten Elemente -- >
					< element name= "requestedSize" type = "Ganzzahl " />

					<! -- Gesamtzahl der Ergebnisse -- >
					< element name= "totalCount" type = "integer " />
					<! -- True, wenn die Gesamtzahl der Ergebnisse ein Suchlimit überschreitet und tatsächlich 
						Unbekannt -- >
					< element name= "countLimitÜberschritten" type= "boolean" />
					<! -- Gibt das verwendete Suchlimit an, falls vorhanden, oder 0, wenn es nicht festgelegt ist -- >
					< element name= "countLimit" type = "integer " />


					<! -- Die Ergebnismenge, die von dieser Abfrage zurückgegeben wird. Dies wird dargestellt 
						als Liste mit null oder mehr "Elementen", wobei jedes Element eine Zeile in der 
						Ergebnismenge. Jedes Element wird durch eine Map dargestellt, wobei die Map die 
						verschiedene Datenspalten, die diesem Element (Zeile) zugeordnet sind. -- >
					< element name="items "type="cmn :Map" minOccurs= "0 "
						maxOccurs="unbounded" />
						
					< element name = "stats "type="tns:QueryStats" />
				</sequence>
			</extension>
		</complexContent>
	</complexType>

	<! -- Dieser Typ enthält die Informationen zu einem einzelnen Attribut, das zurückgegeben wird. 
		als Ergebnis der Ausführung einer gespeicherten Abfrage. -- >
	<complexType name= "AttributeInfo">
		<sequence>

			<! -- Name des Attributs -- >
			< element name = "name "type = "string" />

			<! -- Datentyp des Attributs -- >
			< element name = "type "type = "string"/>

			<! -- Eine Zeichenfolge, die Attribute mit einem bekannten Wertebereich -- >
			< element name = "content "type = "string" />

			<! -- nicht verwendet; auf ' false' setzen -- >
			< element name= "isArray" type = "boolean" />

			<! -- Die zugehörige Abfrage und das zugehörige Attribut, die diese Attributinformationen -- >
			< element name= "sourceAttribute" type = "string " />

			<! -- Die ID der Tabelle des Quellenattributs, wie in der Abfragetabelle definiert 
				Definition -- >
			< element name= "sourceQueryTableIdentifier" type = "string " />
		</sequence>
	</complexType>

	<! -- Dieser Typ wird verwendet, um die Anzahl der Zeilen (Elemente) im Ergebnis zurückzugeben 
		Gruppe, die durch die Ausführung einer bestimmten gespeicherten Abfrage zurückgegeben wird. -- >
	<complexType name= "QueryResultSetCount">
		<complexContent>
			< extension base= " pref :Daten">
				<sequence>

					<! -- Größe der Ergebnismenge (Anzahl der Zeilen) -- >
					< element name = "count "type = "integer" />
				</sequence>
			</extension>
		</complexContent>
	</complexType>
	
	<! -- Ein Container, der verwendet wird, um ein Sortierattribut anhand seines Namens und seiner Sortierung zu beschreiben 
		Reihenfolge. -- >
	<complexType name= "SortAttribute">
		<sequence>
			< element name = "name "type = "string" />
			< element name= "sourceAttribute" type = "string " />
			< element name= "sortOrder" type = "string "/> <! -- ASC, DESC -- >
		</sequence>
	</complexType>
	
	<complexType name= "ProcessInstanceCount ">
		<complexContent>
			< extension base= " pref :Daten">
				<sequence>
					< element name="Übersicht "type="cmn :Map"/>
				</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:qry = 'http://rest.bpm.ibm.com/v1/data/query' xsi:type = 'qry:QueryAttributes' >
    < ID> Name < /ID>
    <query>IBM.DEFAULTALLPROCESSLIST_75</query>
    <displayName> All </displayName>
    <description></description>
    < kind> SAVED_SEARCH < /kind>
    <authorizationType> INSTANCE_BASED </authorizationType>
    <entityTypeName> PROCESS_INSTANCE </entityTypeName >
    <keyAttribute>PROCESS_INSTANCE.PIID</keyAttribute>
    <size>20</size>
    <items>
      <name>name_des_snapshots</name>
      <displayName> Momentaufnahme </displayName>
      <description></description>
      < type> STRING < /type>
      <isArray> false </isArray>
      <sourceAttribute>IBM.DEFAULTALLPROCESSLIST_75.instanceSnapshot</sourceAttribute>
      < content>PROCESS_INSTANCE.SNAPSHOT_NAME< /content>
      <sourceQueryTableIdentifier>n/a </sourceQueryTableIdentifier>
    </items>
    <items>
      < name> PI_STATUS < /name>
      <displayName> Instanzstatus </displayName>
      <description></description>
      < type> STRING < /type>
      <isArray> false </isArray>
      <sourceAttribute>IBM.DEFAULTALLPROCESSLIST_75.instanceStatus</sourceAttribute>
      < content>PROCESS_INSTANCE.STATUS< /content>
      <sourceQueryTableIdentifier>n/a </sourceQueryTableIdentifier>
    </items>
    <items>
      <name>akronym_der_prozessanwendung</name>
      <displayName> Akronym der Prozessanwendung </displayName>
      <description></description>
      < type> STRING < /type>
      <isArray> false </isArray>
      <sourceAttribute>IBM.DEFAULTALLPROCESSLIST_75.instanceProcessApp</sourceAttribute>
      < content>PROCESS_INSTANCE.PROCESS_APP_ACRONYM< /Inhalt>
      <sourceQueryTableIdentifier>n/a </sourceQueryTableIdentifier>
    </items>
    <items>
      < name> PI_PIID < /name>
      <displayName> Instanz-ID </displayName>
      <description></description>
      < Typ> ID < /Typ>
      <isArray> false </isArray>
      <sourceAttribute>IBM.DEFAULTALLPROCESSLIST_75.instanceId</sourceAttribute>
      < content>PROCESS_INSTANCE.PIID< /content>
      <sourceQueryTableIdentifier>n/a </sourceQueryTableIdentifier>
    </items>
    <items>
      < name> PT_NAME < /name>
      <displayName> Prozessdefinition </displayName>
      <description></description>
      < type> STRING < /type>
      <isArray> false </isArray>
      <sourceAttribute>IBM.DEFAULTALLPROCESSLIST_75.bpdName</sourceAttribute>
      < content>PROCESS_INSTANCE.NAME< /Inhalt>
      <sourceQueryTableIdentifier>n/a </sourceQueryTableIdentifier>
    </items>
    <items>
      < name> PI_DISPLAY_NAME < /name>
      <displayName> Beschreibender Name </displayName>
      <description></description>
      < type> STRING < /type>
      <isArray> false </isArray>
      <sourceAttribute>IBM.DEFAULTALLPROCESSLIST_75.instanceName</sourceAttribute>
      < content>PROCESS_INSTANCE.DISPLAY_NAME< /content>
      <sourceQueryTableIdentifier>n/a </sourceQueryTableIdentifier>
    </items>
    <items>
      < name> PI_NAME < /name>
      <displayName> Instanzname </displayName>
      <description></description>
      < type> STRING < /type>
      <isArray> false </isArray>
      <sourceAttribute>IBM.DEFAULTALLPROCESSLIST_75.instanceName</sourceAttribute>
      < content>PROCESS_INSTANCE.NAME< /Inhalt>
      <sourceQueryTableIdentifier>n/a </sourceQueryTableIdentifier>
    </items>
    <items>
      < name> PT_PTID < /name>
      <displayName> Prozessdefinitions-ID </displayName>
      <description></description>
      < Typ> ID < /Typ>
      <isArray> false </isArray>
      <sourceAttribute>IBM.DEFAULTALLPROCESSLIST_75.bpdId</sourceAttribute>
      < content>PROCESS_INSTANCE.PTID< /Inhalt>
      <sourceQueryTableIdentifier>n/a </sourceQueryTableIdentifier>
    </items>
    <items>
      < name> SNAPSHOT_ID < /name>
      <displayName> Snapshot ID </displayName>
      <description></description>
      < type> STRING < /type>
      <isArray> false </isArray>
      <sourceAttribute>IBM.DEFAULTALLPROCESSLIST_75.instanceSnapshotId</sourceAttribute>
      < content>PROCESS_INSTANCE.SNAPSHOT_ID< /content>
      <sourceQueryTableIdentifier>n/a </sourceQueryTableIdentifier>
    </items>
    <items>
      < Name> PT_DISPLAY_NAME < /name>
      <displayName> Prozessdefinitionsname </displayName>
      <description></description>
      < type> STRING < /type>
      <isArray> false </isArray>
      <sourceAttribute>IBM.DEFAULTALLPROCESSLIST_75.bpdName</sourceAttribute>
      < content>PROCESS_INSTANCE.DISPLAY_NAME< /content>
      <sourceQueryTableIdentifier>n/a </sourceQueryTableIdentifier>
    </items>
    <items>
      < name> PI_STATE < /name>
      <displayName> Instanzstatus (zugeordnet) </displayName>
      <description></description>
      < type> STRING < /type>
      <isArray> false </isArray>
      <sourceAttribute>IBM.DEFAULTALLPROCESSLIST_75.instanceStatus</sourceAttribute>
      < Inhalt>PROCESS_INSTANCE.STATE< /content>
      <sourceQueryTableIdentifier>n/a </sourceQueryTableIdentifier>
    </items>
  </data>
< /bpm:ResponseData>

MIME-Typ: application/x-javascript

Fehlerantwortinhalt

Detaillierte Fehlerinformationen

Der Standardinhaltstyp istapplication/json.

MIME-Typ: application/json


Schema
{"description": "WLE-Fehlerantwort", 
   "type": "object",
   "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:
Code erstellenBeschreibung
200 OK
Erfolgreiche Ausführung-angeforderte Daten zurückgegeben.
404 Nicht gefunden
Die Abfrage 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.

Änderungsprotokoll

Die folgenden Änderungen wurden auf diese Methode angewendet:
FreigebenBeschreibung
7.5.1
Die zurückgegebenen Abfrageattributeinträge enthalten neue Eigenschaften:
  • "isFilterable"
  • "isSortable"
7.5.1
Dieser Methode wurde ein neuer Parameter hinzugefügt, um eine zusätzliche Filterung mithilfe eines Prozessanwendungsnamens zu ermöglichen.
  • "processAppName"

Verfügbar seit

7.5.0

Übergeordnetes Thema: Ressource für Abfrageattribute für Prozessinstanzen