Get a list of ingestions

1 min

GET

https://provisioning.rs.int.{environment}.korfinancial.com/ingestions

Query a list of ingestions

Query Parameters

entityIdstring<uuid>
Example
EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
Description
Your KOR entity identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
cursorstring
Description
The cursor to get the next page, empty returns the first page
pageSizeinteger
Description
Max amount of results that should be returned
scrollboolean
Description
A flag to define you intent to scroll through your results
querystring
Example
```
{
  "p": [
    "field"
  ],
  "cf": "eq",
  "v": [
    "value1",
    "value2"
  ]
}
```
Description
URL encoded JSON string containing the search query with various filter options. JSON Structure The following JSON snippet can be passed in through an HTTP query parameter URL encoded: {"lf": "and", "q": [{"p": ["field"], "cf": "eq", "v": ["value"]}]} Possible "cf" Values The "cf" field can have the following values based on data types: Integers: 'neq' (Not Equals) 'eq' (Equals) 'gt' (Greater Than) 'gte' (Greater Than or Equals) 'lt' (Less Than) 'lte' (Less Than or Equals) String: 'neq' (Not Equals) 'eq' (Equals) 'ct' (Contains) Dates: Represented as a unix timestamp as long 'neq' (Not Equals) 'eq' (Equals) 'gt' (Greater Than) 'gte' (Greater Than or Equals) 'lt' (Less Than) 'lte' (Less Than or Equals) Boolean: Represented as the strings true or false 'neq' (Not Equals) 'eq' (Equals) Supported fields and their corresponding types: client: text status: text timestamp: date processedTimestamp: date uploadedTimestamp: date identifier: text processedSubmissions: integer failedSubmissions: integer contentType: text type: text deliveryMechanism: text fileName: text actor: text datafeedIdentifier: text

Responses

200Ingestions page retrieved

IngestionsSearchResult
Description
The search result with a cursor, indicating whether there are more items and the returned (subset of) ingestions
- cursorstring
  Description
  Cursor for the current search request
- hasMoreboolean
  Description
  Indicating whether there are more items that can be retrieved
- itemsobject[]
  Description
  The list of items

400Bad Request

401Unauthorized

403Forbidden

404Not Found

405Method Not Allowed

406Not Acceptable

415Unsupported Media Type

500Internal Server Error

504Gateway Timeout

defaultInternal Server Error

curl

curl --request GET \
     --url https://provisioning.rs.int.{environment}.korfinancial.com/ingestions \
     --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", 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")

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"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Ingestions page retrieved
{
  "cursor": "",
  "hasMore": false,
  "items": [
    {}
  ]
}

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