Get the details of a rule

1 min

GET

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

Get the details of a rule by identifier

Path Parameters

ruleIdstring<uuid>required
Example
EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
Description
The rule identifier

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

200Rules page retrieved

Rule
Description
Model for rule
- identifierstring<uuid>
  Example
  EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
  Description
  The identifier of the rule
- targetKDMFieldNamestring
  Example
  assetClass
  Description
  The target KDM field name of the rule
- kdmFieldTypestring
  Example
  HUB
  Description
  The KDM field type of the rule
  x-extensible-enum: - HUB - ENTITY - RELATIONSHIP - PRODUCT - VALUE_MAPPING
- namestring
  Example
  My assetClass rule
  Description
  The name assigned to the rule
- notestring
  Example
  Lorem ipsum
  Description
  The note containing information and context about the rule
- ruleSetsstring[]
  Description
  The rule sets that this rule is part of
- functionsFunction[]
  Description
  The function definitions that will apply to the KDM field. This field gets left out when querying a list of rules unless details inclusion was requested.
  - argumentReferenceIdentifierstring
    Example
    EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
    Description
    The identifier of the function that will be used to generate the argument value. If null, the function will be treated as a head.
  - categorystring
    Example
    HUB
    Description
    The category of the function
    x-extensible-enum: - HUB - PURPOSE - REG - ENTITY - PRODUCT - RELATIONSHIP - VALUE_MAPPING
  - tagstring
    Example
    [ "sourceField", "upperCase", "mandate" ]
    Description
    The tag of the function
  - functionMetadatastring
    Example
    { "id": "5c7bf808ac0c507e", "value": { "x": -105.2109375, "y": -84.43359375 } }
    Description
    The metadata of the function. Referenced in the user field configuration metadata.
  - argumentsFunctionArgument[]
    Description
    A dynamic list of arguments by name and type
    - typestring
      Example
      STRING
      Description
      The type of the function argument
      x-extensible-enum: - STRING - NUMBER - ARRAY - MAP - FUNCTION - BOOLEAN - KDMFIELD - SOURCEFIELD
    - namestring
      Example
      [ "function", "argument0", "actionType" ]
      Description
      The name of the function argument
    - valueAnyValue
      Description
      Can be anything: string, number, array, object, etc., including `null`
- ruleMetadatastring
  Description
  Overview of the rule metadata. This field gets left out when querying a list of rules unless details inclusion was requested.
- createdTimestampstring<date-time>
  Example
  2020-05-28T14:07:17Z
  Description
  Timestamp when the rule was created
- lastModifiedTimestampstring<date-time>
  Example
  2020-05-28T14:07:17Z
  Description
  Timestamp when the rule was modified
- deletedTimestampstring<date-time>
  Example
  2020-05-28T14:07:17Z
  Description
  Timestamp when the rule was deleted
- 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.
- versionstring
  Example
  3
  Description
  The version of a rule
- statusRuleStatus
  Example
  ACTIVE
  Description
  The status of the rule
  x-extensible-enum: - ACTIVE - INACTIVE - ARCHIVED
- functionalVersionstring
  Example
  d41d8cd98f003204a9800998ecf8427e
  Description
  The functional version hash of a rule

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/rules/{ruleId} \
     --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/rules/{ruleId}", 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/rules/{ruleId}")

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/rules/{ruleId}"

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

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

print(response.text)

200

// Rules page retrieved
{
  "identifier": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB",
  "targetKDMFieldName": "assetClass",
  "kdmFieldType": "HUB",
  "name": "My assetClass rule",
  "note": "Lorem ipsum",
  "ruleSets": [
    ""
  ],
  "functions": [
    {
      "argumentReferenceIdentifier": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB",
      "category": "HUB",
      "tag": "[\"sourceField\",\"upperCase\",\"mandate\"]",
      "functionMetadata": "{\"id\":\"5c7bf808ac0c507e\",\"value\":{\"x\":-105.2109375,\"y\":-84.43359375}}",
      "arguments": [
        {
          "type": "STRING",
          "name": "[\"function\",\"argument0\",\"actionType\"]",
          "value": {}
        }
      ]
    }
  ],
  "ruleMetadata": "",
  "createdTimestamp": "2020-05-28T14:07:17Z",
  "lastModifiedTimestamp": "2020-05-28T14:07:17Z",
  "deletedTimestamp": "2020-05-28T14:07:17Z",
  "permissions": {
    "canEdit": true,
    "canDelete": true
  },
  "version": "3",
  "status": "ACTIVE",
  "functionalVersion": "d41d8cd98f003204a9800998ecf8427e"
}

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