---
title: Get the details of a field
slug: import-test-pdf/Zl-3-get-the-details-of-a-field
createdAt: 2025-10-27T13:00:23.917Z
---

{
  "id": "plgyW55hdL96NDInEpvPX",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://provisioning.rs.int.{environment}.korfinancial.com/clients/{entityIdentifier}/fields/{fieldIdentifier}",
    "servers": [
      {
        "url": "https://provisioning.rs.int.{environment}.korfinancial.com/clients/{entityIdentifier}/fields/{fieldIdentifier}",
        "description": "RS Provisioning Integration API"
      },
      {
        "url": "https://provisioning.rs.{environment}.korfinancial.com/clients/{entityIdentifier}/fields/{fieldIdentifier}",
        "description": "RS Provisioning Production API"
      }
    ],
    "name": "Get the details of a field",
    "description": "Get the details of a field by identifier",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "entityIdentifier",
          "type": "string<uuid>",
          "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": "required",
          "name": "fieldIdentifier",
          "type": "string<uuid>",
          "example": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB",
          "description": "The identifier of the field"
        }
      ],
      "headerParameters": [],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "The field details",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "Details of the field needed for a client mapping",
            "customType": "FieldDetails",
            "schema": [
              {
                "name": "name",
                "kind": "required",
                "type": "string",
                "description": "",
                "example": ""
              },
              {
                "name": "description",
                "kind": "optional",
                "type": "string",
                "description": "",
                "example": ""
              },
              {
                "name": "status",
                "kind": "required",
                "type": "string",
                "description": "The status of the field\n<br> x-extensible-enum: <small>\n  - MAPPED\n  - NOT_MAPPED\n</small>\n",
                "example": ""
              },
              {
                "name": "category",
                "kind": "required",
                "type": "string",
                "description": "Category of a field\n<br> x-extensible-enum: <small>\n  - PURPOSE\n  - EVENTS\n  - COUNTERPARTY\n  - TR\n  - COMPLIANCE\n  - CLEARING\n  - TRANSACTION_RELATED\n  - CUSTOM_BASKETS\n  - NOTIONAL_AMOUNTS_AND_QUANTITIES\n  - PRICES\n  - PACKAGES\n  - PAYMENTS\n  - PRODUCT\n  - SETTLEMENT\n  - DISSEMINATION_RELATED\n  - SETTLEMENT_AND_PRODUCT\n  - TRANSFER\n  - VALUATION\n  - COLLATERAL_AND_MARGINS_MARGIN_AND_CAPITAL_INDICATOR\n  - COLLATERAL_AND_MARGINS\n</small>\n",
                "modelRef": "#/components/schemas/Category",
                "customType": "Category",
                "schema": []
              },
              {
                "name": "groups",
                "kind": "optional",
                "type": "array",
                "description": "Group of fields\n<br> x-extensible-enum: <small>\n  - CURRENCY\n  - FREQUENCY\n  - RESET_PAYMENT_FREQUENCY_PERIOD\n  - NOTATION\n  - UNIT_OF_MEASURE\n  - DAY_COUNT_CONVENTION\n  - REFERENCE_RATE_SOURCE\n  - REFERENCE_RATE\n  - COUNTERPARTY_DESIGNATION\n  - SDR_IDENTIFIER\n  - RATE_INDEX_TENOR_PERIOD\n  - LEG\n  - SETTLEMENT_LOCATION\n  - SPREAD_NOTATION\n  - PRODUCT_NAME\n  - ACTION_TYPE\n  - ALLOCATION_INDICATOR\n  - ASSET_CLASS\n  - CLEARED\n  - CLEARING_ACCOUNT_ORIGIN\n  - COMMODITY_SWAP_CATEGORY\n  - DELIVERY_TYPE\n  - EMBEDDED_OPTION_TYPE\n  - EVENT_TYPE\n  - EXEMPT_PUBLIC_RELATED_MESSAGE\n  - INSTRUMENT_TYPE\n  - JURISDICTION\n  - OPTION_STYLE\n  - OPTION_TYPE\n  - OTHER_COMMODITY_REGION\n  - OTHER_COMMODITY_SWAP_CATEGORY\n  - PLATFORM_IDENTIFIER\n  - RELATED_FUTURES_CONTRACT\n  - RETURN_PRICING_METHOD_OR_PAYOUT_TRIGGER\n  - SENIORITY\n  - SINGLE_OR_MULTIPLE_CURRENCY\n  - STRIKE_PRICE_NOTATION\n  - UNDERLYING_ASSET_TYPE\n  - VALUATION_METHOD\n  - CLEARING_EXCEPTIONS_AND_EXEMPTION\n</small>\n",
                "modelRef": "#/components/schemas/Group",
                "customType": "Group[]",
                "schema": []
              }
            ],
            "modelRef": "#/components/schemas/FieldDetails",
            "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/clients/{entityIdentifier}/fields/{fieldIdentifier} \\\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/clients/{entityIdentifier}/fields/{fieldIdentifier}\", 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/clients/{entityIdentifier}/fields/{fieldIdentifier}\")\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/clients/{entityIdentifier}/fields/{fieldIdentifier}\"\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": "// The field details\n{\n  \"name\": \"\",\n  \"description\": \"\",\n  \"status\": \"\",\n  \"category\": \"\",\n  \"groups\": [\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": ""
    }
  ]
}