updateSystemMetadata: Update the system metadata associated with an object.

Description Usage Arguments Details Value Note See Also

Description

A modified SytemMetadata object can be sent to DataONE that contains updated information. This function allow updating of the system metadata without updating the object that it describes, so that mutable attributes such as accessPolicy can be updated easily.

Usage

1
2
3
4
updateSystemMetadata(x, ...)

## S4 method for signature 'MNode'
updateSystemMetadata(x, pid, sysmeta)

Arguments

x

The MNode instance from which the SystemMetadata will be downloaded

...

(Not yet used.)

pid

The identifier of the object

sysmeta

a SystemMetadata instance with updated information.

Details

In the version 2.0 library and higher, this operation can utilize an 'dataone_token' option to provide credentials for write operations in DataONE. The authentication token is obtained from DataONE (see your profile on https://search.dataone.org). See the vignette("dataone-overview") for details. Alternatively, the version 1.0 approach of using an X.509 certificate in a default location of the file system can also be used. This certificate provides authentication credentials from CILogon https://cilogon.org/?skin=DataONE. See vignette("dataone-overview") for details.

Value

A logical value, TRUE if the operation was successful, FALSE if there was an error.

Note

Please see the vignette *upload-data* for an example: vignette("upload-data")

See Also

https://purl.dataone.org/architecture/apis/MN_APIs.html#MNStorage.updateSystemMetadata


dataone documentation built on July 2, 2018, 1:02 a.m.