The following is the response syntax to a request to query the details of an event:
Response header
The Events REST API response includes the following header:
Retry-After - <time in seconds>
Retry-After
is the time in seconds to wait before making the follow-up request.
Retry-After
appears if the response code is
TOO_MANY_REQUESTS
.
Response body
The Events REST API response includes the following body:
{
"eventId": "Long",
"eventType": "String",
"applicationName": "String",
"topicName": "String",
"pubSubName": "String",
"createTime": "Event StartTime :: Date",
"completionTime": "Event Completed Time :: Date",
"parentEventId": "Long",
"descendantState": "enum mentioned in the request body.",
"childEvents": "List<EventDetailResponse>",
"eventHistory": {
"eventId": "Long",
"timeStamp": "Date",
"eventStatusName": "String",
"comments": "String"
}
}
The following table describes the elements of the response:
eventId
| ID of the event that
Cloud Integration Hub generates for the publication or subscription.
|
eventType
| The type of event that
Cloud Integration Hub generates for the publication or subscription.
|
applicationName
| Name of the application that is associated with the publication or subscription.
|
topicName
| Name of the topic that is associated with the publication or subscription.
|
pubSubName
| Name of the publication or subscription.
|
createTime
| The time when
Cloud Integration Hub created the publication or subscription event.
|
completionTime
| The time when the publication or subscription event ended.
|
eventStatus
| The status of the publication or subscription event.
|
parentEventId
| Creates a child event based on a profile ID and returns the event ID of the child event.
|
descendantState
| The cumulative status of all the child events.
|
childEvents
| The events available within the parent event.
Applies to publication events.
|
eventHistory
| The details of the complete event process. The following syntax appears in the eventHistory response:
{
"eventId": "Long",
"timeStamp": "Date",
"eventStatusName": "String",
"comments": "String"
}
|
sourceSuccessCount
| The number of source rows or files that
Cloud Integration Hub read successfully.
|
sourceFailedCount
| The number of source rows or files that
Cloud Integration Hub failed to read.
|
targetSuccessCount
| The number of target rows or files that
Cloud Integration Hub wrote successfully.
|
targetFailedCount
| The number of target rows or files that
Cloud Integration Hub failed to write.
|
Response codes
When you use the
Cloud Integration Hub
Events API to get the details of an existing event,
Cloud Integration Hub
returns the response code of the action that you perform in the API response.
The API can return the following response codes:
200
| SUCCESS. The request succeeded.
|
429
| TOO_MANY_REQUESTS. The number of failed requests exceeded the allowed limit for your organization.
|
[
{
"eventId": 2179004,
"createTime": "2022-10-06T05:56:43.223Z",
"completionTime": "2022-10-06T05:56:54.213Z",
"eventType": "PUBLICATION",
"eventStatus": "Complete",
"descendantState": "FINAL",
"applicationName": "API_App",
"pubSubName": "APIPUB",
"topicName": "APIT",
"sourceSuccessCount": 1,
"sourceFailedCount": 0,
"targetSuccessCount": 1,
"targetFailedCount": 0,
"childEvents": [
{
"eventId": 2184003,
"createTime": "2022-10-06T06:02:35.018Z",
"completionTime": "2022-10-06T06:02:40.442Z",
"parentEventId": 2179004,
"eventType": "SUBSCRIPTION",
"eventStatus": "Complete",
"descendantState": "NONE",
"applicationName": "API_App",
"pubSubName": "APISUB",
"topicName": "APIT",
"sourceSuccessCount": 1,
"sourceFailedCount": 0,
"targetSuccessCount": 1,
"targetFailedCount": 0,
"eventHistory": [
{
"eventId": 2184003,
"timeStamp": "2022-10-06T06:02:35.036Z",
"eventStatusName": "Processing",
"comments": ""
},
{
"eventId": 2184003,
"timeStamp": "2022-10-06T06:02:40.442Z",
"eventStatusName": "Complete",
"comments": "Subscription to topic completed successfully"
}
]
},
{
"eventId": 2183690,
"createTime": "2022-10-06T05:56:54.243Z",
"completionTime": "2022-10-06T05:57:06.678Z",
"parentEventId": 2179004,
"eventType": "SUBSCRIPTION",
"eventStatus": "Reprocessed",
"descendantState": "NONE",
"applicationName": "API_App",
"pubSubName": "APISUB",
"topicName": "APIT",
"sourceSuccessCount": 1,
"sourceFailedCount": 0,
"targetSuccessCount": 1,
"targetFailedCount": 0,
"eventHistory": [
{
"eventId": 2183690,
"timeStamp": "2022-10-06T05:56:54.244Z",
"eventStatusName": "Processing",
"comments": ""
},
{
"eventId": 2183690,
"timeStamp": "2022-10-06T05:56:54.276Z",
"eventStatusName": "Delayed",
"comments": "Delayed"
},
{
"eventId": 2183690,
"timeStamp": "2022-10-06T05:56:55.768Z",
"eventStatusName": "Processing",
"comments": "This event is a part of a manually-processed event hierarchy."
},
{
"eventId": 2183690,
"timeStamp": "2022-10-06T05:57:06.678Z",
"eventStatusName": "Complete",
"comments": "Subscription to topic completed successfully"
},
{
"eventId": 2183690,
"timeStamp": "2022-10-06T06:02:35.001Z",
"eventStatusName": "Reprocessed",
"comments": "This event is a part of a manually-processed event hierarchy."
}
]
}
],
"eventHistory": [
{
"eventId": 2179004,
"timeStamp": "2022-10-06T05:56:43.230Z",
"eventStatusName": "Processing",
"comments": ""
},
{
"eventId": 2179004,
"timeStamp": "2022-10-06T05:56:54.213Z",
"eventStatusName": "Complete",
"comments": "Publishing to topic completed successfully"
}
]
},
{
"eventId": 2179003,
"createTime": "2022-10-06T05:55:29.583Z",
"completionTime": "2022-10-06T05:55:40.412Z",
"eventType": "PUBLICATION",
"eventStatus": "Complete",
"descendantState": "NONE",
"applicationName": "API_App",
"pubSubName": "APIPUB",
"topicName": "APIT",
"sourceSuccessCount": 1,
"sourceFailedCount": 0,
"targetSuccessCount": 1,
"targetFailedCount": 0,
"eventHistory": [
{
"eventId": 2179003,
"timeStamp": "2022-10-06T05:55:29.589Z",
"eventStatusName": "Processing",
"comments": ""
},
{
"eventId": 2179003,
"timeStamp": "2022-10-06T05:55:40.412Z",
"eventStatusName": "Complete",
"comments": "Publishing to topic completed successfully"
}
]
}
]
