X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/42b9e37cd53d63980d3fa4a238f9ff6adad9ccc4..d75d084f12dbc5efdcf9a65da7849aa5cc183ea5:/doc/api/resources.html.textile.liquid diff --git a/doc/api/resources.html.textile.liquid b/doc/api/resources.html.textile.liquid index 9f36628c61..2c4491f621 100644 --- a/doc/api/resources.html.textile.liquid +++ b/doc/api/resources.html.textile.liquid @@ -5,6 +5,11 @@ navmenu: Concepts title: Common resource fields ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. + +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} This page describes the common attributes of Arvados resources. @@ -12,28 +17,27 @@ h2(#resource). Resource table(table table-bordered table-condensed). |_. Attribute |_. Type |_. Description |_. Example| -|uuid|string|universally unique object identifier|@mk2qn-4zz18-w3anr2hk2wgfpuo@| +|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":{{site.baseurl}}/api/permission-model.html for details.|@mk2qn-tpzed-a4lcehql0dv2u25@| +|created_at|datetime|When resource was created, set on @create@|@2013-01-21T22:17:39Z@| +|modified_by_client_uuid|string|API client software which most recently modified the resource, set on @create@ and @update@|@mk2qn-ozdt8-vq8l5qkzj7pr7h7@| +|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@| +|modified_at|datetime|When resource was last modified, set on @create@ and @update@|@2013-01-25T22:29:32Z@| |href|string|a URL that can be used to address this resource|| |kind|string|@arvados#{resource_type}@|@arvados#collection@| |etag|string|The ETag[1] of the resource|@1xlmizzjq7wro3dlb2dirf505@| -|owner_uuid|string|UUID of owner (must be a User or Group)|@mk2qn-tpzed-a4lcehql0dv2u25@| -|created_at|datetime|When resource was created|@2013-01-21T22:17:39Z@| -|modified_by_client_uuid|string|API client software which most recently modified the resource|@mk2qn-ozdt8-vq8l5qkzj7pr7h7@| -|modified_by_user_uuid|string|Authenticated user, on whose behalf the client was acting when modifying the resource|@mk2qn-tpzed-a4lcehql0dv2u25@| -|modified_at|datetime|When resource was last modified|@2013-01-25T22:29:32Z@| h2. Object UUID Each object is assigned a UUID. This has the format @aaaaa-bbbbb-ccccccccccccccc@. -format. -# The first field ("aaaaa" in the example) is the site prefix. This is unique to a specific Arvados installation. -# The second field ("bbbbb" in the example) is the object type. -# The third field ("ccccccccccccccc" in the example) uniquely identifies the object. +# The first field (@aaaaa@ in the example) is the site prefix. This is unique to a specific Arvados installation. +# The second field (@bbbbb@ in the example) is the object type. +# The third field (@ccccccccccccccc@ in the example) uniquely identifies the object. h2. Timestamps -All Arvados timestamps follow ISO 8601 datetime format with fractional seconds (microsecond precision). All timestamps are UTC. Example date format: @YYYY-mm-ddTHH:MM:SS.SSSSZ@ +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@. h2. ETags