question

Upvotes
Accepted
19 5 9 9

RawExtractionResults versus ExtractedFiles

A simple question :

What is the difference between RawExtractionResults and ExtractedFiles ?

Can the first request save report files on your disk or is it just designed to display a preview of the data (in Postman for instance) ?

tick-history-rest-apidesign
icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

Hi @Jerome Guiot-Dorel,

Thank you for your participation in the forum.

Is the reply below satisfactory in resolving your query? If yes please click the 'Accept' text next to the reply. This will guide all community members who have a similar question. Otherwise please post again offering further insight into your question.

Thanks,

-AHS

1 Answer

· Write an Answer
Upvotes
Accepted
79.1k 250 52 74

RawExtractionResults is used to retrieve a native/raw result from an On-Demand extraction request that includes both the raw extraction contents and the extraction notes. It requires JobID returned by the On-Demand extraction request. For example:

{
    "@odata.context": "https://hosted.datascopeapi.reuters.com/RestApi/v1/$metadata#RawExtractionResults/$entity",
    "JobId": "0x05ce6e5d5ccb2f96",
    "Notes": [
        "Extraction Services Version 11.1.37014 ..."
    ]
}

With the JobID, the application can use RawExtractionResults to retrieve the data (Extractions/RawExtractionResults('{ {jobId}}')/$value).

The ExtractedFiles resources returns all files for all report extractions for all schedules where the most recent ExtractedFiles are returned first.

{
    "@odata.context": "https://hosted.datascopeapi.reuters.com/RestApi/v1/$metadata#ExtractedFiles",
    "value": [
        {
            "ExtractedFileId": "VjF8MHgwNWNlNmU2N2ZjM2IzMDM2fA",
            "ReportExtractionId": "2000000001298791",
            "ScheduleId": "0x05ce6e5d5ccb2f96",
            "FileType": "Note",
            "ExtractedFileName": "_OnD_0x05ce6e5d5ccb2f96.csv.gz.notes.txt",
            "LastWriteTimeUtc": "2017-07-24T04:20:57.260Z",
            "ContentsExists": true,
            "Size": 1246,
            "ReceivedDateUtc": "2017-07-24T04:20:57.260Z"
        },
        {
            "ExtractedFileId": "VjF8MHgwNWNlNmU2N2RkY2IzMDI2fA",
            "ReportExtractionId": "2000000001298791",
            "ScheduleId": "0x05ce6e5d5ccb2f96",
            "FileType": "Full",
            "ExtractedFileName": "_OnD_0x05ce6e5d5ccb2f96.csv.gz",
            "LastWriteTimeUtc": "2017-07-24T04:20:56.000Z",
            "ContentsExists": true,
            "Size": 159406
        },

To retrieve the file, it requires ExtractedFileId (Extractions/ExtractedFiles('{ {extractedFileId}}')/$value). Typically, it is used with scheduled extraction. However, it can also be used to retrieve the data from On-Demand extraction. The JobID from On-Demand extraction is presented as ScheduleId in the ExtractedFiles result.

The files are on the server and it requires ID (On-Demand JobID or ExtractedFileId) to retrieve the data.

icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

Write an Answer

Hint: Notify or tag a user in this post by typing @username.

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.