GET /rest/bpm/wle/v1/system/alertDefinitions/status[?ids={string}]| Name | Werttyp | Beschreibung |
|---|---|---|
| IDs | Zeichenfolge | Eine durch Kommas getrennte Liste mit Alertdefinitionskennungen, für die der Status abgerufen wird.
|
Keine
Der Standardinhaltstyp istapplication/json.
{
"description": "Statusantwort für Alertdefinition",
"type":"object",
"Eigenschaften": {
"alertDefinitionStatus": {
"type":"array",
"Eigenschaften": {
"Definition": {
"type":"object",
"Eigenschaften": {
"ID": {
"type":"string",
"description": " Die ID der Alertdefinition. Dieses Feld ist optional. Wenn nicht festgelegt, wird beim Speichern eine neue Alertdefinition erstellt. ",
"erforderlich" :false
},
"displayName":{
"type":"string",
"description": " Der Anzeigename der Alertdefinition. Dieses Feld ist obligatorisch. ",
"erforderlich" :true
},
"Kategorie": {
"type":"string",
"description": " Die Kategorie der Alertdefinition. Gültige Werte sind INSTANCE und TASK. Dieses Feld ist obligatorisch. ",
"Aufzählung": [
"INSTANZ",
"TASK"
],
"erforderlich" :true
},
"projectId":{
"type":"string",
"description": " Die ausgewählte Prozessanwendungs-ID in der Alertdefinition im externen Zeichenfolgeformat (z. B. 2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0) Dieses Feld ist optional. Es wird mit dem Festlegen der Eigenschaften 'snapshotId' bzw. 'bpdId' automatisch gesetzt. Wenn ein Projekt nicht angegeben wird, werden standardmäßig alle Projekte in die Alertdefinition eingeschlossen. ",
"erforderlich" :false
},
"snapshotId":{
"type":"string",
"description": " Die ausgewählte Momentaufnahme-ID in der Alertdefinition im externen Zeichenfolgeformat (z. B. 2064.aaa569e9-a57a-4684-b357-34237e4e49ea) Dieses Feld ist optional. Der mit dieser Eigenschaft angegebene Snapshot muss dem Projekt zugehörig sein, das optional mit der Eigenschaft 'projectId' angegeben wurde. Wenn keine Momentaufnahme angegeben wird, werden standardmäßig alle Momentaufnahmen eingeschlossen. ",
"erforderlich" :false
},
"bpdId":{
"type":"string",
"description": " Die ID der ausgewählten Geschäftsprozessdefinition in der Alertdefinition im externen Zeichenfolgeformat (z. B. 25.c904b3b1-afc1-4698-bf5a-a20892c20275) Sofern nicht die Eigenschaft 'bpdDisplayName' festgelegt wurde, ist dieses Feld optional. Die mit dieser Eigenschaft angegebene Geschäftsprozessdefinition muss dem Projekt, das optional mit der Eigenschaft 'projectId' angegeben wurde, und dem Snapshot, der optional mit der Eigenschaft 'snapshotId' angegeben wurde, zugehörig sein. Wenn keine Geschäftsprozessdefinition angegeben wird, werden standardmäßig alle Geschäftsprozessdefinitionen eingeschlossen. ",
"erforderlich" :false
},
"bpdDisplay-Name": {
"type":"string",
"description": " Der Anzeigename der ausgewählten Geschäftsprozessdefinition in der Alertdefinition. Dieses Feld ist optional und hat keinen Einfluss auf die Auswertung der Alertdefinition. Diese Eigenschaft sowie die Eigenschaft 'bpdId' müssen aus derselben Geschäftsprozessdefinition stammen. Sie wird automatisch festgelegt, wenn die EigenschaftbpdIdfestgelegt wird. ",
"erforderlich" :false
},
"instanceStatus":{
"type":"string",
"description": " Der Ausführungsstatus der ausgewählten Instanz in der Alertdefinition. Gültige Werte sind ACTIVE, COMPLETED, FAILED, TERMINATED und SUSPENDED. Dieses Feld ist optional. Wenn nicht festgelegt, zielt die Alertdefinition auf alle Instanzausführungsstatus ab. ",
"Aufzählung": [
"AKTIV",
"ABGESCHLOSSEN",
"FEHLGESCHLAGEN",
"terminated",
"AUSGESETZT"
],
"erforderlich" :false
},
"taskStatus":{
"type":"string",
"description": " Der ausgewählte Taskausführungsstatus in der Alertdefinition. Gültige Werte sind NEW (Neu), RECEIVED (Empfangen) und CLOSED (Geschlossen). Dieses Feld ist optional. Ist es nicht gesetzt, so bezieht sich die Alertdefinition auf alle drei Ausführungsstatus. Dieses Feld gilt nur für Alertdefinitionen des Typs TASK. ",
"Aufzählung": [
"NEU",
"EMPFANGEN"
"GESCHLOSSEN"
],
"erforderlich" :false
},
"thresholdOperator":{
"type":"string",
"description": " Der Schwellenwertoperator in der Alertdefinition. Gültige Werte sind GREATER, EQUAL und LESS. Dieses Feld ist obligatorisch. ",
"Aufzählung": [
"GRÖSSER",
"GLEICH",
"WENIGER"
],
"erforderlich" :true
},
"thresholdValue":{
"type":"string",
"description": " Der Schwellenwert in der Alertdefinition. Gültige Werte müssen numerisch und größer-gleich Null sein. Dieses Feld ist obligatorisch. ",
"erforderlich" :true
}
}
},
"actualValue":{
"type":"string",
"description": "Der tatsächliche Wert zur Laufzeit für den in der Alertdefinition festgelegten Schwellenwert.",
"erforderlich" :true
},
"conditionMet":{
"type":"boolean",
"description": "Gibt an, ob die Bedingung der Alertdefinition erfüllt wurde.",
"erforderlich" :true
}
}
},
"failedOperations":{
"type":"array",
"Eigenschaften": {
"objectId":{
"type":"string",
"description": "Die ID des Objekts, für das die Operation fehlgeschlagen ist".
},
"errorNumber":{
"type":"string",
"description": "Die Nachrichten-ID der Ausnahmebedingung."
},
"errorMessage":{
"type":"string",
"description": "Der Nachrichtentext der Ausnahme."
}
}
}
}
}
{
"status": "200",
"Daten":
{
"failedOperations":
[
{
"objectId": "2040.1005",
"errorNumber": "CWTBG0012E",
"errorMessage": "CWTBG0012E: Der Parameter 'ids' ist ungültig. Alertdefinition mit ID '2040.1005' konnte nicht gefunden werden. "
}
],
"StatusalertDefinition":
[
{
"definition":
{
"id": "2040.1006"
"displayName": "Aktive Instanzen",
"category": "INSTANZ",
"instanceStatus": "ACTIVE",
"thresholdOperator": "GREATER",
"thresholdValue": "100"
},
"actualValue": "10",
"conditionMet": falsch
},
{
"definition":
{
"id": "2040.1007",
"displayName": "Abgeschlossene Instanzen im Projekt",
"category": "INSTANZ",
"projectId": "2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0",
"instanceStatus": "COMPLETED",
"thresholdOperator": "LESS",
"thresholdValue": "100"
},
"actualValue": "5",
"conditionMet": wahr
},
{
"definition":
{
"id": "2040.1008",
"displayName": "Allgemeine Tasks",
"category": "TASK",
"thresholdOperator": "EQUAL",
"thresholdValue": "10"
},
"actualValue": "10",
"conditionMet": wahr
},
{
"definition":
{
"id": "2040.1009",
"displayName": "Geschlossene Tasks in aktiven Instanzen von bpd in Momentaufnahme und Projekt",
"category": "TASK",
"projectId": "2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0",
"snapshotId": "2064.d841529d-5d60-4905-9b8e-1361901380bd",
"bpdId": "25.c904b3b1-afc1-4698-bf5a-a20892c20275",
"bpdDisplayName": "Standard HR Open New Position",
"instanceStatus": "ACTIVE",
"taskStatus": "GESCHL",
"thresholdOperator": "GREATER",
"thresholdValue": "100"
},
"actualValue": "3"
"conditionMet": falsch
}
]
}
}
<?xml version="1.0" encoding="UTF-8"?>
< schema targetNamespace= "http://rest.bpm.ibm.com/v1/data/alertDefinition"
elementFormDefault= "unqualified" xmlns= "http://www.w3.org/2001/XMLSchema"
xmlns:tns = "http://rest.bpm.ibm.com/v1/data/alertDefinition"
xmlns:pref = "http://rest.bpm.ibm.com/v1/data/root"
xmlns:common = "http://rest.bpm.ibm.com/v1/data/common">
< 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" />
<!--
Dieser Typ stellt eine Alertdefinition dar, die für die IBM BPM -Installation definiert wurde.
-->
<complexType name= "AlertDefinition">
<complexContent>
< extension base= " pref :Daten">
<sequence>
<!--
Die ID der Alertdefinition.
Dieses Feld ist optional.
Wenn nicht festgelegt, wird beim Speichern eine neue Alertdefinition erstellt.
-->
< element name = "id "type = "zeichenfolge"/>
<!--
Der Anzeigename der Alertdefinition.
Dieses Feld ist obligatorisch.
-->
< element name= "displayName" type = "string " />
<!--
Die Kategorie der Alertdefinition.
Gültige Werte sind INSTANCE und TASK.
Dieses Feld ist obligatorisch.
-->
< element name = "kategorie "type = "zeichenfolge" />
<!--
Die ausgewählte Prozessanwendungs-ID in der Alertdefinition im externen Zeichenfolgeformat
(Beispiel: 2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0) Dieses Feld ist optional.
Es wird mit dem Festlegen der Eigenschaften 'snapshotId' bzw. 'bpdId' automatisch gesetzt.
Ist kein Projekt angegeben, so werden standardmäßig alle Projekte in die Alertdefinition einbezogen.
-->
< element name= "projectId" type = "zeichenfolge " />
<!--
Die ausgewählte Snapshot-ID in der Alertdefinition im externen Zeichenfolgeformat
(Beispiel: 2064.aaa569e9-a57a-4684-b357-34237e4e49ea). Dieses Feld ist optional.
Der mit dieser Eigenschaft angegebene Snapshot muss dem Projekt zugehörig sein, das optional mit der Eigenschaft 'projectId' angegeben wurde.
Ist kein Snapshot angegeben, so werden standardmäßig alle Snapshots einbezogen.
-->
< element name= "snapshotId" type = "string " />
<!--
Die ID der ausgewählten Geschäftsprozessdefinition in der Alertdefinition im externen Zeichenfolgeformat
(Beispiel: 25.c904b3b1-afc1-4698-bf5a-a20892c20275) Sofern nicht die Eigenschaft 'bpdDisplayName' festgelegt wurde, ist dieses Feld optional.
Die mit dieser Eigenschaft angegebene Geschäftsprozessdefinition muss sich auf das optional angegebene Projekt beziehen.
in der Eigenschaft 'projectId' und die Momentaufnahme, die optional mit der Eigenschaft 'snapshotId' angegeben wird.
Ist keine Geschäftsprozessdefinition angegeben, so werden standardmäßig alle Geschäftsprozessdefinitionen einbezogen.
-->
< element name= "bpdId" type = "string " />
<!--
Der Anzeigename der ausgewählten Geschäftsprozessdefinition in der Alertdefinition.
Dieses Feld ist optional und hat keinen Einfluss auf die Auswertung der Alertdefinition.
Diese Eigenschaft sowie die Eigenschaft 'bpdId' müssen aus derselben Geschäftsprozessdefinition stammen.
Sie wird mit dem Festlegen der Eigenschaft 'bpdId' automatisch gesetzt.
-->
< element name= "bpdDisplayName" type="string " />
<!--
Der ausgewählte Ausführungsstatus der Instanz in der Alertdefinition.
Gültige Werte sind ACTIVE, COMPLETED, FAILED, TERMINATED und SUSPENDED.
Dieses Feld ist optional.
Ist kein Wert festgelegt, so werden standardmäßig alle Ausführungsstatus der Instanz in die Alertdefinition einbezogen.
-->
< element name= "instanceStatus" type = "string " />
<!--
Der Ausführungsstatus der ausgewählten Task in der Alertdefinition.
Gültige Werte sind NEW (Neu), RECEIVED (Empfangen) und CLOSED (Geschlossen).
Dieses Feld ist optional.
Wenn nicht festgelegt, werden alle drei Taskausführungsstatus standardmäßig in die Alertdefinition eingeschlossen.
Dieses Feld ist nur für Alertdefinitionen des Typs TASK (Task) maßgeblich.
-->
< element name= "taskStatus" type = "string " />
<!--
Der Schwellenwertoperator in der Alertdefinition.
Gültige Werte sind GREATER, EQUAL und LESS.
Dieses Feld ist obligatorisch.
-->
< element name= "thresholdOperator" type = "string " />
<!--
Der Schwellenwert in der Alertdefinition.
Gültige Werte müssen numerisch und größer-gleich Null sein.
Dieses Feld ist obligatorisch.
-->
< element name= "thresholdValue" type = "string " />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
Eine Liste der Alertdefinitionen
-->
<complexType name= "AlertDefinitions">
<complexContent>
< extension base= " pref :Daten">
<sequence>
< element name = "definitions "type="tns:AlertDefinition" minOccurs= "0 " maxOccurs= "unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
Dieser Typ stellt einen Alertdefinitionsstatus dar, der Informationen zum Laufzeitstatus einer Alertdefinition enthält.
-->
<complexType name= "AlertDefinitionStatus">
<complexContent>
< extension base= " pref :Daten">
<sequence>
<! -- Alertdefinition -- >
< element name = "definition "type="tns:AlertDefinition" />
<! -- Der tatsächliche Wert zur Laufzeit für den in der Alertdefinition festgelegten Schwellenwert -- >
< element name= "actualValue" type = "string " />
<! -- Ob die Bedingung der Alertdefinition erfüllt wurde -- >
< element name= "conditionMet" type = "boolean" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
Dieser Typ beschreibt eine fehlgeschlagene Operation während einer Operation im Zusammenhang mit einer Massenalertdefinition.
-->
<complexType name= "FailedOperation">
<sequence>
<! -- Die Objekt-ID, bei der die Operation fehlgeschlagen ist -- >
< element name= "objectId" type = "string " />
<! -- Dem Fehler zugeordnetes Fehlernachrichtenpräfix -- >
< element name= "errorNumber" type = "string " />
<! -- Fehlernachricht, die dem Fehler zugeordnet ist -- >
< element name= "errorMessage" type = "zeichenfolge " />
</sequence>
</complexType>
<!--
Eine Liste der fehlgeschlagenen Operationen
-->
<complexType name= "FailedOperations">
<complexContent>
< extension base= " pref :Daten">
<sequence>
< element name= "failedOperations" type="tns:FailedOperation" minOccurs= "0" maxOccurs= "unbounded " />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
Dieser Typ wird verwendet, um die Ergebnisse der Ausführung einer Massenoperation für mehrere Alertdefinitionen zurückzugeben.
-->
<complexType name= "AlertDefinitionStatusResponse">
<complexContent>
< extension base= " pref :Daten">
<sequence>
<! -- Liste mit null oder mehr fehlgeschlagenen Operationen -- >
< element name= "failedOperations" type="tns:FailedOperation" minOccurs= "0" maxOccurs= "unbounded " />
<! -- Eine Liste mit null oder mehr Objekten, die den Alertdefinitionsstatus enthalten -- >
< element name= "alertDefinitionStatus" type="tns:AlertDefinitionStatus " minOccurs= "0" maxOccurs= "unbounded " />
</sequence>
</extension>
</complexContent>
</complexType>
</schema>
< ?xml version="1.0 "encoding="UTF-8" standalone="yes " ?>
< bpm:ResponseData xmlns:bpm = "http://rest.bpm.ibm.com/v1/data" xmlns:ex = "http://rest.bpm.ibm.com/v1/data/exception" xmlns:soc = "http://rest.bpm.ibm.com/v1/data/social" xmlns:sys = "http://rest.bpm.ibm.com/v1/data/system" xmlns:ug = "http://rest.bpm.ibm.com/v1/data/usergroup">
<status>200</status>
< data xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:ns8="http://rest.bpm.ibm.com/v1/data/alertDefinition" xsi:type = "ns8:AlertDefinitionStatusResponse">
<failedOperations>
<objectId>2040.1005</objectId>
<errorNumber>CWTBG0012E</errorNumber>
<errorMessage>CWTBG0012E: Der Parameter 'ids' ist ungültig. Alertdefinition mit ID '2040.1005' konnte nicht gefunden werden. </errorMessage>
</failedOperations>
<alertDefinition-Status>
< Definition>
<id>2040.1006</id>
<displayName> Aktive Instanzen </displayName>
< Kategorie> INSTANCE < /Kategorie>
<instanceStatus> ACTIVE </instanceStatus>
<thresholdOperator> GREATER </thresholdOperator>
<thresholdValue>100</thresholdValue>
< /definition>
<actualValue>10</actualValue>
<conditionMet> false </conditionMet>
</alertDefinitionStatus >
<alertDefinition-Status>
< Definition>
<id>2040.1007</id>
<displayName> Abgeschlossene Instanzen im Projekt </displayName>
< Kategorie> INSTANCE < /Kategorie>
<projectId>2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0</projectId>
<instanceStatus> COMPLETED </instanceStatus>
<thresholdOperator> LESS </thresholdOperator>
<thresholdValue>100</thresholdValue>
< /definition>
<actualValue>5</actualValue>
<conditionMet> true </conditionMet>
</alertDefinitionStatus >
<alertDefinition-Status>
< Definition>
<id>2040.1008</id>
<displayName> Tasks insgesamt </displayName>
< Kategorie> TASK < /Kategorie>
<thresholdOperator> EQUAL </thresholdOperator>
<thresholdValue>10</thresholdValue>
< /definition>
<actualValue>10</actualValue>
<conditionMet> true </conditionMet>
</alertDefinitionStatus >
<alertDefinition-Status>
< Definition>
<id>2040.1009</id>
<displayName> Geschlossene Aufgaben in aktiven Instanzen von BPD in Momentaufnahme und Projekt </displayName>
< Kategorie> TASK < /Kategorie>
<projectId>2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0</projectId>
<snapshotId>2064.d841529d-5d60-4905-9b8e-1361901380bd</snapshotId>
<bpdId>25.c904b3b1-afc1-4698-bf5a-a20892c20275</bpdId>
<bpdDisplayName > Standard HR Open New Position </bpdDisplayName >
<instanceStatus> ACTIVE </instanceStatus>
<taskStatus> CLOSED </taskStatus>
<thresholdOperator> GREATER </thresholdOperator>
<thresholdValue>100</thresholdValue>
< /definition>
<actualValue>3</actualValue>
<conditionMet> false </conditionMet>
</alertDefinitionStatus >
</data>
< /bpm:ResponseData>
Der Standardinhaltstyp istapplication/json.
{"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"
}
}
}
<?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>
| Code | Beschreibung |
|---|---|
| 200 OK | Erfolgreiche Beendigung. Hinweis: Die Liste kann leer sein und Fehler können in der Antwort aufgelistet sein (FailedOperations complexType).
|
| 400 Bad Request (Ungültige Anforderung) | Ungültige Anforderung
|
| 403 Nicht zulässig | Der Aufrufende ist nicht berechtigt, diese Operation auszuführen.
|
| 406 Not Acceptable | Der angeforderte Inhaltstyp oder die Codierung des Inhalts wird nicht unterstützt. |
| 500 Interner Serverfehler | Interner Serverfehler. Sehen Sie sich die Details an.
|
8.5.6.0
Übergeordnetes Thema: Statusressource für Alertdefinitionen