The Data Package Manager Web Service provides a suite of operations to create, evaluate, read, update, delete, list, and search data package resources in the PASTA system; additional operations provide access to evaluation reports, provenance metadata, event subscriptions, and whether the user has read access to specific resources. Data package resources include metadata documents, data entities, and quality reports.
Request Summary |
|
---|---|
HTTP Verb : Relative URL | Brief description |
POST : /eml | Create Data Package operation, specifying 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 readDataPackageError to
determine the operation status; see readDataPackage to
obtain the data package resource map if the operation completed
successfully. |
POST : /archive/eml/{scope}/{identifier}/{revision} | 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 readDataPackageError to
determine the operation status or to readDataPackageArchive
to obtain the Zip archive. |
GET : /download/eml/{scope}/{identifier}/{revision} | Download Data Package as a ZIP archive operation, specifying the scope, identifier, and revision of the data package in the URI, and returning a stream of zipped bytes in the response message body. |
POST : /reservations/eml/{scope} | Create Reservation operation, creates a new reservation in PASTA on the next reservable identifier for the specified scope. |
DELETE : /reservations/eml/{scope}/{identifier} | Delete Reservation operation, deletes an existing reservation in PASTA for the specified scope and identifier. |
POST : /evaluate/eml | 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 readDataPackageError to
determine the operation status or to readEvaluateReport to
obtain the evaluate quality report. |
GET : /provenance/eml/{scope}/{identifier}/{revision} | Get Provenance Metadata operation, specifying the scope, identifier, and revision of the parent data package whose provenance metadata is to be generated and retrieved, returning an XML string representing a <methodStep> element that can be inserted into the <methods> section of a dependent data package. |
GET : /authz | 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. |
GET : /data/eml/{scope}/{identifier}/{revision} | List Data Entities operation, specifying the scope, identifier, and revision values to match in the URI. |
GET : /reservations/eml | List Active Reservations operation, lists the set of data package identifiers that users have actively reserved in PASTA. |
GET : /reservations/eml/{scope} | 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. |
GET : /descendants/eml/{scope}/{identifier}/{revision} | List Data Descendants operation, specifying the scope, identifier, and revision values to match in the URI. |
GET : /sources/eml/{scope}/{identifier}/{revision} | List Data Sources operation, specifying the scope, identifier, and revision values to match in the URI. |
GET : /eml/{scope} | List Data Package Identifiers operation, specifying the scope value to match in the URI. |
GET : /eml/{scope}/{identifier} | List Data Package Revisions operation, specifying the scope and identifier values to match in the URI. |
GET : /eml | List Data Package Scopes operation, returning all scope values extant in the data package registry. |
GET : /eml/deleted | List Deleted Data Packages operation, returning all document identifiers (excluding revision values) that have been deleted from the data package registry. |
GET : /service-methods | List Service Methods operation, returning a simple list of web service methods supported by the Data Package Manager web service. |
GET : /data/eml/{scope}/{identifier}/{revision}/{entityId} | Read Data Entity operation, specifying the scope, identifier, revision, and entity identifier of the data entity to be read in the URI. |
GET : /data/acl/eml/{scope}/{identifier}/{revision}/{entityId} | 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. |
GET : /data/rmd/eml/{scope}/{identifier}/{revision}/{entityId} | Read Data Entity Resource Metadata operation, specifying the scope, identifier, revision, and entity identifier of the data entity object whose resource metadata is to be read in the URI, returning an XML string representing the resource metadata for the data entity. |
GET : /data/checksum/eml/{scope}/{identifier}/{revision}/{entityId} | 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. |
GET : /data/size/eml/{scope}/{identifier}/{revision}/{entityId} | Read Data Entity Size operation, specifying the scope, identifier, revision, and entity ID of the data entity object whose size is to be read in the URI, returning an integer, the size value in bytes. |
GET : /data/size/eml/{scope}/{identifier}/{revision} | Read Data Entity Sizes operation, specifying the scope, identifier, and revision of the data package whose entity sizes are to be read in the URI. |
GET : /name/eml/{scope}/{identifier}/{revision}/{entityId} | 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. |
GET : /name/eml/{scope}/{identifier}/{revision} | Read Data Entity Names operation, specifying the scope, identifier, and revision of the data package whose entity names are to be read in the URI. |
GET : /eml/{scope}/{identifier}/{revision} | Read Data Package operation, specifying the scope, identifier, and revision of the data package to be read in the URI, returning a resource graph with reference URLs to each of the metadata, data, and quality report resources that comprise the data package. |
GET : /acl/eml/{scope}/{identifier}/{revision} | 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. |
GET : /rmd/eml/{scope}/{identifier}/{revision} | Read Data Package Resource Metadata operation, specifying the scope, identifier, and revision of the data package whose resource metadata is to be read in the URI, returning an XML string representing the resource metadata for the data package resource. |
GET : /archive/eml/{scope}/{identifier}/{revision}/{transaction} | 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. |
GET : /doi/eml/{scope}/{identifier}/{revision} | 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. |
GET : /error/eml/{transaction} | Read Data Package Error operation, specifying the scope, identifier, revision, and transaction id of the data package error to be read in the URI, returning the error message as plain text. |
GET : /doi/{shoulder}/{pasta}/{md5} | Read Data Package From DOI operation, specifying the DOI of the data package to be read in the URI, returning a resource graph with reference URLs to each of the metadata, data, and quality report resources that comprise the data package. |
GET : /report/eml/{scope}/{identifier}/{revision} | Read Data Package Report operation, specifying the scope, identifier, and revision of the data package quality report document to be read in the URI. |
GET : /report/acl/eml/{scope}/{identifier}/{revision} | 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. |
GET : /report/rmd/eml/{scope}/{identifier}/{revision} | Read Data Package Report Resource Metadata operation, specifying the scope, identifier, and revision of the data package report whose resource metadata is to be read in the URI, returning an XML string representing the resource metadata for the data package report resource. |
GET : /report/checksum/eml/{scope}/{identifier}/{revision} | 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. |
GET : /evaluate/report/eml/{transaction} | Read Evaluate Report operation, specifying the transaction identifier of the evaluate quality report document to be read in the URI. |
GET : /metadata/eml/{scope}/{identifier}/{revision} | Read Metadata operation, specifying the scope, identifier, and revision of the EML document to be read in the URI. |
GET : /metadata/dc/{scope}/{identifier}/{revision} | Read Metadata Dublin Core operation, specifying the scope, identifier, and revision of the Dublin Core metadata document to be read in the URI. |
GET : /metadata/acl/eml/{scope}/{identifier}/{revision} | 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. |
GET : /metadata/rmd/eml/{scope}/{identifier}/{revision} | Read Metadata Resource Metadata operation, specifying the scope, identifier, and revision of the data package metadata resource whose resource metadata is to be read in the URI, returning an XML string representing the resource metadata for the data package metadata resource. |
GET : /metadata/checksum/eml/{scope}/{identifier}/{revision} | 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. |
GET : /metadata/format/eml/{scope}/{identifier}/{revision} | 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. |
GET : /search/eml | Search Data Packages operation, specifying the Solr query as query parameters in the URL. |
GET : /search/download | . |
GET : /uploads/eml | List Recent Uploads operation, optionally specifying the upload type ("insert" or "update") and a maximum limit as query parameters in the URL. |
GET : /changes/eml | List Recent Changes operation, listing data package changes (insert, update, and delete operations) recorded in PASTA's resource registry. |
GET : /user/{dn} | List User Data Packages operation, returning all packageId values (including revision values) where the principal owner (i. |
GET : /workingon/eml | List Working On operation, lists the set of data packages that PASTA is currently working on inserting or updating. |
PUT : /eml/{scope}/{identifier} | 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 readDataPackageError to
determine the operation status; see readDataPackage to
obtain the data package resource map if the operation completed
successfully. |
DELETE : /eml/{scope}/{identifier} | Delete Data Package operation, specifying the scope and identifier of the data package to be deleted in the URI. |
POST : /event/eml | Create Event Subscription operation, creates a new event subscription. |
DELETE : /event/eml/{subscriptionId} | Delete Event Subscription operation, deletes the event subscription with the specified ID from the subscription database. |
POST : /event/eml/{subscriptionId} | Execute Event Subscription operation, specifying the ID of the event subscription whose URL is to be executed. |
GET : /event/eml | Query Event Subscriptions operation, returns a list of the subscriptions whose attributes match those specified in the query string. |
GET : /event/eml/{subscriptionId} | Get Event Subscription operation, returns the event subscription with the specified ID. |
GET : /event/eml/schema | Get Event Subscription Schema operation, returns the XML schema for event subscription creation request entities. |
POST : /citation/eml | Create Journal Citation operation, creates a new journal citation entry in PASTA. |
PUT : /citation/eml/{journalCitationId} | Update Journal Citation operation, updates an existing journal citation entry in PASTA. |
DELETE : /citation/eml/{journalCitationId} | Delete Journal Citation operation, deletes the journal citation entry with the specified ID from the journal citation database. |
GET : /citation/eml/{journalCitationId} | Get Journal Citation operation, returns metadata for a journal citation with the specified ID. |
GET : /citations/eml/{scope}/{identifier}/{revision} | List Data Package Citations operation, specifying the scope, identifier, and revision values to match in the URI. |
GET : /citations/eml/{principalOwner} | List Principal Owner Citations operation, specifying the principal owner of the citations to be listed. |
Request Detail |
---|
POST : /eml | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create Data Package operation, specifying 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 readDataPackageError to
determine the operation status; see readDataPackage to
obtain the data package resource map if the operation completed
successfully.
Request:
Response:
|
POST : /archive/eml/{scope}/{identifier}/{revision} | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 readDataPackageError to
determine the operation status or to readDataPackageArchive
to obtain the Zip archive.
Request:
Response:
|
GET : /download/eml/{scope}/{identifier}/{revision} | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Download Data Package as a ZIP archive operation, specifying the scope, identifier, and revision of the data package in the URI, and returning a stream of zipped bytes in the response message body. Request:
Response:
|
POST : /reservations/eml/{scope} | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create Reservation operation, creates a new reservation in PASTA on the next reservable identifier for the specified scope. Responses:
|
DELETE : /reservations/eml/{scope}/{identifier} | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete Reservation operation, deletes an existing reservation in PASTA for the specified scope and identifier. Responses:
|
POST : /evaluate/eml | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 readDataPackageError to
determine the operation status or to readEvaluateReport to
obtain the evaluate quality report.
Request:
Query parameters:An optional query parameter, "useChecksum", can be appended to the URL. When specified, the useChecksum query parameter directs the server to determine whether it can use an existing copy of a data entity from a previous revision of the data package based on matching a metadata-documented checksum value (MD5 or SHA-1) to the checksum of the existing copy. If a match is found, the server will skip the upload of the data entity from the remote URL and instead use its matching copy. Please Note: Specifying "useChecksum" can save time by eliminating data uploads, but clients should take care to ensure that metadata-documented checksum values are accurate and up to date. Response:
|
GET : /provenance/eml/{scope}/{identifier}/{revision} | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Provenance Metadata operation, specifying the scope, identifier, and revision of the parent data package whose provenance metadata is to be generated and retrieved, returning an XML string representing a <methodStep> element that can be inserted into the <methods> section of a dependent data package. Request:
Responses:
|
GET : /authz | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. Requests:
Query parameters:
The query parameter must be the Responses:
|
GET : /data/eml/{scope}/{identifier}/{revision} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
List Data Entities operation, specifying the scope, identifier, and revision values to match in the URI. Requests:
Responses:
|
GET : /reservations/eml | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
List Active Reservations operation, lists the set of data package identifiers that users have actively reserved in PASTA. Note that data packages identifier that have been successfully uploaded into PASTA are no longer considered active reservations and thus are not included in this list. Requests:
Responses:
|
GET : /reservations/eml/{scope} | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. Requests:
Responses:
|
GET : /descendants/eml/{scope}/{identifier}/{revision} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
List Data Descendants operation, specifying the scope, identifier, and revision values to match in the URI. Requests:
Responses:
|
GET : /sources/eml/{scope}/{identifier}/{revision} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
List Data Sources operation, specifying the scope, identifier, and revision values to match in the URI. Requests:
Responses:
|
GET : /eml/{scope} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
List Data Package Identifiers operation, specifying the scope value to match in the URI. Requests:
Responses:
|
GET : /eml/{scope}/{identifier} | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. Requests:
Query parameters:
If present, the query parameter must be Responses:
|
GET : /eml | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
List Data Package Scopes operation, returning all scope values extant in the data package registry. Requests:
Responses:
|
GET : /eml/deleted | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
List Deleted Data Packages operation, returning all document identifiers (excluding revision values) that have been deleted from the data package registry. Requests:
Responses:
|
GET : /service-methods | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
List Service Methods operation, returning a simple list of web service methods supported by the Data Package Manager web service. Requests:
Responses:
|
GET : /data/eml/{scope}/{identifier}/{revision}/{entityId} | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. Requests:
Responses:
|
GET : /data/acl/eml/{scope}/{identifier}/{revision}/{entityId} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. Requests:
Responses:
|
GET : /data/rmd/eml/{scope}/{identifier}/{revision}/{entityId} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Read Data Entity Resource Metadata operation, specifying the scope, identifier, revision, and entity identifier of the data entity object whose resource metadata is to be read in the URI, returning an XML string representing the resource metadata for the data entity. Requests:
Responses:
|
GET : /data/checksum/eml/{scope}/{identifier}/{revision}/{entityId} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. Requests:
Responses:
|
GET : /data/size/eml/{scope}/{identifier}/{revision}/{entityId} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Read Data Entity Size operation, specifying the scope, identifier, revision, and entity ID of the data entity object whose size is to be read in the URI, returning an integer, the size value in bytes. Requests:
Responses:
|
GET : /data/size/eml/{scope}/{identifier}/{revision} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Read Data Entity Sizes operation, specifying the scope, identifier, and revision of the data package whose entity sizes are to be read in the URI. Returns a newline-separated list of lines, where each line contains an entity id followed by a comma followed by the entity size of that entity. Requests:
Responses:
|
GET : /name/eml/{scope}/{identifier}/{revision}/{entityId} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. Requests:
Responses:
|
GET : /name/eml/{scope}/{identifier}/{revision} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Read Data Entity Names operation, specifying the scope, identifier, and revision of the data package whose entity names are to be read in the URI. Returns a newline-separated list of lines, where each line contains an entity id followed by a comma followed by the entity name of that entity. Requests:
Responses:
|
GET : /eml/{scope}/{identifier}/{revision} | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Read Data Package operation, specifying the scope, identifier, and revision of the data package to be read in the URI, returning a resource graph 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. Requests:
Responses:
|
GET : /acl/eml/{scope}/{identifier}/{revision} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. Requests:
Responses:
|
GET : /rmd/eml/{scope}/{identifier}/{revision} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Read Data Package Resource Metadata operation, specifying the scope, identifier, and revision of the data package whose resource metadata is to be read in the URI, returning an XML string representing the resource metadata for the data package resource. Requests:
Responses:
|
GET : /archive/eml/{scope}/{identifier}/{revision}/{transaction} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. Note that the user id of the request must be the same as the original requestor. Requests:
Responses:
|
GET : /doi/eml/{scope}/{identifier}/{revision} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. Requests:
Responses:
|
GET : /error/eml/{transaction} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Read Data Package Error operation, specifying the scope, identifier, revision, and transaction id of the data package error to be read in the URI, returning the error message as plain text. Requests:
Responses:
|
GET : /doi/{shoulder}/{pasta}/{md5} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Read Data Package From DOI operation, specifying the DOI of the data package to be read in the URI, returning a resource graph with reference URLs to each of the metadata, data, and quality report resources that comprise the data package. When the "ore" query parameter is appended to the request URL, an OAI-ORE compliant resource map in RDF-XML format is returned, for example:
Requests:
Responses:
|
GET : /report/eml/{scope}/{identifier}/{revision} | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. Requests:
Responses:
|
GET : /report/acl/eml/{scope}/{identifier}/{revision} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. Requests:
Responses:
|
GET : /report/rmd/eml/{scope}/{identifier}/{revision} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Read Data Package Report Resource Metadata operation, specifying the scope, identifier, and revision of the data package report whose resource metadata is to be read in the URI, returning an XML string representing the resource metadata for the data package report resource. Requests:
Responses:
|
GET : /report/checksum/eml/{scope}/{identifier}/{revision} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. Requests:
Responses:
|
GET : /evaluate/report/eml/{transaction} | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 Requests:
Responses:
|
GET : /metadata/eml/{scope}/{identifier}/{revision} | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. Requests:
Responses:
|
GET : /metadata/dc/{scope}/{identifier}/{revision} | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Read Metadata Dublin Core operation, specifying the scope, identifier, and revision of the Dublin Core metadata document to be read in the URI. Revision may be specified as "newest" or "oldest" to retrieve the newest or oldest revision, respectively. Requests:
Responses:
|
GET : /metadata/acl/eml/{scope}/{identifier}/{revision} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. Requests:
Responses:
|
GET : /metadata/rmd/eml/{scope}/{identifier}/{revision} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Read Metadata Resource Metadata operation, specifying the scope, identifier, and revision of the data package metadata resource whose resource metadata is to be read in the URI, returning an XML string representing the resource metadata for the data package metadata resource. Requests:
Responses:
|
GET : /metadata/checksum/eml/{scope}/{identifier}/{revision} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. Requests:
Responses:
|
GET : /metadata/format/eml/{scope}/{identifier}/{revision} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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" Requests:
Responses:
|
GET : /search/eml | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Search Data Packages operation, specifying the Solr query as query parameters in the URL. Requests:
Responses:
|
GET : /search/download | |
---|---|
|
GET : /uploads/eml | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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.) Requests:
Responses:
|
GET : /changes/eml | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
List Recent Changes operation, listing data package changes (insert, update, and delete operations) recorded in PASTA's resource registry. If a query string is omitted, all changes (inserts, updates, and deletes) to the resource registry will be returned. If query parameters are included, they are used to filter that set of changes based on their attributes. Query parameters:Query parameters are specified as key=value pairs, multiple pairs must be delimited with ampersands (&), and only a single value should be specified for a particular key. The following query parameter keys are allowed:
If
scope is specified, its value must be one of the recognized
scope values as configured in PASTA. For example:
Requests:
Responses:
|
GET : /user/{dn} | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
List User Data Packages operation, returning all packageId values (including revision values) where the principal owner (i.e. the user who uploaded the data package) matches the specified distinguished name value. Requests:
Responses:
|
GET : /workingon/eml | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
List Working On operation, lists the set of data packages that PASTA is currently working on inserting or updating. Note that data packages that are being evaluated by PASTA are not included in this list. (See example below.) Requests:
Responses:
|
PUT : /eml/{scope}/{identifier} | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 readDataPackageError to
determine the operation status; see readDataPackage to
obtain the data package resource map if the operation completed
successfully.
Requests:
Query parameters:An optional query parameter, "useChecksum", can be appended to the URL. When specified, the useChecksum query parameter directs the server to determine whether it can use an existing copy of a data entity from a previous revision of the data package based on matching a metadata-documented checksum value (MD5 or SHA-1) to the checksum of the existing copy. If a match is found, the server will skip the upload of the data entity from the remote URL and instead use its matching copy. Please Note: Specifying "useChecksum" can save time by eliminating data uploads, but clients should take care to ensure that metadata-documented checksum values are accurate and up to date. Responses:
|
DELETE : /eml/{scope}/{identifier} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete Data Package operation, specifying the scope and identifier of the data package to be deleted in the URI. The data package and its associated quality reports are deleted. Requests:
Responses:
|
POST : /event/eml | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create Event Subscription operation, creates a new event subscription. Request entity:
The request entity should be an XML document (MIME type
<subscription type="eml"> <packageId>packageId</packageId> <url>url</url> </subscription>
The packageId can be either complete or partial. The URL must have 'http'
as its scheme and must be able to receive POST requests with MIME type
Responses:
|
DELETE : /event/eml/{subscriptionId} | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete Event Subscription operation, 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. Responses:
|
POST : /event/eml/{subscriptionId} | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. Requests:
Responses:
|
GET : /event/eml | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. Query parameters:Query parameters are specified as key=value pairs, multiple pairs must be delimited with ampersands (&), and only a single value should be specified for a particular key. The following query parameter keys are allowed:
If a query parameter is specified, and a subscription's respective
attribute does not match it, that subscription will not be included in
the group of subscriptions returned. If Responses:If the request is successful, the response entity will be an XML representation of the subscription group with the following syntax: <subscriptions> <subscription type="eml"> <id>id</id> <creator>creator</creator> <packageId>packageId</packageId> <url>url</url> </subscription> ... </subscriptions>
|
GET : /event/eml/{subscriptionId} | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Event Subscription operation, returns the event subscription with the specified ID. Responses:If the request is successful, the response will contain an XML entity with the following syntax: <subscription type="eml"> <id>id</id> <creator>creator</creator> <packageId>packageId</packageId> <url>url</url> </subscription>
The difference between this response entity and the request entity used
to create the subscription is the addition of the
|
GET : /event/eml/schema | |||||||||
---|---|---|---|---|---|---|---|---|---|
Get Event Subscription Schema operation, returns the XML schema for event subscription creation request entities. Responses:
|
POST : /citation/eml | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create Journal Citation operation, creates a new journal citation entry in PASTA. Request entity:
The request entity should be an XML document (MIME type
<journalCitation> <packageId>edi.0.3</packageId> <articleDoi>10.5072/FK2/06dccc7b0cb2a2d5f6fef62cb4b36dae</articleDoi> <articleTitle>Tree Survey in Southern Arizona</articleTitle> <articleUrl>http://swtrees.com/articles/12345</articleUrl> <journalTitle>Journal of Southwestern Trees</journalTitle> </journalCitation> Responses:
|
PUT : /citation/eml/{journalCitationId} | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update Journal Citation operation, updates an existing journal citation entry in PASTA. Request entity:
The request entity should be an XML document (MIME type
<journalCitation> <packageId>edi.0.3</packageId> <articleDoi>10.5072/FK2/06dccc7b0cb2a2d5f6fef62cb4b36dae</articleDoi> <articleTitle>Tree Survey in Southern Arizona</articleTitle> <articleUrl>http://swtrees.com/articles/12345</articleUrl> <journalTitle>Journal of Southwestern Trees</journalTitle> </journalCitation> Responses:
|
DELETE : /citation/eml/{journalCitationId} | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete Journal Citation operation, deletes the journal citation entry with the specified ID from the journal citation database. Responses:
|
GET : /citation/eml/{journalCitationId} | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Journal Citation operation, returns metadata for a journal citation with the specified ID. Responses:If the request is successful, the response will contain an XML entity with the following syntax: <journalCitation> <journalCitationId>15</journalCitationId> <principalOwner>uid=LNO,o=LTER,dc=ecoinformatics,dc=org</principalOwner> <packageId>edi.0.3</packageId> <articleDoi>10.5072/FK2/06dccc7b0cb2a2d5f6fef62cb4b36dae</articleDoi> <articleTitle>Tree Survey in Southern Arizona</articleTitle> <articleUrl>http://swtrees.com/articles/12345</articleUrl> <journalTitle>Journal of Southwestern Trees</journalTitle> </journalCitation>
The difference between this response entity and the request entity used
to create the citation is the addition of the
|
GET : /citations/eml/{scope}/{identifier}/{revision} | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
List Data Package Citations operation, specifying the scope, identifier, and revision values to match in the URI. Return all citations for a given data package series if the "?all" query parameter is appended to the URL. Requests:
Responses:
|
GET : /citations/eml/{principalOwner} | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
List Principal Owner Citations operation, specifying the principal owner of the citations to be listed. Requests:
Responses:
|