User - Software works

RESTful Web Services Documentation

Methods

Archive object

URL HTTP Verb Functionality
/archiveObject/{filespaceName}/{highLevelName}/{lowLevelName} PUT Archive Object
/archiveObject/{filespaceName}/{highLevelName}/{lowLevelName}?insertion-date&?offset&?length GET Retrieve Object
/archiveObject/{filespaceName}/{highLevelName}/{lowLevelName}?owner&?information&estimated-size&?description POST Update Archive Object
/archiveObject/{filespaceName}/{highLevelName}/{lowLevelName}/?insertion-date/{event} POST Event Retention
/archiveObject/{filespaceName}/{highLevelName}/{lowLevelName}?insertion-date DELETE Delete Archive Object
/archiveObject/{filespaceName}/{highLevelName}/{lowLevelName}/information GET Get Object Information

SSAM Archive object

URL HTTP Verb Functionality
/archiveObject/{filespaceName}/{highLevelName}/{lowLevelName} PUT Archive SSAM Object
/archiveObject/{filespaceName}/{highLevelName}/{lowLevelName}?insertion-date&?offset&?length GET Retrieve SSAM Object
/archiveObject/{id} GET Retrieve SSAM by ID
/archiveObject/{filespaceName}/{highLevelName}/{lowLevelName}?owner&?information&estimated-size&?description POST Update SSAM Archive Object
/archiveObject/{filespaceName}/{highLevelName}/{lowLevelName}/?insertion-date/{event} POST Event Retention
/archiveObject/{filespaceName}/{highLevelName}/{lowLevelName}/information GET Get SSAM Object Information

Backup Object

URL HTTP Verb Functionality
/backupObject/{filespaceName}/{highLevelName}/{lowLevelName} PUT Backup Object
/backupObject/{filespaceName}/{highLevelName}/{lowLevelName}?insertion-date&?offset&?length GET Restore Object
/backupObject/{filespaceName}/{highLevelName}/{lowLevelName}?owner&?information&?estimated-size&?management-class POST Update Backup Object
/backupObject/{filespaceName}/{highLevelName}/{lowLevelName}?insertion-date DELETE Delete Backup Object
/backupObject/{filespaceName}/{highLevelName}/{lowLevelName}/versions GET Get Object Versions

Filespace

URL HTTP Verb Functionality
/filespace GET Query Filespaces

Usage of methods

Archive Object or Backup Object:

Archives or backs up a file with a given filespace, high-level and low-level name. The content must be sent as an Octet Stream.
If any of the elements of the object name contains an asterisk ('*') the method will return error 400 (Bad Request). If the filespace doesn't exist, an exception will be thrown with a 404 (Not Found) error code.
When the operation is successful the HTTP response will be 201 (created).

Archive SSAM object:

Archives a file with with a given filespace, high-level and low-level name that can be retrieved from an SSAM server.

Retrieve Object, SSAM Object or Restore Object:

Retrieves or restores a file with a given filespace, high-level name and low-level name. If any of the elements of the object name contains an asterisk ('*') the method will return error 400 (Bad Request). The content must be sent as an Octet Stream.
If you want to do a partial restore on a file, add query parameter "length" which sets the number of bytes to be received and "offset" which sets the index of the first byte.
If multiple objects exist with the same name an exception will be thrown with error 409 (Conflict). In such a situation you may want to add a query parameter for the insertion date. Parameter "insertion-date" is written in the following format: "yyyy.MM.dd-HH:mm:ss", any other format will cause an exception to be thrown with error 417 (Expectation failed). Example for the correct format: "2014.03.24-16:25:15". You can get the insertion date of an archive object with the get information method or the get version method for a backup object.
When the operation is successful the HTTP response will be 200 (OK).

Retrieve SSAM Object by ID

Retrieves a file with a given ID. If the ID is invalid the method will return error 400 (Bad Request). The content must be set as an Octet Stream.
If you want to do a partial restore on a file, add query parameters "length" which sets the number of bytes to be received and "offset" which sets the index of the first byte.
When the operation is successful the HTTP response will be 200 (OK).

Event Retention

You can manage the retention state of an archive object. Use one of the following parameters 'hold', 'release' or 'activate' to trigger the event.
If multiple objects exist with the same name an exception will be thrown with error 409 (Conflict). In such a situation you may want to add a query parameter for the insertion date. Parameter "insertion-date" is written in the following format: "yyyy.MM.dd-HH:mm:ss", any other format will cause a an exception to be thrown with error 417 (Expectation failed). Example for the correct format: "2014.03.24-16:25:15". You can get the insertion date of an object with the get information method.
When the operation is successful the HTTP response will be 204 (No Content).

Update Archive Object or SSAM Archive Object:

Updates all archived object properties with a given name, for example, owner, information, estimated size and description. These property values can be used as query parameters. The supported query parameters are "owner", "information", "estimated-size" and "description". If you want to reset a parameter to null, use the string "null" as the value.
If any of the elements of the object name contains an asterisk ('*') the method will return error 400 (Bad Request). If the filespace or the object does not exist on the server, an exception will be thrown with a 404 (Not Found) error code.
When the operation is successful but the query parameters are empty, the HTTP response will be 304 (Not Modified).
When the update is successful the HTTP response is 204 (No Content).

Delete Object:

Deletes all objects with a given name or deletes a specified object with a given insertion date.
If any of the elements of the object name contains an asterisk ('*') the method will return error 400 (Bad Request).

Get Object Information:

Should you receive error 409, call this method to get all information on the object versions. It returns an XML file that contains the insertion date for each object returned which you can use to select a single object.
If one of the elements of the object name contains an asterisk ('*') the method will return error 400 (Bad Request).
When the operation is successful the HTTP response will be 200 (OK).

Query filespaces:

Returns an XML file that contains information about the filespaces on the server.
If no filespaces exists on the server the method will return error 400 (Bad Request).
When the operation is successful the HTTP response will be 200 (OK).