PASTA Documentation
Release
PASTAplus
Jun 15, 2017
Contents
1
EDI Data Repository
3
2
EDI Data Portal Users Guide
5
3
PASTA API
3.1 Data Package Manager API . . . . . . . . .
3.1.1
Upload and Evaluation . . . . . . .
3.1.2
Browse and Discovery . . . . . . .
3.1.3
Listing . . . . . . . . . . . . . . . .
3.1.4
Accessing Data Package Resources
3.1.5
Provenance . . . . . . . . . . . . .
3.1.6
Event Notifications . . . . . . . . .
3.1.7
Identifier Reservation Services . . .
3.1.8
System Monitoring Services . . . .
3.1.9
Miscellaneous Services . . . . . . .
3.2 Audit Manager API . . . . . . . . . . . . .
3.2.1
Introduction . . . . . . . . . . . . .
3.2.2
Audit Manager Services . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
7
7
7
8
12
16
23
23
25
27
28
29
29
29
4
PASTA Developers Guide
31
5
General FAQ
33
i
ii
PASTA Documentation, Release
This website is the official documentation of the EDI Data Repository and, more specifically, the Provenance Aware
Synthesis Tracking Architecture (PASTA). The site is divided into five primary categories designed to inform the user
of different aspects of the EDI Data Repository and PASTA.
To assist the weary web traveler in deciding what category to peruse, a short synopsis of each section follows:
1. EDI Data Repository: Overview and motivation for the EDI Data Repository, data producers, and data consumers.
2. EDI Data Portal Users Guide: The EDI Data Portal is the official web-browser interface for users to upload,
search, and download EDI data products. The Data Portal is considered a reference implementation of an
application that utilizes the PASTA Application Program Interface (API).
3. PASTA API: Documentation for the PASTA API and general information and suggestions for software developers who would like to build an application that interacts with the PASTA API.
4. PASTA Developers Guide: Design documentation of the PASTA framework for developers who plan on extending, fixing, or refactoring the core components of PASTA and their associated web-services. Documentation
for DataONE‘s Generic Member Node deployment and GMN’s adapter for harvesting data from PASTA.
5. General FAQ: A list of the most commonly asked questions and their answers about the EDI Data Repository
and PASTA.
Contents
1
PASTA Documentation, Release
2
Contents
CHAPTER
1
EDI Data Repository
The Environmental Data Initiative (EDI) Data Repository can be modeled as a production line that facilitates data flow
from producers to consumers. As such, organization of the data repository can be partitioned into three components:
(1) data producers, (2) data warehouses, and (3) data consumers, all working together as part of an environmental and
ecological research cooperative with the goal of improving the world through science knowledge and education.
Data producers may be represented as either individuals or organizations. In the context of the EDI Data Repository,
data producers are based at a variety of research organizations and sites (LTER, LTREB, MSB, OBFS, etc.) where
focus is on collection and generation of data (and metadata) resulting from the enactment of core science, and scientists
and students, who collect data resulting from scholarly research at the sites or through synthesis – that is, new data
generated by applying analyses against existing data. We envision that site producers “harvest” their data on a regular
basis and store them in a data warehouse.
Data warehouses make up the informatics infrastructure used to manage and archive EDI data products, including the
“wholesale” and value-added delivery of such products to data consumers. The bulk of EDI data can be contained in
one central warehouse, but specialized data products (e.g., GIS or remote sensing imagery) may be stored in separate
warehouses for optimal management and performance.
Data consumers are either end users (e.g., scientists) or exist in the form of a “retailer” that better packages data
products, along with value-added services, who then caters to end users. Multiple retail services can all access the
same data from the warehouses, but each “retailer” provide unique services to different segments of end users. For the
EDI Data Repository, retailers may simply be websites that support applications tailored to serve their communities of
scientists.
In the analogy described above, EDI is focused on developing a modern and innovative data warehouse infrastructure
that will meet the needs of the community. The core of this infrastructure is titled Provenance Aware Synthesis
Tracking Architecture or “PASTA”.
3
PASTA Documentation, Release
4
Chapter 1. EDI Data Repository
CHAPTER
2
EDI Data Portal Users Guide
The EDI Data Portal (https://portal.edirepository.org) is the de facto user interface to PASTA for both producers and
consumers of EDI data products.
For producers, the Data Portal provides a suite of tools designed to review and upload data packages into PASTA,
5
PASTA Documentation, Release
review actions (e.g., data downloads) against data packages, and subscribe to data “upload” events to trigger off-site
workflows.
For consumers, the Data Portal provides a simple search interface that accepts keywords or phrases to find relevant data
packages and a set of browsable categories based on a community-curated controlled vocabulary and by data package
identifier. There is also an advanced search interface that allows users to refine search criteria into 7 faceted categories,
including spatial/place name, research site, subject matter, content creator/organization, temporal, taxonomic, and data
package identifier.
6
Chapter 2. EDI Data Portal Users Guide
CHAPTER
3
PASTA API
Data Package Manager API
The Data Package Manager API consists of six groups of PASTA web services:
1. Upload and Evaluation of data packages
2. Browse and Discovery of data packages
3. Listing data packages
4. Accessing data package resources
5. Provenance tracking and metadata
6. Data package Event Notifications
7. Data package Identifier Reservations
8. System Monitoring services
9. Miscellaneous data package services
Upload and Evaluation
Describes web service methods for uploading (creating or updating) and evaluating data packages.
Create Data Package
Description
Creates a new PASTA data package by providing the EML document describing the data package to be created in the
request message body and returning a transaction identifier in the response message body as plain text; the transaction
identifier may be used in a subsequent call to Read Data Package Error to determine the operation status; see Read
Data Package to obtain the data package resource map if the operation completed successfully.
7
PASTA Documentation, Release
REST API
POST : https://pasta.lternet.edu/package/eml
Examples
1. Using curl to upload a new data package to PASTA where knb-lter-lno.1.1.xml is the filesystem
EML document in XML format:
curl -i -u "uid=ucarroll,o=LTER,dc=ecoinformatics,dc=org:PASSWORD" \
-H "Content-Type: application/xml" --data-binary @knb-lter-lno.1.1.xml \
-X POST https://pasta.lternet.edu/package/eml
Evaluate Data Package
Description
Evaluate Data Package operation, specifying the EML document describing the data package to be evaluated in the
request message body, and returning a transaction identifier in the response message body as plain text; the transaction
identifier may be used in a subsequent call to Read Data Package Error to determine the operation status or to Read
Evaluate Report to obtain the evaluate quality report.
REST API
POST : https://pasta.lternet.edu/package/evaluate/eml
Update Data Package
Description
Update Data Package operation, specifying the scope and identifier of the data package to be updated in the URI,
along with the EML document describing the data package to be created in the request message body, and returning a
transaction identifier in the response message body as plain text; the transaction identifier may be used in a subsequent
call to Read Data Package Error to determine the operation status; see Read Data Package to obtain the data package
resource map if the operation completed successfully.
REST API
PUT : https://pasta.lternet.edu/package/eml/{scope}/{identifier}
Browse and Discovery
Describes web service methods for browsing and discovering data packages.
8
Chapter 3. PASTA API
PASTA Documentation, Release
Search Data Packages
Description
Searches data packages in PASTA using the specified Solr query as the query parameters in the URL. Search results
are returned as XML. Detailed examples of Solr queries and their corresponding search results XML are shown below.
REST API
GET : https://pasta.lternet.edu/package/search/eml
Solr Queries
Solr queries are demonstrated in the examples below.
Note: A full discussion of Solr query syntax is beyond the scope of this document. Documentation on this topic can
be found online, for example, the Apache Solr Wiki.
Searchable Fields
Documents in PASTA’s Solr repository can be discovered based on metadata values stored in the following list of
searchable fields:
Single-value Fields:
• abstract
• begindate
• doi
• enddate
• funding
• geographicdescription
• id
• methods
• packageid
• pubdate
• responsibleParties
• scope
• singledate
• site
• taxonomic
• title
Multi-value Fields
3.1. Data Package Manager API
9
PASTA Documentation, Release
• author
• coordinates
• keyword
• organization
• timescale
Search Results
Search results are returned in XML format. (See examples below.)
Examples
1. Using curl to query PASTA for all documents containing the term “Vernberg”. In this example, all fields for
matching documents are included in the search results (fl=*).
(Note: For brevity, only one document is displayed in the search results shown below and some of its content
has been truncated.):
curl -X GET "https://pasta.lternet.edu/package/search/eml?defType=edismax\
&q=Vernberg&fq=-scope:ecotrends&fq=-scope:lter-landsat*&fl=*\
&sort=score,desc&sort=packageid,asc&debug=false&start=0&rows=10"
<resultset numFound='3' start='0' rows='10'>
<document>
<abstract>This data package consists of Daily Water Sample Parameter,...</
˓→abstract>
<begindate>1981</begindate>
<doi>doi:10.6073/pasta/2b809c045fdd74a7cc12e8f31fc191eb</doi>
<enddate>1993</enddate>
<funding></funding>
<geographicdescription>North Inlet encompasses about 2,630 hectares of
˓→tidal...</geographicdescription>
<id>knb-lter-nin.8</id>
<docid>knb-lter-nin.8</docid>
<methods></methods>
<packageid>knb-lter-nin.8.1</packageid>
<pubdate>2013</pubdate>
<responsibleParties>NIN&#x2d;LTER
Vernberg, John
Blood, Elizabeth
Gardner, Robert
</responsibleParties>
<scope>knb-lter-nin</scope>
<singledate></singledate>
<site>nin</site>
<taxonomic></taxonomic>
<title>Suspended Sediment&#x2e; Daily Water Sample Parameter&#x2c; and
˓→Sediment...</title>
<authors>
<author>Vernberg, John</author>
<author>Blood, Elizabeth</author>
<author>Gardner, Robert</author>
</authors>
10
Chapter 3. PASTA API
PASTA Documentation, Release
<spatialCoverage>
<coordinates>-79.2936 33.1925 -79.1042 33.357</coordinates>
</spatialCoverage>
<sources>
</sources>
<keywords>
<keyword>North Inlet Estuary</keyword>
<keyword>Baruch Institute</keyword>
<keyword>Georgetown, South Carolina</keyword>
<keyword>sediment</keyword>
<keyword>substances</keyword>
<keyword>ecology</keyword>
<keyword>community dynamics</keyword>
<keyword>populations</keyword>
</keywords>
<organizations>
<organization>NIN&#x2d;LTER</organization>
</organizations>
<timescales>
</timescales>
</document>
</resultset>
2. Using curl to query PASTA for all documents containing the term “Vernberg” and limiting the returned fields
to the “packageid” and “doi” fields (fl=packageid,doi):
curl -X GET "https://pasta.lternet.edu/package/search/eml?defType=edismax\
&q=Vernberg&fq=-scope:ecotrends&fq=-scope:lter-landsat*&fl=packageid,doi\
&sort=score,desc&sort=packageid,asc&debug=false&start=0&rows=10"
<resultset numFound='3' start='0' rows='10'>
<document>
<packageid>knb-lter-nin.1.1</packageid>
<doi>doi:10.6073/pasta/0675d3602ff57f24838ca8d14d7f3961</doi>
</document>
<document>
<packageid>knb-lter-nin.5.1</packageid>
<doi>doi:10.6073/pasta/3b69d867d7f6620bd2f47794804363d2</doi>
</document>
<document>
<packageid>knb-lter-nin.8.1</packageid>
<doi>doi:10.6073/pasta/2b809c045fdd74a7cc12e8f31fc191eb</doi>
</document>
</resultset>
3. Using curl to query PASTA for all documents containing the term “sediment” in the keyword field
(q=keyword:sediment) and limiting the returned fields to the keyword field (fl=keyword). Note that
because the keyword field is a multi-value field, its elements are nested inside a parent keywords element.
(Note: For brevity, only two documents are displayed in the search results shown below.):
curl -X GET "https://pasta.lternet.edu/package/search/eml?defType=edismax\
&q=keyword:sediment&fq=-scope:ecotrends&fq=-scope:lter-landsat*&fl=keyword\
&sort=score,desc&sort=packageid,asc&debug=false&start=0&rows=10"
<resultset numFound='71' start='0' rows='10'>
<document>
<keywords>
3.1. Data Package Manager API
11
PASTA Documentation, Release
<keyword>sedimentation</keyword>
<keyword>NTL LTER</keyword>
<keyword>North Temperate Lakes - LTER</keyword>
<keyword>sediment</keyword>
<keyword>sediment deposition</keyword>
</keywords>
</document>
<document>
<keywords>
<keyword>Georgia</keyword>
<keyword>Sapelo Island</keyword>
<keyword>USA</keyword>
<keyword>GCE</keyword>
<keyword>Georgia Coastal Ecosystems</keyword>
<keyword>LTER</keyword>
<keyword>Sediment Monitoring</keyword>
<keyword>accumulation</keyword>
<keyword>elevation</keyword>
<keyword>erosion</keyword>
<keyword>freshwater</keyword>
<keyword>marshes</keyword>
<keyword>sea level</keyword>
<keyword>sediment elevation table</keyword>
<keyword>sediments</keyword>
<keyword>soils</keyword>
<keyword>Organic Matter</keyword>
</keywords>
</document>
</resultset>
Listing
Describes web service methods for listing data packages.
List Data Entities
Description
List Data Entities operation, specifying the scope, identifier, and revision values to match in the URI.
REST API
GET : https://pasta.lternet.edu/package/data/eml/{scope}/{identifier}/{revision}
List Data Descendants
Description
List Data Descendants operation, specifying the scope, identifier, and revision values to match in the URI.
12
Chapter 3. PASTA API
PASTA Documentation, Release
REST API
GET : https://pasta.lternet.edu/package/descendants/eml/{scope}/{identifier}/{revision}
List Data Sources
Description
List Data Sources operation, specifying the scope, identifier, and revision values to match in the URI.
REST API
GET : https://pasta.lternet.edu/package/sources/eml/{scope}/{identifier}/{revision}
List Data Package Identifiers
Description
List Data Package Identifiers operation, specifying the scope value to match in the URI.
REST API
GET : https://pasta.lternet.edu/package/eml/{scope}
List Data Package Revisions
Description
List Data Package Revisions operation, specifying the scope and identifier values to match in the URI. The request
may be filtered by applying the modifiers “oldest” or “newest” to the “filter” query parameter.
REST API
GET : https://pasta.lternet.edu/package/eml/{scope}/{identifier}
List Data Package Scopes
Description
List Data Package Scopes operation, returning all scope values extant in the data package registry.
REST API
GET : https://pasta.lternet.edu/package/eml
3.1. Data Package Manager API
13
PASTA Documentation, Release
List Deleted Data Packages
Description
List Deleted Data Packages operation, returning all document identifiers (excluding revision values) that have been
deleted from the data package registry.
REST API
GET : https://pasta.lternet.edu/package/eml/deleted
List Service Methods
Description
List Service Methods operation, returning a simple list of web service methods supported by the Data Package Manager
web service.
REST API
GET : https://pasta.lternet.edu/package/service-methods
List Recent Changes
Description
List Recent Changes operation, listing all data package insert, update, and delete operations, optionally specifying
the date and time to and/or from which the changes should be listed. An optional scope value can be specified to
filter results for a particular data package scope (e.g. scope=edi). If “fromDate” and “toDate” are omitted, lists the
complete set of changes recorded in PASTA’a resource registry. If a “scope” value is omitted, results are returned for
all data package scopes that exist in the resource registry. Multiple instances of the scope parameter are not supported
(only the last scope value specified will be used). The list of changes is returned in XML format. Inserts and updates
are recorded in “dataPackageUpload” elements, while deletes are recorded in “dataPackageDelete” elements. (See
example below)
REST API
GET : https://pasta.lternet.edu/package/changes/eml
Examples
1. Using curl to list data packages that PASTA is working on uploading:
curl -X GET https://pasta.lternet.edu/package/changes/eml?fromDate=2017-02˓→10T12:00:00&toDate=2017-02-11T12:00:00&scope=knb-lter-nwk
<dataPackageChanges>
<dataPackageUpload>
14
Chapter 3. PASTA API
PASTA Documentation, Release
<packageId>knb-lter-nwk.1225.1</packageId>
<scope>knb-lter-nwk</scope>
<identifier>1225</identifier>
<revision>1</revision>
<serviceMethod>createDataPackage</serviceMethod>
<date>2017-02-10 16:48:56.368</date>
</dataPackageUpload>
<dataPackageDelete>
<packageId>knb-lter-nwk.1225.1</packageId>
<scope>knb-lter-nwk</scope>
<identifier>1225</identifier>
<revision>1</revision>
<serviceMethod>deleteDataPackage</serviceMethod>
<date>2017-02-10 16:49:06.83</date>
</dataPackageDelete>
<dataPackageUpload>
<packageId>knb-lter-nwk.1226.1</packageId>
<scope>knb-lter-nwk</scope>
<identifier>1226</identifier>
<revision>1</revision>
<serviceMethod>createDataPackage</serviceMethod>
<date>2017-02-10 16:49:53.201</date>
</dataPackageUpload>
<dataPackageUpload>
<packageId>knb-lter-nwk.1226.2</packageId>
<scope>knb-lter-nwk</scope>
<identifier>1226</identifier>
<revision>2</revision>
<serviceMethod>updateDataPackage</serviceMethod>
<date>2017-02-10 16:50:22.802</date>
</dataPackageUpload>
<dataPackageDelete>
<packageId>knb-lter-nwk.1226.1</packageId>
<scope>knb-lter-nwk</scope>
<identifier>1226</identifier>
<revision>1</revision>
<serviceMethod>deleteDataPackage</serviceMethod>
<date>2017-02-10 16:50:51.111</date>
</dataPackageDelete>
<dataPackageDelete>
<packageId>knb-lter-nwk.1226.2</packageId>
<scope>knb-lter-nwk</scope>
<identifier>1226</identifier>
<revision>2</revision>
<serviceMethod>deleteDataPackage</serviceMethod>
<date>2017-02-10 16:50:51.111</date>
</dataPackageDelete>
</dataPackageChanges>
List Recent Uploads
Description
List Recent Uploads operation, optionally specifying the upload type (“insert” or “update”) and a maximum limit as
query parameters in the URL. (See example below.)
3.1. Data Package Manager API
15
PASTA Documentation, Release
REST API
GET : https://pasta.lternet.edu/package/uploads/eml
Accessing Data Package Resources
Describes web service methods for accessing data package resources such as data, metadata, and reports.
Read Data Entity
Description
Read Data Entity operation, specifying the scope, identifier, revision, and entity identifier of the data entity to be read
in the URI.
Revision may be specified as “newest” or “oldest” to retrieve data from the newest or oldest revision, respectively.
REST API
GET : https://pasta.lternet.edu/package/data/eml/{scope}/{identifier}/{revision}/{entityId}
Read Data Entity ACL
Description
Read Data Entity ACL operation, specifying the scope, identifier, and revision of the data entity object whose Access
Control List (ACL) is to be read in the URI, returning an XML string representing the ACL for the data entity. Please
note: only a very limited set of users are authorized to use this service method.
REST API
GET : https://pasta.lternet.edu/package/data/acl/eml/{scope}/{identifier}/{revision}/{entityId}
Read Data Entity Checksum
Description
Read Data Entity Checksum operation, specifying the scope, identifier, and revision of the data entity object whose
checksum is to be read in the URI, returning a 40-character SHA-1 checksum value.
REST API
GET : https://pasta.lternet.edu/package/data/checksum/eml/{scope}/{identifier}/{revision}/{entityId}
16
Chapter 3. PASTA API
PASTA Documentation, Release
Read Data Entity Name
Description
Read Data Entity Name operation, specifying the scope, identifier, revision, and entity identifier of the data entity
whose name is to be read in the URI.
REST API
GET : https://pasta.lternet.edu/package/name/eml/{scope}/{identifier}/{revision}/{entityId}
Read Data Entity Names
Description
Read Data Entity Names operation, specifying the scope, identifier, and revision of the data package whose data entity
names are to be read in the URI, returning a newline-separated list of entity identifiers and name values. Each line in
the list contains an entity identifier and its corresponding name value, separated by a comma. Only data entities that
the user is authorized to read are included in the list.
REST API
GET : https://pasta.lternet.edu/package/name/eml/{scope}/{identifier}/{revision}
Read Data Entity Size
Description
Read Data Entity Size operation, specifying the scope, identifier, and revision of the data entity object whose size is to
be read in the URI, returning the size value (in bytes).
REST API
GET : https://pasta.lternet.edu/package/data/size/eml/{scope}/{identifier}/{revision}/{entityId}
Read Data Entity Sizes
Description
Read Data Entity Sizes operation, specifying the scope, identifier, and revision of the data package whose data entity
sizes are to be read in the URI, returning a newline-separated list of entity identifiers and size values (in bytes). Each
line in the list contains an entity identifier and its corresponding size value, separated by a comma. Only data entities
that the user is authorized to read are included in the list.
REST API
GET : https://pasta.lternet.edu/package/data/size/eml/{scope}/{identifier}/{revision}
3.1. Data Package Manager API
17
PASTA Documentation, Release
Read Data Package
Description
Read Data Package operation, specifying the scope, identifier, and revision of the data package to be read in the URI,
returning a resource map with reference URLs to each of the metadata, data, and quality report resources that comprise
the data package.
Revision may be specified as “newest” or “oldest” to retrieve the newest or oldest revision, respectively.
When the ”?ore” query parameter is appended to the request URL, an OAI-ORE compliant resource map in RDF-XML
format is returned.
REST API
GET : https://pasta.lternet.edu/package/eml/{scope}/{identifier}/{revision}
Examples
1. Using curl to read a data package resource map:
curl -X GET https://pasta.lternet.edu/package/eml/knb-lter-nin/1/1
https://pasta-d.lternet.edu/package/data/eml/knb-lter-nin/1/1/
˓→67e99349d1666e6f4955e9dda42c3cc2
https://pasta-d.lternet.edu/package/metadata/eml/knb-lter-nin/1/1
https://pasta-d.lternet.edu/package/report/eml/knb-lter-nin/1/1
https://pasta-d.lternet.edu/package/eml/knb-lter-nin/1/1
2. Using curl to read a data package resource map, using the ”?ore” query parameter to specify that the resource
map should be returned as an OAI-ORE compliant RDF-XML document:
curl -X GET https://pasta.lternet.edu/package/eml/knb-lter-nin/1/1?ore
<?xml version="1.0" encoding="UTF-8"?>
<rdf:RDF
xmlns:cito="http://purl.org/spar/cito/"
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:dcterms="http://purl.org/dc/terms/"
xmlns:foaf="http://xmlns.com/foaf/0.1/"
xmlns:ore="http://www.openarchives.org/ore/terms/"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:rdfs1="http://www.w3.org/2001/01/rdf-schema#"
>
<rdf:Description rdf:about="https://pasta-d.lternet.edu/package/eml/knb-lter˓→nin/1/1">
<rdf:type rdf:resource="http://www.openarchives.org/ore/terms/ResourceMap"/>
<dcterms:created>2013-05-10T22:27:29.763</dcterms:created>
<dcterms:modified>2013-05-10T22:27:29.763</dcterms:modified>
<dcterms:creator rdf:resource="http://environmentaldatainitiative.org"/>
<ore:describes rdf:resource="https://pasta-d.lternet.edu/package/eml/knb-lter˓→nin/1/1#aggregation"/>
<dcterms:identifier>doi:10.6073/pasta/3bcc89b2d1a410b7a2c678e3c55055e1</
˓→dcterms:identifier>
<dc:format>application/rdf+xml</dc:format>
18
Chapter 3. PASTA API
PASTA Documentation, Release
</rdf:Description>
<rdf:Description rdf:about="https://pasta-d.lternet.edu/package/eml/knb-lter˓→nin/1/1#aggregation">
<rdf:type rdf:resource="http://www.openarchives.org/ore/terms/Aggregation"/>
<ore:aggregates rdf:resource="https://pasta-d.lternet.edu/package/eml/
˓→metadata/knb-lter-nin/1/1"/>
<ore:aggregates rdf:resource="https://pasta-d.lternet.edu/package/eml/data/
˓→knb-lter-nin/1/1/67e99349d1666e6f4955e9dda42c3cc2"/>
<ore:aggregates rdf:resource="https://pasta-d.lternet.edu/package/eml/report/
˓→knb-lter-nin/1/1"/>
</rdf:Description>
<rdf:Description rdf:about="https://pasta-d.lternet.edu/package/eml/metadata/
˓→knb-lter-nin/1/1">
<dcterms:identifier>https://pasta-d.lternet.edu/package/eml/metadata/knb-lter˓→nin/1/1</dcterms:identifier>
<cito:documents rdf:resource="https://pasta-d.lternet.edu/package/eml/data/
˓→knb-lter-nin/1/1/67e99349d1666e6f4955e9dda42c3cc2"/>
<cito:documents rdf:resource="https://pasta-d.lternet.edu/package/eml/report/
˓→knb-lter-nin/1/1"/>
</rdf:Description>
<rdf:Description rdf:about="https://pasta-d.lternet.edu/package/eml/data/knb˓→lter-nin/1/1/67e99349d1666e6f4955e9dda42c3cc2">
<dcterms:identifier>https://pasta-d.lternet.edu/package/eml/data/knb-lter-nin/
˓→1/1/67e99349d1666e6f4955e9dda42c3cc2</dcterms:identifier>
<cito:isDocumentedBy rdf:resource="https://pasta-d.lternet.edu/package/eml/
˓→metadata/knb-lter-nin/1/1"/>
</rdf:Description>
<rdf:Description rdf:about="https://pasta-d.lternet.edu/package/eml/report/knb˓→lter-nin/1/1">
<dcterms:identifier>https://pasta-d.lternet.edu/package/eml/report/knb-lter˓→nin/1/1</dcterms:identifier>
<cito:isDocumentedBy rdf:resource="https://pasta-d.lternet.edu/package/eml/
˓→metadata/knb-lter-nin/1/1"/>
</rdf:Description>
<rdf:Description rdf:about="http://environmentaldatainitiative.org">
<foaf:name>Environmental Data Initiative</foaf:name>
<foaf:mbox>[email protected]</foaf:mbox>
</rdf:Description>
<rdf:Description rdf:about="http://www.openarchives.org/ore/terms/ResourceMap">
<rdfs1:label>ResourceMap</rdfs1:label>
<rdfs1:isDefinedBy>http://www.openarchives.org/ore/terms/</rdfs1:isDefinedBy>
</rdf:Description>
<rdf:Description rdf:about="http://www.openarchives.org/ore/terms/Aggregation">
<rdfs1:label>Aggregation</rdfs1:label>
<rdfs1:isDefinedBy>http://www.openarchives.org/ore/terms/</rdfs1:isDefinedBy>
</rdf:Description>
</rdf:RDF>
Read Data Package ACL
Description
Read Data Package ACL operation, specifying the scope, identifier, and revision of the data package whose Access
Control List (ACL) is to be read in the URI, returning an XML string representing the ACL for the data package.
Please note: only a very limited set of users are authorized to use this service method.
3.1. Data Package Manager API
19
PASTA Documentation, Release
REST API
GET : https://pasta.lternet.edu/package/acl/eml/{scope}/{identifier}/{revision}
Read Data Package Archive
Description
Read Data Package Archive operation, specifying the transaction identifier of the data package archive to be read in
the URI, returning the data package archive as a binary object in the ZIP file format.
REST API
GET : https://pasta.lternet.edu/package/archive/eml/{scope}/{identifier}/{revision}/{transaction}
Read Data Package DOI
Description
Read Data Package DOI operation, specifying the scope, identifier, and revision of the data package DOI to be read in
the URI, returning the canonical Digital Object Identifier.
REST API
GET : https://pasta.lternet.edu/package/doi/eml/{scope}/{identifier}/{revision}
Read Data Package Error
Description
Read Data Package Error operation, specifying the scope, identifier, revision, and transaction identifier of the data
package error to be read in the URI, returning the error message as plain text.
REST API
GET : https://pasta.lternet.edu/package/error/eml/{transaction}
Read Data Package Report
Description
Read Data Package Report operation, specifying the scope, identifier, and revision of the data package quality report
document to be read in the URI.
If an HTTP Accept header with value ‘text/html’ is included in the request, returns an HTML representation of the
report. The default representation is XML.
20
Chapter 3. PASTA API
PASTA Documentation, Release
REST API
GET : https://pasta.lternet.edu/package/report/eml/{scope}/{identifier}/{revision}
Read Data Package Report ACL
Description
Read Data Package Report ACL operation, specifying the scope, identifier, and revision of the data package report
whose access control list (ACL) is to be read in the URI, returning an XML string representing the ACL for the data
package report resource. Please note: only a very limited set of users are authorized to use this service method.
REST API
GET : https://pasta.lternet.edu/package/report/acl/eml/{scope}/{identifier}/{revision}
Read Data Package Report Checksum
Description
Read Data Package Report Checksum operation, specifying the scope, identifier, and revision of the data package
report object whose checksum is to be read in the URI, returning a 40 character SHA-1 checksum value.
REST API
GET : https://pasta.lternet.edu/package/report/checksum/eml/{scope}/{identifier}/{revision}
Read Evaluate Report
Description
Read Evaluate Report operation, specifying the transaction identifier of the evaluate quality report document to be
read in the URI.
If an HTTP Accept header with value ‘text/html’ is included in the request, returns an HTML representation of the
report. The default representation is XML.
See the Evaluate Data Package service method for information about how to obtain the transaction identifier.
REST API
GET : https://pasta.lternet.edu/package/evaluate/report/eml/{transaction}
3.1. Data Package Manager API
21
PASTA Documentation, Release
Read Metadata
Description
Read Metadata operation, specifying the scope, identifier, and revision of the EML document to be read in the URI.
Revision may be specified as “newest” or “oldest” to retrieve the newest or oldest revision, respectively.
REST API
GET : https://pasta.lternet.edu/package/metadata/eml/{scope}/{identifier}/{revision}
Read Metadata ACL
Description
Read Metadata ACL operation, specifying the scope, identifier, and revision of the data package metadata whose
Access Control List (ACL) is to be read in the URI, returning an XML string representing the ACL for the data
package metadata resource. Please note: only a very limited set of users are authorized to use this service method.
REST API
GET : https://pasta.lternet.edu/package/metadata/acl/eml/{scope}/{identifier}/{revision}
Read Metadata Checksum
Description
Read Metadata Checksum operation, specifying the scope, identifier, and revision of the metadata object whose checksum value is to be read in the URI, returning a 40 character SHA-1 checksum value.
REST API
GET : https://pasta.lternet.edu/package/metadata/checksum/eml/{scope}/{identifier}/{revision}
Read Metadata Format
Description
Read Metadata Format operation, specifying the scope, identifier, and revision of the metadata to be read in the URI,
returning the metadata format type, e.g. “eml://ecoinformatics.org/eml-2.1.1”
REST API
GET : https://pasta.lternet.edu/package/metadata/format/eml/{scope}/{identifier}/{revision}
22
Chapter 3. PASTA API
PASTA Documentation, Release
Provenance
Describes web service methods for tracking and generating provenance metadata.
Get Provenance Metadata
Description
Add Provenance Metadata from Level-1 metadata in PASTA to an XML document containing a single methods element in the request message body.
REST API
GET : https://pasta.lternet.edu/package/provenance/eml/{scope}/{identifier}/{revision}
Event Notifications
Describes web service methods for subscribing to and receiving data package event notifications.
Create Event Subscription
Description
Create Event Subscription creates a new event subscription.
REST API
POST : https://pasta.lternet.edu/package/event/eml
Delete Event Subscription
Description
Delete Event Subscription deletes the event subscription with the specified ID from the subscription database. After
“deletion,” the subscription might still exist in the subscription database, but it will be inactive - it will not conflict
with future creation requests, it cannot be read, and it will not be notified of events.
REST API
DELETE : https://pasta.lternet.edu/package/event/eml/{subscriptionId}
3.1. Data Package Manager API
23
PASTA Documentation, Release
Execute Event Subscription
Description
Execute Event Subscription operation, specifying the ID of the event subscription whose URL is to be executed. Used
to execute a particular subscription in the event manager, via an HTTP POST request. Upon notification, the event
manager queries its database for the subscription matching the specified subscriptionId. POST requests are then made
(asynchronously) to the matching subscription.
The request headers must contain an authorization token. If the request is successful, an HTTP response with status
code 200 ‘OK’ is returned. If the request is unauthorized, based on the content of the authorization token and the
current access control rule for event notification, status code 401 ‘Unauthorized’ is returned. If the request contains an
error, status code 400 ‘Bad Request’ is returned, with a description of the encountered error.
REST API
POST : https://pasta.lternet.edu/package/event/eml/{subscriptionId}
Query Event Subscriptions
Description
Query Event Subscriptions operation, returns a list of the subscriptions whose attributes match those specified in the
query string. If a query string is omitted, all subscriptions in the subscription database will be returned for which the
requesting user is authorized to read. If query parameters are included, they are used to filter that set of subscriptions
based on their attributes.
REST API
GET : https://pasta.lternet.edu/package/event/eml
Get Event Subscription
Description
Get Event Subscription returns the event subscription with the specified ID.
REST API
GET : https://pasta.lternet.edu/package/event/eml/{subscriptionId}
Get Event Subscription Schema
Description
Get Event Subscription Schema operation, returns the XML schema for event subscription creation request entities.
24
Chapter 3. PASTA API
PASTA Documentation, Release
REST API
GET : https://pasta.lternet.edu/package/event/eml/schema
Identifier Reservation Services
Web service methods whereby an end user may reserve data package identifiers for future upload to PASTA.
Create Reservation
Description
Create Reservation operation, creates a new reservation in PASTA for the specified user on the next reservable identifier
for the specified scope. The integer value of the reserved identifier (as assigned by PASTA) is returned in the web
service response body. User authentication is required.
REST API
POST : https://pasta.lternet.edu/package/reservations/eml/{scope}
Examples
1. Using curl to reserve the next available identifier for the specified scope (“edi”):
curl -i -u uid=jsmith,o=LTER,dc=ecoinformatics,dc=org:SOME_PASSWORD -X POST
˓→"https://pasta.lternet.edu/package/reservations/eml/edi"
HTTP/1.1 201 Created
12
In the example above, user "jsmith" creates a reservation on the next
available identifier for the "edi" scope. PASTA assigns the value "12",
meaning that data package identifier "edi.12" is now reserved for future
upload by user "jsmith". Only user "jsmith" will be allowed to upload
data packages with identifier "edi.12".
List Active Reservations
Description
List Active Reservations operation, lists the set of data package identifiers that users have actively reserved in PASTA.
Note that data package identifiers that have been successfully uploaded into PASTA are no longer considered active
reservations and thus are not included in this list.
REST API
GET : https://pasta.lternet.edu/package/reservations/eml
3.1. Data Package Manager API
25
PASTA Documentation, Release
Examples
1. Using curl to list active reservations:
curl -X GET https://pasta.lternet.edu/package/reservations/eml
<reservations>
<reservation>
<docid>edi.99</docid>
<principal>uid=LNO,o=LTER,dc=ecoinformatics,dc=org</principal>
<dateReserved>2017-01-23 14:11:48.234</dateReserved>
</reservation>
<reservation>
<docid>edi.100</docid>
<principal>uid=LNO,o=LTER,dc=ecoinformatics,dc=org</principal>
<dateReserved>2017-01-23 14:14:49.205</dateReserved>
</reservation>
<reservation>
<docid>edi.7</docid>
<principal>uid=LNO,o=LTER,dc=ecoinformatics,dc=org</principal>
<dateReserved>2017-01-23 16:03:44.48</dateReserved>
</reservation>
<reservation>
<docid>edi.10</docid>
<principal>uid=LNO,o=LTER,dc=ecoinformatics,dc=org</principal>
<dateReserved>2017-01-23 16:16:29.321</dateReserved>
</reservation>
<reservation>
<docid>edi.11</docid>
<principal>uid=LNO,o=LTER,dc=ecoinformatics,dc=org</principal>
<dateReserved>2017-01-23 16:16:49.304</dateReserved>
</reservation>
<reservation>
<docid>edi.12</docid>
<principal>uid=LNO,o=LTER,dc=ecoinformatics,dc=org</principal>
<dateReserved>2017-01-23 16:16:51.857</dateReserved>
</reservation>
</reservations>
List Reservation Identifiers
Description
List Reservation Identifiers operation, lists the set of numeric identifiers for the specified scope that end users have
actively reserved for future upload to PASTA. The numeric identifiers are listed one per line.
REST API
GET : https://pasta.lternet.edu/package/reservations/eml/{scope}
Examples
1. Using curl to list reservation identifiers for a specified scope:
26
Chapter 3. PASTA API
PASTA Documentation, Release
curl -X GET https://pasta.lternet.edu/package/reservations/eml/edi
7
10
11
12
99
100
System Monitoring Services
Web service methods for monitoring the state of data packages being processed in PASTA.
List Working On
Description
List Working On operation, lists the set of data packages that PASTA is currently working on inserting or updating.
(Note that data packages currently being evaluated by PASTA are not included in the list.)
REST API
GET : https://pasta.lternet.edu/package/workingon/eml
Examples
1. Using curl to list data packages that PASTA is working on uploading:
curl -X GET https://pasta.lternet.edu/package/workingon/eml
<workingOn>
<dataPackage>
<packageId>edi.9.1</packageId>
<startDate>2016-12-21 10:43:24.923</startDate>
</dataPackage>
<dataPackage>
<packageId>knb-lter-nin.1.2</packageId>
<startDate>2016-12-08 16:58:29.307</startDate>
</dataPackage>
<dataPackage>
<packageId>knb-lter-nin.1.4</packageId>
<startDate>2016-12-08 17:20:59.998</startDate>
</dataPackage>
<dataPackage>
<packageId>knb-lter-nwk.1836.1</packageId>
<startDate>2016-12-12 16:54:09.269</startDate>
</dataPackage>
<dataPackage>
<packageId>knb-lter-nwk.1837.1</packageId>
<startDate>2016-12-12 16:55:05.453</startDate>
</dataPackage>
<dataPackage>
3.1. Data Package Manager API
27
PASTA Documentation, Release
<packageId>knb-lter-nwk.1837.2</packageId>
<startDate>2016-12-12 16:55:36.232</startDate>
</dataPackage>
<dataPackage>
<packageId>knb-lter-nwk.1838.1</packageId>
<startDate>2016-12-12 16:58:01.403</startDate>
</dataPackage>
<dataPackage>
<packageId>knb-lter-nwk.1844.1</packageId>
<startDate>2017-01-23 16:41:32.349</startDate>
</dataPackage>
<dataPackage>
<packageId>knb-lter-nwk.1849.1</packageId>
<startDate>2017-01-24 13:37:29.09</startDate>
</dataPackage>
</workingOn>
Miscellaneous Services
Additional web service methods for working with data packages.
Create Data Package Archive
Description
Create Data Package Archive (Zip) operation, specifying the scope, identifier, and revision of the data package to be
Zipped in the URI, and returning a transaction identifier in the response message body as plain text; the transaction
identifier may be used in a subsequent call to Read Data Package Error to determine the operation status or to Read
Data Package Archive to obtain the Zip archive.
REST API
POST : https://pasta.lternet.edu/package/archive/eml/{scope}/{identifier}/{revision}
Is Authorized
Description
Is Authorized (to read resource) operation, determines whether the user as defined in the authentication token has
permission to read the specified data package resource.
REST API
GET : https://pasta.lternet.edu/package/authz?resourceId={resource identifier}
28
Chapter 3. PASTA API
PASTA Documentation, Release
Audit Manager API
Introduction
The Audit Manager web service allows other PASTA web services to create, and users to access, PASTA audit logs.
Audit Manager Services
Create Audit Record
Description
Creates a new logged entry in the Audit Manager’s logging database.
REST API
POST : https://pasta.lternet.edu/audit
Get Audit Record
Description
Gets a single audit record based on the audit identifier value specified in the path.
REST API
GET : https://pasta.lternet.edu/audit/report/{oid}
Get Audit Report
Description
Gets an audit report, an XML list of zero or more audit records matching the query parameters as specified in the
request.
REST API
GET : https://pasta.lternet.edu/audit/report
Get Audit Count
Description
Returns a count of the number of audit records matching the query parameters as specified in the request.
3.2. Audit Manager API
29
PASTA Documentation, Release
REST API
GET : https://pasta.lternet.edu/audit/count
Get Recent Uploads
Description
Gets a list of zero or more audit records of either recently inserted or recently updated data packages, as specified in
the request.
REST API
GET : https://pasta.lternet.edu/audit/recent-uploads
30
Chapter 3. PASTA API
CHAPTER
4
PASTA Developers Guide
31
PASTA Documentation, Release
32
Chapter 4. PASTA Developers Guide
CHAPTER
5
General FAQ
search
33