•         advanced

LEAD TDR Interface

Please note that the interface described here is still a prototype, and subject to change.

Resources

• A dataset: either a single file or a packed collection of data files
• A data directory: a container for datasets and other directories
• Metadata: for either datasets or directories

URLs

• URLs that do not end with a / are mapped to datasets
• URLs that end with / and /catalog.xmlare mapped to directories
• URLs that end with _metadata.xml refer to the metadata associated with that directory or dataset

Double slashes are removed. Spaces are replaced with underscores.

Create A New Resource or Update a Resource

If the path does not exist a priori, a new resource will be created. For a valid request, all path elements (tokens in the path) for the new resource are created. If a path exists a priori, the resource will be updated.

Note that datasets and metadata are handled separately. The client must ensure that the two are properly synchronized by performing the appropriate operations.

In creating a new resource, the user name that is provided via Tomcat authentication is used as the "owner" of a resource. The server does not include this name in any way in the path provided by the client. If the client wants a user name in the path, then it must be provided explicitly as part of the path.

It is an error to update a resource by a user that is not the owner of that resource.

Create New or Update Resource Examples

Add a container called "wxChallenge" and a nested dataset called "experiment_notes" to the above:
PUT http://servername:8080/tdr/lead/Anne/wxChallenge/experiment_notes
(file is attached as body)

Add metadata to "experiment_notes" to the above:
PUT http://servername:8080/tdr/lead/Anne/wxChallenge/experiment_notes_metadata.xml
(metadata is attached as body in XML format)

Update the dataset called "Anne/wxChallenge/experiment_notes":
PUT http://servername:8080/tdr/lead/Anne/wxChallenge/experiment_notes
(file is attached as body)

Update metadata to "experiment_notes" to the above:
PUT http://servername:8080/tdr/lead/Anne/wxChallenge/experiment_notes_metadata.xml
(metadata is attached as body in XML format)

Get Resource

Get Resource Examples

Get the dataset called "Anne/wxChallenge/experiment_notes":
GET http://servername:8080/tdr/lead/Anne/wxChallenge/experiment_notes

Get the metadata associated with "experiment_notes" in XML format:
GET http://servername:8080/tdr/lead/Anne/wxChallenge/experiment_notes_metadata.xml

Remove Resource

It is an error to remove a resource by a user that is not the owner of that resource.

Remove Resource Examples

Remove the metadata associated with "experiment_notes" in XML format:
DELETE http://servername:8080/tdr/lead/Anne/wxChallenge/experiment_notes_metadata.xml

Remove the dataset called "Anne/wxChallenge/experiment_notes":
DELETE http://servername:8080/tdr/lead/Anne/wxChallenge/experiment_notes

Remove the the container called "Anne" and everything below it:
DELETE http://servername:8080/tdr/lead/Anne/

Status Codes Returned

• 200 : success
• 201 : new resource has been created
• 302 : redirect to an authorization challenge
• 400 : malformed request
• 401 : authorization challenge
• 403 : forbidden, as in attempt to modify resource of another owner
• 404 : unknown resource
• 501 : server error

TDR Metadata XML Schema

        <?xml version="1.0" encoding="UTF-8"?>
        <document>
          <NVPair name="name">regexp</NVPair>
          <NVPair name="dataType">Image</NVPair>
          <NVPair name="dataFormatType">BUFR</NVPair>
          <NVPair name="summary">the quick brown fox</NVPair>
          <NVPair name="startTime">2007-06-28 11:40:00Z</NVPair>
          <NVPair name="endTime">2007-06-28 11:40:00Z</NVPair>
          <NVPair name="north">20.0</NVPair>
          <NVPair name="south">10.0</NVPair>
          <NVPair name="east">40.2</NVPair>
          <NVPair name="west">30.1</NVPair>
          <NVPair name="title">New User Title</NVPair>
          <NVPair name="publisherName">Anne</NVPair>
          <NVPair name="publisherUrl">www.unidata.ucar.edu</NVPair>
          <NVPair name="publisherEmail">anne@unidata.ucar.edu</NVPair>
          <NVPair name="xlink" title="unidata">http://www.unidata.ucar.edu</NVPair>
          <NVPair name="new name 1">value</NVPair>
          <NVPair name="new name 2">5.2</NVPair>
        </document>

Predefined metadata elements are defined in the section below.

These keys are mapped directly to THREDDS metadata elements. Other keys and their values are stored in THREDDS metadata as properties.

Note that currently the xlink key requires an attribute that is the title of the xlink.

Predefined Metadata

Contact Us   •   Site Map   •   Search   •   Terms and Conditions   •   Privacy Policy   •   Participation Policy

Unidata is a member of the UCAR Office of Programs, is managed by the University Corporation for Atmospheric Research, and is sponsored by the National Science Foundation. P.O. Box 3000   •   Boulder, CO 80307-3000 USA   •   Tel: 303-497-8643   •   Fax: 303-497-8690