Session Id

1)You suggest we should attach clientSessionId HTTP header; how do you understand a “session”? Is this the time a specific token authorization is valid?
2. Note we already set a header named Authorization with value Token xxx where xxx is the value we receive from your endpoint /Authentication/RequestToken ; is this not sufficient and you want our client to send a different unique identifier?
3. Do you want to be able to identify each REST API call our REST client is doing with its own, unique request id? Then clientSessionId is not the best name - it suggests the value is the same for the duration of some session, but it will be different for each request; therefore I suggest “clientRequestId” header name.
Best Answer
-
Context
When contacting customer support, you need to provide the Client-Session-Id and Request-Execution-Correlation-Id of the extraction request that had an issue.
The Client-Session-Id is a client-side unique identifier for a "client-side unit of work". It is a value that is generated by the client, and is used to identify a request.
Request-Execution-Correlation-Id is returned by the DSS REST API in the response header.
The client is responsible for logging these IDs, that will be useful when failures are detected or when the response received is not satisfactory.
See this help page for more information.
To answer your queries:
1) You suggest we should attach clientSessionId HTTP header; how do you understand a “session”? Is this the time a specific token authorization is valid?
A "session" can be defined as the "set of queries that are made for a single extraction request". Each extraction request needs a new and unique Client-Session-Id. In case of doubt, just use a unique Client-Session-Id for every single call you make to the API.
2. Note we already set a header named Authorization with value Token xxx where xxx is the value we receive from your endpoint /Authentication/RequestToken ; is this not sufficient and you want our client to send a different unique identifier?
The token, valid 24 hours, is only for authentication. In no way does it uniquely identify an extraction request.
The Client-Session-Id is set by the client in a separate header of a request. Example:
Token <your_auth_token_goes_here>
X-Client-Session-Id: 8FBAA1E1-DFF3-435C-A0CA-1C9A6C46C266
Prefer: respond-asyncAgain, it must be unique, to be able to identify that particular query or unit of work.
3. Do you want to be able to identify each REST API call our REST client is doing with its own, unique request id? Then clientSessionId is not the best name - it suggests the value is the same for the duration of some session, but it will be different for each request; therefore I suggest “clientRequestId” header name.
The idea is to be able to identify each extraction request a REST client is doing, using a unique ID. The name choice is debatable, but it is what it is.
0
Categories
- All Categories
- 3 Polls
- 6 AHS
- 36 Alpha
- 166 App Studio
- 6 Block Chain
- 4 Bot Platform
- 18 Connected Risk APIs
- 47 Data Fusion
- 34 Data Model Discovery
- 687 Datastream
- 1.4K DSS
- 622 Eikon COM
- 5.2K Eikon Data APIs
- 10 Electronic Trading
- Generic FIX
- 7 Local Bank Node API
- 3 Trading API
- 2.9K Elektron
- 1.4K EMA
- 255 ETA
- 557 WebSocket API
- 38 FX Venues
- 14 FX Market Data
- 1 FX Post Trade
- 1 FX Trading - Matching
- 12 FX Trading – RFQ Maker
- 5 Intelligent Tagging
- 2 Legal One
- 23 Messenger Bot
- 3 Messenger Side by Side
- 9 ONESOURCE
- 7 Indirect Tax
- 60 Open Calais
- 276 Open PermID
- 44 Entity Search
- 2 Org ID
- 1 PAM
- PAM - Logging
- 6 Product Insight
- Project Tracking
- ProView
- ProView Internal
- 22 RDMS
- 1.9K Refinitiv Data Platform
- 680 Refinitiv Data Platform Libraries
- 4 LSEG Due Diligence
- LSEG Due Diligence Portal API
- 4 Refinitiv Due Dilligence Centre
- Rose's Space
- 1.2K Screening
- 18 Qual-ID API
- 13 Screening Deployed
- 23 Screening Online
- 12 World-Check Customer Risk Screener
- 1K World-Check One
- 46 World-Check One Zero Footprint
- 45 Side by Side Integration API
- 2 Test Space
- 3 Thomson One Smart
- 10 TR Knowledge Graph
- 151 Transactions
- 143 REDI API
- 1.8K TREP APIs
- 4 CAT
- 27 DACS Station
- 121 Open DACS
- 1.1K RFA
- 104 UPA
- 194 TREP Infrastructure
- 229 TRKD
- 918 TRTH
- 5 Velocity Analytics
- 9 Wealth Management Web Services
- 91 Workspace SDK
- 11 Element Framework
- 5 Grid
- 18 World-Check Data File
- 1 Yield Book Analytics
- 48 中文论坛