Skip to content

retention_policy_assignments.md

Latest commit

 

History

History
185 lines (129 loc) · 6.78 KB

retention_policy_assignments.md

File metadata and controls

185 lines (129 loc) · 6.78 KB

RetentionPolicyAssignmentsManager

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

See the endpoint docs at API Reference.

client.retention_policy_assignments.get_retention_policy_assignments(
    retention_policy.id
)

Arguments

  • retention_policy_id str
    • The ID of the retention policy. Example: "982312"
  • type Optional[GetRetentionPolicyAssignmentsType]
    • The type of the retention policy assignment to retrieve.
  • fields Optional[List[str]]
    • A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
  • marker Optional[str]
    • Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
  • 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 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 create_retention_policy_assignment.

See the endpoint docs at API Reference.

client.retention_policy_assignments.create_retention_policy_assignment(
    retention_policy.id,
    CreateRetentionPolicyAssignmentAssignTo(
        type=CreateRetentionPolicyAssignmentAssignToTypeField.FOLDER, id=folder.id
    ),
)

Arguments

  • policy_id str
    • The ID of the retention policy to assign.
  • assign_to CreateRetentionPolicyAssignmentAssignTo
    • The item to assign the policy to.
  • filter_fields Optional[List[CreateRetentionPolicyAssignmentFilterFields]]
    • If the assign_to type is metadata_template, then optionally add the filter_fields parameter which will require an array of objects with a field entry and a value entry. Currently only one object of field and value is supported.
  • start_date_field Optional[str]
    • The date the retention policy assignment begins. If the assigned_to type is metadata_template, this field can be a date field's metadata attribute key id.
  • 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 RetentionPolicyAssignment.

Returns a new retention policy assignment object.

Get retention policy assignment

Retrieves a retention policy assignment.

This operation is performed by calling function get_retention_policy_assignment_by_id.

See the endpoint docs at API Reference.

client.retention_policy_assignments.get_retention_policy_assignment_by_id(
    retention_policy_assignment.id
)

Arguments

  • retention_policy_assignment_id str
    • The ID of the retention policy assignment. Example: "1233123"
  • fields Optional[List[str]]
    • A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
  • 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 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 delete_retention_policy_assignment_by_id.

See the endpoint docs at API Reference.

client.retention_policy_assignments.delete_retention_policy_assignment_by_id(
    retention_policy_assignment.id
)

Arguments

  • retention_policy_assignment_id str
    • The ID of the retention policy assignment. Example: "1233123"
  • 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 None.

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

See the endpoint docs at API Reference.

client.retention_policy_assignments.get_files_under_retention_policy_assignment(
    retention_policy_assignment.id
)

Arguments

  • retention_policy_assignment_id str
    • The ID of the retention policy assignment. Example: "1233123"
  • 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 FilesUnderRetention.

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