--- title: Get a list of rule sets slug: import-test-pdf/xOAX-get-a-list-of-rule-sets createdAt: 2025-10-27T12:52:26.651Z --- { "id": "mctUw0N1ZwqIlxCHXGmR1", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://provisioning.rs.int.{environment}.korfinancial.com/rule-sets", "servers": [ { "url": "https://provisioning.rs.int.{environment}.korfinancial.com/rule-sets", "description": "RS Provisioning Integration API" }, { "url": "https://provisioning.rs.{environment}.korfinancial.com/rule-sets", "description": "RS Provisioning Production API" } ], "name": "Get a list of rule sets", "description": "Get a list of rule sets", "contentType": "application/json", "request": { "pathParameters": [], "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." }, { "kind": "optional", "name": "cursor", "type": "string", "description": "

The cursor to get the next page, empty returns the first page

" }, { "kind": "optional", "name": "query", "type": "string", "example": "%7B%22p%22%3A%5B%22field%22%5D%2C%22cf%22%3A%22eq%22%2C%22v%22%3A%5B%22value1%22%2C%22value2%22%5D%7D", "description": "

URL encoded JSON string containing the search query with various filter options.\n \n JSON Structure The following JSON snippet can be passed in through an HTTP query parameter URL encoded: {\"lf\": \"and\", \"q\": [{\"p\": [\"field\"], \"cf\": \"eq\", \"v\": [\"value\"]}]} Possible \"cf\" Values The \"cf\" field can have the following values based on data types: \n Integers: 'neq' (Not Equals) 'eq' (Equals) 'gt' (Greater Than) 'gte' (Greater Than or Equals) 'lt' (Less Than) 'lte' (Less Than or Equals) String: 'neq' (Not Equals) 'eq' (Equals) 'ct' (Contains) Dates: Represented as a unix timestamp as long 'neq' (Not Equals) 'eq' (Equals) 'gt' (Greater Than) 'gte' (Greater Than or Equals) 'lt' (Less Than) 'lte' (Less Than or Equals) Boolean: Represented as the strings true or false 'neq' (Not Equals) 'eq' (Equals) Supported fields and their corresponding types:

" }, { "kind": "optional", "name": "pageSize", "type": "integer", "description": "Max amount of results that should be returned" }, { "kind": "optional", "name": "scroll", "type": "boolean", "description": "A flag to define you intent to scroll through your results" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [] }, "responses": [ { "statusCode": "200", "description": "Rule sets page retrieved", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "The search result with a cursor, indicating whether there are more items and the returned (subset of) products", "customType": "RuleSets", "schema": [ { "name": "cursor", "kind": "optional", "type": "string", "description": "Cursor for the current search request", "example": "" }, { "name": "hasMore", "kind": "optional", "type": "boolean", "description": "Indicating whether there are more items that can be retrieved", "example": "" }, { "name": "items", "kind": "optional", "type": "array", "description": "The list of rule sets", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" } ], "modelRef": "#/components/schemas/RuleSets", "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 \\\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\", 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\")\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\"\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 sets page retrieved\n{\n \"cursor\": \"\",\n \"hasMore\": false,\n \"items\": [\n {}\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": "" } ] }