--- title: Get the details of a rule set slug: import-test-pdf/0SMx-get-the-details-of-a-rule-set createdAt: 2025-10-27T13:00:23.928Z --- { "id": "jxK1L7RWCQ_Q7hsxQPE38", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://provisioning.rs.int.{environment}.korfinancial.com/rule-sets/{ruleSetIdentifier}", "servers": [ { "url": "https://provisioning.rs.int.{environment}.korfinancial.com/rule-sets/{ruleSetIdentifier}", "description": "RS Provisioning Integration API" }, { "url": "https://provisioning.rs.{environment}.korfinancial.com/rule-sets/{ruleSetIdentifier}", "description": "RS Provisioning Production API" } ], "name": "Get the details of a rule set", "description": "Get the details of a rule set by identifier", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "ruleSetIdentifier", "type": "string", "example": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB", "description": "The identifier of the rule set" } ], "headerParameters": [], "queryParameters": [ { "kind": "optional", "name": "entityId", "type": "string", "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." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [] }, "responses": [ { "statusCode": "200", "description": "Rule Set retrieved", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "identifier", "kind": "optional", "type": "string", "description": "", "example": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB" }, { "name": "name", "kind": "optional", "type": "string", "description": "", "example": "Rule set name" }, { "name": "type", "kind": "optional", "type": "string", "description": "The feed type of data feed\n
x-extensible-enum: \n - TRADE_LEVEL\n - PORTFOLIO_LEVEL\n - ENTITY\n - PRODUCT\n - REFERENCE_DATA\n - RELATIONSHIP\n - POSITION_LEVEL\n\n", "example": "" }, { "name": "requiresApproval", "kind": "optional", "type": "boolean", "description": "Indicates approval requirements for the rules in that rule set", "example": "" }, { "name": "purposes", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/RuleSetPurpose", "customType": "RuleSetPurpose[]", "schema": [ { "name": "target", "kind": "optional", "type": "string", "description": "The target for the rule set fields\n
x-extensible-enum: \n - KOR\n - DTCC\n\n", "example": "" }, { "name": "mandates", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "approvalStrategy", "kind": "optional", "type": "string", "description": "\nThe approval strategy that will be executed for this rule set
x-extensible-enum: \n - REQUIRES_ALL_APPROVALS\n - NO_APPROVAL_REQUIRED\n\n", "example": "" }, { "name": "fields", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/RuleSetField", "customType": "RuleSetField[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "tag", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "status", "kind": "optional", "type": "string", "description": "The status of the field approval\n
x-extensible-enum: \n - TO_DO\n - PENDING\n - PARTIALLY_APPROVED\n - APPROVED\n\n", "example": "" }, { "name": "implementation", "kind": "optional", "type": "string", "description": "The implementation type of the field\n
x-extensible-enum: \n - IGNORE\n - RULE\n - DIRECT_MAPPING\n\n", "example": "" }, { "name": "changeRequestedBy", "kind": "optional", "type": "string", "description": "", "example": "actor1" }, { "name": "approvals", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/RuleSetFieldApproval", "customType": "RuleSetFieldApproval[]", "schema": [ { "name": "target", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "jurisdiction", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "status", "kind": "optional", "type": "string", "description": "The status of the approval\n
x-extensible-enum: \n - PENDING\n - APPROVED\n\n", "example": "" }, { "name": "approvedTimestamp", "kind": "optional", "type": "string", "description": "", "example": "2020-05-28T14:07:17Z" }, { "name": "approvedBy", "kind": "optional", "type": "string", "description": "", "example": "actor" } ] }, { "name": "appliesOn", "kind": "optional", "type": "map", "description": "", "example": "{\"ESMA\":[\"Transaction\",\"Valuation\"],\"CFTC\":[\"Valuation\"],\"CA\":[\"Collateral\"]}", "customType": "map", "schema": [] }, { "name": "activeRule", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "identifier", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "version", "kind": "optional", "type": "string", "description": "", "example": "" } ] }, { "name": "requiredApprovals", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "", "example": "" } ] }, { "name": "notes", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "category", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "groups", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "", "example": "" } ] }, { "name": "lastModifiedTimestamp", "kind": "optional", "type": "string", "description": "Timestamp when the rule set was modified", "example": "2020-05-28T14:07:17Z" }, { "name": "createdTimestamp", "kind": "optional", "type": "string", "description": "Timestamp when the rule set was created", "example": "2020-05-28T14:07:17Z" }, { "name": "permissions", "kind": "optional", "type": "object", "description": "Experimental. The permissions the user has on a resource.", "modelRef": "#/components/schemas/Permissions", "customType": "Permissions", "schema": [ { "name": "canEdit", "kind": "optional", "type": "boolean", "description": "Experimental. Whether a user can edit the resource.", "example": true }, { "name": "canDelete", "kind": "optional", "type": "boolean", "description": "Experimental. Whether a user can delete the resource.", "example": true } ] } ], "complexItems": [ { "name": "object", "schema": [] }, { "name": "object", "schema": [ { "name": "identifier", "kind": "optional", "type": "string", "description": "", "example": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB" }, { "name": "name", "kind": "optional", "type": "string", "description": "", "example": "Rule set name" }, { "name": "type", "kind": "optional", "type": "string", "description": "The feed type of data feed\n
x-extensible-enum: \n - TRADE_LEVEL\n - PORTFOLIO_LEVEL\n - ENTITY\n - PRODUCT\n - REFERENCE_DATA\n - RELATIONSHIP\n - POSITION_LEVEL\n\n", "example": "" }, { "name": "requiresApproval", "kind": "optional", "type": "boolean", "description": "Indicates approval requirements for the rules in that rule set", "example": "" }, { "name": "purposes", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/RuleSetPurpose", "customType": "RuleSetPurpose[]", "schema": [ { "name": "target", "kind": "optional", "type": "string", "description": "The target for the rule set fields\n
x-extensible-enum: \n - KOR\n - DTCC\n\n", "example": "" }, { "name": "mandates", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "approvalStrategy", "kind": "optional", "type": "string", "description": "\nThe approval strategy that will be executed for this rule set
x-extensible-enum: \n - REQUIRES_ALL_APPROVALS\n - NO_APPROVAL_REQUIRED\n\n", "example": "" }, { "name": "fields", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/RuleSetField", "customType": "RuleSetField[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "tag", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "status", "kind": "optional", "type": "string", "description": "The status of the field approval\n
x-extensible-enum: \n - TO_DO\n - PENDING\n - PARTIALLY_APPROVED\n - APPROVED\n\n", "example": "" }, { "name": "implementation", "kind": "optional", "type": "string", "description": "The implementation type of the field\n
x-extensible-enum: \n - IGNORE\n - RULE\n - DIRECT_MAPPING\n\n", "example": "" }, { "name": "changeRequestedBy", "kind": "optional", "type": "string", "description": "", "example": "actor1" }, { "name": "approvals", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/RuleSetFieldApproval", "customType": "RuleSetFieldApproval[]", "schema": [ { "name": "target", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "jurisdiction", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "status", "kind": "optional", "type": "string", "description": "The status of the approval\n
x-extensible-enum: \n - PENDING\n - APPROVED\n\n", "example": "" }, { "name": "approvedTimestamp", "kind": "optional", "type": "string", "description": "", "example": "2020-05-28T14:07:17Z" }, { "name": "approvedBy", "kind": "optional", "type": "string", "description": "", "example": "actor" } ] }, { "name": "appliesOn", "kind": "optional", "type": "map", "description": "", "example": "{\"ESMA\":[\"Transaction\",\"Valuation\"],\"CFTC\":[\"Valuation\"],\"CA\":[\"Collateral\"]}", "customType": "map", "schema": [] }, { "name": "activeRule", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "identifier", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "version", "kind": "optional", "type": "string", "description": "", "example": "" } ] }, { "name": "requiredApprovals", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "", "example": "" } ] }, { "name": "notes", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "category", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "groups", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "", "example": "" } ] }, { "name": "lastModifiedTimestamp", "kind": "optional", "type": "string", "description": "Timestamp when the rule set was modified", "example": "2020-05-28T14:07:17Z" }, { "name": "createdTimestamp", "kind": "optional", "type": "string", "description": "Timestamp when the rule set was created", "example": "2020-05-28T14:07:17Z" }, { "name": "permissions", "kind": "optional", "type": "object", "description": "Experimental. The permissions the user has on a resource.", "modelRef": "#/components/schemas/Permissions", "customType": "Permissions", "schema": [ { "name": "canEdit", "kind": "optional", "type": "boolean", "description": "Experimental. Whether a user can edit the resource.", "example": true }, { "name": "canDelete", "kind": "optional", "type": "boolean", "description": "Experimental. Whether a user can delete the resource.", "example": true } ] } ], "modelRef": "#/components/schemas/RuleSetDetail", "customType": "RuleSetDetail" } ], "complexType": "allOf", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Not Found", "jsonExample": "", "isExpanded": true }, { "statusCode": "405", "description": "Method Not Allowed", "jsonExample": "", "isExpanded": true }, { "statusCode": "406", "description": "Not Acceptable", "jsonExample": "", "isExpanded": true }, { "statusCode": "415", "description": "Unsupported Media Type", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "Internal Server Error", "jsonExample": "", "isExpanded": true }, { "statusCode": "504", "description": "Gateway Timeout", "jsonExample": "", "isExpanded": true }, { "statusCode": "default", "description": "Internal Server Error", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "example-0-curl", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://provisioning.rs.int.{environment}.korfinancial.com/rule-sets/{ruleSetIdentifier} \\\n --header 'accept: application/json'" }, { "id": "example-1-javascript", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://provisioning.rs.int.{environment}.korfinancial.com/rule-sets/{ruleSetIdentifier}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "example-2-ruby", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://provisioning.rs.int.{environment}.korfinancial.com/rule-sets/{ruleSetIdentifier}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "example-3-python", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://provisioning.rs.int.{environment}.korfinancial.com/rule-sets/{ruleSetIdentifier}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "example-0-curl" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Rule Set retrieved\n{\n \"identifier\": \"EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB\",\n \"name\": \"Rule set name\",\n \"type\": \"\",\n \"requiresApproval\": false,\n \"purposes\": [\n {\n \"target\": \"\",\n \"mandates\": [\n \"\"\n ]\n }\n ],\n \"approvalStrategy\": \"\",\n \"fields\": [\n {\n \"name\": \"\",\n \"tag\": \"\",\n \"status\": \"\",\n \"implementation\": \"\",\n \"changeRequestedBy\": \"actor1\",\n \"approvals\": [\n {\n \"target\": \"\",\n \"jurisdiction\": \"\",\n \"status\": \"\",\n \"approvedTimestamp\": \"2020-05-28T14:07:17Z\",\n \"approvedBy\": \"actor\"\n }\n ],\n \"appliesOn\": \"{\\\"ESMA\\\":[\\\"Transaction\\\",\\\"Valuation\\\"],\\\"CFTC\\\":[\\\"Valuation\\\"],\\\"CA\\\":[\\\"Collateral\\\"]}\",\n \"activeRule\": {\n \"identifier\": \"\",\n \"version\": \"\"\n },\n \"requiredApprovals\": {\n \"type\": \"\"\n },\n \"notes\": \"\",\n \"category\": \"\",\n \"groups\": [\n \"\"\n ],\n \"type\": \"\"\n }\n ],\n \"lastModifiedTimestamp\": \"2020-05-28T14:07:17Z\",\n \"createdTimestamp\": \"2020-05-28T14:07:17Z\",\n \"permissions\": {\n \"canEdit\": true,\n \"canDelete\": true\n }\n}" }, { "id": "response-1-400", "language": "400", "code": "// Bad Request\n" }, { "id": "response-2-401", "language": "401", "code": "// Unauthorized\n" }, { "id": "response-3-403", "language": "403", "code": "// Forbidden\n" }, { "id": "response-4-404", "language": "404", "code": "// Not Found\n" }, { "id": "response-5-405", "language": "405", "code": "// Method Not Allowed\n" }, { "id": "response-6-406", "language": "406", "code": "// Not Acceptable\n" }, { "id": "response-7-415", "language": "415", "code": "// Unsupported Media Type\n" }, { "id": "response-8-500", "language": "500", "code": "// Internal Server Error\n" }, { "id": "response-9-504", "language": "504", "code": "// Gateway Timeout\n" }, { "id": "response-10-default", "language": "default", "code": "// Internal Server Error\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }