--- title: Get the details of a rule slug: import-test-pdf/yBw8-get-the-details-of-a-rule createdAt: 2025-10-27T12:57:15.105Z --- { "id": "-qr0dF3HfWGza_O8nmIg8", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://provisioning.rs.int.{environment}.korfinancial.com/rules/{ruleId}", "servers": [ { "url": "https://provisioning.rs.int.{environment}.korfinancial.com/rules/{ruleId}", "description": "RS Provisioning Integration API" }, { "url": "https://provisioning.rs.{environment}.korfinancial.com/rules/{ruleId}", "description": "RS Provisioning Production API" } ], "name": "Get the details of a rule", "description": "Get the details of a rule by identifier", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "ruleId", "type": "string", "example": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB", "description": "The rule identifier" } ], "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": "Rules page retrieved", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Model for rule", "customType": "Rule", "schema": [ { "name": "identifier", "kind": "optional", "type": "string", "description": "The identifier of the rule", "example": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB" }, { "name": "targetKDMFieldName", "kind": "optional", "type": "string", "description": "The target KDM field name of the rule", "example": "assetClass" }, { "name": "kdmFieldType", "kind": "optional", "type": "string", "description": "The KDM field type of the rule\n
x-extensible-enum: \n - HUB\n - ENTITY\n - RELATIONSHIP\n - PRODUCT\n - VALUE_MAPPING\n\n", "example": "HUB" }, { "name": "name", "kind": "optional", "type": "string", "description": "The name assigned to the rule", "example": "My assetClass rule" }, { "name": "note", "kind": "optional", "type": "string", "description": "The note containing information and context about the rule", "example": "Lorem ipsum" }, { "name": "ruleSets", "kind": "optional", "type": "array", "description": "The rule sets that this rule is part of", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "functions", "kind": "optional", "type": "array", "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.", "modelRef": "#/components/schemas/Function", "customType": "Function[]", "schema": [ { "name": "argumentReferenceIdentifier", "kind": "optional", "type": "string", "description": "The identifier of the function that will be used to generate the argument value.\nIf null, the function will be treated as a head.\n", "example": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB" }, { "name": "category", "kind": "optional", "type": "string", "description": "The category of the function\n
x-extensible-enum: \n - HUB\n - PURPOSE\n - REG\n - ENTITY\n - PRODUCT\n - RELATIONSHIP\n - VALUE_MAPPING\n\n", "example": "HUB" }, { "name": "tag", "kind": "optional", "type": "string", "description": "The tag of the function", "example": "[\"sourceField\",\"upperCase\",\"mandate\"]" }, { "name": "functionMetadata", "kind": "optional", "type": "string", "description": "The metadata of the function. Referenced in the user field configuration metadata.", "example": "{\"id\":\"5c7bf808ac0c507e\",\"value\":{\"x\":-105.2109375,\"y\":-84.43359375}}" }, { "name": "arguments", "kind": "optional", "type": "array", "description": "A dynamic list of arguments by name and type", "modelRef": "#/components/schemas/FunctionArgument", "customType": "FunctionArgument[]", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "The type of the function argument\n
x-extensible-enum: \n - STRING\n - NUMBER\n - ARRAY\n - MAP\n - FUNCTION\n - BOOLEAN\n - KDMFIELD\n - SOURCEFIELD\n\n", "example": "STRING" }, { "name": "name", "kind": "optional", "type": "string", "description": "The name of the function argument", "example": "[\"function\",\"argument0\",\"actionType\"]" }, { "name": "value", "kind": "optional", "type": "object", "description": "Can be anything: string, number, array, object, etc., including `null`", "modelRef": "#/components/schemas/AnyValue", "customType": "AnyValue", "schema": [] } ] } ] }, { "name": "ruleMetadata", "kind": "optional", "type": "string", "description": "Overview of the rule metadata. This field gets left out when querying a list of rules unless details inclusion was requested.", "example": "" }, { "name": "createdTimestamp", "kind": "optional", "type": "string", "description": "Timestamp when the rule was created", "example": "2020-05-28T14:07:17Z" }, { "name": "lastModifiedTimestamp", "kind": "optional", "type": "string", "description": "Timestamp when the rule was modified", "example": "2020-05-28T14:07:17Z" }, { "name": "deletedTimestamp", "kind": "optional", "type": "string", "description": "Timestamp when the rule was deleted", "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 } ] }, { "name": "version", "kind": "optional", "type": "string", "description": "The version of a rule", "example": "3" }, { "name": "status", "kind": "optional", "type": "string", "description": "The status of the rule\n
x-extensible-enum: \n - ACTIVE\n - INACTIVE\n - ARCHIVED\n\n", "example": "ACTIVE", "modelRef": "#/components/schemas/RuleStatus", "customType": "RuleStatus", "schema": [] }, { "name": "functionalVersion", "kind": "optional", "type": "string", "description": "The functional version hash of a rule", "example": "d41d8cd98f003204a9800998ecf8427e" } ], "modelRef": "#/components/schemas/Rule", "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/rules/{ruleId} \\\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/rules/{ruleId}\", 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/rules/{ruleId}\")\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/rules/{ruleId}\"\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": "// Rules page retrieved\n{\n \"identifier\": \"EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB\",\n \"targetKDMFieldName\": \"assetClass\",\n \"kdmFieldType\": \"HUB\",\n \"name\": \"My assetClass rule\",\n \"note\": \"Lorem ipsum\",\n \"ruleSets\": [\n \"\"\n ],\n \"functions\": [\n {\n \"argumentReferenceIdentifier\": \"EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB\",\n \"category\": \"HUB\",\n \"tag\": \"[\\\"sourceField\\\",\\\"upperCase\\\",\\\"mandate\\\"]\",\n \"functionMetadata\": \"{\\\"id\\\":\\\"5c7bf808ac0c507e\\\",\\\"value\\\":{\\\"x\\\":-105.2109375,\\\"y\\\":-84.43359375}}\",\n \"arguments\": [\n {\n \"type\": \"STRING\",\n \"name\": \"[\\\"function\\\",\\\"argument0\\\",\\\"actionType\\\"]\",\n \"value\": {}\n }\n ]\n }\n ],\n \"ruleMetadata\": \"\",\n \"createdTimestamp\": \"2020-05-28T14:07:17Z\",\n \"lastModifiedTimestamp\": \"2020-05-28T14:07:17Z\",\n \"deletedTimestamp\": \"2020-05-28T14:07:17Z\",\n \"permissions\": {\n \"canEdit\": true,\n \"canDelete\": true\n },\n \"version\": \"3\",\n \"status\": \"ACTIVE\",\n \"functionalVersion\": \"d41d8cd98f003204a9800998ecf8427e\"\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": "" } ] }