Q

General Usage

The 'q' query parameter can be used within a supporting call to search any field within the resource. 'q' supports most of the syntax used by MongoDB db.find()

How do I use 'q'?

You can use 'q' to search any field within a response. Below is an example of the basic response from the /lists request. Any field or fields within the Regulatory List resource structure can be searched using 'q'. (The links collection cannot be searched with 'q'.)

We can see that the Regulator List resource has a Tags collection with a tag property; therefore if we want to request only Regulatory Lists that are relevant to authoring SDSs, we would set our 'q' paremeter to {"tags.tag.name": "SDS Relevant"}

{
  "regulatory_list": [
    {
      "_id": 2,
      "name": "Physical Properties - SMILES Notations",
      "description": "This list provides the SMILES (Simplified Molecular Input Line Entry Specification) notations of various chemical compounds.",
      "is_inventory": false,
      "source_languages": {
        "language": [
          {
            "iso_639_1_language": "English",
            "iso_639_1_code": "EN"
          }
        ]
      },
      "tags": {
        "tag": [
          {
            "name": "Non-Regional"
          },
          {
            "name": "SDS Relevant"
          },
          {
            "name": "Non-Regulatory Information"
          },
          {
            "name": "Physical Properties"
          }
        ]
      }

How do I use 'qlists'?

This parameters is used with the same syntax as 'q' parameter as an additional options for filtering calls where 'q' would filter based on entries. 'qlists' filters based on lists and can be used as the same time as 'q'.