Endpoints and parameters

Note:

The POST and GET methods have the same semantic here, they only get data from the database, nothing is added or removed from it.

/search/[target_name]

Search in the Elasticsearch database with filters.

target_name is optional and it can be for instance /search/Mars
If it's not specified the search will be performed on every target names (Mars, Venus...).
It can be useful to get the list of the target names for example, with: /search?distinct=true&fields=target_name

Return

If moc_group is NOT in the parameters

Returns an array of objects.
Each object corresponds to an item that matches with the query. The keys of each object are the fields returned and the values of each key is the value of this field.
If none were provided then we have all of the fields of the current element.

If moc_group IS in the parameters

Returns an object.
Each key of this object corresponds to a value of the field specified in moc_group.
The value of associated to a key, is the MOC created by merging all of the MOCs of the items that matched with the query and whose moc_group field value is equal to the key.

Accepted request methods

GET and POST.
If a MOC is provided it's recommended to send it in a POST query since it may be too large for GET.

List of accepted parameters

size: (integer) Max number of results
fields: (list of strings or string) List of the fields returned
moc: (list of objects) MOCs that define the searched areas. It's a list of objects. Each object is a MOC and its keys are 'json' and 'bounds'. 'json' is the MOC JSON data and 'bounds' is a dictionnary of ra, dec coordinates ranges (arrays of 2 floats) defining the bounds of this MOC. Bounds are not necessary, but providing them increase the number of results.
moc_group: (string) If it's not null then we group the MOCs by this field and we return a dictionnary, where each key is a value of this field and each value is the MOC created by merging all the MOCs with the same value for this field
distinct: (string or boolean) If it's true, then we return for each fields a list of distinct values. If it's a string if it's not equal to "true" then it's considered as False
exclude_selected: (list of strings). Each string is a field name whose values are excluded from the search (MUST NOT instead of MUST)
Any field of the Elasticsearch database. Those are used to add constraints to the query (e.g. dataproduct_type = "ci", will only return elements where dataproduct_type == "ci")

moc_group and distinct can't be used simultaneously since they return different types of results, and if both are present, then distinct will be used instead of moc_group

/help

Display this help page.
"/" redirects to this page by default.

/hips/[target_name]

Get a list of HiPS for the given target_name.

target_name is NOT optional
You can give the name of a HiPS as a parameter to search for it, for example: /hips/Mars/Mars%20MRO%20CTX

Return

Returns an array of objects.
Each object corresponds to a HiPS that matches with the query.
The object data is as followed (object keys are in bold):

name: (string) name of the HiPS
urls: (list of strings) URLs that can be used to access the HiPS data
order: (integer) Order of the HiPS (please refer to the HiPS documentation described by the IVOA)
imgFormat: (list of strings) Available formats of the HiPS data (e.g. ['fits','png'])

Accepted request methods

GET and POST.

List of accepted parameters

hips_name: (string) Name of the HiPS searched

/hips/properties

Get the HiPS properties of the HiPS given in the parameters.

Return

Returns an object corresponding to the searched HiPS.
Each key and values corresponds to a property parameter
Those properties are for example in the format at: Example

Accepted request methods

GET and POST.

List of REQUIRED parameters

hips_name: (string) Name of the HiPS searched

/moc/from-points

Create a MOC from a list of points (those points define the borders).
The points order is important.

Return

Returns an object corresponding the MOC in JSON format
For more information about the MOC format, refer to the IVOA MOC documentation.

Accepted request methods

POST.

List of REQUIRED parameters

points: (list of list of floats) Points that define the MOC. Each item of the list is a point defined by a list of two floats (ra and dec)

/hips/from-hips/[target_name]/[order]

Create a MOC from a HiPS.

target_name and order are NOT optional
order is the order of the created MOC as defined by the IVOA.

Return

Returns an object corresponding the MOC in JSON format
For more information about the MOC format, refer to the IVOA MOC documentation.

Accepted request methods

GET and POST.

List of REQUIRED parameters

hipsName: (string) Name of the HiPS from which we create a MOC
min: (float) Minimum value that must be contained by the HiPS tiles that will be in the new MOC
max: (float) Maximum value that must be contained by the HiPS tiles that will be in the new MOC
url: (string) URL of the HiPS

/moc/from-hips/max-order/[target_name]

Get the max order that can have a MOC generated from the given HiPS.

target_name is NOT optional

Return

Returns an integer corresponding to the max order.

Accepted request methods

GET and POST.

List of REQUIRED parameters

hipsName: (string) Name of the HiPS from which we create a MOC
url: (string) URL of the HiPS

/moc/center

Get the center of a MOC

Return

Returns the array of floats [ra,dec] that corresponds to the coordinates of the center of the given MOC

Accepted request methods

POST.

List of REQUIRED parameters

moc: (object) MOC object in JSON as defined by the IVOA

/moc/from-str/

Create a MOC in JSON from a string in ASCII.

Return

Returns the MOC in JSON

Accepted request methods

GET & POST.

List of REQUIRED parameters

str: (str) String defining a MOC in ASCII