Get the details of the resultant instances of an event
get
/mftapp/rest/v1/events/{eventSessionId}/instances
Retrieves details about the instances created by an event. Requires submitting an eventSessionId as a path parameter. Submit with query parameter inDetail=true for response to contain complete details of the resultant instances; submit without query parameter for response to contain minimal details.
The following tables summarize the client request.
Query Parameters
Name | Description | Format |
---|---|---|
inDetail | Return complete details of of the resultant instances of an event. | boolean |
The following tables summarize the server response.
Supported Media Types
- application/json
- description
200 Response
Body
404 Response
Body
Example of Response Body: 200 Response: Minimal Instance Details of an Event
The following example shows the contents of the response body for a successful request in JSON format when the inDetail=true query parameter is not submitted:
{ "eventSessionId": "ss212020-2139021-122", "totalInstances": 1, "sourceName": "src1", "sourceType": "SFTP", "endpointReference": "srrha1", "submittedBy": "user1", "instances": [ { "filename": "file1", "status": [ { "status": "COMPLETED", "subStatus": "SUCCESSFUL" } ] } ] }
Example of Response Body: 200 Response: Complete Instance Details of an Event
The following example shows the contents of the response body for a successful request in JSON format when the inDetail=true query parameter is submitted:
{ "eventSessionId": "ss212020-2139021-122", "totalInstances": 1, "sourceName": "src1", "sourceType": "SFTP", "endpointReference": "srrha1", "submittedBy": "user1", "instances": [ { "filename": "file1", "status": [ { "status": "COMPLETED", "subStatus": "SUCCESSFUL" } ], "details": [ { "statusDetail": "Successful 1,Errored 0,InPogress 0", "bytesReceived": "28", "receivedTime": "2014-09-30 20:26:36.855", "sourceURL": "http://host:port/mftconsole/faces/report?type=source=0000KZ742Fr1VcHpMs5Eie1KAg5t00000U", "priority": "MEDIUM", "targets": [ { "targetName": "file_tgt2", "status": "COMPLETED", "deliveredFileName": "test1.txt", "bytesTransferred": "28", "completionTime": "2014-09-30 20:26:38.414" } ] } ] } ] }
Example of Response Body: 404 Response
The following example shows the contents of the response body for an successful request in JSON format:
{ "errorCode":"MFT-5436" "errorKey":"MFT_WS_EVENT_SERVICE_NO_EVENT_FOUND" "errorMessage":"Error in processing EventService request. No Event found with provided Event Session Id {id}." }