MAST API
Tools for programmatically querying the MAST Portal.
 All Classes Namespaces Properties Pages
Properties | List of all members
Mashup.MashupRequest Class Reference

Handles Mashup requests to the STScI servers. More...

Properties

string service [get, set]
 (required) The service that will be queried for data More...
 
IDictionary< string, object > params [get, set]
 (required) Service specific parameters. More...
 
string format [get, set]
 (default ‘extjs’) Defines the format in which dataset data will be returned. More...
 
object data [get, set]
 (optional) service dependent More...
 
string filename [get, set]
 (optional) Filename in which to save results. More...
 
string timeout [get, set]
 (default 20) Request timeout. More...
 
string clearcache [get, set]
 (default false) Clear cache prior to request. More...
 
string removecache [get, set]
 (default false) Clear cache after request. More...
 
string removenullcolumns [get, set]
 (default false) Remove columns with all null values. More...
 
string page [get, set]
 (default 1) Page of results to be returned. More...
 
string pagesize [get, set]
 (default 1000) Number of rows per page. More...
 

Detailed Description

Handles Mashup requests to the STScI servers.

The Mashup Request Url is https://mast.stsci/api/v0/invoke?request=(Mashup Request Object)

Property Documentation

string Mashup.MashupRequest.clearcache
getset

(default false) Clear cache prior to request.

On incoming request, if there is a previously completed identical request (service and params match) in the server cache, if clearecache is true it is removed, if it is false cached result is returned.

object Mashup.MashupRequest.data
getset

(optional) service dependent

Used for uploading content to the service. Unnecessary for most services, ones that require this value will be marked (for API use crossmatch is the only important one).

string Mashup.MashupRequest.filename
getset

(optional) Filename in which to save results.

If specified, the result is saved to this filename and a url to the file (on STScI servers) is returned instead.

string Mashup.MashupRequest.format
getset

(default ‘extjs’) Defines the format in which dataset data will be returned.

The options are: extjs, votable, csv, json (see descriptions here). Almost all requests will return a dataset, however other result types are possible, in which case this property has no effect. The documentation for specific services specifies the result type.

string Mashup.MashupRequest.page
getset

(default 1) Page of results to be returned.

Relevant for dataset return type only. Specifies which page of results is returned.

string Mashup.MashupRequest.pagesize
getset

(default 1000) Number of rows per page.

Relevant for dataset return type only. Specifies pagesize in number of rows. Note, will not have an effect unless "page" property is also defined.

IDictionary<string, object> Mashup.MashupRequest.params
getset

(required) Service specific parameters.

See service documentation for specifics.

string Mashup.MashupRequest.removecache
getset

(default false) Clear cache after request.

If set to true, after a completed query is returned the result is removed from server cache.

string Mashup.MashupRequest.removenullcolumns
getset

(default false) Remove columns with all null values.

Relevant for dataset return type only. If set to true, any columns with all null values are removed from the dataset.

string Mashup.MashupRequest.service
getset

(required) The service that will be queried for data

For example Mast.Caom.Cone. Detailed descriptions of available services are here.

string Mashup.MashupRequest.timeout
getset

(default 20) Request timeout.

This value defines the maximum number of seconds before a response is returned to the client. After timeout seconds, if the request has not completed a response of “executing” is returned. At this point another request must be sent to the server for the client to receive the completed response and return data. There is a 10 minute inactivity timeout (not configurable) after which if another request has not been received by the server, the job is terminated and the server cache cleared.


The documentation for this class was generated from the following file: