Data Repository Service

access_id
optional

An arbitrary string to be passed to the /access method to get an AccessURL. This string must be unique within the scope of a single object. Note that at least one of access_url and access_id must be provided.

string

access_url
optional

An AccessURL that can be used to fetch the actual object bytes. Note that at least one of access_url and access_id must be provided.

AccessURL

region
optional

Name of the region in the cloud service provider that the object belongs to.
Example : "us-east-1"

string

type
required

Type of the access method.

enum (s3, gs, ftp, gsiftp, globus, htsget, https, file)

headers
optional

An optional list of headers to include in the HTTP request to url. These headers can be used to provide auth tokens required to fetch the object bytes.
Example : {
"Authorization" : "Basic Z2E0Z2g6ZHJz"
}

< string > array

url
required

A fully resolvable URL that can be used to fetch the actual object bytes.

string

checksum
required

The hex-string encoded checksum for the data

string

type
required

The digest method used to create the checksum.

The value (e.g. sha-256) SHOULD be listed as Hash Name String in the IANA Named Information Hash Algorithm Registry. Other values MAY be used, as long as implementors are aware of the issues discussed in RFC6920.

GA4GH may provide more explicit guidance for use of non-IANA-registered algorithms in the future. Until then, if implementors do choose such an algorithm (e.g. because it’s implemented by their storage provider), they SHOULD use an existing standard type value such as md5, etag, crc32c, trunc512, or sha1.
Example : "sha-256"

string

contents
optional

If this ContentsObject describes a nested bundle and the caller specified "?expand=true" on the request, then this contents array must be present and describe the objects within the nested bundle.

< ContentsObject > array

drs_uri
optional

A list of full DRS identifier URI paths that may be used to obtain the object. These URIs may be external to this DRS instance.
Example : "drs://drs.example.org/314159"

< string > array

id
optional

A DRS identifier of a DrsObject (either a single blob or a nested bundle). If this ContentsObject is an object within a nested bundle, then the id is optional. Otherwise, the id is required.

string

name
required

A name declared by the bundle author that must be used when materialising this object, overriding any name directly associated with the object itself. The name must be unique with the containing bundle. This string is made up of uppercase and lowercase letters, decimal digits, hypen, period, and underscore [A-Za-z0-9.-_]. See portable filenames.

string

access_methods
optional

The list of access methods that can be used to fetch the DrsObject.
Required for single blobs; optional for bundles.

< AccessMethod > array

aliases
optional

A list of strings that can be used to find other metadata about this DrsObject from external metadata sources. These aliases can be used to represent secondary accession numbers or external GUIDs.

< string > array

checksums
required

The checksum of the DrsObject. At least one checksum must be provided.
For blobs, the checksum is computed over the bytes in the blob.

For bundles, the checksum is computed over a sorted concatenation of the checksums of its top-level contained objects (not recursive, names not included). The list of checksums is sorted alphabetically (hex-code) before concatenation and a further checksum is performed on the concatenated checksum value.

For example, if a bundle contains blobs with the following checksums:
md5(blob1) = 72794b6d
md5(blob2) = 5e089d29

Then the checksum of the bundle is:
md5( concat( sort( md5(blob1), md5(blob2) ) ) )
= md5( concat( sort( 72794b6d, 5e089d29 ) ) )
= md5( concat( 5e089d29, 72794b6d ) )
= md5( 5e089d2972794b6d )
= f7a29a04

< Checksum > array

contents
optional

If not set, this DrsObject is a single blob.
If set, this DrsObject is a bundle containing the listed ContentsObject s (some of which may be further nested).

< ContentsObject > array

created_time
required

Timestamp of content creation in RFC3339.
(This is the creation time of the underlying content, not of the JSON object.)

string (date-time)

description
optional

A human readable description of the DrsObject.

string

id
required

An identifier unique to this DrsObject.

string

mime_type
optional

A string providing the mime-type of the DrsObject.
Example : "application/json"

string

name
optional

A string that can be used to name a DrsObject.
This string is made up of uppercase and lowercase letters, decimal digits, hypen, period, and underscore [A-Za-z0-9.-_]. See portable filenames.

string

self_uri
required

A drs:// URI, as defined in the DRS documentation, that tells clients how to access this object.
The intent of this field is to make DRS objects self-contained, and therefore easier for clients to store and pass around.
Example : "drs://drs.example.org/314159"

string

size
required

For blobs, the blob size in bytes.
For bundles, the cumulative size, in bytes, of items in the contents field.

integer (int64)

updated_time
optional

Timestamp of content update in RFC3339, identical to created_time in systems that do not support updates. (This is the update time of the underlying content, not of the JSON object.)

string (date-time)

version
optional

A string representing a version.
(Some systems may use checksum, a RFC3339 timestamp, or an incrementing version number.)

string

msg
optional

A detailed error message.

string

status_code
optional

The integer representing the HTTP status code (e.g. 200, 404).

integer