IBM Business Process Manager, Version 8.5.5

REST interface for BPD-related resources - ECM Event Resource - POST Method

Sample method invocation

Parameters

Required parameters

Name	Value Type	Description
eventSourceId	string	The ID of the ECM server repository that is sending the event. For FileNet, this is the object store ID. To view the event source ID, open your event subscription in Process Designer and select File > Preferences, then navigate to IBM BPM > Capabilities > IBM BPM Advanced Features and select "Public API". When you click Apply, the event source ID 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 ID must be CMIS-compatible; that is, it must be usable for subsequent outbound ECM operations.)
eventType	string	The type of the event. Value Description CheckOutCanceled A reservation on a versionable document is canceled. CheckedIn A versionable document is checked in. CheckedOut A versionable document is checked out. ClassChanged The class of an document/folder is changed. ClassifyCompleted A document has been assigned a document class automatically during check-in. Created A document or folder instance is created and saved. Deleted A document or folder is deleted. Filed An object is filed in a folder (including the creation of the subfolder). Frozen A versionable document is frozen. Locked A document or folder is locked or an existing lock is updated. PublishCompleted A document publishing request has completed. PublishRequested A request has been made to publish or republish a document. SecurityUpdated The security of a document or folder is changed. StateChanged The lifecycle state of a document object is changed. Unfiled An object is unfiled from a folder (including the deletion of the subfolder). Unlocked A document or folder is unlocked. Updated Changes are made to the properties of a document or folder. VersionDemoted A versionable document is demoted to a minor version. VersionPromoted A document is promoted or checked in as a major version.
objectId	string	The ID of the object instance that the event occurred on (The ID must be CMIS-compatible; that is, it must be usable for subsequent outbound ECM operations).

Request content

None

Response content

None

Error Response content

The default content type is application/json.

MIME type: 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."
      }
   }
} 

MIME type: application/xml

<?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>
	</sequence>
    </complexType>
</schema>

MIME type: application/x-javascript

Status codes

The method returns one of the following status codes:

Code	Description
200 OK	Success completion.
400 Bad Request	The objectTypeId or the eventType is unknown.
401 Unauthorized	The caller is not authorized for this request.
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.

Available since

8.0.1

Parent Topic: ECM Event Resource