filter-mass-batch-post

post

filter-mass-batch-post

You can use this endpoint when you have multiple masses to search as a batch. Submit an array of up to 20 monoisotopic masses via POST. Each item in the array is an object with properties 'mass' and 'range'. Submit mass as a double between 1 and 11000 Atomic Mass Units, and a range between 0.0001 and 0.02. For example, if you specify a monoisotopic mass of 40 and a range of 0.0005, all masses between 39.9995 and 40.0005 are searched. You can optionally supply dataSources as a JSON-formatted array of up to 20 strings, representing the data sources to query. You can obtain valid values from the /lookups/datasources endpoint. If dataSources is not specified, all known sources are searched. This will take longer. Optionally, you can also submit orderBy and orderDirection to specify the sort order for the results. If you do not specify a value for orderBy, results are sorted by Record ID by default. Valid values for orderBy are recordId, massDefect, molecularWeight, referenceCount, dataSourceCount, pubMedCount, rscCount. Valid values for orderDirection are ascending, descending. If successful, returns a Query ID representing the search. If not successful, returns an HTTP status other than 200. After running this search, iteratively send the returned Query ID to /filter/mass/batch/{queryId}/status to check the status of the asynchronous query. When the status is 'Complete', send the Query ID to /filter/mass/batch/{queryId}/results to obtain the result.

Resource URL

https://api.rsc.org/compounds/v1 /filter/mass/batch

Header Parameters


Name Values Description
Content-Type

apikey
(required)

Your personal key

Body Parameters


Name Values Description
body
(required)

Request Body

Search query object

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.

  • 413
    413

    Payload Too Large. The request you sent was too big to handle. 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...