REST-Schnittstelle für BPD-bezogene Ressourcen-ECM-Ereignisressource-Methode POST

Verwenden Sie diese Methode zum Senden eines ECM-Ereignisses an IBM Business Automation Workflow. Wenn diese Methode aufgerufen wird, muss der Business Automation Workflow -Server über eine Verbindung zu dem durch den Parameter eventSourceId angegebenen ECM-System verfügen.

Beispiel für Methodenaufruf

POST /rest/bpm/wle/v1/event/ecm?eventSourceId={string}&objectTypeId={string}&eventType={string}&objectId={string}[&relatedObjectTypeId={string}][&relatedObjectId={string}]

Parameter

Erforderliche Parameter
NameWerttypBeschreibung
eventSource-ID Zeichenfolge
Die Kennung des ECM-Server-Repositorys, das das Ereignis sendet. Bei FileNetist dies die Objektspeicher-ID. Um die Ereignisquellen-ID anzuzeigen, öffnen Sie Ihre Ereignissubskription in Process Designer und wählen Sie Datei > Vorgabenaus, navigieren Sie zu IBM BPM > Funktionen > IBM BPM Advanced Features und wählen Sie Public APIaus. Wenn Sie auf Anwendenklicken, wird die Ereignisquellen-ID im Abschnitt "Allgemein" des Ereignissubskriptionseditors angezeigt.
objectTypeId Zeichenfolge
Der Objekttyp der Ereignisklasse, in der das Ereignis aufgetreten ist. Die ID muss CMIS-kompatibel sein, d. h., sie muss für nachfolgende abgehende ECM-Operationen verwendbar sein.
eventType Zeichenfolge
Der Typ des Ereignisses.
WertBeschreibung
CheckOutAbgebrochen
Eine Reservierung für ein versionierbares Dokument wird abgebrochen.
CheckedIn
Ein versionierbares Dokument wird eingecheckt.
CheckedOut
Ein versionierbares Dokument ist ausgecheckt.
ClassChanged
Die Klasse eines Dokuments oder Ordners wird geändert.
ClassifyCompleted
Einem Dokument wurde beim Einchecken automatisch eine Dokumentklasse zugeordnet.
Erstellt
Eine Dokument-oder Ordnerinstanz wird erstellt und gespeichert.
Gelöscht
Ein Dokument oder Ordner wird gelöscht.
Abgelegt
Ein Objekt wird in einem Ordner abgelegt (einschließlich der Erstellung des Unterordners).
Blockiert
Ein versionierbares Dokument ist eingefroren.
Gesperrt
Ein Dokument oder Ordner ist gesperrt oder eine vorhandene Sperre wird aktualisiert.
PublishCompleted
Eine Dokumentveröffentlichungsanforderung wurde abgeschlossen.
PublishRequested
Es wurde angefordert, ein Dokument zu veröffentlichen oder erneut zu veröffentlichen.
SecurityUpdated
Die Sicherheit eines Dokuments oder Ordners wird geändert.
StateChanged
Der Lebenszyklusstatus eines Dokumentobjekts wird geändert.
Nicht abgelegt
Ein Objekt wird aus einem Ordner entfernt (einschließlich des Löschens des Unterordners).
Entriegelt
Ein Dokument oder Ordner ist entsperrt.
Aktualisiert
Die Eigenschaften eines Dokuments oder Ordners werden geändert.
VersionDemoted
Ein versionierbares Dokument wird auf eine Nebenversion herabgestuft.
VersionPromoted
Ein Dokument wird als Hauptversion hochgestuft oder eingecheckt
objectId Zeichenfolge
Die Kennung der Objektinstanz, in der das Ereignis aufgetreten ist. Die ID muss CMIS-kompatibel sein, d. h., sie muss für nachfolgende abgehende ECM-Operationen verwendbar sein.
Optionale Parameter
NameWerttypBeschreibung
relatedObjectTypeId Zeichenfolge
Der Objekttyp eines zugehörigen Objekts, z. B. das in einem Ordner abgelegte Objekt. Wenn Sie diesen Parameter angeben, müssen Sie auch den Parameter relatedObjectId angeben. Die ID muss CMIS-kompatibel sein, d. h., sie muss für nachfolgende abgehende ECM-Operationen verwendbar sein.
relatedObjectId Zeichenfolge
The identifier of a related object, for example, the object filed into a folder. Wenn Sie diesen Parameter angeben, müssen Sie auch den Parameter relatedObjectTypeId angeben. Die ID muss CMIS-kompatibel sein, d. h., sie muss für nachfolgende abgehende ECM-Operationen verwendbar sein.

Anforderungsinhalt

Keine

Antwortinhalt

Keine

Fehlerantwortinhalt

Detaillierte Fehlerinformationen

Der Standardinhaltstyp istapplication/json.

MIME-Typ: application/json


Schema
{"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"
      }
   }
} 

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:
CodeBeschreibung
200 OKErfolgreiche Ausführung.
400 Bad Request (Ungültige Anforderung)
Die ID des Objekttyps oder Ereignistyps ist unbekannt.
401 Nicht autorisiertDer Aufrufende ist für diese Anforderung nicht berechtigt.
403 Nicht zulässig
Die Ereignisquellen-ID ist nicht zulässig.
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.

Verfügbar seit

8.0.1

Übergeordnetes Thema: ECM-Ereignisressource