X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/12e80e54e288773d77ef15b522a954bf597a5be7..3b1d212dfc945964b99c7dd3153f1ba3cc9ef604:/doc/api/methods.textile?ds=sidebyside diff --git a/doc/api/methods.textile b/doc/api/methods.textile index 4caaf0306a..5b47d3f55d 100644 --- a/doc/api/methods.textile +++ b/doc/api/methods.textile @@ -1,7 +1,7 @@ --- layout: default navsection: api -title: Methods +title: REST methods navorder: 3 --- @@ -9,14 +9,14 @@ h1. REST Methods (using Group as an example) -h2. Index, list, search +h2(#index). Index, list, search
-GET https://xyzzy.arvados.org/arvados/v1/groups?where[owner]=xyzzy-tpzed-a4lcehql0dv2u25 +GET https://{{ site.arvados_api_host }}/arvados/v1/groups?where[owner_uuid]=xyzzy-tpzed-a4lcehql0dv2u25 -POST https://xyzzy.arvados.org/arvados/v1/groups +POST https://{{ site.arvados_api_host }}/arvados/v1/groups _method=GET -where[owner]=xyzzy-tpzed-a4lcehql0dv2u25 +where[owner_uuid]=xyzzy-tpzed-a4lcehql0dv2u25→ Group resource list @@ -30,7 +30,7 @@ table(table table-bordered table-condensed). h2. Create
-POST https://xyzzy.arvados.org/arvados/v1/groups +POST https://{{ site.arvados_api_host }}/arvados/v1/groups group={"name":"fresh new group"}@@ -39,7 +39,7 @@ group={"name":"fresh new group"} h2. Delete
-DELETE https://xyzzy.arvados.org/arvados/v1/groups/xyzzy-ldvyl-vyydjeplwaa6emg +DELETE https://{{ site.arvados_api_host }}/arvados/v1/groups/xyzzy-ldvyl-vyydjeplwaa6emg→ Group resource @@ -47,7 +47,7 @@ DELETE https://xyzzy.arvados.org/arvados/v1/groups/xyzzy-ldvyl-vyydjeplwaa6emg h2. Show
-GET https://xyzzy.arvados.org/arvados/v1/groups/xyzzy-ldvyl-vyydjeplwaa6emg +GET https://{{ site.arvados_api_host }}/arvados/v1/groups/xyzzy-ldvyl-vyydjeplwaa6emg→ Group resource @@ -55,14 +55,14 @@ GET https://xyzzy.arvados.org/arvados/v1/groups/xyzzy-ldvyl-vyydjeplwaa6emg h2. Update
-PUT https://xyzzy.arvados.org/arvados/v1/groups/xyzzy-ldvyl-vyydjeplwaa6emg +PUT https://{{ site.arvados_api_host }}/arvados/v1/groups/xyzzy-ldvyl-vyydjeplwaa6emg group={"uuid":"xyzzy-ldvyl-vyydjeplwaa6emg", "name":"Important group"}→ Group resource
-PUT https://xyzzy.arvados.org/arvados/v1/groups/xyzzy-ldvyl-vyydjeplwaa6emg +PUT https://{{ site.arvados_api_host }}/arvados/v1/groups/xyzzy-ldvyl-vyydjeplwaa6emg group[uuid]=xyzzy-ldvyl-vyydjeplwaa6emg group[name]=Important group@@ -72,7 +72,7 @@ group[name]=Important group More appropriate (but not yet implemented):
-PATCH https://xyzzy.arvados.org/arvados/v1/groups/xyzzy-ldvyl-vyydjeplwaa6emg +PATCH https://{{ site.arvados_api_host }}/arvados/v1/groups/xyzzy-ldvyl-vyydjeplwaa6emg group={"uuid":"xyzzy-ldvyl-vyydjeplwaa6emg", "name":"Important group"}