RetentionPolicyAssignmentsManager

July 28, 2025 ยท View on GitHub

List retention policy assignments

Returns a list of all retention policy assignments associated with a specified retention policy.

This operation is performed by calling function getRetentionPolicyAssignments.

See the endpoint docs at API Reference.

try await client.retentionPolicyAssignments.getRetentionPolicyAssignments(retentionPolicyId: retentionPolicy.id)

Arguments

  • retentionPolicyId String
    • The ID of the retention policy. Example: "982312"
  • queryParams GetRetentionPolicyAssignmentsQueryParams
    • Query parameters of getRetentionPolicyAssignments method
  • headers GetRetentionPolicyAssignmentsHeaders
    • Headers of getRetentionPolicyAssignments method

Returns

This function returns a value of type RetentionPolicyAssignments.

Returns a list of the retention policy assignments associated with the specified retention policy.

Assign retention policy

Assigns a retention policy to an item.

This operation is performed by calling function createRetentionPolicyAssignment.

See the endpoint docs at API Reference.

try await client.retentionPolicyAssignments.createRetentionPolicyAssignment(requestBody: CreateRetentionPolicyAssignmentRequestBody(policyId: retentionPolicy.id, assignTo: CreateRetentionPolicyAssignmentRequestBodyAssignToField(type: CreateRetentionPolicyAssignmentRequestBodyAssignToTypeField.folder, id: folder.id)))

Arguments

  • requestBody CreateRetentionPolicyAssignmentRequestBody
    • Request body of createRetentionPolicyAssignment method
  • headers CreateRetentionPolicyAssignmentHeaders
    • Headers of createRetentionPolicyAssignment method

Returns

This function returns a value of type RetentionPolicyAssignment.

Returns a new retention policy assignment object.

Get retention policy assignment

Retrieves a retention policy assignment.

This operation is performed by calling function getRetentionPolicyAssignmentById.

See the endpoint docs at API Reference.

try await client.retentionPolicyAssignments.getRetentionPolicyAssignmentById(retentionPolicyAssignmentId: retentionPolicyAssignment.id)

Arguments

  • retentionPolicyAssignmentId String
    • The ID of the retention policy assignment. Example: "1233123"
  • queryParams GetRetentionPolicyAssignmentByIdQueryParams
    • Query parameters of getRetentionPolicyAssignmentById method
  • headers GetRetentionPolicyAssignmentByIdHeaders
    • Headers of getRetentionPolicyAssignmentById method

Returns

This function returns a value of type RetentionPolicyAssignment.

Returns the retention policy assignment object.

Remove retention policy assignment

Removes a retention policy assignment applied to content.

This operation is performed by calling function deleteRetentionPolicyAssignmentById.

See the endpoint docs at API Reference.

try await client.retentionPolicyAssignments.deleteRetentionPolicyAssignmentById(retentionPolicyAssignmentId: retentionPolicyAssignment.id)

Arguments

  • retentionPolicyAssignmentId String
    • The ID of the retention policy assignment. Example: "1233123"
  • headers DeleteRetentionPolicyAssignmentByIdHeaders
    • Headers of deleteRetentionPolicyAssignmentById method

Returns

This function returns a value of type ``.

Returns an empty response when the policy assignment is successfully deleted.

Get files under retention

Returns a list of files under retention for a retention policy assignment.

This operation is performed by calling function getFilesUnderRetentionPolicyAssignment.

See the endpoint docs at API Reference.

try await client.retentionPolicyAssignments.getFilesUnderRetentionPolicyAssignment(retentionPolicyAssignmentId: retentionPolicyAssignment.id)

Arguments

  • retentionPolicyAssignmentId String
    • The ID of the retention policy assignment. Example: "1233123"
  • queryParams GetFilesUnderRetentionPolicyAssignmentQueryParams
    • Query parameters of getFilesUnderRetentionPolicyAssignment method
  • headers GetFilesUnderRetentionPolicyAssignmentHeaders
    • Headers of getFilesUnderRetentionPolicyAssignment method

Returns

This function returns a value of type FilesUnderRetention.

Returns a list of files under retention that are associated with the specified retention policy assignment.