MetaApi: Agave Meta API operations

Description Usage Format Details Arguments Methods See Also

Description

MetaApi Class

Usage

1
meta <- MetaApi$new( apiClient = ApiClient$new(), cache = AgaveCache$new() )

Format

An object of class R6ClassGenerator of length 24.

Details

The Agave Metadata service allows you to manage metadata and associate it with Agave entities via associated UUIDs. It supports JSON schema for structured JSON metadata; it also accepts any valid JSON-formatted metadata or plain text String when no schema is specified. As with other Agave services, a full access control layer is available, enabling you to keep your metadata private or share it with your colleagues.

Read more about the Meta API in the Agave Developer's Guide

Arguments

apiClient a rAgave::ApiClient instance preconfigured to speak to the Agave Platform.

cache an rAgave::AgaveCache instance pointing to the persistent auth cache file on disk.

responseType the default object type methods of this class should return. Valid values are:

Methods

$addMetadata() Update or Add new Metadata.

Usage

1
meta$addMetadata$listMeta(body, naked, )

$addMetadataPermission() Add a user permission for the given metadata.

Usage

1
meta$addMetadataPermission$listMeta(uuid, body, naked, )

$addMetadataSchema() Add a new Metadata Schema.

Usage

1
meta$addMetadataSchema$listMeta(body, naked, )

$addMetadataSchemaPermission() Add a user permission for the given schema.

Usage

1
meta$addMetadataSchemaPermission$listMeta(uuid, body, naked, )

$clearMetadataPermissions() Deletes all permissions on the given metadata.

Usage

1
meta$clearMetadataPermissions$listMeta(uuid, naked, )

$clearMetadataSchemaPermissions() Deletes all permissions on the given schema.

Usage

1
meta$clearMetadataSchemaPermissions$listMeta(uuid, naked, )

$deleteMetadata() Remove Metadata from the system.

Usage

1
meta$deleteMetadata$listMeta(uuid, naked, )

$deleteMetadataPermission() Removes user permissions for a user on a given metadata resource.

Usage

1
meta$deleteMetadataPermission$listMeta(uuid, username, naked, )

$deleteMetadataSchema() Remove Metadata Schema from the system.

Usage

1
meta$deleteMetadataSchema$listMeta(uuid, naked, )

$deleteSchemaPermission() Deletes all metadata schema permissions on the given metadata.

Usage

1
meta$deleteSchemaPermission$listMeta(uuid, username, naked, )

$getMetadata() Retrieve Metadata.

Usage

1
meta$getMetadata$listMeta(uuid, naked, )

$getMetadataPermission() Get the user permission for this metadata.

Usage

1
meta$getMetadataPermission$listMeta(uuid, username, naked, )

$getMetadataSchema() Retrieve Metadata Schemata.

Usage

1
meta$getMetadataSchema$listMeta(uuid, naked, )

$getMetadataSchemaPermission() Get the user permission for this schema.

Usage

1
meta$getMetadataSchemaPermission$listMeta(uuid, username, naked, )

$listMetadata() List and/or search metadata.

Usage

1
2
meta$listMetadata$listMeta(q, naked, limit, offset, search, )
meta$listMetadata$listMeta(search=list("foo"="bar"))

$listMetadataPermissions() Get the permission ACL for this metadata.

Usage

1
2
meta$listMetadataPermissions$listMeta(uuid, naked, limit, offset, search, )
meta$listMetadataPermissions$listMeta(search=list("foo"="bar"))

$listMetadataSchema() List and query Metadata Schemata.

Usage

1
2
meta$listMetadataSchema$listMeta(q, naked, limit, offset, search, )
meta$listMetadataSchema$listMeta(search=list("foo"="bar"))

$listMetadataSchemaPermissions() Get the permission for this schema.

Usage

1
2
meta$listMetadataSchemaPermissions$listMeta(uuid, naked, limit, offset, search, )
meta$listMetadataSchemaPermissions$listMeta(search=list("foo"="bar"))

$updateMetadata() Update or Add new Metadata.

Usage

1
meta$updateMetadata$listMeta(uuid, body, naked, )

$updateMetadataPermission() Update a user permission for the given metadata.

Usage

1
meta$updateMetadataPermission$listMeta(uuid, username, body, naked, )

$updateMetadataSchema() Update an existing Metadata Schema.

Usage

1
meta$updateMetadataSchema$listMeta(uuid, body, naked, )

$updateMetadataSchemaPermission() Add or update a user permission for the given metadata schema.

Usage

1
meta$updateMetadataSchemaPermission$listMeta(uuid, username, body, naked, )

See Also

rAgave::ApiClient rAgave::Agave [rAgave::Metadata][rAgave::MetadataSchema][rAgave::Permission]


agaveplatform/r-sdk documentation built on Sept. 22, 2018, 2:14 p.m.