---
layout: default
navsection: api
navmenu: API Methods
title: "humans"

...

API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/humans@

Object type: @7a9it@

Example UUID: @zzzzz-7a9it-0123456789abcde@

h2. Resource

A metadata record that may be used to represent a human subject.

Each Human has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:

table(table table-bordered table-condensed).
|_. Attribute|_. Type|_. Description|_. Example|
|properties|hash|||

h2. Methods

See "Common resource methods":{{site.baseurl}}/api/methods.html more information about @create@, @delete@, @get@, @list@, and @update@.

Required arguments are displayed in %{background:#ccffcc}green%.

h3. create

Create a new Human.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
|human|object||query||

h3. delete

Delete an existing Human.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||

h3. get

Gets a Human's metadata by UUID.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||

h3. list

List humans.

See "common resource list method.":{{site.baseurl}}/api/methods.html#index

h3. update

Update attributes of an existing Human.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||
|human|object||query||