UuidsApi: Agave Uuids API operations

Description Usage Format Details Arguments Methods See Also

Description

UuidsApi Class

Usage

1
uuids <- UuidsApi$new( apiClient = ApiClient$new(), cache = AgaveCache$new() )

Format

An object of class R6ClassGenerator of length 24.

Details

The Agave UUID service resolves the type and representation of one or more Agave UUID. This is helpful, for instance, when you need to expand the hypermedia response of another resource, get the URL corresponding to a UUID, or fetch the representations of multiple resources in a single request.

Read more about the Uuids 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

$createUuid() Generate a new UUID for a given resource type

Usage

1
uuids$createUuid$listUuids(body, naked, )

$resolveUuid() Resolve one or more UUID to their resource URL and type

Usage

1
uuids$resolveUuid$listUuids(uuid, naked, expand, )

$resolveUuids() Resolve one or more UUID to their resource URL and type

Usage

1
2
uuids$resolveUuids$listUuids(naked, uuids, limit, offset, expand, search, )
uuids$resolveUuids$listUuids(search=list("foo"="bar"))

See Also

rAgave::ApiClient rAgave::Agave [rAgave::UUIDRequest][rAgave::UUIDResolution][rAgave::UUIDSummary]


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