Arvados™ Docs
  1. Concepts
    1. API Reference
    2. API Authorization
    3. REST API syntax
    4. Common resource methods
    5. Common resource fields
  2. Permission and authentication
    1. users
    2. groups
    3. api_client_authorizations
    4. links
    5. computed_permissions
    6. authorized_keys
    7. user_agreements
    8. virtual_machines
  3. Data management
    1. WebDAV
    2. S3 API
    3. Keep-web URL patterns
    4. Projects and filter groups
    5. Metadata properties
    6. collections
    7. logs
    8. keep_services
  4. Container engine
    1. container_requests
    2. containers
    3. workflows
    4. cloud dispatcher

Common resource fields

This page describes the common attributes shared by most or all Arvados resources.

Resource

Attribute Type Description Example
uuid string universally unique object identifier. Set on create. mk2qn-4zz18-w3anr2hk2wgfpuo
owner_uuid string UUID of owner (must be a User or Group), set on create. Controls who may access the resource. Ownership may be changed explicitly with update, see permission model for details. mk2qn-tpzed-a4lcehql0dv2u25
name string Human-assigned name. Not present on all object types, check individual API page. Uniqueness constraint varys by object type.
description string Free text description of the object. Not present on all object types, check individual API page. May be HTML formatted, see below for valid HTML tags and attributes .
created_at datetime When resource was created. Set on create. 2013-01-21T22:17:39Z
modified_at datetime When resource was last modified. Set on create and update. 2013-01-25T22:29:32Z
modified_by_user_uuid string The owner of the API token used to authenticate the create or update request. mk2qn-tpzed-a4lcehql0dv2u25
kind string arvados#{resource_type} arvados#collection
etag string The ETag1 of the resource 1xlmizzjq7wro3dlb2dirf505

Object UUID

Each object is assigned a UUID. This has the format aaaaa-bbbbb-ccccccccccccccc.

  1. The first field (aaaaa in the example) is the site prefix. This is unique to a specific Arvados installation.
  2. The second field (bbbbb in the example) is the object type.
  3. The third field (ccccccccccccccc in the example) uniquely identifies the object.

Descriptions

The following HTML tags are permitted: a, b, blockquote, br, code, del, dd, dl, dt, em, h1, h2, h3, h4, h5, h6, hr, i, img, kbd, li, ol, p, pre, s, del, section, span, strong, sub, sup, and ul.

The following HTML attributes are permitted: src, width, height, href, alt, title, and style.

All styling must be made in-line with the style attribute. Disallowed tags and attributes will not render.

Timestamps

All Arvados timestamps follow ISO 8601 datetime format with fractional seconds (microsecond precision). All timestamps are UTC. Date format: YYYY-mm-ddTHH:MM:SS.SSSSZ example date: 2016-11-08T21:38:24.124834000Z.

ETags

1 Each response includes an ETag, a string which changes when the resource changes. Clients can use this to check whether a resource has changed since they last retrieved it. If a previous ETag is provided along with a request, and the resource has not changed since, the server may return a “not modified” response.

Previous: Common resource methods Next: users

The content of this documentation is licensed under the Creative Commons Attribution-Share Alike 3.0 United States licence.
Code samples in this documentation are licensed under the Apache License, Version 2.0.