beautypg.com

Delete custom metadata, Example – HP StoreAll Storage User Manual

Page 225

background image

If the urlpath does not exist, an HTTP 405 error is returned with the message (Method Not
Allowed)

.

Description

Parameter

The name of the existing file/directory on the HTTP share for which custom metadata is
being added or replaced.

pathname

Directory pathnames must end in a trailing slash /.

If the pathname parameter is not present, custom metadata is applied to the directory
identified by .

The attribute name. Up to 15 attributes can be assigned in a single command. The first
character must be alphabetic (a-z or A-Z), followed by a sequence of alphanumeric

attribute[n]

characters or underscores. No other characters are allowed. Attribute names must be
80 characters in length or less.

The value to associate with this attribute. Currently, only a string value can be assigned
and the value must be enclosed in single quotes. Future versions of the API may support

value[n]

numeric or other value types. If the attribute already exists for this file or directory, its
value will be replaced with this supplied value. Values must be 80 characters in length
or less.

Example

curl -g -X PUT

"https://99.226.50.92/ibrix_share1/lab/images/xyz.jpg?assign=physician

='Smith,+John;+8136',scan_pass='17'"

This example assigns two custom metadata attributes to the existing file called xyz.jpg in the
lab/images

subdirectory on the ibrix_share1 HTTP share.

Metadata Value

Description

Attribute

The metadata value for this key is
Smith, John; 8136

with spaces

encoded as the plus character (+).

Its value contains the last name, first
name, and physician’s ID number in
the medical center.

The first attribute is physician.

The metadata value for this key is 17.
All custom metadata values, even if they

Its value identifies this image as the
17th pass of a multi-image scan.

The second attribute is scan_pass.

are numeric, must be quoted, since all
custom metadata values are stored as
strings.

Delete custom metadata

This command removes one or more metadata attributes from an existing file or directory in the
HTTP share. Up to 15 metadata attributes may be removed in one command. The ability to delete
custom metadata depends on the permissions of the directory and file. If the user has permission
to navigate to the directory containing the file (depending on the 'x' (execute) permission bits of
the directory and all of its parents), and if the user has write permission on the file, then custom
metadata can be deleted. Files in WORM/retention state do not have ‘w’ (write) permissions, and
therefore the custom metadata delete operation is rejected for those files.

If the file does not exist, no HTTP error status is returned. A JSON error message is returned instead,
as shown in the following example:

[
{ "physician" : "error in deleting"}
]

If the file exists but any attributes being deleted do not exist, no HTTP error status is returned, and
the non-existent attributes are silently ignored.

The HTTP command is sent in the form of an HTTP DELETE request.

Custom metadata assignment 225