Archive and Restore management
The archive and restore management capabilities of the API allow application developers to archive assets (metadata and its high_res) at the collection/query level and provides extensibility to restore/import the same assets into a different QPP server environment. This includes the following REST calls:
archiveCollectionAssets
|
Function |
Archive collection assets. |
||
|
Description |
This request archives all assets belonging to a particular collection, from the given collection ID or complete collection path. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Name/ID of the collection. (Mandatory) |
|
|
|
string |
The path. Any file path that is accessible to the server, it could be on a network. (Mandatory) |
|
|
|
boolean |
Defaults to true. (Optional) If true, the server will archive all available versions of all assets. |
|
|
|
boolean |
Defaults to true. (Optional) If true, the server will maintain all the relations of assets to be archived. |
|
|
|
boolean |
Defaults to false. (Optional) If true, the server will delete all the assets after archiving it. |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
archiveQueryAssets
|
Function |
Archive resulted assets of any given saved search. |
||
|
Description |
This request archives all assets returned in the query result for the given query name. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Name of the saved search. (Mandatory) |
|
|
|
string |
The path. Any file path that is accessible to server, it could be on network. (Mandatory) |
|
|
|
boolean |
Defaults to true.(Optional)If true, the server will archive all available versions of all assets. |
|
|
|
boolean |
Defaults to true.(Optional)If true, the server will maintain all the relations of assets to be archived. |
|
|
|
boolean |
Defaults to false.(Optional)If true,the server will delete all the assets after archiving it. |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
archiveAssets
|
Function |
Archive specified assets. |
||
|
Description |
This request archives an asset from the given asset id or asset path. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
long or string |
The IDs or Collection Path of assets to be archived. (Mandatory) Comma separated IDs of assets (long), or a collection path of assets (string). |
|
|
|
string |
The path. Any file path that is accessible to server, it could be on network. (Mandatory) |
|
|
|
boolean |
Defaults to true.(Optional)If true, the server will archive all available versions of all assets. |
|
|
|
boolean |
Defaults to true.(Optional)If true, the server will maintain all the relations of assets to be archived. |
|
|
|
boolean |
Defaults to false.(Optional)If true, the server will delete all the assets after archiving it. |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
restoreAssets
|
Function |
Restore archived assets into the system. |
||
|
Description |
This request restores assets from the given folder path. This request requires the same collection hierarchy with same set of workflow, users etc which existed at the time of archiving the assets. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The full path of the folder which contains the archived assets and its information. (Mandatory) |
|
|
|
string |
Specify the lookup strategy to be used for fetching entities, like content type, relation type and attributes. Use name to restore across different servers, else use id. (Optional, Default value is id) |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
