doc/api/methods.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: Concepts
   5 title: REST methods
   6
   7 ...
   8
   9 h1. REST Methods
  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?where[owner_uuid]=xyzzy-tpzed-a4lcehql0dv2u25
  17
  18 POST https://{{ site.arvados_api_host }}/arvados/v1/groups
  19 _method=GET
  20 where[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 |max_results|integer|Maximum number of resources to return|
  28 |page_token|string||
  29 |where{}|list|Attribute values to search for|
  30
  31 h2. Create
  32
  33 <pre>
  34 POST https://{{ site.arvados_api_host }}/arvados/v1/groups
  35 group={"name":"fresh new group"}
  36 </pre>
  37
  38 &rarr; Group resource
  39
  40 h2. Delete
  41
  42 <pre>
  43 DELETE https://{{ site.arvados_api_host }}/arvados/v1/groups/xyzzy-ldvyl-vyydjeplwaa6emg
  44 </pre>
  45
  46 &rarr; Group resource
  47
  48 h2. Show
  49
  50 <pre>
  51 GET https://{{ site.arvados_api_host }}/arvados/v1/groups/xyzzy-ldvyl-vyydjeplwaa6emg
  52 </pre>
  53
  54 &rarr; Group resource
  55
  56 h2. Update
  57
  58 <pre>
  59 PUT https://{{ site.arvados_api_host }}/arvados/v1/groups/xyzzy-ldvyl-vyydjeplwaa6emg
  60 group={"uuid":"xyzzy-ldvyl-vyydjeplwaa6emg", "name":"Important group"}
  61 </pre>
  62
  63 &rarr; Group resource
  64
  65 <pre>
  66 PUT https://{{ site.arvados_api_host }}/arvados/v1/groups/xyzzy-ldvyl-vyydjeplwaa6emg
  67 group[uuid]=xyzzy-ldvyl-vyydjeplwaa6emg
  68 group[name]=Important group
  69 </pre>
  70
  71 &rarr; Group resource
  72
  73 More appropriate (but not yet implemented):
  74
  75 <pre>
  76 PATCH https://{{ site.arvados_api_host }}/arvados/v1/groups/xyzzy-ldvyl-vyydjeplwaa6emg
  77 group={"uuid":"xyzzy-ldvyl-vyydjeplwaa6emg", "name":"Important group"}
  78 </pre>
  79
  80 &rarr; Group resource