doc/api/methods/collections.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "collections"
   6
   7 ...
   8
   9 See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
  10
  11 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/collections@
  12
  13 Required arguments are displayed in %{background:#ccffcc}green%.
  14
  15 h2. create
  16
  17 Create a new Collection.
  18
  19 Arguments:
  20
  21 table(table table-bordered table-condensed).
  22 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  23 |collection|object||query||
  24
  25 h2. delete
  26
  27 Delete an existing Collection.
  28
  29 Arguments:
  30
  31 table(table table-bordered table-condensed).
  32 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  33 {background:#ccffcc}.|uuid|string|The UUID of the Collection in question.|path||
  34
  35 h2. get
  36
  37 Gets a Collection's metadata by UUID.
  38
  39 Arguments:
  40
  41 table(table table-bordered table-condensed).
  42 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  43 {background:#ccffcc}.|uuid|string|The UUID of the Collection in question.|path||
  44
  45 h2. list
  46
  47 List collections.
  48
  49 Arguments:
  50
  51 table(table table-bordered table-condensed).
  52 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  53 |limit|integer (default 100)|Maximum number of collections to return.|query||
  54 |order|string|Order in which to return matching collections.|query||
  55 |filters|array|Conditions for filtering collections.|query||
  56 |select|array|Data fields to return in the result list.|query|@["uuid", "manifest_text"]@|
  57
  58 Note: Because adding access tokens to manifests can be computationally expensive, the @manifest_text@ field is not included in results by default.  If you need it, pass a @select@ parameter that includes @manifest_text@.
  59
  60 h2. update
  61
  62 Update attributes of an existing Collection.
  63
  64 Arguments:
  65
  66 table(table table-bordered table-condensed).
  67 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  68 {background:#ccffcc}.|uuid|string|The UUID of the Collection in question.|path||
  69 |collection|object||query||