doc/api/Collections.textile

   1 ---
   2 layout: default
   3 navsection: api
   4 title: "Resource: Collections"
   5 navorder: 13
   6 ---
   7
   8 h1. Collections
   9
  10 This resource concerns metadata, usage accounting, and integrity checks for data stored on the cloud.  Reading and writing the data _per se_ is achieved by the "Keep":{{ baseurl }}/user/intro-keep.html storage system.
  11
  12
  13 h2. Methods
  14
  15 See "REST methods for working with Arvados resources":methods.html
  16
  17 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/links@
  18
  19 h3. Conditions of creating a Collection
  20
  21 The @uuid@ and @manifest_text@ attributes must be provided when creating a Collection. The cryptographic digest of the supplied @manifest_text@ must match the supplied @uuid@.
  22
  23 h3. Side effects of creating a Collection
  24
  25 Referenced data can be protected from garbage collection.
  26
  27 Data can be shared with other users via the Arvados permission model.
  28
  29 Clients can request checks of data integrity and storage redundancy.
  30
  31 h2. Resource
  32
  33 Each collection has, in addition to the usual "attributes of Arvados resources":resources.html:
  34
  35 table(table table-bordered table-condensed).
  36 |*Attribute*|*Type*|*Description*|*Example*|
  37 |locator|string|||
  38 |portable_data_hash|string|||
  39 |name|string|||
  40 |redundancy|number|||
  41 |redundancy_confirmed_by_client_uuid|string|API client||
  42 |redundancy_confirmed_at|datetime|||
  43 |redundancy_confirmed_as|number|||
  44 |manifest_text|text|||