Science Object Operations

Commands for creating and retrieving Science Data Objects and System Metadata.

get <pid> <file>

Get an object from a MN.

The object is saved to file.

Active session parameters: mn-url, Authentication

meta <pid> [file]

Get the System Metadata that is associated with a Science Object from a CN.

Provide file if saving the System Metadata is desired.

Connects to the CN set in the dataone-url session parameter.

Active session parameters: dataone-url, Authentication

create <pid> <file>

Create a new Science Object on a MN.

The System Metadata that becomes associated with the new Science Object is generated from the values in the System Metadata, Access Policy and Replication Policy session parameters.

The algorithm set in algorithm is used for calculating the checksum for the new object. If the value is unset, it defaults to the DataONE system wide default, which is currently SHA1.

Active session parameters: mn-url, format-id, submitter, rights-holder, origin-mn, authoritative-mn, algorithm, Access Policy, Replication Policy, Authentication

update <pid> <file> <pid>

Replace an existing Science Object in a MN with another.

The existing Science Object becomes obsoleted by the new Science Object. obsoleted by the new values in the System Metadata, Access Policy and Replication Policy session parameters.

The algorithm set in algorithm is used for calculating the checksum for the new object. If the value is unset, it defaults to the DataONE system wide default, which is currently SHA1.

Active session parameters: mn-url, format-id, submitter, rights-holder, origin-mn, authoritative-mn, algorithm, Access Policy, Replication Policy, Authentication

delete <pid>

Mark an existing Science Object as archived.

Active session parameters: mn-url, submitter, Access Policy, Replication Policy, Authentication

resolve <pid>

Given the pid for a Science Object, find all locations from which the Science Object can be downloaded.

Active session parameters: dataone-url, Authentication

list

Retrieve a list of available Science Data Objects from a single MN with basic filtering.

Active session parameters: mn-url, start, count, from-date, to-date, search-format-id, Authentication

See also: Search Page

log

Retrieve event log.

Active session parameters: mn-url, start, count, from-date, to-date, search-format-id, Authentication

setaccess <pid>

Update the Access Policy on an existing Science Data Object.

Requires that the calling subject has authenticated and has changePermission access level on the object for which Access Policy is to be updated.

Active session parameters: dataone-url, Authentication, Access Policy

setreplication <pid>

Update the Replication Policy on an existing Science Data Object.

Requires that the calling subject has authenticated and has changePermission access level on the object for which Replication Policy is to be updated.

Active session parameters: dataone-url, Replication Policy, Authentication