GET Attribute¶

Description¶

Gets the specified attribute of a dataset, group, or committed datatype.

Requests¶

Syntax¶

To get an attribute of a group:

GET /groups/<id>/attributes/<name> HTTP/1.1
Host: DOMAIN
Authorization: <authorization_string>

To get an attribute of a dataset:

GET /datasets/<id>/attributes/<name> HTTP/1.1
Host: DOMAIN
Authorization: <authorization_string>

To get an attribute of a datatype:

GET /datatypes/<id>/attributes/<name> HTTP/1.1
Host: DOMAIN
Authorization: <authorization_string>

where:

<id> is the UUID of the dataset/group/committed datatype
<name> is the url-encoded name of the requested attribute

Request Parameters¶

This implementation of the operation does not use request parameters.

Request Headers¶

This implementation of the operation uses only the request headers that are common to most requests. See Common Request Headers

Responses¶

Response Headers¶

This implementation of the operation uses only response headers that are common to most responses. See Common Response Headers.

Response Elements¶

On success, a JSON response will be returned with the following elements:

type¶

A JSON object representing the type of the attribute. See Types for details of the type representation.

shape¶

A JSON object that represents the dataspace of the attribute. Subkeys of shape are:

class: A string with one of the following values:

H5S_NULL: A null dataspace, which has no elements

H5S_SCALAR: A dataspace with a single element (although possibly of a complext datatype)

H5S_SIMPLE: A dataspace that consists of a regular array of elements

dims: An integer array whose length is equal to the number of dimensions (rank) of the dataspace. The value of each element gives the the current size of each dimension. Dims is not returned for H5S_NULL or H5S_SCALAR dataspaces.

value¶

A json array (or string or number for scalar datasets) giving the values of the requested attribute.

hrefs¶

An array of links to related resources. See Hypermedia.

Special Errors¶

The implementation of the operation does not return special errors. For general information on standard error codes, see Common Error Responses.

Examples¶

Sample Request¶

Get an attribute named “attr1” from a group with UUID: “45a882e1-…”.

GET /groups/1a956e54-abf6-11e4-b878-3c15c2da029e/attributes/attr1 HTTP/1.1
host: tall.test.hdfgroup.org
Accept-Encoding: gzip, deflate
Accept: */*
User-Agent: python-requests/2.3.0 CPython/2.7.8 Darwin/14.0.0

Sample Response¶

HTTP/1.1 200 OK
Date: Tue, 03 Feb 2015 22:44:04 GMT
Content-Length: 648
Etag: "55b2e2ce2d3a2449a49cfd76c4dae635ec43a150"
Content-Type: application/json
Server: TornadoServer/3.2.2

{
"name": "attr1",
"type": {
    "class": "H5T_INTEGER",
    "base": "H5T_STD_I8LE"
},
"shape": {
    "class": "H5S_SIMPLE",
    "dims": [10]
},
"value": [97, 98, 99, 100, 101, 102, 103, 104, 105, 0],
"created": "2015-02-03T22:40:09Z",
"lastModified": "2015-02-03T22:40:09Z",
"hrefs": [
    {"href": "http://tall.test.hdfgroup.org/groups/1a956e54-abf6-11e4-b878-3c15c2da029e/attributes/attr1", "rel": "self"},
    {"href": "http://tall.test.hdfgroup.org/groups/1a956e54-abf6-11e4-b878-3c15c2da029e", "rel": "owner"},
    {"href": "http://tall.test.hdfgroup.org/groups/1a956e54-abf6-11e4-b878-3c15c2da029e", "rel": "root"},
    {"href": "http://tall.test.hdfgroup.org/", "rel": "home"}
  ]
}