doc/api/methods.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: Concepts
   5 title: REST methods
   6
   7 ...
   8
   9
  10
  11 (using Group as an example)
  12
  13 h2(#index). Index, list, search
  14
  15 <pre>
  16 GET https://{{ site.arvados_api_host }}/arvados/v1/groups?filters=[["owner_uuid","=","xyzzy-tpzed-a4lcehql0dv2u25"]]
  17
  18 POST https://{{ site.arvados_api_host }}/arvados/v1/groups
  19 _method=GET
  20 filters=[["owner_uuid","=","xyzzy-tpzed-a4lcehql0dv2u25"]]
  21 </pre>
  22
  23 &rarr; Group resource list
  24
  25 table(table table-bordered table-condensed).
  26 |*Parameter name*|*Value*|*Description*|
  27 |limit   |integer|Maximum number of resources to return|
  28 |offset  |integer|Skip the first 'offset' objects|
  29 |filters |array  |Conditions for selecting resources to return|
  30 |order   |array  |List of fields to use to determine sorting order for returned objects|
  31 |select  |array  |Specify which fields to return|
  32 |distinct|boolean|true: (default) do not return duplicate objects<br> false: permitted to return duplicates|
  33
  34 h2. Create
  35
  36 <pre>
  37 POST https://{{ site.arvados_api_host }}/arvados/v1/groups
  38 group={"name":"fresh new group"}
  39 </pre>
  40
  41 &rarr; Group resource
  42
  43 h2. Delete
  44
  45 <pre>
  46 DELETE https://{{ site.arvados_api_host }}/arvados/v1/groups/xyzzy-ldvyl-vyydjeplwaa6emg
  47 </pre>
  48
  49 &rarr; Group resource
  50
  51 h2. Update
  52
  53 <pre>
  54 PUT https://{{ site.arvados_api_host }}/arvados/v1/groups/xyzzy-ldvyl-vyydjeplwaa6emg
  55 group={"uuid":"xyzzy-ldvyl-vyydjeplwaa6emg", "name":"Important group"}
  56 </pre>
  57
  58 &rarr; Group resource
  59
  60 <pre>
  61 PUT https://{{ site.arvados_api_host }}/arvados/v1/groups/xyzzy-ldvyl-vyydjeplwaa6emg
  62 group[uuid]=xyzzy-ldvyl-vyydjeplwaa6emg
  63 group[name]=Important group
  64 </pre>
  65
  66 &rarr; Group resource
  67
  68 More appropriate (but not yet implemented):
  69
  70 <pre>
  71 PATCH https://{{ site.arvados_api_host }}/arvados/v1/groups/xyzzy-ldvyl-vyydjeplwaa6emg
  72 group={"uuid":"xyzzy-ldvyl-vyydjeplwaa6emg", "name":"Important group"}
  73 </pre>
  74
  75 &rarr; Group resource