Get the details of a rule set

1 min

GET

https://provisioning.rs.int.{environment}.korfinancial.com/rule-sets/{ruleSetIdentifier}

Get the details of a rule set by identifier

Path Parameters

ruleSetIdentifierstring<uuid>required
Example
EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
Description
The identifier of the rule set

Query Parameters

entityIdstring<uuid>
Example
EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
Description
Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.

Responses

200Rule Set retrieved

object
- object
- objectRuleSetDetail
  - identifierstring<uuid>
    Example
    EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
  - namestring
    Example
    Rule set name
  - typestring
    Description
    The feed type of data feed
    x-extensible-enum: - TRADE_LEVEL - PORTFOLIO_LEVEL - ENTITY - PRODUCT - REFERENCE_DATA - RELATIONSHIP - POSITION_LEVEL
  - requiresApprovalboolean
    Description
    Indicates approval requirements for the rules in that rule set
  - purposesRuleSetPurpose[]
    - targetstring
      Description
      The target for the rule set fields
      x-extensible-enum: - KOR - DTCC
    - mandatesstring[]
  - approvalStrategystring
    Description
    The approval strategy that will be executed for this rule set
    x-extensible-enum: - REQUIRES_ALL_APPROVALS - NO_APPROVAL_REQUIRED
  - fieldsRuleSetField[]
    - namestring
    - tagstring
    - statusstring
      Description
      The status of the field approval
      x-extensible-enum: - TO_DO - PENDING - PARTIALLY_APPROVED - APPROVED
    - implementationstring
      Description
      The implementation type of the field
      x-extensible-enum: - IGNORE - RULE - DIRECT_MAPPING
    - changeRequestedBystring
      Example
      actor1
    - approvalsRuleSetFieldApproval[]
      - targetstring
      - jurisdictionstring
      - statusstring
        Description
        The status of the approval
        x-extensible-enum: - PENDING - APPROVED
      - approvedTimestampstring<date-time>
        Example
        2020-05-28T14:07:17Z
      - approvedBystring
        Example
        actor
    - appliesOnmap<string, string[]>
      Example
      { "ESMA": [ "Transaction", "Valuation" ], "CFTC": [ "Valuation" ], "CA": [ "Collateral" ] }
    - activeRuleobject
      - identifierstring
      - versionstring
    - requiredApprovalsobject
      - typestring
    - notesstring
    - categorystring
    - groupsstring[]
    - typestring
  - lastModifiedTimestampstring<date-time>
    Example
    2020-05-28T14:07:17Z
    Description
    Timestamp when the rule set was modified
  - createdTimestampstring<date-time>
    Example
    2020-05-28T14:07:17Z
    Description
    Timestamp when the rule set was created
  - permissionsPermissions
    Description
    Experimental. The permissions the user has on a resource.
    - canEditboolean
      Example
      true
      Description
      Experimental. Whether a user can edit the resource.
    - canDeleteboolean
      Example
      true
      Description
      Experimental. Whether a user can delete the resource.

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/rule-sets/{ruleSetIdentifier} \
     --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/rule-sets/{ruleSetIdentifier}", 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/rule-sets/{ruleSetIdentifier}")

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/rule-sets/{ruleSetIdentifier}"

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

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

print(response.text)

200

// Rule Set retrieved
{
  "identifier": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB",
  "name": "Rule set name",
  "type": "",
  "requiresApproval": false,
  "purposes": [
    {
      "target": "",
      "mandates": [
        ""
      ]
    }
  ],
  "approvalStrategy": "",
  "fields": [
    {
      "name": "",
      "tag": "",
      "status": "",
      "implementation": "",
      "changeRequestedBy": "actor1",
      "approvals": [
        {
          "target": "",
          "jurisdiction": "",
          "status": "",
          "approvedTimestamp": "2020-05-28T14:07:17Z",
          "approvedBy": "actor"
        }
      ],
      "appliesOn": "{\"ESMA\":[\"Transaction\",\"Valuation\"],\"CFTC\":[\"Valuation\"],\"CA\":[\"Collateral\"]}",
      "activeRule": {
        "identifier": "",
        "version": ""
      },
      "requiredApprovals": {
        "type": ""
      },
      "notes": "",
      "category": "",
      "groups": [
        ""
      ],
      "type": ""
    }
  ],
  "lastModifiedTimestamp": "2020-05-28T14:07:17Z",
  "createdTimestamp": "2020-05-28T14:07:17Z",
  "permissions": {
    "canEdit": true,
    "canDelete": true
  }
}

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