PUT Attribute¶

Description¶

Creates a new attribute in a group, dataset, or committed datatype.

Note: The new attribute will replace any existing attribute with the same name.

Requests¶

Syntax¶

To create a group attribute:

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

To create a dataset attribute:

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

To create a committed datatype attribute:

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

<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

Request Elements¶

The request body must include a JSON object with “type” key. Optionally a “shape” key can be provide to make a non-scalar attribute.

type¶

Specify’s the desired type of the attribute. Either a string that is one of the predefined type values, a uuid of a committed type, or a JSON object describing the type. See Types for details of the type specification.

shape¶

Either a string with the value H5S_NULL or an integer array describing the dimensions of the attribute. If shape is not provided, a scalar attribute will be created. If a shape value of H5S_NULL is specified a null space attribute will be created. (Null space attributes can not contain any data values.)

value¶

A JSON array (or number or string for scalar attributes with primitive types) that specifies the initial values for the attribute. The elements of the array must be compatible with the type of the attribute. Not valid to provide if the shape is H5S_NULL.

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:

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 - scalar attribute¶

Create an integer scalar attribute in the group with UUID of “be319519-” named “attr4”. The value of the attribute will be 42.

PUT /groups/be319519-acff-11e4-bf8e-3c15c2da029e/attributes/attr4 HTTP/1.1
Content-Length: 38
User-Agent: python-requests/2.3.0 CPython/2.7.8 Darwin/14.0.0
host: tall_updated.test.hdfgroup.org
Accept: */*
Accept-Encoding: gzip, deflate

{
"type": "H5T_STD_I32LE",
"value": 42
}

Sample Response - scalar attribute¶

HTTP/1.1 201 Created
Date: Thu, 05 Feb 2015 06:25:30 GMT
Content-Length: 359
Content-Type: application/json
Server: TornadoServer/3.2.2

{"hrefs": [
    {"href": "http://tall_updated.test.hdfgroup.org/groups/be319519-acff-11e4-bf8e-3c15c2da029e/attributes/attr4", "rel": "self"},
    {"href": "http://tall_updated.test.hdfgroup.org/groups/be319519-acff-11e4-bf8e-3c15c2da029e", "rel": "owner"},
    {"href": "http://tall_updated.test.hdfgroup.org/groups/be319519-acff-11e4-bf8e-3c15c2da029e", "rel": "root"}
  ]
}

Sample Request - string attribute¶

Create a two-element, fixed width string attribute in the group with UUID of “be319519-” named “attr6”. The attributes values will be “Hello, …” and “Goodbye!”.

PUT /groups/be319519-acff-11e4-bf8e-3c15c2da029e/attributes/attr6 HTTP/1.1
Content-Length: 162
User-Agent: python-requests/2.3.0 CPython/2.7.8 Darwin/14.0.0
host: tall_updated.test.hdfgroup.org
Accept: */*
Accept-Encoding: gzip, deflate

{
"shape": [2],
"type": {
    "class": "H5T_STRING",
    "cset": "H5T_CSET_ASCII",
    "strpad": "H5T_STR_NULLPAD",
    "strsize": 40
},
"value": ["Hello, I'm a fixed-width string!", "Goodbye!"]
}

Sample Response - string attribute¶

HTTP/1.1 201 Created
Date: Thu, 05 Feb 2015 06:42:14 GMT
Content-Length: 359
Content-Type: application/json
Server: TornadoServer/3.2.2

{
"hrefs": [
    {"href": "http://tall_updated.test.hdfgroup.org/groups/be319519-acff-11e4-bf8e-3c15c2da029e/attributes/attr6", "rel": "self"},
    {"href": "http://tall_updated.test.hdfgroup.org/groups/be319519-acff-11e4-bf8e-3c15c2da029e", "rel": "owner"},
    {"href": "http://tall_updated.test.hdfgroup.org/groups/be319519-acff-11e4-bf8e-3c15c2da029e", "rel": "root"}
  ]
}

Sample Request - compound type¶

Create a two-element, attribute of group with UUID of “be319519-” named “attr_compound”. The attribute has a compound type with an integer and a floating point element.

PUT /groups/be319519-acff-11e4-bf8e-3c15c2da029e/attributes/attr_compound HTTP/1.1
Content-Length: 187
User-Agent: python-requests/2.3.0 CPython/2.7.8 Darwin/14.0.0
host: tall_updated.test.hdfgroup.org
Accept: */*
Accept-Encoding: gzip, deflate

{
"shape": 2,
"type": {
    "class": "H5T_COMPOUND",
    "fields": [
        {"type": "H5T_STD_I32LE", "name": "temp"},
        {"type": "H5T_IEEE_F32LE", "name": "pressure"}
    ]
},
"value": [[55, 32.34], [59, 29.34]]
}

Sample Response - compound type¶

HTTP/1.1 201 Created
Date: Thu, 05 Feb 2015 06:49:19 GMT
Content-Length: 367
Content-Type: application/json
Server: TornadoServer/3.2.2

{
"hrefs": [
    {"href": "http://tall_updated.test.hdfgroup.org/groups/be319519-acff-11e4-bf8e-3c15c2da029e/attributes/attr_compound", "rel": "self"},
    {"href": "http://tall_updated.test.hdfgroup.org/groups/be319519-acff-11e4-bf8e-3c15c2da029e", "rel": "owner"},
    {"href": "http://tall_updated.test.hdfgroup.org/groups/be319519-acff-11e4-bf8e-3c15c2da029e", "rel": "root"}
  ]
}