doc/api/methods.textile

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