PowerScale OneFS API Reference

Set the retention period and commit a file in a SmartLock directory

Sets the retention period and commits a file in a SmartLock directory.

Request syntax

PUT /namespace/<access_point>/<WORM_directory>/<file_name>?worm HTTP/1.1
Host: <hostname>[:<port>]
Date: <date>
Authorization: <signature>

{
   "worm_retention_date":<"YYYY-MM-DD hh:mm:ss GMT">,
   "commit_to_worm":<Boolean>
}

NOTE:

If a file is not explicitly committed and an autocommit time period is configured for the SmartLock directory where the file resides, the file is automatically committed when the autocommit period elapses.

If the file is committed without setting a retention expiration date, the default retention period that is specified for the SmartLock directory where the file resides is applied. The retention date on the file can also be limited by the maximum retention period set on the SmartLock directory.

For details about SmartLock WORM behavior, see the OneFS Administration Guide.

Request query parameters


Parameter Name	Description	Default	Type	Required
worm	The worm argument must be placed at the first position of the argument list in the URI.	N/A	String	No

Request body parameters


Parameter Name	Description	Default	Type	Required
worm_retention_date	Specifies the retention expiration date string in Coordinated Universal Time (UTC/GMT).	N/A	Time, in the string format of: "YYYY-MM-DD hh:m:ss GMT"	No
commit_to_worm	Specifies whether to commit the file to a WORM state after the retention date is set. If the file was committed before, the file remains committed regardless of the value in this field.	False	Boolean	No

Request headers

This call sends common request headers.

Response headers

This call returns common response headers.

Response body

No message body is returned upon success.

Example request

Set the retention date for a file in a SmartLock directory.

PUT /namespace/ifs/dir1/file?worm HTTP/1.1
Host: my_cluster:8080
Date: Tue, 22 May 2012 12:00:00 GMT
Authorization: <signature>

{
   "worm_retention_date":"2013-04-11 12:00:00 GMT",
   "commit_to_worm":true
}

Example response

HTTP/1.1 200 OK
Date: Tue, 22 May 2012 12:00:00 GMT
Content-Length: 0
Connection: close
Server: Apache2/2.2.19

Welcome

Welcome to Dell