Versions Compared

Key

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

...

This functionality allows providers to specify collection-specific order limits as needed to ensure prevent large orders do not from adversely impact impacting 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 the order will not be allowed.

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

Step-by-step guide

  1. The ability to tag collections is granted through the TAG_GROUP system object identity.  In MMT, this is obtained via membership in the permissions group "Tagging Group SYS."  If you need tagging access, contact CMR or Earthdata Search devops.

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

    Code Block
    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>my_earthdata-username</username>
        <password>--ask task lead--<<password>my_earthdata_password</password>
        <client_id>--ED Login client ID. Look it up in EECS or services.yml.erb--<_id>client_id_of_my_choosing</client_id>
        <user_ip_address>--a valid IP address, can be anything. For example, address>valid_ip_address_of_my_choosing_example_127.0.0.1--<1</user_ip_address>
    </token>’
  3. Associate Tag each collection to be limited with the edsc.limited_collections tag, and set setting desired the order limit:

    --- Example: to associate tag a single collection C12345-DAAC_NAME with the edsc.limited_collections tag and set an the order limit to 2000 granules, create a tag association and include a data field named "limit"as follows:

    Code Block
    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 tag multiple collections with the tag and set limits,

    Code Block
    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":"C00001-DAAC_NAME", "data":{"limit":2000}}, \
     "C00002-DAAC_NAME", "data":{"limit":2000}}, \
     "C00003-DAAC_NAME", "data":{"limit":1000}}, \
     "C00004-DAAC_NAME", "data":{"limit":3000}}, \ 
     "C00005-DAAC_NAME", "data":{"limit":2300}}, \
     "C00006-DAAC_NAME", "data":{"limit":100}}, \
     "C00007-DAAC_NAME", "data":{"limit":2000}}, \
     "C00008-DAAC_NAME", "data":{"limit":5000}}, \
     "C00009-DAAC_NAME", "data":{"limit":500}}, \
     "C00010-DAAC_NAME", "data":{"limit":800}}]'
    


    see you will have to first find all the concept_ids and then do it one at a time.  See examples in ticket 

    Jira
    serverEarthdata Ticketing System
    serverId9a2ac141-7181-31f1-a247-ccbc66e20158
    keyEDSC-1591


Note

The following command shows the To show all tags for a given collection in PROD (the tags can will be found returned in the field labeled "tags field"):

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

The following command shows To show all collections that are tagged with have the order limit tag edsc.limited_collections:

Code Block
curl "https://cmr.earthdata.nasa.gov/search/collections?tag_key=edsc.limited_collections" 
Page properties
hiddentrue

Creating a Token Common

CRM Search API: tagging

Limited order collections