doc/user/api-resources.textile

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: API Resources
   5 subnavsection: "Reference: API"
   6 ---
   7
   8 h1. API Resources
   9
  10 h2. Object IDs
  11
  12 Object IDs are alphanumeric strings, unique across all installations (each installation has a unique prefix to prevent collisions).
  13
  14 h2. Attributes of resources
  15
  16 table(table table-bordered table-condensed).
  17 |*Attribute name*|*Value*|*Description*|*Example*|
  18 |uuid|string|universally unique object identifier|@mk2qn-4zz18-w3anr2hk2wgfpuo@|
  19 |kind|string|@arvados#{resource_type}@|@arvados#collection@|
  20 |etag|string|The ETag[1] of the resource|@1xlmizzjq7wro3dlb2dirf505@|
  21 |self_link|string|||
  22 |owner_uuid|string|UUID of owner (typically User or Project)|@mk2qn-tpzed-a4lcehql0dv2u25@|
  23 |created_at|datetime|When resource was created|@2013-01-21T22:17:39Z@|
  24 |modified_by_client|string|API client software which most recently modified the resource|@mk2qn-ozdt8-vq8l5qkzj7pr7h7@|
  25 |modified_by_user|string|Authenticated user, on whose behalf the client was acting when modifying the resource|@mk2qn-tpzed-a4lcehql0dv2u25@|
  26 |modified_at|datetime|When resource was last modified|@2013-01-25T22:29:32Z@|
  27
  28 h2. Attributes of resource lists
  29
  30 table(table table-bordered table-condensed).
  31 |*Attribute name*|*Value*|*Description*|*Example*|
  32 |kind|string|@arvados#{resource_type}_list@|@arvados#project_list@|
  33 |etag|string|The ETag[1] of the resource list|@cd3o1wi9sf934saajykawrz2e@|
  34 |self_link|string|||
  35 |next_page_token|string|||
  36 |next_link|string|||
  37 |items[]|list|List of resources||
  38
  39
  40 h2. ETags
  41
  42 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.
  43