Command

Syntax

The command parameter uses the following syntax:

s.cmd=<someCommand>[ <someCommand>]*

A query string may contain many s.cmd parameters, and each s.cmd parameter may contain may commands separated by a space (‘ ‘) character. The order of s.cmd parameters within the query string and the order of commands within an s.cmd parameter are unimportant. Command names do not contain any special characters that would require escaping, but the following characters in the command arguments must be escaped: ,:\()${}

Function

The command parameter passes commands to the search api.

Example – Using the command parameter

This command clears all textQueries, searchTerms, textFilters, rangeFilters, facetValueFilters and paging, then applies a textQuery of <span class=”code”>tropical rain forest</span> and requests ContentType facet counts:

s.cmd=clearSearch()+setTextQuery(tropical+rain+forest) &
s.cmd=addFacetField(ContentType,or,1,10)

Example response

s.cmd=clearSearch()+setTextQuery(tropical+rain+forest)&s.cmd=addFacetField(ContentType,or,1,10)
{
  "version":"2.0.0",
  "sessionId":"test-application-74703",
  "elapsedQueryTime":1896,
  "queryTime":1878,
  "totalRequestTime":1960,
  "pageCount":169696818,
  "recordCount":1696968180,
  "query":{
    "queryString":"s.secure=f&s.ff=ContentType%2Cor%2C1%2C10",
    "pageNumber":1,
    "pageSize":10,
    "textQueries":[
      
    ],
    "searchTerms":[
      
    ],
    "textFilters":[
      
    ],
    "rangeFilters":[
      
    ],
    "facetValueFilters":[
      
    ],
    "inclusiveFacetValueFilters":[
      
    ],
    "facetValueGroupFilters":[
      
    ],
    "facetFields":[
      {
        "fieldName":"ContentType",
        "combineMode":"or",
        "pageNumber":1,
        "pageSize":10,
        "removeCommand":"removeFacetField(ContentType)"
      }
    ],
    "rangeFacetFields":[
      
    ],
    "sort":[
      
    ]
  },
  "facetFields":[
    {
      "fieldName":"ContentType_mfacet",
      "displayName":"ContentType",
      "combineMode":"or",
      "pageNumber":1,
      "pageSize":10,
      "hasLimitingValue":true,
      "hasAppliedValue":false,
      "removeCommand":"removeFacetField(ContentType)",
      "listValuesCommand":"listFacetValues(ContentType,or)",
      "removeValueFiltersCommand":"removeFacetValueFilter(ContentType)",
      "counts":[
        {
          "value":"Newspaper Article",
          "count":927134891,
          "isApplied":false,
          "isNegated":false,
          "isFurtherLimiting":true,
          "applyCommand":"addFacetValueFilters(ContentType,Newspaper Article)",
          "applyNegatedCommand":"addFacetValueFilters(ContentType,Newspaper Article:t)"
        },
        {
          "value":"Journal Article",
          "count":252671406,
          "isApplied":false,
          "isNegated":false,
          "isFurtherLimiting":true,
          "applyCommand":"addFacetValueFilters(ContentType,Journal Article)",
          "applyNegatedCommand":"addFacetValueFilters(ContentType,Journal Article:t)"
        },
        {
          "value":"Manuscript",
          "count":119095831,
          "isApplied":false,
          "isNegated":false,
          "isFurtherLimiting":true,
          "applyCommand":"addFacetValueFilters(ContentType,Manuscript)",
          "applyNegatedCommand":"addFacetValueFilters(ContentType,Manuscript:t)"
        },
        {
          "value":"Patent",
          "count":77808593,
          "isApplied":false,
          "isNegated":false,
          "isFurtherLimiting":true,
          "applyCommand":"addFacetValueFilters(ContentType,Patent)",
          "applyNegatedCommand":"addFacetValueFilters(ContentType,Patent:t)"
        },
        {
          "value":"Report",
          "count":62172881,
          "isApplied":false,
          "isNegated":false,
          "isFurtherLimiting":true,
          "applyCommand":"addFacetValueFilters(ContentType,Report)",
          "applyNegatedCommand":"addFacetValueFilters(ContentType,Report:t)"
        },
        {
          "value":"Book / eBook",
          "count":51142277,
          "isApplied":false,
          "isNegated":false,
          "isFurtherLimiting":true,
          "applyCommand":"addFacetValueFilters(ContentType,Book / eBook)",
          "applyNegatedCommand":"addFacetValueFilters(ContentType,Book / eBook:t)"
        },
        {
          "value":"Magazine Article",
          "count":40490601,
          "isApplied":false,
          "isNegated":false,
          "isFurtherLimiting":true,
          "applyCommand":"addFacetValueFilters(ContentType,Magazine Article)",
          "applyNegatedCommand":"addFacetValueFilters(ContentType,Magazine Article:t)"
        },
        {
          "value":"Newsletter",
          "count":26008405,
          "isApplied":false,
          "isNegated":false,
          "isFurtherLimiting":true,
          "applyCommand":"addFacetValueFilters(ContentType,Newsletter)",
          "applyNegatedCommand":"addFacetValueFilters(ContentType,Newsletter:t)"
        },
        {
          "value":"Book Review",
          "count":25193667,
          "isApplied":false,
          "isNegated":false,
          "isFurtherLimiting":true,
          "applyCommand":"addFacetValueFilters(ContentType,Book Review)",
          "applyNegatedCommand":"addFacetValueFilters(ContentType,Book Review:t)"
        },
        {
          "value":"Reference",
          "count":18650020,
          "isApplied":false,
          "isNegated":false,
          "isFurtherLimiting":true,
          "applyCommand":"addFacetValueFilters(ContentType,Reference)",
          "applyNegatedCommand":"addFacetValueFilters(ContentType,Reference:t)"
        }
      ]
    }
  ],
  "rangeFacetFields":[
    
  ],
  "didYouMeanSuggestions":[
    
  ],
  "recommendationLists":{
    
  },
  "documents":[
    {
      "hasFullText":true,
      "isFullTextHit":false,
      "isPrint":false,
      "inHoldings":true,
      "openUrl":"ctx_ver=Z39.88-2004&ctx_enc=info%3Aofi%2Fenc%3AUTF-8&rfr_id=info%3Asid%2Fsummon.serialssolutions.com&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Ajournal&rft.genre=article&rft.atitle=Driveshaft+housing+apparatus&rft.au=Griffin%2C+Clarence+A&rft.date=1901-01-01",
      "link":"http://demo.summon.serialssolutions.com/2.0.0/link/0/eLvHCXMwY2AQA7aRSnSR5l91gU1W8GBAsKOpS7iFLzCGmRhh1x4ixGgat0AxYOyC9sqSEL9wQ4ECQDYwloEkMJ6BJFEx7VIEOjo2IzGtRDsjvxTc9wcGC-hI71J4g9kdPDYDmWDPSYScLOuI6PGD6mtIj58ZmHuNzDCqDHA9GCLIIIy4m1cBWD-VghhCDEypeSIMMgh3KEDdoQB3hyiDiptriLOHLszY-MQk0CBLcklxvCGouQZscpmZGkswKFgkpgDbhmmJpsYmKSbmSZYWRuamqckGaSmgqeuUVDNJBlm8ZkgRkJdm4EL4VoaBpaSoNFWWgSUlNTcfAJ-PvRk",
      "IngestDate":[
        "Fri Oct 20 00:23:39 EDT 2017"
      ],
      "DBID":[
        "8FD",
        "F28",
        "7TB",
        "8BQ",
        "FR3",
        "JG9",
        "H8D",
        "L7M"
      ],
      "PublicationDate_xml":[
        {
          "month":"01",
          "year":"1901",
          "text":"00010101",
          "day":"01"
        }
      ],
      "Score":[
        "0.01"
      ],
      "DatabaseTitleList":[
        "Technology Research Database"
      ],
      "ID":[
        "FETCH-proquest_abstracts_17416232653"
      ],
      "PQPubID":[
        "23500"
      ],
      "AbstractList":[
        "Apparatus for further improving the efficiency of a propulsion unit having a driveshaft depending from the stern of a boat, while protecting flora and fauna in the water as well as the propulsion unit. A plate member has an upper end adapted to be positioned forward of a driveshaft housing, and to depend downwardly and rearwardly to terminate in a trailing lower end below a propeller. The plate member tapers outwardly along lateral edges from the upper end to the lower end to divert flora and fauna around and under a housing and a propeller attached thereto. A lower portion of the plate member is divided into a plurality of spaced plate-like components defining passageways therebetween to enable water to flow therethrough for more efficient operation of a propeller. At the same time, the forward surfaces of the plate-like components react with passage of water when under way to urge a boat's stern upwardly to a more efficient hull operating position."
      ],
      "Language":[
        "English"
      ],
      "Author":[
        "Griffin, Clarence A"
      ],
      "PublicationCentury":[
        "1900"
      ],
      "IsScholarly":[
        "false"
      ],
      "PublicationDecade":[
        "1900"
      ],
      "Snippet":[
        "Apparatus for further improving the efficiency of a propulsion unit having a driveshaft depending from the stern of a boat, while protecting flora and fauna in..."
      ],
      "ProviderPackageCode":[
        "8FD",
        "7TB",
        "8BQ",
        "F28",
        "FR3",
        "JG9",
        "H8D",
        "L7M"
      ],
      "SubjectTerms":[
        "Boats",
        "Hulls (structures)",
        "Housing",
        "Passageways",
        "Hulls",
        "Propulsion",
        "Propellers"
      ],
      "ContentType":[
        "Government Document"
      ],
      "SourceType":[
        "Index Database"
      ],
      "Author_xml":[
        {
          "sequence":"1",
          "fullname":"Griffin, Clarence A"
        }
      ],
      "Abstract":[
        "Apparatus for further improving the efficiency of a propulsion unit having a driveshaft depending from the stern of a boat, while protecting flora and fauna in the water as well as the propulsion unit. A plate member has an upper end adapted to be positioned forward of a driveshaft housing, and to depend downwardly and rearwardly to terminate in a trailing lower end below a propeller. The plate member tapers outwardly along lateral edges from the upper end to the lower end to divert flora and fauna around and under a housing and a propeller attached thereto. A lower portion of the plate member is divided into a plurality of spaced plate-like components defining passageways therebetween to enable water to flow therethrough for more efficient operation of a propeller. At the same time, the forward surfaces of the plate-like components react with passage of water when under way to urge a boat's stern upwardly to a more efficient hull operating position."
      ],
      "PublicationYear":[
        "1901"
      ],
      "Title":[
        "Driveshaft housing apparatus"
      ],
      "PublicationDate":[
        "00010101"
      ],
      "Genre":[
        "Patent"
      ],
      "DatabaseTitle":[
        "Technology Research Database",
        "Aerospace Database",
        "ANTE: Abstracts in New Technology & Engineering",
        "METADEX",
        "Advanced Technologies Database with Aerospace",
        "Engineering Research Database",
        "Mechanical & Transportation Engineering Abstracts",
        "Materials Research Database"
      ],
      "MergedId":[
        "FETCHMERGED-proquest_abstracts_17416232653"
      ],
      "PQID":[
        "1741623265"
      ],
      "IsPeerReviewed":[
        "false"
      ],
      "LinkModel":[
        "OpenURL"
      ],
      "BookMark":[
        "ePnHCXMw42SQcSkCnZiakZhWopCRD1q-na6QWAA-ybq0mJtBxc01xNlDF1bwxScmgfr0ySXF8Yag1gGwhjcD3VRMlDIAzgAjUA"
      ],
      "DatabaseName":[
        "METADEX",
        "Materials Research Database",
        "Aerospace Database",
        "Advanced Technologies Database with Aerospace"
      ]
    },
    {
      "hasFullText":true,
      "isFullTextHit":false,
      "isPrint":false,
      "inHoldings":true,
      "openUrl":"ctx_ver=Z39.88-2004&ctx_enc=info%3Aofi%2Fenc%3AUTF-8&rfr_id=info%3Asid%2Fsummon.serialssolutions.com&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Ajournal&rft.genre=article&rft.atitle=US+Patent+Issued+to+Ansell+Healthcare+Products+on+July+5+for+%22Glove+with+Hand-Friendly+Coating+and+Method+of+Making%22+%28Malaysian%2C+American+Inventors%29&rft.jtitle=US+Fed+News+Service%2C+Including+US+State+News&rft.date=2011-07-09&rft.pub=HT+Media+Ltd&rft.externalDocID=2394283051",
      "link":"http://demo.summon.serialssolutions.com/2.0.0/link/0/eLvHCXMwhV1LS8NAEB60XjxZUfFVGIoFBWNr09jkJKU1VCFYqOKxrN2tlzYbk_TQn-DdH-zMpgnBgt7CDmxmmWH223kCHBFGSq1S_NUiyGqcAeOeM3hzA5JwqW5_LdHcEBrrLPWUHeNNAtOO69H7_D76tHhSFEdU12MztmGnTe8r1uSg_Vy-0jyndbthWo358_fgK__vh77hAVWMs0i87AeIVXaN6LgZJb-IRXtGTlQjFeKq203GaXXNOn0VzDdsv8R-wx5kB6hClQ1ZJCIVYy_Tk33YUuEBfL-OcURYM0zRDOGTmGrscYn6HIdFXhiOsqawCeoQn5bzFTpISBfrJv0T2ZGLQxFKy-eWyZLofS04mRppEQMzoRr1DAMz96qOl4GYixXXbl5jHi_CR5P7ruPk6hAu_IeX_tDKTzwJc_aTSXFY-xjQFZJQ5Ew4dkd2uu-e2-46atqaSQ5yS3V3ArU_9zj9h34Gu5lrt2u1vHOopPFS1aAi1UL_AMOUyao",
      "ExternalDocumentID":[
        "2394283051"
      ],
      "IngestDate":[
        "Wed Jul 26 01:09:47 EDT 2017"
      ],
      "DBID":[
        "8FX",
        "M2O",
        "M1Q",
        "R06",
        "Q9U",
        "GUQSH",
        "7XB",
        "AZQEC",
        "S0X",
        "HCIFZ",
        "8FK",
        "BGLVJ",
        "ABUWG",
        "BENPR",
        "88F",
        "8G5",
        "MBDVC",
        "DWQXO",
        "3V.",
        "GNUQQ"
      ],
      "PublicationDate_xml":[
        {
          "month":"07",
          "year":"2011",
          "text":"20110709",
          "day":"09"
        }
      ],
      "Score":[
        "0.01"
      ],
      "PublicationPlace":[
        "Washington, D.C"
      ],
      "URI":[
        "https://search.proquest.com/docview/875589202"
      ],
      "PublicationPlace_xml":[
        {
          "name":"Washington, D.C"
        }
      ],
      "Publisher_xml":[
        {
          "name":"HT Media Ltd"
        }
      ],
      "ID":[
        "FETCH-proquest_newspapers_8755892023"
      ],
      "GeographicLocations":[
        "ALEXANDRIA, Va"
      ],
      "PQPubID":[
        "29619"
      ],
      "Publisher":[
        "HT Media Ltd"
      ],
      "Language":[
        "English"
      ],
      "PublicationCentury":[
        "2000"
      ],
      "IsScholarly":[
        "false"
      ],
      "PublicationDecade":[
        "2010"
      ],
      "PublicationTitle":[
        "US Fed News Service, Including US State News"
      ],
      "ProviderPackageCode":[
        "8FX",
        "M2O",
        "M1Q",
        "R06",
        "Q9U",
        "GUQSH",
        "AZQEC",
        "7XB",
        "HCIFZ",
        "S0X",
        "BGLVJ",
        "8FK",
        "ABUWG",
        "BENPR",
        "88F",
        "8G5",
        "MBDVC",
        "DWQXO",
        "3V.",
        "GNUQQ"
      ],
      "ContentType":[
        "Newspaper Article"
      ],
      "SourceType":[
        "Aggregation Database"
      ],
      "PublicationYear":[
        "2011"
      ],
      "SSID":[
        "ssib000829501"
      ],
      "Title":[
        "US Patent Issued to Ansell Healthcare Products on July 5 for \"Glove with Hand-Friendly Coating and Method of Making\" (Malaysian, American Inventors)"
      ],
      "PublicationDate":[
        "20110709"
      ],
      "DatabaseTitle":[
        "ProQuest Central K12",
        "ProQuest Central Basic",
        "SIRS Editorial",
        "SciTech