kickstart.filepreservation

Available methods

Description

Provides methods to retrieve and manipulate kickstart file preservation lists.

Namespace:

kickstart.filepreservation

Method: create

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.

Method: delete

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.

Method: getDetails

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"

      • string - name

Method: listAllFilePreservations

Description:

List all file preservation lists for the organization associated with the user logged into the given session

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct - file preservation

    • int "id"

    • string "name"

    • dateTime.iso8601 "created"

    • dateTime.iso8601 "last_modified"