For a deeper look into our DataScope Select REST API, look into:

Overview |  Quickstart |  Documentation |  Downloads |  Tutorials

question

Upvotes
Accepted
2 0 4 6

Asynchronous answers happen in DSS Rest API

Do asynchronous answers happen in DSS Rest API?

Client advised that in the past they were facing such asynchronous answers, which have been eliminated by using a special rule. Due to this they are no longer able to determine, if asynchronous answers still happen or not. The code they used to fix it cannot be repeated, thus the question if they need to develop a new rule? Or whether the asynchronous answers are not an issue anymore.

dss-rest-apidatascope-selectdss
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.

Upvotes
Accepted
13.7k 26 8 12

In a nutshell: yes, and this is a desirable feature.

In detail: the DSS REST API asynchronous mechanism is designed to support long running requests, which pose several problems:

  • they require the connection to remain open for the duration of the request (firewalls might close idle connections).
  • the user code must maintain a running process for the duration of the request, which could be quite long for large data amounts.
  • long running requests drive the need for periodic status updates and the ability to cancel the request.

The DSS REST API conforms to OASIS OData standards for async. In addition to the standard asynchronous protocol defined by OData, which supports polling and status and progress updates, we added the ability to cancel a request, as well as manage the list of active asynchronous jobs.

To avoid data retrieval issues, the recommend practice is to use the asynchronous mechanisms. Using synchronous mechanisms might result in issues, especially when requesting large data sets. The typical symptom will be data requests that timeout without returning any data; this can occur randomly, as the server load influences extraction times.

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.

Upvotes
11.3k 25 9 14

To me, the asynchronous behavior you described looks similar to a known issue patched in version 10.8, released early January 2017. The issue is that DSS incorrectly used async when there was no Prefer: respond-async option set.

You can find detailed information in this question and "Why do I get a 202 when I submit a synchronous request?" topic of the FAQ in the document page.

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.