Get the details of a parked message

1 min

GET

https://provisioning.rs.int.{environment}.korfinancial.com/parked-messages/{parkedMessageIdentifier}

Get the details of a parked message by identifier

Path Parameters

parkedMessageIdentifierstring<uuid>required
Example
EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
Description
The parked message identifier

Query Parameters

entityIdstring<uuid>
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.

Responses

200The parked message details

ParkedMessageDetails
Description
Detailed information of a parked message
- identifierstring<uuid>
  Example
  EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
  Description
  The identifier of the parked message
- korLifecycleIdentifierstring<uuid>
  Example
  5D4B7224-90BA-4489-9C8C-5D54867C2437
  Description
  The identifier of the trade that the parked message is related to
- tradeIdentifierstring<uuid>
  Example
  5D4B7224-90BA-4489-9C8C-5D54867C2437
  Description
  Warning: Deprecated The identifier of the trade that the parked message is related to, deprecated in favor of korLifecycleIdentifier
- korRegLifecycleIdentifierstring<uuid>
  Example
  31ECC495-33F9-4DBD-A731-E3237991D525
  Description
  The identifier of the trade that the parked message is related to
- korRegLifecycleIdentifierSourcestring
  Description
  The source of the identifier of the trade that the parked message is related to
- submissionEventTimestampstring<date-time>
  Example
  2024-10-24T08:56:42Z
  Description
  The event timestamp of the submission
- clientIdentifierstring<uuid>
  Example
  85DA13C0-6288-11EE-AE5D-0800200C9A66
  Description
  The identifier of the client that submitted the parked message
- userIdentifierstring<uuid>
  Example
  8F90F460-6288-11EE-AE5D-0800200C9A66
  Description
  The identifier of the user that submitted the parked message
- parkedTypeParkedType
  Description
  The type of the parked message, reflecting the reason why it was parked
  x-extensible-enum: - REHYDRATING_TRADE_STATE - PRIOR_UNRESOLVED_REJECTION - PRECEDING_TRADE_EVENT_PENDING - PRIOR_EVENT_AWAITING_UTI - DELAYED
- jurisdictionstring
  Example
  CFTC
  Description
  The jurisdiction of the parked message
- messageTypestring
  Example
  TRANSACTION
  Description
  The message type of the parked message
- clientPayloadstring
  Example
```
{
  "field": "value"
}
```
  Description
  The payload of the parked message
- clientPayloadContentTypeIngestionContentType
  Description
  The type of the upload
  x-extensible-enum: - CSV - JSON - XML - UNSUPPORTED
- deliveryMechanismDeliveryMechanism
  Description
  The delivery mechanism that upload was ingested
  x-extensible-enum: - API - UI - KOR_SFTP - CLIENT_SFTP - KOR_KAFKA
- timestampstring<date-time>
  Example
  2020-05-28T14:07:17Z
  Description
  Timestamp when the parked message was parked
- lineageParkedMessageLineage
  Description
  The lineage of the submission that created the parked message
  - ingestionIdentifierstring<uuid>
    Example
    EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
    Description
    The ingestion identifier
  - ingestionTypestring
    Description
    The ingestion type
    x-extensible-enum: - SINGLE_ENTRY - UPLOAD - REPROCESS - REPROCESSED_UPLOAD
  - ingestionIndexinteger
    Description
    The ingestion index
  - dataFeedIdentifierstring<uuid>
    Example
    EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
    Description
    The data feed identifier
  - submissionIdentifierstring<uuid>
    Example
    1FAFBBB4-CAFA-46D9-AF0F-384E2300B4DB
    Description
    The submission identifier that created the parked message
  - originalSubmissionIdentifierstring<uuid>
    Example
    91A3C984-2481-4298-8F5C-DCC91134309F
    Description
    The identifier of the original submissions that was reprocessed
- supplementalDataSupplementalData
  Description
  The supplemental data that is part of the submission or static data
- permissionsParkedMessagePermissions
  Description
  Experimental. The permissions the user has on a resource.
  - canDeleteboolean
    Example
    true
    Description
    Experimental. Whether a user can delete the resource.
- provincestring
  Example
  ON
  Description
  The province of the parked message

400Bad Request

401Unauthorized

403Forbidden

404Not Found

405Method Not Allowed

406Not Acceptable

415Unsupported Media Type

500Internal Server Error

504Gateway Timeout

defaultInternal Server Error

curl

curl --request GET \
     --url https://provisioning.rs.int.{environment}.korfinancial.com/parked-messages/{parkedMessageIdentifier} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://provisioning.rs.int.{environment}.korfinancial.com/parked-messages/{parkedMessageIdentifier}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://provisioning.rs.int.{environment}.korfinancial.com/parked-messages/{parkedMessageIdentifier}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://provisioning.rs.int.{environment}.korfinancial.com/parked-messages/{parkedMessageIdentifier}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// The parked message details
{
  "identifier": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB",
  "korLifecycleIdentifier": "5D4B7224-90BA-4489-9C8C-5D54867C2437",
  "tradeIdentifier": "5D4B7224-90BA-4489-9C8C-5D54867C2437",
  "korRegLifecycleIdentifier": "31ECC495-33F9-4DBD-A731-E3237991D525",
  "korRegLifecycleIdentifierSource": "",
  "submissionEventTimestamp": "2024-10-24T08:56:42Z",
  "clientIdentifier": "85DA13C0-6288-11EE-AE5D-0800200C9A66",
  "userIdentifier": "8F90F460-6288-11EE-AE5D-0800200C9A66",
  "parkedType": "",
  "jurisdiction": "CFTC",
  "messageType": "TRANSACTION",
  "clientPayload": "{\"field\": \"value\"}",
  "clientPayloadContentType": "",
  "deliveryMechanism": "",
  "timestamp": "2020-05-28T14:07:17Z",
  "lineage": {
    "ingestionIdentifier": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB",
    "ingestionType": "",
    "ingestionIndex": 0,
    "dataFeedIdentifier": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB",
    "submissionIdentifier": "1FAFBBB4-CAFA-46D9-AF0F-384E2300B4DB",
    "originalSubmissionIdentifier": "91A3C984-2481-4298-8F5C-DCC91134309F"
  },
  "supplementalData": [
    ""
  ],
  "permissions": {
    "canDelete": true
  },
  "province": "ON"
}

400

// Bad Request

401

// Unauthorized

403

// Forbidden

404

// Not Found

405

// Method Not Allowed

406

// Not Acceptable

415

// Unsupported Media Type

500

// Internal Server Error

504

// Gateway Timeout

default

// Internal Server Error