How can I retrieve Platts Corrections through DSS REST API
When client subscribe platts through DSS, they can get daily corrections file in extraction. How can they extract that Corrections detail through API?
Hi @tao.yuan,
To retrieve last extraction file, you need to know Schedule ID by using GetByName endpoint with Schedule name.(i.e. "PlattsCorrections"). The Schedule ID should not be changed for a schedule, so application can store and reuse the ID for next retrieval.
Below is the sample of request.
Request:
GET https://hosted.datascopeapi.reuters.com/RestApi/v1/Extractions/ScheduleGetByName(ScheduleName='PlattsCorrections')
Response:
{
"@odata.context": "https://hosted.datascopeapi.reuters.com/RestApi/v1/$metadata#Schedules/$entity",
"ScheduleId": "0x05b6ab1f77eb3026",
"Name": "PlattsCorrections",
"OutputFileName": "",
"TimeZone": "SE Asia Standard Time",
"Recurrence": {
...
Below are the steps to get the extraction result from Schedule ID via API.
1) Get last Report Extraction ID for the Schedule ID using Schedule.LastExtraction.
Your corrections file is generated daily, so the schedule should be recurring. You need to get only last extraction information.
In this sample, the Schedule ID is '0x05b6ab1f77eb3026'. The last Report Extraction ID received in this sample is '2000000087212479'.
Request:
GET https://hosted.datascopeapi.reuters.com/RestApi/v1/Extractions/Schedules('0x05b6ab1f77eb3026')/LastExtraction
Response:
{
"@odata.context": "https://hosted.datascopeapi.reuters.com/RestApi/v1/$metadata#ReportExtractions/$entity",
"ReportExtractionId": "2000000087212479",
"ScheduleId": "0x05b6ab1f77eb3026",
"Status": "Completed",
...
2) Get Extracted File ID of extracted data using ReportExtraction.FullFile.
Normally an extraction will generate two files; data and Notes. You need to get ExtractedFileId for data file. The Extracted File ID for data file in this sample is 'VjF8fDUwNjM3NTg2OQ'
Request:
GET https://hosted.datascopeapi.reuters.com/RestApi/v1/Extractions/ReportExtractions('2000000087212479')/FullFile
Response:
{
"@odata.context": "https://hosted.datascopeapi.reuters.com/RestApi/v1/$metadata#ExtractedFiles/$entity",
"ExtractedFileId": "VjF8fDUwNjM3NTg2OQ",
"ReportExtractionId": "2000000087212479",
"ScheduleId": "0x05b6ab1f77eb3026",
"FileType": "Full",
...
3) Retrieve data with ExtractedFileId using GetDefaultStream.
Finally, you can retrieve the extracted data.
Request:
GET https://hosted.datascopeapi.reuters.com/RestApi/v1/Extractions/ExtractedFiles('VjF8fDUwNjM3NTg2OQ')/$value
For more detailed information, please see this GUI control calls: immediate extract tutorial.