REGARDS complex search API

This page assumes you know how to authenticate your REST API requests

Introduction

This section describes how to:

• do complex search searches on the catalog with multiple search requests.
• request the attributes of the data objects recovered from a given request.
• get a summary for a given dataset

The complex search handles the different available search engines, which must be precised in the engineType parameter.

REST API

How to

The Regards REST API concept describes how REST interfaces must be handled to submit requests.

Multiple search requests

Endpoint

Endpoint	Verb
/api/v1/rs-catalog/complex/search	POST

Request body format

dataTypes	Array of strings Items Enum: "RAWDATA" "QUICKLOOK_SD" "QUICKLOOK_MD" "QUICKLOOK_HD" "DOCUMENT" "THUMBNAIL" "OTHER" "AIP" "DESCRIPTION"
page	integer <int32>
	Array of objects (SearchRequest) [ 0 .. 100 ] items
size	integer <int32>

Example :

{
  "dataTypes": ["RAWDATA"],
  "page": 0,
  "requests": [
    {
      "datasetUrn": "string",
      "engineType": "string",
      "entityIdsToExclude": ["string"],
      "entityIdsToInclude": ["string"],
      "searchDateLimit": "2019-08-24T14:15:22Z",
      "searchParameters": {
        "all": {
          "property1": "string",
          "property2": "string"
        },
        "empty": true,
        "property1": ["string"],
        "property2": ["string"]
      }
    }
  ],
  "size": 0
}

Search attributes

Endpoint

Endpoint	Verb
/api/v1/rs-catalog/complex/search/dataobjects/attributes	POST

Request body format

datasetUrn	string
engineType required	string
entityIdsToExclude	Array of strings [ 0 .. 1000 ] items
entityIdsToInclude	Array of strings [ 0 .. 1000 ] items
searchDateLimit	string <date-time>
	object

Example :

{
  "datasetUrn": "string",
  "engineType": "string",
  "entityIdsToExclude": ["string"],
  "entityIdsToInclude": ["string"],
  "searchDateLimit": "2019-08-24T14:15:22Z",
  "searchParameters": {
    "all": {
      "property1": "string",
      "property2": "string"
    },
    "empty": true,
    "property1": ["string"],
    "property2": ["string"]
  }
}

Compute Datasets Summary

Endpoint

Endpoint	Verb
/api/v1/rs-catalog/complex/search/summary	POST

Request body format

dataTypes	Array of strings Items Enum: "RAWDATA" "QUICKLOOK_SD" "QUICKLOOK_MD" "QUICKLOOK_HD" "DOCUMENT" "THUMBNAIL" "OTHER" "AIP" "DESCRIPTION"
page	integer <int32>
	Array of objects (SearchRequest) [ 0 .. 100 ] items
size	integer <int32>

Example :

{
  "dataTypes": ["RAWDATA"],
  "page": 0,
  "requests": [
    {
      "datasetUrn": "string",
      "engineType": "string",
      "entityIdsToExclude": ["string"],
      "entityIdsToInclude": ["string"],
      "searchDateLimit": "2019-08-24T14:15:22Z",
      "searchParameters": {
        "all": {
          "property1": "string",
          "property2": "string"
        },
        "empty": true,
        "property1": ["string"],
        "property2": ["string"]
      }
    }
  ],
  "size": 0
}