doc/api/methods.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: Concepts
   5 title: Common resource methods
   6
   7 ...
   8
   9 The following methods are available for most resources.  Some resources may limit who can perform certain operations.  Consult documentation for individual resource types for details.
  10
  11 The methods are relative to the base URI, e.g. @/arvados/v1/resource_type@.  For arguments specifying a *Location* of @path@, the value of the argument is incorporated into the path portion of the URI.  For example, a @uuid@ of @aaaaa-bbbbb-ccccccccccccccc@ in a path position yields a URI of @/arvados/v1/resource_type/aaaaa-bbbbb-ccccccccccccccc@.
  12
  13 Arguments specifying a *Location* of @query@ are incorporated into the query portion of the URI or request body.  For example, @/arvados/v1/resource_type?resource_type={}@.
  14
  15 h2. create
  16
  17 The @create@ method creates a new object of the specified type.  Note that:
  18
  19 * Only the listed attributes (and "standard metadata":resources.html) are set
  20 * Unset attributes will get default values
  21 * The attributes of a given resource type are fixed (you cannot introduce new toplevel attributes)
  22
  23 This method corresponds to the HTTP request @POST /arvados/v1/resource_type@.  A successful create call returns a copy of the new object.
  24
  25 Arguments:
  26
  27 table(table table-bordered table-condensed).
  28 |_. Argument |_. Type |_. Description |_. Location |
  29 |{resource_type}|object|Name is the singular form of the resource type, e.g. for the "collections" resource, this argument is "collection"|query||
  30
  31 h2. delete
  32
  33 The @delete@ method deletes an object of the specified type.  It corresponds to the HTTP request @DELETE /arvados/v1/resource_type/uuid@.  A successful delete call returns a copy of the deleted object.
  34
  35 Arguments:
  36
  37 table(table table-bordered table-condensed).
  38 |_. Argument |_. Type |_. Description |_. Location |
  39 {background:#ccffcc}.|uuid|string|The UUID of the object in question.|path|
  40
  41 h2. get
  42
  43 The @get@ method gets a single object with the specified @uuid@.  It corresponds to the HTTP request @GET /arvados/v1/resource_type/uuid@.
  44
  45 Arguments:
  46
  47 table(table table-bordered table-condensed).
  48 |_. Argument |_. Type |_. Description |_. Location |
  49 {background:#ccffcc}.|uuid|string|The UUID of the object in question.|path|
  50
  51 h2(#index). list
  52
  53 The @list@ method requests an list of resources of that type.  It corresponds to the HTTP request @GET /arvados/v1/resource_type@.  All resources support "list" method unless otherwise noted.
  54
  55 Arguments:
  56
  57 table(table table-bordered table-condensed).
  58 |_. Argument |_. Type |_. Description |_. Location |
  59 |limit   |integer|Maximum number of resources to return.  If not provided, server will provide a default limit.  Server may also impose a maximum number of records that can be returned in a single request.|query|
  60 |offset  |integer|Skip the first 'offset' number of resources that would be returned under the given filter conditions.|query|
  61 |filters |array  |"Conditions for selecting resources to return.":#filters|query|
  62 |order   |array  |Attributes to use as sort keys to determine the order resources are returned, each optionally followed by @asc@ or @desc@ to indicate ascending or descending order.
  63 Example: @["head_uuid asc","modified_at desc"]@
  64 Default: @["created_at desc"]@|query|
  65 |select  |array  |Set of attributes to include in the response.
  66 Example: @["head_uuid","tail_uuid"]@
  67 Default: all available attributes.  As a special case, collections do not return "manifest_text" unless explicitly selected.|query|
  68 |distinct|boolean|@true@: (default) do not return duplicate objects
  69 @false@: permitted to return duplicates|query|
  70 |count|string|@"exact"@ (default): Include an @items_available@ response field giving the number of distinct matching items that can be retrieved (irrespective of @limit@ and @offset@ arguments).
  71 @"none"@: Omit the @items_available@ response field. This option will produce a faster response.|query|
  72
  73 h3(#filters). Available list method filters
  74
  75 The value of the @filters@ parameter is an array of conditions. The @list@ method returns only the resources that satisfy all of the given conditions. In other words, the conjunction @AND@ is implicit.
  76
  77 Each condition is expressed as an array with three elements: @[attribute, operator, operand]@.
  78
  79 table(table table-bordered table-condensed).
  80 |_. Index|_. Element|_. Type|_. Description|_. Examples|
  81 |0|attribute|string|Name of the attribute to compare (or "any" to return resources with any matching attribute)|@script_version@, @head_uuid@, @any@|
  82 |1|operator|string|Comparison operator|@>@, @>=@, @like@, @not in@|
  83 |2|operand|string, array, or null|Value to compare with the resource attribute|@"d00220fb%"@, @"1234"@, @["foo","bar"]@, @nil@|
  84
  85 The following operators are available.
  86
  87 table(table table-bordered table-condensed).
  88 |_. Operator|_. Operand type|_. Example|
  89 |@<@, @<=@, @>=@, @>@, @like@, @ilike@|string|@["script_version","like","d00220fb%"]@|
  90 |@=@, @!=@|string or null|@["tail_uuid","=","xyzzy-j7d0g-fffffffffffffff"]@
  91 @["tail_uuid","!=",null]@|
  92 |@in@, @not in@|array of strings|@["script_version","in",["master","d00220fb38d4b85ca8fc28a8151702a2b9d1dec5"]]@|
  93 |@is_a@|string|@["head_uuid","is_a","arvados#pipelineInstance"]@|
  94
  95 h3. Results of list method
  96
  97 A successful call to list will return the following object.
  98
  99 table(table table-bordered table-condensed).
 100 |_. Attribute |_. Type |_. Description |
 101 |kind|string|type of objects returned|
 102 |offset|integer|query offset in effect|
 103 |limit|integer|query limit in effect|
 104 |items|array|actual query payload, an array of resource objects|
 105 |items_available|integer|total items available matching query|
 106
 107 h2. update
 108
 109 The @update@ method updates fields on the object with the specified @uuid@.  It corresponds to the HTTP request @PUT /arvados/v1/resource_type/uuid@.  Note that only the listed attributes (and "standard metadata":resources.html) are updated, unset attributes will retain their previous values, and the attributes of a given resource type are fixed (you cannot introduce new toplevel attributes).  Also note that updates replace the value of the attribute, so if an attribute has an object value, the entire object is replaced.  A successful update call returns the updated copy of the object.
 110
 111 table(table table-bordered table-condensed).
 112 |_. Argument |_. Type |_. Description |_. Location |
 113 {background:#ccffcc}.|uuid|string|The UUID of the resource in question.|path||
 114 |{resource_type}|object||query||