Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Returns the encrypted and signed version of the query and other query parameters. This encrypted query can then be used with the `Query Items` endpoint using `encrypted_query` parameter to get items matching the encrypted query.

Parameters:
  • tenant – User tenant.
  • project_id – Project identifier.
JSON Data:

Data is passed in as a JSON object.

Valid object keys:

    • querySearch query to be encrypted.
    • aggregationsDictionary of aggregations to execute on matching items to be encrypted.
    • created_beforeDate and Time value limiting the returned items to items that have been created before this date to be encrypted.
    • created_afterDate and Time limiting the returned items to items that have been created after this date to be encrypted
    • options – Dictionary of options influencing the result-set to be encrypted.
      • Currently, only the 'template_params' property of 'options' dict is encrypted even though the 'options' parameter support much more variables with the `Query Items` resource
    • fieldsComma-separated list of fields to be encrypted.

Example request body:

Code Block
languagejs
{
	"query": "Hitachi"
,
Headers:See Common Headers.
Status Codes:
  • 200 – Results returned.

See also Common Status Codes.

Returns:

Response fields:

  • encrypted_query – Encrypted version of `query` and any other parameters ('aggregations', 'options') if specified.

Code Block
js
js
{
	'encrypted_query': 'YR4h147YAldsARmTmIrOcJqpuntiJULXPV3ZrXblVWvbCavvESTw4Jis6sTgGC9a1LhrLd9Nq-77CNX2eeieMEDnPFPRqlPGO8V'
}

 

List Items (deprecated)

GET https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/items

...