quartzbio.resource.apiresource module

class quartzbio.resource.apiresource.APIResource(id=None, **params)

Bases: QuartzBioObject

Abstract Class for an API Resource

classmethod class_name()

classmethod class_url()

Returns a versioned URI string for this class

instance_url()

Get instance URL by ID

refresh()

classmethod retrieve(id, **params)

class quartzbio.resource.apiresource.CreateableAPIResource(id=None, **params)

Bases: APIResource

classmethod create(**params)

class quartzbio.resource.apiresource.DeletableAPIResource(id=None, **params)

Bases: APIResource

delete(**params)

class quartzbio.resource.apiresource.DownloadableAPIResource(id=None, **params)

Bases: APIResource

download(path=None, **kwargs)

Download the file to the specified directory or file path. Downloads to a temporary directory if no path is specified.

Returns the absolute path to the file.

download_url(**kwargs)

class quartzbio.resource.apiresource.ListObject(id=None, **params)

Bases: QuartzBioObject

all(**params)

Lists all items in a class that you have access to

create(**params)

first_page(**params)

next()

next_page(**params)

prev_page(**params)

quartzbio_objects()

set_tabulate(fields, **kwargs)

class quartzbio.resource.apiresource.ListableAPIResource(id=None, **params)

Bases: APIResource

Has one method: all() which lists everything in the resource.

classmethod all(**params)

classmethod pager(**params)

class quartzbio.resource.apiresource.SearchableAPIResource(id=None, **params)

Bases: APIResource

classmethod search(query='', **params)

class quartzbio.resource.apiresource.SingletonAPIResource(id=None, **params)

Bases: APIResource

classmethod class_url()

Returns a versioned URI string for this class, and don’t pluralize the class name.

instance_url()

Get instance URL by ID

classmethod retrieve(**kwargs)

class quartzbio.resource.apiresource.UpdateableAPIResource(id=None, **params)

Bases: APIResource

save()

serialize(obj)