filter-queryId-status-get

get

filter-queryId-status-get

Call this endpoint with a queryId returned from another filter query. If successful, returns a JSON object. This object contains 'status', which is the status of the query represented by the queryId. When the status is 'Complete', the object also contains 'count', which is the number of results returned. If not successful, returns an HTTP status other than 200. After receiving a status of 'Complete' from this endpoint, send the Query ID to /filter/{queryId}/results to obtain the result. We recommend that you wait at least 10 seconds before calling this endpoint, and then call this endpoint every 5 seconds. You should stop calling this endpoint when the status changes to Suspended, Failed, Not Found or Complete. A status of Suspended can be caused if the results could not be compiled within a reasonable amount of time. Create a new filter request with more restrictive parameters. A status of Failed can be caused if the backend system could not compile the results. Create a new filter request and, if the same outcome occurs, apply more restrictive parameters. A status of Not Found can be caused if the Query ID has not been registered or has expired. Create a new filter request.

Resource URL

https://api.rsc.org/compounds/v1 /filter/{queryId}/status

Header Parameters


Name Values Description
Content-Type

apikey
(required)

Your personal key

Request Body

queryId The Id of the filter query null true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400
    400

    Bad Request. Check the request you sent and try again.

  • 401
    401

    Unauthorized. Check you have supplied the correct API key and that you have sent it as an HTTP Header called 'apikey'.

  • 404
    404

    Not Found. The requested endpoint URL is not recognized. Change your request and try again.

  • 405
    405

    Method Not Allowed. The verb is incorrect for the endpoint. Change your request and try again.

  • 429
    429

    Too Many Requests. Send fewer requests, or use rate-limiting to slow them down, then try again.

  • 500
    500

    Internal Server Error. Wait and try again.

  • 503
    503

    Service Unavailable. Wait and try again.

Resource Summary

Security

Category

filtering

Working...