--- title: Get a list of parked messages slug: import-test-pdf/get-a-list-of-parked-messages createdAt: 2025-10-27T12:52:26.636Z --- { "id": "Ogg4ASMBuKGBjFCWWbEqC", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://provisioning.rs.int.{environment}.korfinancial.com/parked-messages", "servers": [ { "url": "https://provisioning.rs.int.{environment}.korfinancial.com/parked-messages", "description": "RS Provisioning Integration API" }, { "url": "https://provisioning.rs.{environment}.korfinancial.com/parked-messages", "description": "RS Provisioning Production API" } ], "name": "Get a list of parked messages", "description": "Get a list of parked messages", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [ { "kind": "optional", "name": "entityId", "type": "string", "example": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB", "description": "Your KOR entity 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": "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" }, { "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:

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [] }, "responses": [ { "statusCode": "200", "description": "Parked messages 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) parked messages", "customType": "ParkedMessagesSearchResult", "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 items", "modelRef": "#/components/schemas/ParkedMessage", "customType": "ParkedMessage[]", "schema": [ { "name": "identifier", "kind": "optional", "type": "string", "description": "The identifier of the parked message", "example": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB" }, { "name": "korLifecycleIdentifier", "kind": "optional", "type": "string", "description": "The identifier of the trade that the parked message is related to", "example": "5D4B7224-90BA-4489-9C8C-5D54867C2437" }, { "name": "tradeIdentifier", "kind": "optional", "type": "string", "deprecated": true, "description": "Warning: Deprecated\nThe identifier of the trade that the parked message is related to, deprecated in favor of korLifecycleIdentifier", "example": "5D4B7224-90BA-4489-9C8C-5D54867C2437" }, { "name": "korRegLifecycleIdentifier", "kind": "optional", "type": "string", "description": "The identifier of the trade that the parked message is related to", "example": "31ECC495-33F9-4DBD-A731-E3237991D525" }, { "name": "korRegLifecycleIdentifierSource", "kind": "optional", "type": "string", "description": "The source of the identifier of the trade that the parked message is related to", "example": "" }, { "name": "submissionEventTimestamp", "kind": "optional", "type": "string", "description": "The event timestamp of the submission", "example": "2024-10-24T08:56:42Z" }, { "name": "clientIdentifier", "kind": "optional", "type": "string", "description": "The identifier of the client that submitted the parked message", "example": "85DA13C0-6288-11EE-AE5D-0800200C9A66" }, { "name": "userIdentifier", "kind": "optional", "type": "string", "description": "The identifier of the user that submitted the parked message", "example": "8F90F460-6288-11EE-AE5D-0800200C9A66" }, { "name": "parkedType", "kind": "optional", "type": "string", "description": "The type of the parked message, reflecting the reason why it was parked\n
x-extensible-enum: \n - REHYDRATING_TRADE_STATE\n - PRIOR_UNRESOLVED_REJECTION\n - PRECEDING_TRADE_EVENT_PENDING\n - PRIOR_EVENT_AWAITING_UTI\n - DELAYED\n\n", "modelRef": "#/components/schemas/ParkedType", "customType": "ParkedType", "schema": [] }, { "name": "jurisdiction", "kind": "optional", "type": "string", "description": "The jurisdiction of the parked message", "example": "CFTC" }, { "name": "messageType", "kind": "optional", "type": "string", "description": "The message type of the parked message", "example": "TRANSACTION" }, { "name": "clientPayloadContentType", "kind": "optional", "type": "string", "description": "The type of the upload\n
x-extensible-enum: \n - CSV\n - JSON\n - XML\n - UNSUPPORTED\n\n", "modelRef": "#/components/schemas/IngestionContentType", "customType": "IngestionContentType", "schema": [] }, { "name": "deliveryMechanism", "kind": "optional", "type": "string", "description": "The delivery mechanism that upload was ingested\n
x-extensible-enum: \n - API\n - UI\n - KOR_SFTP\n - CLIENT_SFTP\n - KOR_KAFKA\n\n", "modelRef": "#/components/schemas/DeliveryMechanism", "customType": "DeliveryMechanism", "schema": [] }, { "name": "timestamp", "kind": "optional", "type": "string", "description": "Timestamp when the parked message was parked", "example": "2020-05-28T14:07:17Z" }, { "name": "lineage", "kind": "optional", "type": "object", "description": "The lineage of the submission that created the parked message", "modelRef": "#/components/schemas/ParkedMessageLineage", "customType": "ParkedMessageLineage", "schema": [ { "name": "ingestionIdentifier", "kind": "optional", "type": "string", "description": "The ingestion identifier", "example": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB" }, { "name": "ingestionType", "kind": "optional", "type": "string", "description": "The ingestion type\n
x-extensible-enum: \n - SINGLE_ENTRY\n - UPLOAD\n - REPROCESS\n - REPROCESSED_UPLOAD\n\n", "example": "" }, { "name": "ingestionIndex", "kind": "optional", "type": "integer", "description": "The ingestion index", "example": 0 }, { "name": "dataFeedIdentifier", "kind": "optional", "type": "string", "description": "The data feed identifier", "example": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB" }, { "name": "submissionIdentifier", "kind": "optional", "type": "string", "description": "The submission identifier that created the parked message", "example": "1FAFBBB4-CAFA-46D9-AF0F-384E2300B4DB" }, { "name": "originalSubmissionIdentifier", "kind": "optional", "type": "string", "description": "The identifier of the original submissions that was reprocessed", "example": "91A3C984-2481-4298-8F5C-DCC91134309F" } ] }, { "name": "permissions", "kind": "optional", "type": "object", "description": "Experimental. The permissions the user has on a resource.", "modelRef": "#/components/schemas/ParkedMessagePermissions", "customType": "ParkedMessagePermissions", "schema": [ { "name": "canDelete", "kind": "optional", "type": "boolean", "description": "Experimental. Whether a user can delete the resource.", "example": true } ] }, { "name": "province", "kind": "optional", "type": "string", "description": "The province of the parked message", "example": "ON" } ] } ], "modelRef": "#/components/schemas/ParkedMessagesSearchResult", "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/parked-messages \\\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/parked-messages\", 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/parked-messages\")\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/parked-messages\"\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": "// Parked messages page retrieved\n{\n \"cursor\": \"\",\n \"hasMore\": false,\n \"items\": [\n {\n \"identifier\": \"EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB\",\n \"korLifecycleIdentifier\": \"5D4B7224-90BA-4489-9C8C-5D54867C2437\",\n \"tradeIdentifier\": \"5D4B7224-90BA-4489-9C8C-5D54867C2437\",\n \"korRegLifecycleIdentifier\": \"31ECC495-33F9-4DBD-A731-E3237991D525\",\n \"korRegLifecycleIdentifierSource\": \"\",\n \"submissionEventTimestamp\": \"2024-10-24T08:56:42Z\",\n \"clientIdentifier\": \"85DA13C0-6288-11EE-AE5D-0800200C9A66\",\n \"userIdentifier\": \"8F90F460-6288-11EE-AE5D-0800200C9A66\",\n \"parkedType\": \"\",\n \"jurisdiction\": \"CFTC\",\n \"messageType\": \"TRANSACTION\",\n \"clientPayloadContentType\": \"\",\n \"deliveryMechanism\": \"\",\n \"timestamp\": \"2020-05-28T14:07:17Z\",\n \"lineage\": {\n \"ingestionIdentifier\": \"EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB\",\n \"ingestionType\": \"\",\n \"ingestionIndex\": 0,\n \"dataFeedIdentifier\": \"EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB\",\n \"submissionIdentifier\": \"1FAFBBB4-CAFA-46D9-AF0F-384E2300B4DB\",\n \"originalSubmissionIdentifier\": \"91A3C984-2481-4298-8F5C-DCC91134309F\"\n },\n \"permissions\": {\n \"canDelete\": true\n },\n \"province\": \"ON\"\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": "" } ] }