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

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "collections"
   6
   7 ...
   8 {% comment %}
   9 Copyright (C) The Arvados Authors. All rights reserved.
  10
  11 SPDX-License-Identifier: CC-BY-SA-3.0
  12 {% endcomment %}
  13
  14 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/collections@
  15
  16 Object type: @4zz18@
  17
  18 Example UUID: @zzzzz-4zz18-0123456789abcde@
  19
  20 h2. Resource
  21
  22 Collections describe sets of files in terms of data blocks stored in Keep.  See "storage in Keep":{{site.baseurl}}/api/storage.html for details.
  23
  24 Each collection has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  25
  26 table(table table-bordered table-condensed).
  27 |_. Attribute|_. Type|_. Description|_. Example|
  28 |name|string|||
  29 |description|text|||
  30 |portable_data_hash|string|The MD5 sum of the manifest text stripped of block hints other than the size hint.||
  31 |manifest_text|text|||
  32 |replication_desired|number|Minimum storage replication level desired for each data block referenced by this collection. A value of @null@ signifies that the site default replication level (typically 2) is desired.|@2@|
  33 |replication_confirmed|number|Replication level most recently confirmed by the storage system. This field is null when a collection is first created, and is reset to null when the manifest_text changes in a way that introduces a new data block. An integer value indicates the replication level of the _least replicated_ data block in the collection.|@2@, null|
  34 |replication_confirmed_at|datetime|When replication_confirmed was confirmed. If replication_confirmed is null, this field is also null.||
  35 |trash_at|datetime|If @trash_at@ is non-null and in the past, this collection will be hidden from API calls.  May be untrashed.||
  36 |delete_at|datetime|If @delete_at@ is non-null and in the past, the collection may be permanently deleted.||
  37 |is_trashed|datetime|True if @trash_at@ is in the past, false if not.||
  38
  39 h3. Conditions of creating a Collection
  40
  41 The @portable_data_hash@ and @manifest_text@ attributes must be provided when creating a Collection. The cryptographic digest of the supplied @manifest_text@ must match the supplied @portable_data_hash@.
  42
  43 h3. Side effects of creating a Collection
  44
  45 Referenced blocks are protected from garbage collection in Keep.
  46
  47 Data can be shared with other users via the Arvados permission model.
  48
  49 h2. Methods
  50
  51 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  52
  53 Required arguments are displayed in %{background:#ccffcc}green%.
  54
  55 h3. create
  56
  57 Create a new Collection.
  58
  59 Arguments:
  60
  61 table(table table-bordered table-condensed).
  62 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  63 |collection|object||query||
  64
  65 h3. delete
  66
  67 Put a Collection in the trash.  This sets the @trash_at@ field to @now@ and @delete_at@ field to @now@ + token TTL.  A trashed group is invisible to most API calls unless the @include_trash@ parameter is true.
  68
  69 Arguments:
  70
  71 table(table table-bordered table-condensed).
  72 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  73 {background:#ccffcc}.|uuid|string|The UUID of the Collection in question.|path||
  74
  75 h3. get
  76
  77 Gets a Collection's metadata by UUID.
  78
  79 Arguments:
  80
  81 table(table table-bordered table-condensed).
  82 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  83 {background:#ccffcc}.|uuid|string|The UUID of the Collection in question.|path||
  84
  85 h3. list
  86
  87 List collections.
  88
  89 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  90
  91 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@.
  92
  93 h3. update
  94
  95 Update attributes of an existing Collection.
  96
  97 Arguments:
  98
  99 table(table table-bordered table-condensed).
 100 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 101 {background:#ccffcc}.|uuid|string|The UUID of the Collection in question.|path||
 102 |collection|object||query||
 103
 104 h3. untrash
 105
 106 Remove a Collection from the trash.  This sets the @trash_at@ and @delete_at@ fields to @null@.
 107
 108 Arguments:
 109
 110 table(table table-bordered table-condensed).
 111 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 112 {background:#ccffcc}.|uuid|string|The UUID of the Collection to untrash.|path||
 113 |ensure_unique_name|boolean (default false)|Rename collection uniquely if untrashing it would fail with a unique name conflict.|query||