specimens

Note:

This is a legacy API. This endpoint is deprecated, disabled by default in new installations, and is slated to be removed entirely in a future major release of Arvados. The recommended way to store metadata is with ‘properties’ field on collections and projects.

API endpoint base: https://pirca.arvadosapi.com/arvados/v1/specimens

Object type: j58dm

Example UUID: zzzzz-j58dm-0123456789abcde

Resource

A metadata record that may be used to represent a biological specimen.

Each Specimen has, in addition to the Common resource fields:

Attribute	Type	Description	Example
material	string
properties	hash

Methods

See Common resource methods for more information about create, delete, get, list, and update.

Required arguments are displayed in green.

create

Create a new Specimen.

Arguments:

Argument	Type	Description	Location	Example
specimen	object		query

delete

Delete an existing Specimen.

Arguments:

Argument	Type	Description	Location	Example
uuid	string	The UUID of the Specimen in question.	path

get

Gets a Specimen’s metadata by UUID.

Arguments:

Argument	Type	Description	Location	Example
uuid	string	The UUID of the Specimen in question.	path

list

List specimens.

See common resource list method.

update

Update attributes of an existing Specimen.

Arguments:

Argument	Type	Description	Location	Example
uuid	string	The UUID of the Specimen in question.	path
specimen	object		query

Previous: humans Next: traits