5 title: Common resource methods
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.
13 The @create@ method creates a new object of the specified type. It corresponds to the HTTP request @POST /arvados/v1/resource_name@. A successful create call returns a copy of the new object.
17 table(table table-bordered table-condensed).
18 |_. Argument |_. Type |_. Description |_. Location |
19 |{resource_name}|object||query||
23 The @delete@ method deletes a object of the specified type. It corresponds to the HTTP request @DELETE /arvados/v1/resource_name/uuid@. A successful delete call returns a copy of the deleted object.
27 table(table table-bordered table-condensed).
28 |_. Argument |_. Type |_. Description |_. Location |
29 {background:#ccffcc}.|uuid|string|The UUID of the object in question.|path|
33 The @get@ method gets a single object with the specified @uuid@. It corresponds to the HTTP request @GET /arvados/v1/resource_name/uuid@.
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|
43 The @list@ method requests an list of resources of that type. It corresponds to the HTTP request @GET /arvados/v1/resource_name@. All resources support listing with unless otherwise noted.
47 table(table table-bordered table-condensed).
48 |_. Argument |_. Type |_. Description |_. Location |
49 |limit |integer|Maximum number of resources to return. May also be subject to server limit.|query|
50 |offset |integer|Skip the first 'offset' resources that match the given filter conditions.|query|
51 |filters |array |Conditions for selecting resources to return (see below).|query|
52 |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.
53 Example: @["head_uuid asc","modified_at desc"]@
54 Default: @["created_at desc"]@|query|
55 |select |array |Set of attributes to include in the response.
56 Example: @["head_uuid","tail_uuid"]@
57 Default: all available attributes. As a special case, collections do not return "manifest_text" unless explicitly selected.|query|
58 |distinct|boolean|@true@: (default) do not return duplicate objects
59 @false@: permitted to return duplicates|query|
63 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.
65 Each condition is expressed as an array with three elements: @[attribute, operator, operand]@.
67 table(table table-bordered table-condensed).
68 |_. Index|_. Element|_. Type|_. Description|_. Examples|
69 |0|attribute|string|Name of the attribute to compare (or "any" to return resources with any matching attribute)|@script_version@, @head_uuid@, @any@|
70 |1|operator|string|Comparison operator|@>@, @>=@, @like@, @not in@|
71 |2|operand|string, array, or null|Value to compare with the resource attribute|@"d00220fb%"@, @"1234"@, @["foo","bar"]@, @nil@|
73 The following operators are available.
75 table(table table-bordered table-condensed).
76 |_. Operator|_. Operand type|_. Example|
77 |@<@, @<=@, @>=@, @>@, @like@, @ilike@|string|@["script_version","like","d00220fb%"]@|
78 |@=@, @!=@|string or null|@["tail_uuid","=","xyzzy-j7d0g-fffffffffffffff"]@
79 @["tail_uuid","!=",null]@|
80 |@in@, @not in@|array of strings|@["script_version","in",["master","d00220fb38d4b85ca8fc28a8151702a2b9d1dec5"]]@|
81 |@is_a@|string|@["head_uuid","is_a","arvados#pipelineInstance"]@|
85 A successful call to list will return the following object.
87 table(table table-bordered table-condensed).
88 |_. Attribute |_. Type |_. Description |
89 |kind|string|type of objects returned|
90 |offset|integer|query offset in effect|
91 |limit|integer|query limit in effect|
92 |items|array|actual query payload, an array of resource objects|
93 |items_available|integer|total items available matching query|
97 The @update@ method updates fields on the object with the specified @uuid@. It corresponds to the HTTP request @PUT /arvados/v1/resource_name/uuid@. A successful update call returns the updated copy of the object.
99 table(table table-bordered table-condensed).
100 |_. Argument |_. Type |_. Description |_. Location |
101 {background:#ccffcc}.|uuid|string|The UUID of the resource in question.|path||
102 |{resource_name}|object||query||