Discover Refinitiv
MyRefinitiv Refinitiv Perspectives Careers
Created with Sketch.
All APIs Questions & Answers  Register |  Login
Ask a question
  • Questions
  • Tags
  • Badges
  • Unanswered
Search:
  • Home /
  • DSS /
avatar image
Question by mdoberschuetz · Jan 18, 2018 at 03:59 AM · dss rest apidss rest api http

DSS REST API MonitorURL Async behaviour

In order for a call to the following endpoint:

https://hosted.datascopeapi.reuters.com/RestApi/v1/Extractions/Schedules('{0}')/ThomsonReuters.Dss.Api.Extractions.ScheduleExtractNow

to be treated as an asynchronous request the "Prefer: respond-async" header needs to be added.

Looking at the documentation here:

https://hosted.datascopeapi.reuters.com/RestApi.Help/Home/KeyMechanisms?ctx=Extractions&tab=0&uid=Async

and here:

https://hosted.datascopeapi.reuters.com/RestApi/v1/Jobs/$metadata

can I confirm that:

1) The monitor url (that is returned in the Location header of the "ScheduleExtractNow" response if the call takes longer than 30 seconds) also needs the "Prefer: respond-async" header if I want it to return a 202 Accepted after 30 seconds for long running requests?

2) None of the following endpoints support the asynchronous behaviour and therefore do no need the "Prefer: respond-async" header:

https://hosted.datascopeapi.reuters.com/RestApi/v1/Authentication/RequestToken https://hosted.datascopeapi.reuters.com/RestApi/v1/Extractions/Schedules('{0}')/LastExtraction https://hosted.datascopeapi.reuters.com/RestApi/v1/Extractions/ReportExtractions('{0}')/Files https://hosted.datascopeapi.reuters.com/RestApi/v1/Extractions/ExtractedFiles('{0}')/$value

?

amulligan

People who like this

1 Show 0
Comment
10 |1500 characters needed characters left characters exceeded
▼
  • Viewable by all users
  • Viewable by moderators
  • Viewable by moderators and the original poster
  • Advanced visibility
Viewable by all users

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

1 Reply

  • Sort: 
avatar image
REFINITIV
Best Answer
Answer by Troy Dalldorf · Jan 18, 2018 at 10:15 AM

1) Monitor calls do not need the Prefer: respond-async header.

2) These are preferences (including respond-async) which means that the API may choose not to respect the header. The examples you mentioned in #2 that do not need the respond-async preference will simply ignore the prefer-async header. The preference is not needed, but won't cause any problems. However, only set the prefer-async header if your client side code is ready to accept a 202 since we do reserve the right to support asynchronous behavior on methods and would not consider it a breaking change.

Comment
mdoberschuetz

People who like this

1 Show 2 · Share
10 |1500 characters needed characters left characters exceeded
▼
  • Viewable by all users
  • Viewable by moderators
  • Viewable by moderators and the original poster
  • Advanced visibility
Viewable by all users

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

avatar image
mdoberschuetz · Jan 18, 2018 at 11:05 AM 1
Share

@Troy Dalldorf Regarding 1) - does this mean the Monitor url will return a response after a specified time with a 202 Accepted status code or it will never respond with a 202 Accepted and it will eventually respond with a 200 OK and the result of the extraction?

avatar image
REFINITIV
Christiaan Meihsl ♦♦ mdoberschuetz · Jan 25, 2018 at 03:22 AM 1
Share

@mdoberschuetz, the monitor URL will return either:

  • a 200 OK and a response body (after less than 30 seconds),
  • a 202 Accepted with no body (after ~30 seconds). You will need to repeat the GET to the monitor URL until you get an answer that is not a 202.

Watch this question

Add to watch list
Add to your watch list to receive emailed updates for this question. Too many emails? Change your settings >
10 People are following this question.

Related Questions

How to download historical click data of a chain RIC from DSS REST API using python by creating instrument list and report template

/Extractions/ExtractWithNotes answer time

FuturesAndOptionsSearch - Results are not consistent

DSS REST API HTTP Retrieve based on ExtractedFileName (not ExtractedFileId)

Need details regarding Options RIC construction

  • Feedback
  • Copyright
  • Cookie Policy
  • Privacy Statement
  • Terms of Use
  • Careers
  • Anonymous
  • Sign in
  • Create
  • Ask a question
  • Spaces
  • Alpha
  • App Studio
  • Block Chain
  • Bot Platform
  • Calais
  • Connected Risk APIs
  • DSS
  • Data Fusion
  • Data Model Discovery
  • Datastream
  • Eikon COM
  • Eikon Data APIs
  • Elektron
    • EMA
    • ETA
    • WebSocket API
  • Legal One
  • Messenger Bot
  • Messenger Side by Side
  • ONESOURCE
    • Indirect Tax
  • Open PermID
    • Entity Search
  • Org ID
  • PAM
    • PAM - Logging
  • ProView
  • ProView Internal
  • Product Insight
  • Project Tracking
  • Refinitiv Data Platform
    • Refinitiv Data Platform Libraries
  • Rose's Space
  • Screening
    • Qual-ID API
    • Screening Deployed
    • Screening Online
    • World-Check One
    • World-Check One Zero Footprint
  • Side by Side Integration API
  • TR Knowledge Graph
  • TREP APIs
    • CAT
    • DACS Station
    • Open DACS
    • RFA
    • UPA
  • TREP Infrastructure
  • TRIT
  • TRKD
  • TRTH
  • Thomson One Smart
  • Transactions
    • REDI API
  • Velocity Analytics
  • Wealth Management Web Services
  • World-Check Data File
  • Explore
  • Tags
  • Questions
  • Badges