Developer Guide

10.2.3
- 10.5.3
- 10.5.0
- 10.4.0
- 10.2.2 HotFix 1
- 10.2.2
- 10.2.1
- 10.2

Back Next

API Reference

The following table lists the methods available in the B2B Data Exchange Run-time API:

Method	Return Value	Description
addEventDocument ( String eventId, Document document )	String	Attaches a document to an event and returns the document ID for the document attached to the event.
completeCorrelation ( String eventId, String correlationId )	String	Completes a reconciliation process and returns the ID of the event that initiated the reconciliation process.
completeCorrelations ( String eventId )	void	Closes all correlation events of the specified event Id.
createChildEvent ( String parentEventId, String profileId )	String	Creates a child event based on a profile ID and returns the event ID of the child event.
createChildEvent ( String parentEventId, String profileId, String eventStatusName, String eventTypeName, String subject )	String	Creates a child event based on a profile ID and sets the properties of the child event. Returns the event ID of the child event.
createDocument ( String temporaryFilePath, String eventId )	Document	Moves a file into the B2B Data Exchange document store and returns the associated document reference.
flowEntry ( String profileId )	String	Indicates the start of a workflow. This method creates an event and returns the event ID.
flowEntry ( String profileId, String reuseEventId )	String	Indicates the start of a workflow. You can specify the event ID to use.
flowExit ( String eventId )	String	Indicates the end of a workflow. This method updates the status of the event with the system default status and returns the event ID.
flowExit ( String eventId, String status )	String	Indicates the end of a workflow. This method updates the status of the event with the given status and returns the event ID.
generateTemporaryFilePath ( String eventId )	String	Creates a unique file name in the B2B Data Exchange temporary document directory and returns the path and file name.
getChildrenCount ( String parentEventId )	Integer	Returns the number of child events for a parent event.
getDocumentData ( Document document, Long offset, Long count, String eventId )	byte[]	Returns the data of a document.
getDocumentFilePath ( Document documentReference, String eventId )	String	Returns the path and file name of the file associated with a document reference.
getEventAttribute ( String eventId, String attributeKey )	String	Returns the value of an event attribute.
getEventContext ( String eventId )	Map	Returns the run-time context of an event.
getEventDocuments ( String eventId )	List<Document>	Returns information about all documents associated with an event.
getEventInfo ( String eventId )	Properties	Returns the information associated with an event, including event status and event type.
getEventParentEventId ( String eventId )	String	Returns the event ID of the parent event.
getEventStatusName ( String eventId )	String	Returns the status of an event.
incrementProfileSequenceValue ( String profileId, String parameterSequenceId )	String	Increments by one the value of a sequence parameter associated with a profile.
incrementProfileSequenceValue ( String profileId, String parameterSequenceId, String incrementBy )	String	Increments by incrementBy the value of a sequence parameter associated with a profile.
initiateCorrelation ( String eventId, String correlationId, String correlationType, long timeWindowSeconds )	void	Initiates a reconciliation process.
releaseDelayedEvents ( String profileId, List<String> eventIds )	void	Releases delayed events.
resolveProfileId ( String accountNumber, String application, String partnerName, String profileName )	String	Returns the profile ID associated with an application and an account number or partner.
setEventAttribute ( String eventId, String attributeKey, String attributeValue )	String	Sets the value of the attribute associated with an event.
setEventStatus ( String eventId, String eventStatus )	void	Updates the status of an event.
setEventStatus ( String eventId, String eventStatusId, String comments )	void	Updates the status of an event.
setEventSubject ( String eventId, String subject )	void	Updates the subject of an event.
setEventType ( String eventId, String eventType )	void	Updates the type of an event.
setProfileSequenceValue ( String profileId, String parameterSequenceId, Object newValue )	String	Assigns a value to a sequence parameter associated with a profile.

Rename Saved Search

Table of Contents

Developer Guide

Developer Guide

API Reference

API Reference