( Return to API Overview )
- create
- delete
- getDetails
- listAllFilePreservations
Description
Provides methods to retrieve and manipulate kickstart file
preservation lists.
Namespace:
kickstart.filepreservation
Description:
Create a new file preservation list.
Parameters:
-
string session_key
-
string name - name of the file list to create
-
array:
- string - name - file names to include
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Delete a file preservation list.
Parameters:
-
string session_key
-
string name - name of the file list to delete
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Returns all of the data associated with the given file preservation
list.
Parameters:
-
string session_key
-
string name - name of the file list to retrieve
details for
Returns:
-
struct - file list
- string "name"
- array "file_names"
Description:
List all file preservation lists for the organization
associated with the user logged into the given session
Parameters:
Returns:
-
array:
-
struct - file preservation
- int "id"
- string "name"
- dateTime.iso8601 "created"
- dateTime.iso8601 "last_modified"
Generated on 3/4/2020