eventSourceId
parameter.POST /rest/bpm/wle/v1/event/ecm?eventSourceId={string}&objectTypeId={string}&eventType={string}&objectId={string}[&relatedObjectTypeId={string}][&relatedObjectId={string}]
Name | Value Type | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
eventSourceId | string | The identifier of the ECM server repository that is sending the event. For FileNet, this is the object store identifier. To view the event source identifier, open your event subscription in Process Designer and select File > Preferences, navigate to IBM BPM > Capabilities > IBM BPM Advanced Features and select Public API. When you click Apply, the event source identifier is displayed in the Common section of the event subscription editor.
|
||||||||||||||||||||||||||||||||||||||||
objectTypeId | string | The object type of the event class that the event occurred on. The identifier must be CMIS-compatible; that is, it must be usable for subsequent outbound ECM operations.
|
||||||||||||||||||||||||||||||||||||||||
eventType | string | The type of the event.
|
||||||||||||||||||||||||||||||||||||||||
objectId | string | The identifier of the object instance that the event occurred on. The identifier must be CMIS-compatible; that is, it must be usable for subsequent outbound ECM operations.
|
Name | Value Type | Description |
---|---|---|
relatedObjectTypeId | string | The object type of a related object, for example, the object filed into a folder. If you specify this parameter, you must also specify the
relatedObjectId parameter. The identifier must be CMIS-compatible; that is, it must be usable for subsequent outbound ECM operations. |
relatedObjectId | string | The identifier of a related object, for example, the object filed into a folder. If you specify this parameter, you must also specify the
relatedObjectTypeId parameter. The identifier must be CMIS-compatible; that is, it must be usable for subsequent outbound ECM operations. |
None
None
The default content type is application/json.
{ "description": "WLE Error Response", "type": "object", "properties": { "status": {"type": "string", "description": "The status of the previous API call." }, "exceptionType": {"type": "string", "description": "The classname associated with the exception." }, "errorNumber": {"type": "string", "description": "Message ID of the exception." }, "errorMessage": {"type": "string", "description": "Message text of the exception." }, "errorMessageParameters": {"type": ["string"], "optional": true, "description":"Message text parameters of the exception." }, "programmersDetails": {"type": "object", "optional": true, "description":"Additional exception details, for example, a 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" /> <!-- This type represents an error response. --> <element name="RestRuntimeException"> <complexType> <sequence> <element name="status" type="string"/> <element name="Data" type="tns:ExceptionData"> </element> </sequence> </complexType> </element> <!-- This type contains detailed error information associated with an exception. --> <complexType name="ExceptionData"> <sequence> <element name="status" type="string"/> <!-- This specifies the java class name of the exception --> <element name="exceptionType" type="string"/> <!-- The message ID of the error message --> <element name="errorNumber" type="string" minOccurs="0"/> <!-- The complete error message --> <element name="errorMessage" type="string"/> <!-- The list of strings inserted into the error message --> <element name="errorMessageParameters" type="string" minOccurs="0" maxOccurs="unbounded"/> <!-- The stacktrace associated with the exception. Note that this will be omitted unless the "server-stacktrace-enabled" property is enabled in the server's 100Custom.xml file. --> <element name="programmersDetails" type="string"></element> <!-- Prior responses. Set if a bulk command was used --> <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="string" /> <element name="data" type="string" minOccurs="0" /> </sequence> </complexType> </schema>
Code | Description |
---|---|
200 OK | Success completion. |
400 Bad Request | The identifier of the object type or the event type is unknown.
|
401 Unauthorized | The caller is not authorized for this request. |
403 Forbidden | The event source identifier is not allowed.
|
406 Not Acceptable | The requested content type or content encoding is not supported. |
500 Internal Server Error | A severe problem has occurred, programmer's details are provided. |
8.0.1
Parent Topic: ECM Event Resource