Create a data feed

1 min

POST

https://provisioning.rs.int.{environment}.korfinancial.com/clients/{entityIdentifier}/data-feeds

Create a data feed

Path Parameters

entityIdentifierstring<uuid>required
Example
3AE803B1-5765-481D-BFAB-D176679D7D8C
Description
Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.

Body Parameters

bodyDataFeedCreateRequest
Description
Model for creating data feed
- objectDataFeedInput
  - namestringrequired
    Example
    Daily file
    Description
    The name of the data feed
  - sourceSystemstringrequired
    Example
    XYZ
    Description
    The source system of the data feed. This is typically the name of the system that is sending the data feed.
  - feedTypeFeedTyperequired
    Description
    The feed type of data feed
    x-extensible-enum: - TRADE_LEVEL - PORTFOLIO_LEVEL - ENTITY - PRODUCT - REFERENCE_DATA - RELATIONSHIP - POSITION_LEVEL
  - utiEnrichmentTypeUtiEnrichmentType
    Description
    The type of UTI_ENRICHMENT data feed type
    x-extensible-enum: - STANDARD - CUSTOM
  - statusDataFeedStatusrequired
    Description
    Whether the data feed is active or not
    x-extensible-enum: - ACTIVE - INACTIVE - ARCHIVED
  - contentTypeDataFeedContentType
    Description
    Content type of the data feed. When present, restricts the type of datafeed. ANY option supports all available contents, but by default restricts the XML format to ISO
    x-extensible-enum: - ANY - JSON - CSV - XML
  - contentFormatDataFeedContentFormat
    Description
    Content format of the datafeed. When present, restricts the content format of the datafeed. This field is valid only if content type (DataFeedContentType) is XML. It should be null otherwise.
    x-extensible-enum: - ISO - FPML - REMIT
  - deliveryMechanismsDeliveryMechanism[]
    Description
    The delivery mechanism that upload was ingested
    x-extensible-enum: - API - UI - KOR_SFTP - CLIENT_SFTP - KOR_KAFKA
  - ruleSetIdentifierstring<uuid>required
    Example
    EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
    Description
    The identifier of the rule set that contains the rules that should be used to translate the data feed ingestions
  - supplementalDatabooleanrequired
  - joinKeystring
    Description
    The CSV column or JSON property that should be used to join the different types of feed data
  - filtersDataFeedFilter[]
    Description
    Filter for data feed
    - filterTypeFilterType
      Description
      The feed type of data feed
      x-extensible-enum: - SUBMISSIONS - SUPPLEMENTAL
    - keystring
      Description
      The CSV column or JSON property that should be used to filter the data feed
    - valuestring
      Description
      The value that should be used to filter the data feed

Responses

202Data Feed has been accepted

object
- identifierstring<uuid>
  Example
  EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB

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 POST \
     --url https://provisioning.rs.int.{environment}.korfinancial.com/clients/{entityIdentifier}/data-feeds \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "name": "Daily file",
     "sourceSystem": "XYZ",
     "feedType": "",
     "status": "",
     "ruleSetIdentifier": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB",
     "supplementalData": ""
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "name": "Daily file",
   "sourceSystem": "XYZ",
   "feedType": "",
   "status": "",
   "ruleSetIdentifier": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB",
   "supplementalData": ""
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://provisioning.rs.int.{environment}.korfinancial.com/clients/{entityIdentifier}/data-feeds", 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/clients/{entityIdentifier}/data-feeds")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "name": "Daily file",
   "sourceSystem": "XYZ",
   "feedType": "",
   "status": "",
   "ruleSetIdentifier": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB",
   "supplementalData": ""
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://provisioning.rs.int.{environment}.korfinancial.com/clients/{entityIdentifier}/data-feeds"

payload = json.dumps({
   "name": "Daily file",
   "sourceSystem": "XYZ",
   "feedType": "",
   "status": "",
   "ruleSetIdentifier": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB",
   "supplementalData": ""
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

202

// Data Feed has been accepted
{
  "identifier": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB"
}

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