Get the details of an ingestion
1 min
GET
https://provisioning.rs.int.{environment}.korfinancial.com/ingestions/{ingestionIdentifier}
Path Parameters
- ingestionIdentifierstring<uuid>requiredExampleDescription
Query Parameters
- entityIdIngestionDetailsDescription
- objectSingleEntryDetails
- entryPayloadstringDescription
- objectUpload
- identifierstring<uuid>Example
- dataFeedIdentifierstring<uuid>Example
- startedTimestampstring<date-time>ExampleDescription
- ingestedTimestampstring<date-time>ExampleDescription
- clientstring<uuid>Example
- actorstring<uuid>Example
- failureReasonstringExample
- permissionsUploadPermissionsDescription
- canReprocessbooleanExampleDescription
- canIgnorebooleanExampleDescription
- typeIngestionTyperequiredDescription
- statusUploadStatusDescription
- fileNamestringExample
- contentTypeIngestionContentTypeDescription
- deliveryMechanismDeliveryMechanismDescription
- ignoredTimestampstring<date-time>ExampleDescription
- detectedSubmissionsintegerDescription
- identifiedSubmissionsintegerDescription
- identificationFailedSubmissionsintegerDescription
- objectReprocessDetails
- failuresobject[]Description
- submissionIdentifierstring<uuid>Example
- regulatoryMessageIdentifierstring<uuid>Example
- failureReasonstringExample
- objectReprocessedUploadDetails
- identifierstring<uuid>Example
- dataFeedIdentifierstring<uuid>Example
- startedTimestampstring<date-time>ExampleDescription
- ingestedTimestampstring<date-time>ExampleDescription
- clientstring<uuid>Example
- actorstring<uuid>Example
- failureReasonstringExample
- permissionsUploadPermissionsDescription
- canReprocessbooleanExampleDescription
- canIgnorebooleanExampleDescription
- typeIngestionTyperequiredDescription
- statusUploadStatusDescription
- contentTypeIngestionContentTypeDescription
- deliveryMechanismDeliveryMechanismDescription
- ignoredTimestampstring<date-time>ExampleDescription
- detectedSubmissionsintegerDescription
- identifiedSubmissionsintegerDescription
- identificationFailedSubmissionsintegerDescription
- dataFeedIdentifierstring<uuid>Example
- uploadIdentifierToReprocessstring<uuid>Example
- rowNumbersinteger[]
Responses
200
- IngestionDetailsDescription
- objectSingleEntryDetails
- entryPayloadstringDescription
- objectUpload
- identifierstring<uuid>Example
- dataFeedIdentifierstring<uuid>Example
- startedTimestampstring<date-time>ExampleDescription
- ingestedTimestampstring<date-time>ExampleDescription
- clientstring<uuid>Example
- actorstring<uuid>Example
- failureReasonstringExample
- permissionsUploadPermissionsDescription
- canReprocessbooleanExampleDescription
- canIgnorebooleanExampleDescription
- typeIngestionTyperequiredDescription
- statusUploadStatusDescription
- fileNamestringExample
- contentTypeIngestionContentTypeDescription
- deliveryMechanismDeliveryMechanismDescription
- ignoredTimestampstring<date-time>ExampleDescription
- detectedSubmissionsintegerDescription
- identifiedSubmissionsintegerDescription
- identificationFailedSubmissionsintegerDescription
- objectReprocessDetails
- failuresobject[]Description
- submissionIdentifierstring<uuid>Example
- regulatoryMessageIdentifierstring<uuid>Example
- failureReasonstringExample
- objectReprocessedUploadDetails
- identifierstring<uuid>Example
- dataFeedIdentifierstring<uuid>Example
- startedTimestampstring<date-time>ExampleDescription
- ingestedTimestampstring<date-time>ExampleDescription
- clientstring<uuid>Example
- actorstring<uuid>Example
- failureReasonstringExample
- permissionsUploadPermissionsDescription
- canReprocessbooleanExampleDescription
- canIgnorebooleanExampleDescription
- typeIngestionTyperequiredDescription
- statusUploadStatusDescription
- contentTypeIngestionContentTypeDescription
- deliveryMechanismDeliveryMechanismDescription
- ignoredTimestampstring<date-time>ExampleDescription
- detectedSubmissionsintegerDescription
- identifiedSubmissionsintegerDescription
- identificationFailedSubmissionsintegerDescription
- dataFeedIdentifierstring<uuid>Example
- uploadIdentifierToReprocessstring<uuid>Example
- rowNumbersinteger[]
400
401
403
404
405
406
415
500
504
default
curl
curl --request GET \
--url 'https://provisioning.rs.int.{environment}.korfinancial.com/ingestions/{ingestionIdentifier}?entityId={%22permissions%22%3A{}%2C%22type%22%3A%22string%22%2C%22failures%22%3A[{}]}' \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://provisioning.rs.int.{environment}.korfinancial.com/ingestions/{ingestionIdentifier}?entityId={\"permissions\":{},\"type\":\"string\",\"failures\":[{}]}", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://provisioning.rs.int.{environment}.korfinancial.com/ingestions/{ingestionIdentifier}?entityId={\"permissions\":{},\"type\":\"string\",\"failures\":[{}]}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://provisioning.rs.int.{environment}.korfinancial.com/ingestions/{ingestionIdentifier}?entityId={\"permissions\":{},\"type\":\"string\",\"failures\":[{}]}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// The ingestion details
{
"entryPayload": "",
"identifier": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB",
"dataFeedIdentifier": "85DA13C0-6288-11EE-AE5D-0800200C9A66",
"startedTimestamp": "2020-05-28T14:07:17Z",
"ingestedTimestamp": "2020-05-28T14:07:17Z",
"client": "31F5D854-2358-4E90-9348-38C803118F8F",
"actor": "8F90F460-6288-11EE-AE5D-0800200C9A66",
"failureReason": "When status is failed provides the reason of failure",
"permissions": {
"canReprocess": true,
"canIgnore": true
},
"type": "",
"status": "",
"fileName": "filename.json",
"contentType": "",
"deliveryMechanism": "",
"ignoredTimestamp": "2020-05-28T14:07:17Z",
"detectedSubmissions": 0,
"identifiedSubmissions": 0,
"identificationFailedSubmissions": 0,
"failures": [
{
"submissionIdentifier": "2F12F644-7B9A-422C-838A-6A56FC4C4E22",
"regulatoryMessageIdentifier": "A1C63F49-9561-4EDB-A224-4B12E125E3AF",
"failureReason": "The submission was not found in cold storage"
}
],
"uploadIdentifierToReprocess": "85DA13C0-6288-11EE-AE5D-0800200C9A66",
"rowNumbers": [
0
]
}400
// Bad Request
401
// Unauthorized
403
// Forbidden
404
// Not Found
405
// Method Not Allowed
406
// Not Acceptable
415
// Unsupported Media Type
500
// Internal Server Error
504
// Gateway Timeout
default
// Internal Server Error