Update a rule

1 min

PUT

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

Update a new rule

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.
ruleIdstring<uuid>required
Example
EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
Description
The identifier of the rule

Body Parameters

bodyRuleUpdateRequest
Description
Model for rule update
- namestring
  Example
  My assetClass rule
  Description
  The name assigned to the rule
- notestringrequired
  Example
  Updated to also cover the ESMA mandate
  Description
  The note that documents the purpose of the rule and the changes that happened to it
- ruleSetsstring[]
  Description
  The rule sets that this rule is part of
- functionsFunction[]required
  Description
  The function definitions that will apply to the KDM field
  - 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
  Example
```
{
  "connections": [
    {
      "id": "4568e6983fef85d9",
      "source": "2d7bc70c10f8db77",
      "sourceOutput": "outputKDMField",
      "target": "d75cd0beba2bf8b0",
      "targetInput": "upperFuncInput_argument0"
    },
    {
      "id": "660c0766dc3599aa",
      "source": "d75cd0beba2bf8b0",
      "sourceOutput": "upperFuncOutput",
      "target": "e25c88e883e204a6",
      "targetInput": "mandateInput"
    }
  ],
  "targetKDMField": {
    "id": "2d7bc70c10f8db77",
    "value": {
      "x": -133.265625,
      "y": -38.0546875
    }
  }
}
```
  Description
  Overview of a rule metadata
- statusRuleStatus
  Example
  ACTIVE
  Description
  The status of the rule
  x-extensible-enum: - ACTIVE - INACTIVE - ARCHIVED

Responses

202Rule update has been accepted

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 PUT \
     --url https://provisioning.rs.int.{environment}.korfinancial.com/clients/{entityIdentifier}/rules/{ruleId} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "note": "Updated to also cover the ESMA mandate",
     "functions": [
     {}
     ]
     }'

javascript

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

var raw = JSON.stringify({
   "note": "Updated to also cover the ESMA mandate",
   "functions": [
      {}
   ]
});

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

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

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

request = Net::HTTP::Put.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "note": "Updated to also cover the ESMA mandate",
   "functions": [
      {}
   ]
})

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

python

import requests
import json

url = "https://provisioning.rs.int.{environment}.korfinancial.com/clients/{entityIdentifier}/rules/{ruleId}"

payload = json.dumps({
   "note": "Updated to also cover the ESMA mandate",
   "functions": [
      {}
   ]
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

202

// Rule update has been accepted

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