Skip to content

Latest commit

 

History

History
161 lines (97 loc) · 4.18 KB

legalholdpolicies.md

File metadata and controls

161 lines (97 loc) · 4.18 KB

LegalHoldPoliciesManager

List all legal hold policies

Retrieves a list of legal hold policies that belong to an enterprise.

This operation is performed by calling function getLegalHoldPolicies.

See the endpoint docs at API Reference.

client.getLegalHoldPolicies().getLegalHoldPolicies()

Arguments

  • queryParams GetLegalHoldPoliciesQueryParams
    • Query parameters of getLegalHoldPolicies method
  • headers GetLegalHoldPoliciesHeaders
    • Headers of getLegalHoldPolicies method

Returns

This function returns a value of type LegalHoldPolicies.

Returns a list of legal hold policies.

Create legal hold policy

Create a new legal hold policy.

This operation is performed by calling function createLegalHoldPolicy.

See the endpoint docs at API Reference.

client.getLegalHoldPolicies().createLegalHoldPolicy(new CreateLegalHoldPolicyRequestBody.CreateLegalHoldPolicyRequestBodyBuilder(legalHoldPolicyName).description(legalHoldDescription).filterStartedAt(filterStartedAt).filterEndedAt(filterEndedAt).isOngoing(false).build())

Arguments

  • requestBody CreateLegalHoldPolicyRequestBody
    • Request body of createLegalHoldPolicy method
  • headers CreateLegalHoldPolicyHeaders
    • Headers of createLegalHoldPolicy method

Returns

This function returns a value of type LegalHoldPolicy.

Returns a new legal hold policy object.

Get legal hold policy

Retrieve a legal hold policy.

This operation is performed by calling function getLegalHoldPolicyById.

See the endpoint docs at API Reference.

client.getLegalHoldPolicies().getLegalHoldPolicyById(legalHoldPolicyId)

Arguments

  • legalHoldPolicyId String
    • The ID of the legal hold policy Example: "324432"
  • headers GetLegalHoldPolicyByIdHeaders
    • Headers of getLegalHoldPolicyById method

Returns

This function returns a value of type LegalHoldPolicy.

Returns a legal hold policy object.

Update legal hold policy

Update legal hold policy.

This operation is performed by calling function updateLegalHoldPolicyById.

See the endpoint docs at API Reference.

client.getLegalHoldPolicies().updateLegalHoldPolicyById(legalHoldPolicyId, new UpdateLegalHoldPolicyByIdRequestBody.UpdateLegalHoldPolicyByIdRequestBodyBuilder().policyName(updatedLegalHoldPolicyName).build())

Arguments

  • legalHoldPolicyId String
    • The ID of the legal hold policy Example: "324432"
  • requestBody UpdateLegalHoldPolicyByIdRequestBody
    • Request body of updateLegalHoldPolicyById method
  • headers UpdateLegalHoldPolicyByIdHeaders
    • Headers of updateLegalHoldPolicyById method

Returns

This function returns a value of type LegalHoldPolicy.

Returns a new legal hold policy object.

Remove legal hold policy

Delete an existing legal hold policy.

This is an asynchronous process. The policy will not be fully deleted yet when the response returns.

This operation is performed by calling function deleteLegalHoldPolicyById.

See the endpoint docs at API Reference.

client.getLegalHoldPolicies().deleteLegalHoldPolicyById(legalHoldPolicy.getId())

Arguments

  • legalHoldPolicyId String
    • The ID of the legal hold policy Example: "324432"
  • headers DeleteLegalHoldPolicyByIdHeaders
    • Headers of deleteLegalHoldPolicyById method

Returns

This function returns a value of type void.

A blank response is returned if the policy was successfully deleted.