Skip to content

Latest commit

 

History

History
85 lines (53 loc) · 2.56 KB

fileversionlegalholds.md

File metadata and controls

85 lines (53 loc) · 2.56 KB

FileVersionLegalHoldsManager

Get file version legal hold

Retrieves information about the legal hold policies assigned to a file version.

This operation is performed by calling function getFileVersionLegalHoldById.

See the endpoint docs at API Reference.

client.getFileVersionLegalHolds().getFileVersionLegalHoldById(fileVersionLegalHoldId)

Arguments

  • fileVersionLegalHoldId String
    • The ID of the file version legal hold Example: "2348213"
  • headers GetFileVersionLegalHoldByIdHeaders
    • Headers of getFileVersionLegalHoldById method

Returns

This function returns a value of type FileVersionLegalHold.

Returns the legal hold policy assignments for the file version.

List file version legal holds

Get a list of file versions on legal hold for a legal hold assignment.

Due to ongoing re-architecture efforts this API might not return all file versions for this policy ID.

Instead, this API will only return file versions held in the legacy architecture. Two new endpoints will available to request any file versions held in the new architecture.

For file versions held in the new architecture, the GET /legal_hold_policy_assignments/:id/file_versions_on_hold API can be used to return all past file versions available for this policy assignment, and the GET /legal_hold_policy_assignments/:id/files_on_hold API can be used to return any current (latest) versions of a file under legal hold.

The GET /legal_hold_policy_assignments?policy_id={id} API can be used to find a list of policy assignments for a given policy ID.

Once the re-architecture is completed this API will be deprecated.

This operation is performed by calling function getFileVersionLegalHolds.

See the endpoint docs at API Reference.

client.getFileVersionLegalHolds().getFileVersionLegalHolds(new GetFileVersionLegalHoldsQueryParams(policyId))

Arguments

  • queryParams GetFileVersionLegalHoldsQueryParams
    • Query parameters of getFileVersionLegalHolds method
  • headers GetFileVersionLegalHoldsHeaders
    • Headers of getFileVersionLegalHolds method

Returns

This function returns a value of type FileVersionLegalHolds.

Returns the list of file version legal holds for a specific legal hold policy.