B2B Gateway > B2B Gateway REST APIs > Event Status REST API

Event Status REST API

When you use a B2B Gateway Run Partner REST API to trigger a mapping to run a partner flow and the action succeeds, B2B Gateway returns the event ID of the task event that it generates in the REST API response.

You can use the B2B Gateway Event Status REST API to query the status of the event, based on the event ID.

When you query a task event and the event reaches its final status, the API returns the event IDs of all the file events that the mapping generated. You can then run the API to query the status of each file event.

A task event reaches its final status when the mapping finishes running. A file event reaches its final status when the file processing is complete. Processing is complete when all task and file events are in a final status.

Event status REST API request

Use a GET request with an application/json content type to query the status of a partner event.

To query the status of a partner event, use the following REST URL:

https://b2bgateway.<pod>.<baseUrl>/b2b-gw/api/v3/event/status/eventId

Where:

•<pod> is the name of the Informatica Intelligent Cloud Services point of delivery (PoD) where you access B2B Gateway. For example: pod1.
•<baseUrl> is the Informatica Intelligent Cloud Services URL. For example: dm-us.informaticacloud.com/.

For example:

https://use6-b2bgw.dm-us.informaticacloud.com/b2b-gw/api/v3/event/status/7638

Tip: You can copy the values of <pod> and <baseUrl> from the B2B Gateway URL after you access it from the My Services page of Informatica Intelligent Cloud Services.

Event Status API action response

When you use the B2B Gateway Event Status API to query the status of task and file events, the API returns the event response in a JSON format.

When the request fails, the API returns the HTTP response code that is relevant to the cause of the error. For example, if the event you query is of an unsupported type, such as a group event, the API returns 400, the code for a bad request. When file processing fails, the event is in Error status.

Success response for task events

When you query the status of task events and the request succeeds, the response includes the following information about the event:

Property	Description
eventType	Type of event: Task Level Event.
eventStatus	Status of the event.
eventId	ID of the event.
eventCreationTimestamp	Time when the event occurred. System time in milliseconds as returned by Java API java.lang.System.currentTimeMillis.
partnerName	Name of the partner.
partnerNumber	Number of the partner.
partnerFileType	Type of files that are exchanged with the partner.
direction	Direction of the partner flow, INBOUND or OUTBOUND.
isErrorStatus	Indicates whether or not the event is in error status.
isFinalStatus	Indicates whether or not the event reached its final status.
files	List of files that were exchanged with the partner, including details of each file event.

Success response for file events

When you query the status of a task event or a file event and the request succeeds, the response includes the following information for each file event:

Property	Description
eventType	Type of event: File Level Event.
eventStatus	Status of the event.
eventId	ID of the event.
eventCreationTimestamp	Time when the event occurred. System time in milliseconds as returned by Java API java.lang.System.currentTimeMillis.
parentEventId	ID of the parent task event.
messageType	Type of message that is exchanged with the partner.
ackCode	Correlated acknowledgment status.
ackCodeDescription	Description of correlated acknowledgment status.
fileName	Name of the file.
interchangeControlNumber	Interchange control number.
groupList	If the file event includes groups, list of group events, including details of each group event and the group's transaction events.
transactionList	If the file event includes transactions that aren't nested under groups, list of transaction events, including details of each transaction event.
sectionList	If the file event includes sections, list of section events, including details of each section event. Applies to inbound custom files with Intelligent Structure Discovery.
hasUnidentifiedData	Indicates whether or not the file includes unidentified data. Applies to inbound custom files with Intelligent Structure Discovery.
isErrorStatus	Indicates whether or not the event is in error status.
isFinalStatus	Indicates whether or not the event reached its final status.

Group event details

If a file event includes groups of transactions, the file event success response includes group events.

A group event includes the following information:

Property	Description
eventType	Type of event: Group Level Event.
eventStatus	Status of the event: Complete or in progress.
eventId	ID of the event.
eventCreationTimestamp	Time when the event occurred. System time in milliseconds as returned by Java API java.lang.System.currentTimeMillis.
parentEventId	ID of the parent file event.
messageType	Type of message that is exchanged with the partner.
ackCode	Correlated acknowledgment status.
ackCodeDescription	Description of correlated acknowledgment status.
groupControlNumber	Group control number.
transactionList	List of transaction events, including details of each transaction event.
isErrorStatus	Indicates whether or not the event is in error status.
isFinalStatus	Indicates whether or not the event reached its final status.

Transaction event details

If a file event includes transactions, the file event success response includes transaction events. Transaction events can be nested directly under the file event or under group events.

A transaction event includes the following information:

Property	Description
eventType	Type of event: Transaction Level Event.
eventStatus	Status of the event: Complete or in progress.
eventId	ID of the event.
eventCreationTimestamp	Time when the event occurred. System time in milliseconds as returned by Java API java.lang.System.currentTimeMillis.
parentEventId	ID of the parent event, either a file event or a group event.
messageType	Type of message that is exchanged with the partner.
ackCode	Correlated acknowledgment status.
ackCodeDescription	Description of correlated acknowledgment status.
number	Transaction number.
messageControlNumber	Message control number.
groupNumber	ID of the parent group. Applies to transactions that are nested under groups.
isErrorStatus	Indicates whether or not the event is in error status.
isFinalStatus	Indicates whether or not the event reached its final status.

Section event details

If a file event includes sections, the file event success response includes section events.

A section event includes the following information:

Property	Description
eventType	Type of event: Section Level Event.
eventStatus	Status of the event: Complete or in progress.
eventId	ID of the event.
eventCreationTimestamp	Time when the event occurred. System time in milliseconds as returned by Java API java.lang.System.currentTimeMillis.
parentEventId	ID of the parent file event.
messageType	Type of message that is exchanged with the partner.
sectionName	Name of the section.
fileName	Name of the file. Applies when messageType is File.
isErrorStatus	Indicates whether or not the event is in error status.
isFinalStatus	Indicates whether or not the event reached its final status.