Synchronize the rules

1 min

PUT

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

Synchronize a number of rules from another environment. Optionally copying them over to a different rule set.

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

bodySynchronizeRulesRequest
Description
The synchronize rules request containing one or more rules to synchronize
- rulesRuleSyncInfo[]
  Description
  The rule synchronization information
  - 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
  - notestring
    Example
    Lorem ipsum
    Description
    The note containing information and context about the rule
  - ruleSetsRuleSetSyncInfo[]
    Description
    The rule sets that this rule is part of
    - identifierstring
      Example
      EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      Description
      The identifier of an exiting or to be created rule set
    - namestring
      Example
      My rule set
      Description
      The name of the rule set
    - typestring
    - approvalStrategystring
      Description
      The approval strategy that will be executed for this rule set
      x-extensible-enum: - REQUIRES_ALL_APPROVALS - NO_APPROVAL_REQUIRED
    - purposesRuleSetPurpose[]
      - targetstring
        Description
        The target for the rule set fields
        x-extensible-enum: - KOR - DTCC
      - mandatesstring[]
  - namestring
    Example
    My assetClass rule
    Description
    The name assigned to the rule
  - functionsFunction[]
    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
    Description
    Overview of the rule metadata
  - statusRuleStatus
    Example
    ACTIVE
    Description
    The status of the rule
    x-extensible-enum: - ACTIVE - INACTIVE - ARCHIVED
- optionsSynchronizeRuleOptions
  - setAsNewActiveVersionboolean
    Example
    true
    Description
    When true, replace the currently active rule in the rule set(s)
  - copyToRuleSetstring<uuid>
    Example
    EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
    Description
    The existing rule set to which a copy of the rules should be added

Responses

202The rules synchronization request has been accepted for processing.

SynchronizeRulesResponse
Description
The synchronize rules response
- rulesRuleSynchronizationResult[]
  Description
  The rule synchronization result
  - ruleIdentifierstring<uuid>
    Example
    EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
    Description
    The identifier of the rule
  - commentstring
    Example
    Version updated from 1 to 2
    Description
    Information on the synchronization result

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/synchronizations \
     --header 'accept: application/json'

javascript

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

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

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

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"

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

python

import requests
import json

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

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

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

print(response.text)

202

// The rules synchronization request has been accepted for processing.
{
  "rules": [
    {
      "ruleIdentifier": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB",
      "comment": "Version updated from 1 to 2"
    }
  ]
}

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