Skip to content

Latest commit

 

History

History
87 lines (59 loc) · 2.85 KB

file_version_legal_holds.md

File metadata and controls

87 lines (59 loc) · 2.85 KB
Raw

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 get_file_version_legal_hold_by_id.

See the endpoint docs at API Reference.

client.file_version_legal_holds.get_file_version_legal_hold_by_id(
    file_version_legal_hold_id
)

Arguments

  • file_version_legal_hold_id str
    • The ID of the file version legal hold Example: "2348213"
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

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 get_file_version_legal_holds.

See the endpoint docs at API Reference.

client.file_version_legal_holds.get_file_version_legal_holds(policy_id)

Arguments

  • policy_id str
    • The ID of the legal hold policy to get the file version legal holds for.
  • marker Optional[str]
    • Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
  • limit Optional[int]
    • The maximum number of items to return per page.
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

Returns

This function returns a value of type FileVersionLegalHolds.

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