5.5 Flow Outcome

For 'Private Exchange' and 'Broadcast' transports (in case where there is a pickup) Outcome API should be called to provide visibility about the 'Flow' outcome
Special useful cases are:

Ability to report batch mixed result information
Ability to define 'private/selective delivery' for broadcast transports.

Flow results could be: 1-passed, 2-failed, 3-mixed result.

In case of batch processing Flow Outcome will return notes on failing records, Message Id and total / failed record counters.

Method	Request Url
POST	api/TransportMgr/ FlowOutcome

Type

Parameter

Values

HEAD
POST

JAVA

Authorization 
{ 
"fileCode" "FL5885807902", 
"flowOutcome": 1, 
"flowInstanceCode": "specificid", 
"batchTotalRecordCount": 10, 
"batchFailedRecordCount": 0, 
"ActivityMessage": "", 
"ActivityDetail": "", 
"SelectiveDropOffRecipients": "" 
}

Parameter	Value
Flow Outcome	Status of file transfer/processing: Passed = 1, Failed = 2, Mixed Result = 3
Flow Instance Code	Flow Message id (middleware id) for reference in OptiPaaS
Batch Total Record Count	Number of processed records in batch flow
Batch Failed Record Count	Number of failed records in batch flow
Activity Message	Status or exception message (also batch aggregated exception string)
Activity Detail:	Exception stack trace

Status	Response	Note
200		success
403	Content contains access denied message	Invalid Authorization Header in API call. Flow Code parameter in Transport does not match the Flow Code in Authorization header
500	Content contains exception (message and stack trace)	Failed to set the outcome or change file status