How To: Set the maximum granules per order for a collection

This describes how to limit the number of granules per order for a collection in Earthdata Search by setting a tag on the collection. 

This functionality allows providers to specify collection-specific order limits as needed to ensure large orders do not adversely impact provider operations.

The tag is edsc.limited_collections, with the limit is specified in the tag data field "limit".

For a properly tagged collection, clicking "Download Granules" in Earthdata Search when too many granules are selected will display an error message, and order will not be allowed.

Step-by-step guide

1. If you do not already have one, generate an ECHO token.  (Note the id field in the response to the following command is your token.)

   curl -XPOST \
     https://cmr.earthdata.nasa.gov/legacy-services/rest/tokens \
     -H 'cache-control: no-cache' \
     -H 'content-type: application/xml' \
     -d '<token>
       <username>--ask task lead--</username>
       <password>--ask task lead--</password>
       <client_id>--ED Login client ID. Look it up in EECS or services.yml.erb--</client_id>
       <user_ip_address>--a valid IP address, can be anything. For example, 127.0.0.1--</user_ip_address>
   </token>’

2. Associate each collection with the edsc.limited_collections tag, and set the limit:

   --- to associate a single collection with the edsc.limited_collections tag and set an order limit, create a tag association and include a data field named "limit":

   curl -XPOST -i -H "Content-Type: application/json" -H "Echo-Token: <token from first step>" https://cmr.earthdata.nasa.gov/search/tags/edsc.limited_collections/associations -d '[{"concept_id":"C12345-DAAC_NAME", "data":{"limit":2000}}]'

   
   ---to associate multiple collections with the tag and set limits, you will have to first find all the concept_ids and then do it one at a time.  See examples in ticket  EDSC-1591 - Getting issue details... STATUS
   
   

curl -s "https://cmr.earthdata.nasa.gov/search/collections.json?include_tags=*&concept_id=C12345-DAAC_NAME"

curl "https://cmr.earthdata.nasa.gov/search/collections?tag_key=edsc.limited_collections"