Export server documentation

URL construction

To request the server, you need to construct a correct URL. Just below you can find the URL schema and a description of mandatory parameters:

{{ apiPath }}/search/dataset?a=id_attribute&c=id_attribute::operator::value
  • dataset: dataset in which to search. See datasets section for available datasets.
  • a: output parameters as attributes id list semicolon separated. See outputs section for available attributes.
  • a=1;2;3
  • c: criteria list separeted with semicolon. A criterion is defined by an id_attribute, an operator and a value. See operators section for available operators.
  • c=3::eq::ping;2::eq::pong

Available parameters

Datasets
dataset description
l1 L0 & L1 products list
products SR3 & SR4 products list
sp_cards Contains metadata of scientific products (Core Program & General Program)
Outputs
L0/L1 output list
id attribute
1 rawproduct_id
2 filename
3 level
4 obs_id
5 obs_seq
6 obs_num
7 obs_type
8 object_id
9 source_id
10 apid
11 category
12 instrument
13 detector
14 version
15 ext_name
16 ext_rel
17 group_name
18 packet_id
19 start_stime
20 end_stime
21 conf_min
22 conf_max
23 temp_low
24 temp_high
Scientific products output list
id attribute
1 product_id
2 obs_id
3 sp_acronym
4 filename
5 criteria
6 added_at
7 version
8 program
9 instrument
10 type
SP Metadata output list
id attribute
1 acronym
2 sp_id
3 version
4 program
5 instrument
6 type
7 json_schema
8 search_kw
9 json_schema_uploaded
Operators
operator description usage example
eq equal to c=id_attribute::eq::value c=1::eq::89
neq not equal to c=id_attribute::neq::value c=1::neq::89
gt greater than c=id_attribute::gt::value c=1::gt::1.5
gte greater than or equal to c=id_attribute::gte::value c=1::gte::2
lt lower than c=id_attribute::lt::value c=1::lt::1.5
lte lower than or equal to c=id_attribute::lte::value c=1::lte::2
bw between c=id_attribute::bw::value_min|value_max c=1::bw::10|90
lk like c=id_attribute::lk::value c=1::lk::ECL
nlk not like c=id_attribute::nlk::value c=1::nlk::ECL
in in c=id_attribute::in::value_x|value_y|value_z c=1::in::TT_ECL|TT_GRM|TT_VT
nin not in c=id_attribute::nin::value_x|value_y|value_z c=1::nin::TT_ECL|TT_GRM|TT_VT
nl is null c=id_attribute::nl c=1::nl
nnl is not null c=id_attribute::nnl c=1::nnl
js json c=id_attribute::js::extension,keyword|operator|value c=1::js::PrimaryHDU,OBS_ID|eq|45

Examples

{{ apiPath }}/search/l1?a=1;2;3&c=1::eq::1

This will return the raw product with id equals to 1 and display its rawproduct_id, filename and level as outputs.

{{ apiPath }}/search/products?a=1;2;3;4;5;6;7;8;9;10&c=3::in::TT_ECL|TT_GRM

This will return a list of TT_ECL or TT_GRM products with all available outputs.

{{ apiPath }}/search/products?a=1&c=3::eq::LAMTEST_DC1;5::js::PrimaryHDU,OBS_ID|nnl

This will return a list of product id of LAMTEST_DC1 scientific product where the searchable keyword OBS_ID is not null.