doc/api/resources.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: Concepts
   5 title: Common resource fields
   6
   7 ...
   8 {% comment %}
   9 Copyright (C) The Arvados Authors. All rights reserved.
  10
  11 SPDX-License-Identifier: CC-BY-SA-3.0
  12 {% endcomment %}
  13
  14 This page describes the common attributes of Arvados resources.
  15
  16 h2(#resource). Resource
  17
  18 table(table table-bordered table-condensed).
  19 |_. Attribute |_. Type |_. Description |_. Example|
  20 |uuid|string|universally unique object identifier, set on @create@|@mk2qn-4zz18-w3anr2hk2wgfpuo@|
  21 |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":{{site.baseurl}}/api/permission-model.html for details.|@mk2qn-tpzed-a4lcehql0dv2u25@|
  22 |created_at|datetime|When resource was created, set on @create@|@2013-01-21T22:17:39Z@|
  23 |modified_by_client_uuid|string|API client software which most recently modified the resource, set on @create@ and @update@|@mk2qn-ozdt8-vq8l5qkzj7pr7h7@|
  24 |modified_by_user_uuid|string|Authenticated user, on whose behalf the client was acting when modifying the resource, set on @create@ and @update@|@mk2qn-tpzed-a4lcehql0dv2u25@|
  25 |modified_at|datetime|When resource was last modified, set on @create@ and @update@|@2013-01-25T22:29:32Z@|
  26 |href|string|a URL that can be used to address this resource||
  27 |kind|string|@arvados#{resource_type}@|@arvados#collection@|
  28 |etag|string|The ETag[1] of the resource|@1xlmizzjq7wro3dlb2dirf505@|
  29
  30 h2. Object UUID
  31
  32 Each object is assigned a UUID.  This has the format @aaaaa-bbbbb-ccccccccccccccc@.
  33
  34 # The first field (@aaaaa@ in the example) is the site prefix.  This is unique to a specific Arvados installation.
  35 # The second field (@bbbbb@ in the example) is the object type.
  36 # The third field (@ccccccccccccccc@ in the example) uniquely identifies the object.
  37
  38 h2. Timestamps
  39
  40 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@.
  41
  42 h2. ETags
  43
  44 fn1. 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.