SSA AIO User`s Manual - Science Archives at ESAC
Contents
1. 11 PRODUCT METADATA NUMCHOPCYC numChopOyc LONG 1 1 PRODUCT METADATANUMHIFISAA numHifisaa LONG PRODUCT METADATANUMJIGGLEPOS numJiggiePos LONG 1 PRODUCT METADATANUMNODCYC mnumNodyc LONG __ PRODUCT_ METADATA NUMPACSSAA numPacsSaa LONG 1 PRODUCT METADATA NUMRASIERCOL mnumRaserCl LONG 1 1 PRODUCT METADATA NUMRASTERLINES mumRasterlimes LONG 1 PRODUCT METADATA NUMSCANLINES numScnlins LONG poo 1 PRODUCT METADATA NUMSPECTRA mumSpedra LONG poo 1 PRODUCT METADATA NUMSPIRESAA mumSpireSaa LONG poo 1 PRODUCT METADATAOBSID obid INTEGER 1 PRODUCT METADATAOBJECT object STRING o 1 PRODUCT METADATAOBJECTTYPE objectType SIRING ooo 1 PRODUCT METADATAOBSERVER observe STRING poo 1 PRODUCT METADATA OBSMODE obsMode STRING PRODUCT METADATAODNUMBER odNumber LONG iti Page 19 21 SSA AIO User s Manual Date 19 09 2012 Issue 1 Rev 0 ESA UNCLASSIFIED For Official Use 1 PRODUCT METADATA OFFPOSFLAG offPosHlag BOOLEAN PRODUCT METADATA ONTARGETFLAG onTargetElag BOOLEAN 1 1 PRODUCT METADATAORIGIN origin STRING 11 PRODUCT METADATA OUTOFFIELDFLAG outOfFieldFlag BOOLEAN 11 PRODUCT METADATAPIXELROW pixlRow INIEGER PRODUCT METADATAPOINTINGMODE pointingMode STRING oo PRODUCT METADATAPOSANGLE pos nde DOUBLE P2. DOUBLE OBSERVATIONPROP END PROPEND DATE OBSERVATIONPROP END EXPIRATION DATE OBSERVATIONSTART TIME START TIME DATE OBSERVATIONEND TIME ENDTIME DATE oC OBSERVATIONOBSERVER OBSERVER STRING PoC OBSERVATIONOD NUMBER OD NUMBER INTEGER OBSERVATIONAOR A0R STRING PRODUCT HCSS URN H CSSURNN STRING PRODUCT HCSS FILE NAME FILENAME STRING PRODUCT HCSS FILE NAME HOSS FILE NAME STRING __ PRODUCT HCSS TRACK VERSION VERSION INTEGER __ PRODUCT HCSS TRACK VERSION HOSS TRACK VERSION INTEGER PRODUCEHCSS URN VERSION HCSSURN VERSION INTEGER __ PRODUCT HCSS TRACK ID HOSS TRACK ID STRING O PRODUCLHCSS SIZE HCSS SIZE INTEGER __ PRODUCT HCSS TOTAL SIZE HCSS TOTAL SIZE INTEGER o PRODUCTHCSS HASH HOSS HASH STRING ooo PRODUCLHCSS CLASS PATH HOSS CLASS PATH _ STRING poo PRODUCT METADATAACTIVESTRID acivSrid STRING po PRODUCT METADATAAORIABEL aorlabl STRING poo PRODUCT METADATAAOT lat STRING PRODUCT METADATAAPERTURE aperture STRING Page 17 21 SSA AIO User s Manual European Space Agency Date 19 09 2012 Issue 1 Rev 0 Agence spatiale europ enne ESA UNCLASSIFIED For Official Use 1 PRODUCT METADATAAPID pid SC STRING 1 1 PRODUCT METADATA ARRAYNAME amayName STRING PRODUCT MET
3. Date 19 09 2012 Issue 1 RevO Agence spatiale europ enne ESA UNCLASSIFIED For Official Use 1 INTRODUCTION Within the ESA s Science Operations Department the SAT in ESAC Spain is responsible of developing and maintaining ESA Scientific Archives For the Herschel Science Archive HSA the standard way to access to this ESA archive is through a powerful Java interface http archives esac esa int hsa ui hui jnlp To allow the access to external applications and expert or normal users that need to retrieve data directly from the archive bypassing the Java User Interface an integrated Archive Inter Operability system AlO has been developed for HSA This AlO system can be accessed using standard HTTP requests This subsystem shares the core system of the standard HSA User Interface It is normally called using scripts application code or command line tools Capabilities e Observation Retrieval It allows the user to obtain one single observation file e Product Retrieval It allows the user to obtain the products associated to a determinate observation e Observation Product Search It allows the user to discover observations or products that fulfill a certain search criteria Multiple Observation Products Search Retrieval By combining the two previous points the HAIO allows the download of all the observations or all products that fulfill a certain search criteria by using pagination internally This inte
4. DATE poo 1 PRODUCT METADATACREATOR creator STRING 1 PRODUCT METADATACROTA2 owt2 DOUBLE 1 PRODUCT METADATACRPIX1 pict DOUBLE PRODUCT METADATACRPIX2 capi DOUBLE PRODUCT METADATA CDS 2 Page 18 21 SSA AIO User s Manual Date 19 09 2012 Issue 1 Rev 0 ESA UNCLASSIFIED For Official Use DOUBLE DOUBLE PRODUCT METADATADEC deco DOUBLE STRING STRING STRING STRING STRING ATE PRODUCT METADATA DECNOMINAL DOUBLE PRODUCT METADATA DECOB ECT decObject DOUBLE po ol PRODUCT METADATA DELTAPIX DOUBLE poo o oO PRODUCT_METADATA DESCRIPTION i OUBLE DOUBLE DOUBLE DOUBLE STRING LONG STRING STRING PRODUCT METADATA GYROPROPQUALIDX gyroPropQualldx DOUBLE PRODUCT METADATAINSTRUMENT instrument G 1 PRODUCT METADATAINSTMODE insiMode STRING 111 PRODUCT METADATAINTERPMETHOD interpMethod STRING 1 PRODUCT METADATAJIGGLEID jigdeld LONG 1 PRODUCT METADATAKEYWAVELENGTH keyWavelengh_ DOUBLE 1 PRODUCT METADATALEVEL level STRING PRODUCT METADATA MAXWAVELENGTH maxWavelength DOUBLE PRODUCT METADATA MINWAVELENGTH minWavelength DOUBLE po PRODUCT METADATA MISSIONCONFIG missionConfig STRING PRODUCT METADATA MODELNAME modelName STRING 1 1 PRODUCT METADATANAIFID naa STRING PRODUCT METADATA NODCYCLENUM nodCydeNum LONG
5. 52 e Download all Auxiliary products that belongs to an observation which observation id is 1342231052 http archives esac esa int hsa aio jsp product jsp PROTOCOL HTTPGOBSID 1342231 052 amp PRODUCT LEVEL Auxiliary amp SPROTOCOL HTTP e Download all Auxiliary products that belongs to an observation which observation id is 1342231052 in a Tarball compressed http archives esac esa int hsa aio jsp product jsp PROTOCOL HTTP amp OBSID 1342231 052 amp PRODUCT LEVEL Auxiliary amp COMPRESSION TARGZ amp PROTOCOL HTTP Download a XML ingestion request file name Page 13 21 SSA AIO User s Manual Date 19 09 2012 Issue 1 Rev 0 ESA UNCLASSIFIED For Official Use http archives esac esa int hsa aio jsp product jsp requestfile xml C herschel spire ia cal SpireCal 23509 xml amp PROTOCOL HTTP 3 2 Product postcard requests A Product postcard request will provide as response a JPG file This file contains the product postcard associated to an observation and should be ingested into HSA The file name shall follow some rules specified in the HSA HCSSICD Parameter Name s Description Mandatory Possible Values Unique identifier of the OBSERVATION_ ID observation we want to YES Any integer value retrieve RETRIEVAL TYPE la D canine POSTCARD Case POSICARD Table 4 Postcard request parameters Examples e Postcard of observation with identifier 1342211606 http archives esac esa int
6. ADATAAUTHOR author STRING 1 PRODUCT METADATAAVERAGING averaging STRING PRODUCT METADATABAND band STRING poo PRODUCT METADATA BASELINEMODEL baselineModel STRING 1 PRODUCT METADATABASELINEPARAMS baselineParams STRING PRODUCT METADATABBCOUNT bbCount INTEGER 1 1 PRODUCT METADATABBID bbid INTEGER 1 1 PRODUCT METADATABBTYPE bblype INTEGER 11 PRODUCT METADATABBIYPENAME bbTypeName STRING poo 1 1 PRODUCT METADATABIASMODE biasMode STRING oo 1 PRODUCT METADATABIASFREQ biasFrq DOUBLE oo 1 PRODUCT METADATABIASVOLTAGE biasVoltage DOUBLE o 1 PRODUCT METADATABITPOS bitPos INTEGER NG O G I STRI INTEGER DOUBLE NG STRIN PRODUCT METADATACD1 1 om1 DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE PRODUCT METADATA CD3 1 DOUBLE DOUBLE DOUBLE H 1 2 3 1 2 3 1 2 3 PRODUCT METADATAPCL1 pci DOUBLE PRODUCT METADATA PCL2 12 DOUBLE PRODUCT METADATAPCL3 pa3 DOUBLE DOUBLE 3 8 38 B CO IN DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE 1 PRODUCT METADATA CHANGELOG changelog STRING 1 1 PRODUCT _METADATA CHOPPERPLATEAU chopperplateu_ INTEGER P PRODUCT METADATA CONSIVELELAG oonstVellag BOOLEAN P PRODUCT METADATA CONVERSIONFACIOR conversionFactor DOUBLE poo 1 1 PRODUCT METADATA CREATIONDATE creationDate
7. ESA UNCLASSIFIED For Official Use DOCUMENT MA esac European Space Astronomy Centre P O Box 78 28691 Villanueva de la Cafiada Madrid Spain T 34 91 8131 100 F 34 91 8131 139 www esa int HSA Archive Inter Operability AIO System User s Manual Prepared by MHS Reference Issue 1 Revision 0 Date of Issue 19 09 2012 Status Draft Document Type UM Distribution European Space Agency Agence spatiale europ enne ESA UNCLASSIFIED For Official Use Title Revision 0 Date 19 09 2012 Issue 1 Approved by Date Reason for change Issue Revision Date Issue 1 Revision 0 Reason for change Page 2 21 SSA AIO User s Manual Date 19 09 2012 Issue 1 Rev 0 ESA UNCLASSIFIED For Official Use Table of contents A NO 4 A s asasi 4 2 METADATA REQUEST Ss z cosoinoocosinnsesoaannnsehlanknaossahundonnnananananana no nna sann b nda nd a a es dns i e ak o i a 6 2 1 Metadata Request IA 6 2 2 Use of QUERY parameter an r a rr rk RA 9 3 DATA REQUESTS Hn 11 3 1 Product reguestS AN 11 3 2 Product postcard TeqUests sssssssssisiiisessssiniesessceieiesesnisesese er enerneteneerenebenereteb bereret neneetsreteterset nceder ndedese nis es 14 Ded A DE i o i i i i i RO 15 4 LIST OF HSA ENTITIES AND ATTRIBUTES 17 Page 3 21 SSA AIO User s Manual European Space Agency
8. ION ID parameter The followingis a list with the possible If PRODUCT LEVEL values is ALL an HSA Tarball wit the complete BE observation is generated PRODUCT LEVEL and served through HTTP connection IfPRODUCT LEVEL is equal to any of Auxiliary Calibration Level2 5 etc An HSA Tarball with the selected products is generated and served Page 12 21 SSA AIO User s Manual Date 19 09 2012 Issue 1 Rev 0 ESA UNCLASSIFIED For Official Use If this parameter is present a Tar COMPRESSION compressed in tar gz format is generated and served through HTTP the connection Table 3 Product request parameters Examples e File of observation with identifier 1342231052 http archives esac esa int hsa aio jsp product jsp PROTOCOL HTTP amp OBSERVATION _ID 1342231052 e Retrieve a product which URN is urn hsa herschel spire ia dataset NhkTimeline 1045695 http archives esac esa int hsa aio jsp product jsp PROTOCOL HTTPG amp URN um hsa h erschel spire ia dataset NhkTimeline 1045695 amp PROTOCOL HTTP e Download a FITS file containing only product metadata http archives esac esa int hsa aio jsp product jsp PROTOCOL HTTPG amp URN um hsa h erschel spire ia dataset NhkTimeline 1045695 METADATA TRUESPROTOCOL HTTP e Retrieve a product which metadata field obsid is 1342231052 http archives esac esa int hsa aio jsp product jsp PROTOCOL HTTP amp OBSID 1342231 0
9. NG 1 PRODUCT METADATASPECNUM spcNum LONG o 1 PRODUCT METADATA SPECTRALRESOLUTION spectralResolution DOUBLE PRODUCT METADATASTARIDATE startDate DATE 1 PRODUCT METADATASTARTWAVELENGTH statWavdengh DOUBLE o PRODUCT METADATASTATUS status STRING oo PRODUCT METADATASTRINTERLACINGSTATUS strinterlacingStatus BOOLEAN PRODUCT METADATASTROUALIDX stiQualdx DOUBLE PRODUCT METADATA SUBINSTRUMENTID subinstrumentid STRING 1 1 PRODUCT METADATASUBSYSTEM subsystem STRING PRODUCT METADATATELESCOPE teesope STRING 11 PRODUCT METADATATEMPERATURE temperatwe DOUBLE 11 1 PRODUCT METADATATYPE type STRING 1 PRODUCT METADATAVARIABILITY variability SIRING 1 PRODUCT METADATAVERSION version STRING PRODUCT METADATA WAVELENGTHID wavelenghid______ INTEGER z ii ii Page 20 21 SSA AIO User s Manual Date 19 09 2012 Issue 1 Rev 0 ESA UNCLASSIFIED For Official Use Page 21 21 SSA AIO User s Manual European Space Agency Date 19 09 2012 Issue 1 Rev 0 Agence spatiale europ enne
10. O User s Manual European Space Agency Date 19 09 2012 Issue 1 Rev 0 Agence spatiale europ enne ESA UNCLASSIFIED For Official Use AS AA If it is specified and the number of results are greater that the specified value a VOTable containing an error is returned TRUE means that each VOT able record will SHOW PROPRIETARY contain a field that NOT TRUE specifies proprietary rights access TRUE means that the NOT TRUE FALSE results must contain only Table 1 Metadata reguest parameters Integer value less than 25000 HSA Hard Limit public observations whereas FALSE means that results must contain only proprietary observations In addition to all these parameter names simple attribute restrictions can be added as Entity Attribute value to the metadata request for example INSTRUMENT NAME PACS Once again the possible values for this Entity and Attribute fields need to be compliant with the List of SSA entities and attributes Please note that for metadata requests e Dates are expressed in DD MM YYYY format and contained inside apostrophes e HTTP prefix and parameters are separated by a question mark e Requests are build using parameter value sentences separated by an ampersand amp Let s see the use of all the above through some examples e Get the greatest HCSS URN VERSION of an HCSS CLASS TYPE in VOTable format http archives esac esa int hsa aio jsp metad
11. RODUCT METADATA PROPOSAL proposal STRING INTEGER INTE Lui sg PRODUCT METADATARA ra _ DOUBLE o PRODUCT METADATARADESYS raDesys INTEGER 1 PRODUCT METADATARAERR raEm DOUBLE poo PRODUCT METADATA RANOMINAL raNominal DOUBLE poo 1 PRODUCT METADATARAOBJECT mObjet DOUBLE poo 1 PRODUCT METADATA RASTERCOLUMNNUM raserColumnNum SHORT poo PRODUCT_METADATA RASTERLINENUM reserlinNum SHORT PRODUCT METADATAREADOUTS readous SIRING o 1 1 PRODUCT METADATAREFERENCES references STRING 11 PRODUCT METADATAREFPIXEL refPxd 1 LONG PRODUCT METADATAROLL roll DOUBLE PRODUCT METADATASAA m DOUBLE po PRODUCT METADATASATURATION saturacion DOUBLE 1 1 1 PRODUCT METADATASATVALUESSIGNED satValuesSigned INTEGER o 1 PRODUCT METADATASATVALUESUNSIGNED satValuesUnsigned INTEGER 1 PRODUCT METADATA SCANLINENUM scalineNum SHORT PRODUCT METADATASCOPE scope STRING pT PRODUCT METADATASEDVERSION sedVersion STRING oo PRODUCT METADATASERENDIPITYFAG___ serendipityFlag BOOLEAN 11 PRODUCT METADATASIAMID sama STRING PRODUCT METADATA SKYRESOLUTION skyResolution DOUBLE PRODUCT METADATASLEWFLAG slwHag STRING PRODUCT METADATASOURCE source STRING PRODUCT METADATASOURCEDETECTOR sourceDetector STRING 1 1 PRODUCT METADATASOURCESMEC sourceSmec STRI
12. amp EXPIRED FALSE amp PAGE SIZE 1000 amp PAGE 2 amp RETURN TYPE ZVOTABLE When requesting in VOTABLE format eg SELECTED FIELDS OBSERVATION additional information will be provided for each result e A Data Link to retrieve the file e A Postcard Link to retrieve its postcard the default one if it does not exist e A Details Link to retrieve more precise information about this observation Page 8 21 SSA AIO User s Manual European Space Agency Date 19 09 2012 Issue 1 Rev 0 Agence spatiale europ enne ESA UNCLASSIFIED For Official Use 2 2 Use of QUERY parameter In the metadata request the Keyword value paradigm creates simple queries using the AND argument as logical operator If a user wants to create a complex request by using gt lt gt lt like including SQL wildcards and or operators he she will have to use the QUERY parameter The rest of the keyword parameters will be seen as other AND conditions The value of this query field should be URL encodeds Inside the value of the QUERY parameter we allow any J ython valid query expression which makes use of SSA attributes see List of SSA entities and Attributes Jython query operations are slightly different to the SOL ones as stated in this table QUERY Operators Precedence Symbol pom EC CN me s o LIKE gt MULTIPLE CHARACTERS Relational 2 LIKE gt ONE CHARACTER Ft ES D ft amp Table 2 QUERY parameter ope
13. ata sp RESOURCE CLASS HCSS CLASS TYPE amp HCSS CLASS TYPE herschel ia dataset Product amp LAST TRACK VERSION TR UE amp RETURN TYPE VOTABLESPAGE SIZE 100 e All observations of operational day 380 and proposal Calibration pvpacs 71 in VOTable format http archives esac esa int hsa aio jsp metadata sp RESOURCE CLASS OBSERVATIO N amp OD NUMBER 380 amp PROPOSAL Calibration pvpacs 71 amp RETURN TYPE VOTABLE amp PAGE SIZE 100 Page 7 21 SSA AIO User s Manual Date 19 09 2012 Issue 1 Rev 0 ESA UNCLASSIFIED For Official Use e All products of operational day 380 and proposal Calibration pvpacs 71 in VOTable format http archives esac esa int hsa aio jsp metadata sp RESOURCE CLASS PRODUCT amp P ROPOSAL Calibration pvpacs 7ISODNUMBER 3806LAST TRACK VERSION TRUE amp RETURN TYPE VOTABLE mrt mene mmm tam T tc dl 2 nt 0 Poopo Quem omen 7 or Q w O v e ll v a S Cute ove Te XML Get pee to h ve anp eyle alerte eese sth The document per shows below Figure 1 Returned VOTable file e Get first 1000 public observations in VOTable format http archives esac esa int hsa aio jsp metadata jsp RESOURCE CLASS OBSERVATIO NSEXPIRED TRUESPAGE SIZE 1000 amp PAGE I amp RETURN TYPE VOTABLE e Get observations 1001 to 2000 which proprietary status is private in VOTable format http archives esac esa int hsa aio jsp metadata sp RESOURCE CLASS OBSERVATIO N
14. ehsadev aio jsp productjsp RETRIEVAL TYPE POSICARD SPROTOCOL HTTPSOBSERVATION 1D 1342211606 Tre E de waw per O ina de co o Y ar Lito ll re lun waskawan Y Quya mn Y rat lB v n da rn ove vom V m i 0 LL E LE e _ Jue oe IIT TTL SE predio Orie TT DM OG RO Figure 2 HTTP Product Postcard Request Page 14 21 SSA AIO User s Manual European Space Date 19 09 2012 Issue 1 Rev 0 Agence spatiale eu ESA UNCLASSIFIED For Official Use 3 3 Login requests A client can do login into the HAIO by invoking the url described in the example below The server will return a HTTP cookie that should be used in product retrieval in order to access proprietary data In case of login problem an HTTP error login error will be raised See HSA HCSS ICD for further information All the data requests have the following HTTP prefix Please note that e Login Request syntax and parameters are separated by a question mark e Login Requests are build using parameter value sentences separated by an ampersand 87 Parameter Name s Description Mandatory Possible Values USERNAME User Name YES Any alphanumerical combination PASSWORD User Password Any alphanumerical combination but not less than four characters PROTOCOL If this parameter does not appear an intermediate html page will be displayed in a human readable way Table 5 Latest available postcard parameters Page 15 21 SSA AIO User s Man
15. hat matches the given criteria in the requested format It is important to highlight that the default return type for all metadata requests is the VOTable format 2 1 Metadata Request Parameters All metadata requests have the following HTTP prefix After the HTTP prefix the following parameters are used to build the request Parameter Name s Description Mandatory Possible Values attributes See List of HSA entities and Single Entity Entity or Any HSA Entity or any list of Attributes combination of HAS SELECTED_FIELDS requested Entity Attribute list separated by commas attributes Output format of the response The default response formal is VOTABLE default EE VOTable Other formats CSV J SON are J SON or CSV in next releases E d Any HSA Entity See ea List of HSA entities and RESOURCE_ CLASS ended attributes query response Number of records per NOT but highly PAGE SIZE amp SIZE page amp page number ended Any integer value Complex restrictions of Any J ython valid query QUERY the request expression see below E Any HSA attribute See ORDER BY Oilers pis ICE List of HSA entities and attributes TRUE means that the results must contain only LAST TRAC VERSION latest versions grouped TRUE by HCSS TRACK ID and International Virtual Observatory standard for the interchange of data http www ivoa net Documents VOTable YES NOT YES NOT NOT NOT Page 6 21 SSA AI
16. rators 5 URL encoding reference http www w3schools com tags ref urlencode asp 6 http www jython org Page 9 21 SSA AIO User s Manual European Space Agency Date 19 09 2012 Issue 1 Rev 0 Agence spatiale europ enne ESA UNCLASSIFIED For Official Use Let s see the use of all the above through some examples e First 100 observations that fulfill the criteria QUERY INSTRUMENT HIFI AND INSTRUMENT OBS MODE HifiSScanModeD Equivalent URL http archives esac esa int hsa aio jsp metadata jsp RESOURCE CLASS OBSERVATIO N amp QUERY 28INSTRUMENT 27HIFI 27 20AND 20INSTRUMENT OBS MOD E 27HifiSScanModeDBS 27 296PAGE SIZE 100 amp PAGE I1 amp RETURN TYPE VOT ABLE e Observations 101to 200 that fulfill the criteria QUERY INSTRUMENT PACS AND INSTRUMI BS MODE 2 PacsPhoto OR INSTRUMENT OBS MODE PacsRangeSpec Equivalent URL http archives esac esa int hsa aio jsp metadata sp RESOURCE CLASS OBSERVATIO N amp SELECTED FIELDS 0BSERVATIONSQUERY 28INSTRUMENT 27PACS 27 20AND 20 28INSTRUMENT OBS MODE 27PacsPhoto 27 200R 201INSTRUM ENT_OBS_MODE 27PacsRangeSpec 27 29 298PAGE SIZE 100 amp PAGE 2 e Get observations that fulfil the criteria ERY AOR PACS SDPhotSetup_na_nStd_orbitproWait_na_0114 AND POSAL Calibration_pvpacs_71 Equivalent URL http archives esac esa in
17. rface is ideally created to fulfill the necessity of retrieving data massively Through it you can retrieve either one or all the observation or product files that match a given criteria HCSS URN OD NUMBER HCSS CLASS TYPE etc 1 European Space Agency http www esa int Science Archives Team http archives esac esa int 3 European Space Astronomy Centre http www esa int esaMI ESAC index html Page 4 21 SSA AIO User s Manual ope Date 19 09 2012 Issue 1 Rev 0 Agence spa 1 Space Agency le europ enne ESA UNCLASSIFIED For Official Use HAIO accepts two kinds of requests e Metadata request To be used when we want to retrieve the metadata details of observation file s e Data request To be used when we want to retrieve an observation file Ideally this interface should be used by a script application code or command line tools First we retrieve a list of observation details through a metadata request and then we issue a data request for each one of them in order to retrieve the file s Page 5 21 SSA AIO User s Manual European Space Agency Date 19 09 2012 Issue 1 Rev 0 Agence spatiale europ enne ESA UNCLASSIFIED For Official Use 2 METADATA REQUESTS Metadata requests are used to retrieve the metadata details of one or many observations They are HTTP requests that the user will have to build using several parameters Once this request is sent the HSA backend will return the metadata t
18. selected observation or product level auxiliary products etc The structure of this file is specified by the HSA HCSS ICD e Virtual Tar This object is a TAR file that contains the specified URNs requested in an HAIO product query The structure of this file is specified by the HSA HCSS ICD Page 11 21 SSA AIO User s Manual European Space Agency Date 19 09 2012 Issue 1 Rev 0 Agence spatiale europ enne ESA UNCLASSIFIED For Official Use Parameter Name s Description Mandatory Possible Values Unique identifier of the YES When omsmvamov m ID observation we want to RESOURCE CLASS OBS Any integer value OBSERVATION D ss ERVATION Several URNs can be provided If a single URN is provided the requested product is served through the YES When HTTP connection If RESOURCE CLASS PRO Any value of Product more that one URN is provided a Virtual TAR is generated and served through the HTTP connection If this parameter does not appear an PROTOCOL intermediate html page will be displayed in a human readable way If this parameter does not appear the already ingested product is returned If this METADATA parameter appears and its value is true a FITS file containing product metadata only is returned If this parameter is present urn and XML ingestion REOUESTHEE KMI metadata parameters reguest file name are discarded Product Metadata ons fee for ET Used with OBSID or OBSERVAT
19. t hsa aio jsp metadata sp RESOURCE CLASS OBSERVATIO N amp QUERY AOR PACS SDPhotSetup na nStd orbitproWait na 0114 Y 20AND 20PROPOSAL Calibration p vpacs 7 amp RETURN TYPE VOTABLE Page 10 21 SSA AIO User s Manual uropean Space Agency Date 19 09 2012 Issue 1 Rev 0 Agence spatiale europ enne ESA UNCLASSIFIED For Official Use 3 DATA REQUESTS Data requests are used to retrieve files These files can be science files fits files Ascii files Or postcards jpg files They are HTTP requests that the user will have to build using several parameters Once this request is sent the HSA backend will return one HTML link to download one specific file All the data requests have the following HTTP prefix There are three types of data requests e Product requests e Product postcard requests e Latest available postcard requests The kind of request you want to use is defined by the parameters RESOUCE CLASS and or RETRIEVAL TYPE Depending on its value your request will be processed differently and different combination of parameters will be expected Please note that for data requests e HTTP prefix and parameters are separated by a question mark e Requests are build using parameter value sentences separated by an ampersand amp 3 1 Product requests One data request will provide as response one link to download one of the following options e HSA Tarball This object is a tarball file which contains the
20. ual European Space Agency Date 19 09 2012 Issue 1 Rev 0 Agence spatiale europ enne ESA UNCLASSIFIED For Official Use Examples e Example of login request http archives esac esa int hsa aio jsp login jsp username sathsa amp password passwor d e Example of login request with the parameter PROTOCOL specified http archives esac esa int hsa aio jsp login jsp username sathsa amp password passwor d amp protocol HTTP Page 16 21 SSA AIO User s Manual pean Space Agency Date 19 09 2012 Issue 1 Rev 0 Agence spatia urop ennt ESA UNCLASSIFIED For Official Use 4 LIST OF HSA ENTTTIES AND ATTRIBUTES Below you can find the list of all the HSA entities and attributes They can be used in the metadata request related to certain parameters e Entity names can appear as SELECTED FIELDS only one at a time e Entity names can appear as RESOURCE CLASS only one at a time e Attribute names can appear as SELECTED FIELDS one or a combination of them e Attribute names can appear as ORDER BY one or a combination of them e Simple attribute restrictions can be added as Attribute Name value Entity Name Attribute Name Alias Name Attribute Type OBSERVATION URN VERSION URN VERSION INTEGER OBSERVATIONSPG ID SPGID STRING PoC OBSERVATIONRA RA DOUBLE OBSERVATIONDEC DEC DOUBLE OBSERVATIONPA PA DOUBLE OBSERVATIONDURATION DURATION
Download Pdf Manuals
Related Search