B2B Gateway > B2B Gateway REST APIs > Download Event Grid REST API
  

Download Event Grid REST API

You can use a Download Event Grid REST API request with an application/json content type to download a JSON output of event grid details for an organisation. The JSON output can be easily shared or stored locally. You can download a JSON response of events for a specific time period.
The JSON output contains details of a maximum of 2000 events.
To download the output, use the following URL:
https://b2bgateway.<pod>.<baseUrl>/b2b-gw/api/v1/event/downloadEventDetails
Where:
You can copy the values of pod and base Url from the B2B Gateway URL after you access it from the My Services page of Informatica Intelligent Cloud Services.

Download Event Grid REST API request

Use a POST request with an application/json content type to download a JSON output of event grid within an organisation.
The following table describes the request body parameters of the request URL:
Parameter
Type
Description
eventId
String
The ID of the event.
fromDate
String
The date from when the events are required to be filtered. The value in this field is displayed in Unix time format or Epoch time in which the date is converted to milliseconds.
Todate
String
The date till when the events are required to be filtered. The value in this field is displayed in Unix time format or Epoch time in which the date is converted to milliseconds.
messageTypeNames
String
The type of messages that you exchange with partners.
entityNumber
String
The identification number of an external or internal entity that sends documents for processing or receives documents after processing in B2B Gateway.
statuses
String
The status details of the events.
eventTypes
String
The type of the event.
showDeleted
String
The details of the deleted partners field.
internalPartnerIDList
String
The list of internal partners.
partnerTags
String
The tags that are labels you create to help organize the partners.
resultSize
String
The size of the result after filtering the events.
The following example shows a sample request:
{
"eventId":34046598, "fromDate":1730042349474,

"toDate":1730128749474,

"messageTypeNames":["810"],

"entityNumber":null,

"statuses":["Complete"],

"eventTypes":["OUTBOUND"],

"showDeleted":false,

"internalPartnerIDList":[75226],

"partnerTags":[],

"resultSize":2000
}

Download Event Grid REST API response

When you make the B2B Gateway Download Event Grid REST API, the REST API returns the event response in a JSON format.
The following table describes the response attributes of the response:
Parameter
Type
Description
eventType
String
The type of the event that is defined in the Operation Console.
eventStatus
String
The status of the event.
eventId
String
The ID of the event.
eventCreationTimestamp
String
The time of the event creation.
parentEventId
String
The ID of the parent event.
messageType
String
The type of messages that you exchange with partners.
fileName
String
Name of the inbound or outbound files.
interchangeControlNumber
String
An identifier generated internally by B2B gateway for each message.
number
String
The unique identification number of the message based on the message type.
messageControlNumber
String
The transaction number, for example, invoice number.
groupNumber
String
The group control number for the functional group of the transaction.
isErrorStatus
String
Indicates if the event displays an error. Returns True if an event indicates an error; otherwise, returns False.
isFinalStatus
String
Indicates whether the event is in a final state. Returns True if the event status is final; otherwise, returns False.
The following table describes the response parameters for the JSON output:
[
{
"eventType": "File Level Event",
"eventStatus": "Complete",
"eventId": 34041057,
"eventCreationTimestamp": 1730113018058,
"parentEventId": 34041056,
"messageType": "file",
"partnerName": "x12-24-10-28-SWR",
"partnerNumber": "XLT4AS8ZQH45",
"partnerFileType": "EDIX12",
"direction": "OUTBOUND",
"isErrorStatus": false,
"isFinalStatus": true,
"files": [
{
"eventType": "File Level Event",
"eventStatus": "Complete",
"eventId": 34041057,
"eventCreationTimestamp": 1730113018058,
"parentEventId": 34041056,
"messageType": "file",
"fileName": "x12_810_034041057_34041057_2024_24_10_28_06_06_58_00_521_EDT.edi",
"interchangeControlNumber": "034041057",
"groupList": [
{
"eventType": "Group Level Event",
"eventStatus": "Complete",
"eventId": 34040759,
"eventCreationTimestamp": 1730113252305,
"parentEventId": 34041057,
"messageType": "810",
"transactionList": [
{
"eventType": "Transaction Level Event",
"eventStatus": "Complete",
"eventId": 34041153,
"eventCreationTimestamp": 1730113253246,
"parentEventId": 34041057,
"messageType": "810",
"number": "DO091003TESTINV01TAX",
"messageControlNumber": "0001",
"groupNumber": "34041057",
"isErrorStatus": false,
"isFinalStatus": true
},
{
"eventType": "Transaction Level Event",
"eventStatus": "Complete",
"eventId": 34041154,
"eventCreationTimestamp": 1730113253275,
"parentEventId": 34041057,
"messageType": "810",
"number": "DO091003TESTINV01TAX",
"messageControlNumber": "0002",
"groupNumber": "34041057",
"isErrorStatus": false,
"isFinalStatus": true
}
],
"groupControlNumber": "34041057",
"isErrorStatus": false,
"isFinalStatus": true
}
],
"isErrorStatus": false,
"isFinalStatus": true
}
]
}
]