Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

page_size=<n>

This is a CMR parameter to control the number of granules in the page of returned results. 

Discussion: When there are multiple granules returned from the CMR query, they are returned in sets called pages. The default page size is 10 granules. The page_size KVP allows the user to change the page size. Multi-page results can be accessed one page at a time using the page_num KVP described below. 

Note that the system configuration parameter MAX_GRANS_FOR_SYNC_REQUEST limits the size of a request in EGI. Exceeding that number returns an error. Page_size should always be set to less than or equal to this request limit.

See the FAQ for more discussion. 

page_num=<n>

This is a CMR parameter to select the page of results to be processed. The page contains the number of granules selected in the page_size KVP. 

Version=1.0.0

WCS Clients Only: Indicates WCS Version 1.0.0 compatibility (optional) 

Request=GetCoverage

WCS Clients Only: Identifies the type of WCS request (optional) 

token=<token>

Allows the user to provide an Earthdata Login token. This token is used as proof that the user has been authenticated by the Earthdata Login system. It is used for:

  • enabling user access to ACL protected granule rsults in CMR
  • enabling Programmatic Access delivery of results only to authenticated users
  • metrics collection 
request_mode=synch | async | stream (default)

Request mode indicates how the user will receive their results:

  • synch = response returned to the client once request has completed processing;response will be XML formatted status that includes result links
  • async = response returned to client immediately;email will be sent upon completion of the request providing result links
  • stream = response will not be returnted to the client until request has completed and results are sent directly to the client


Anchor
usageexamples
usageexamples
EGI Programmatic Access Usage Examples

...