79 lines
2.7 KiB
Markdown
79 lines
2.7 KiB
Markdown
---
|
|
name: legal-hold-policy-assignments-routes
|
|
description: Handle 6 OpenAPI operation(s) under /legal_hold_policy_assignments for the legal hold policy assignments route group.
|
|
---
|
|
|
|
# legal hold policy assignments API Routes
|
|
|
|
Handle 6 OpenAPI operation(s) under /legal_hold_policy_assignments for the legal hold policy assignments route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### get_legal_hold_policy_assignments
|
|
|
|
- Operation ID: `get_legal_hold_policy_assignments`
|
|
- Route: `GET /legal_hold_policy_assignments`
|
|
- Mode: READ
|
|
- Summary: List legal hold policy assignments
|
|
- Parameters:
|
|
- `policy_id` in `query` required
|
|
- `assign_to_type` in `query`
|
|
- `assign_to_id` in `query`
|
|
- `marker` in `query`
|
|
- `limit` in `query`
|
|
- `fields` in `query`
|
|
|
|
### post_legal_hold_policy_assignments
|
|
|
|
- Operation ID: `post_legal_hold_policy_assignments`
|
|
- Route: `POST /legal_hold_policy_assignments`
|
|
- Mode: WRITE
|
|
- Summary: Assign legal hold policy
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_legal_hold_policy_assignments_id
|
|
|
|
- Operation ID: `get_legal_hold_policy_assignments_id`
|
|
- Route: `GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}`
|
|
- Mode: READ
|
|
- Summary: Get legal hold policy assignment
|
|
- Parameters:
|
|
- `legal_hold_policy_assignment_id` in `path` required
|
|
|
|
### delete_legal_hold_policy_assignments_id
|
|
|
|
- Operation ID: `delete_legal_hold_policy_assignments_id`
|
|
- Route: `DELETE /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}`
|
|
- Mode: WRITE
|
|
- Summary: Unassign legal hold policy
|
|
- Parameters:
|
|
- `legal_hold_policy_assignment_id` in `path` required
|
|
|
|
### get_legal_hold_policy_assignments_id_files_on_hold
|
|
|
|
- Operation ID: `get_legal_hold_policy_assignments_id_files_on_hold`
|
|
- Route: `GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/files_on_hold`
|
|
- Mode: READ
|
|
- Summary: List files with current file versions for legal hold policy assignment
|
|
- Parameters:
|
|
- `legal_hold_policy_assignment_id` in `path` required
|
|
- `marker` in `query`
|
|
- `limit` in `query`
|
|
- `fields` in `query`
|
|
|
|
### get_legal_hold_policy_assignments_id_file_versions_on_hold
|
|
|
|
- Operation ID: `get_legal_hold_policy_assignments_id_file_versions_on_hold`
|
|
- Route: `GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/file_versions_on_hold`
|
|
- Mode: READ
|
|
- Summary: List previous file versions for legal hold policy assignment
|
|
- Parameters:
|
|
- `legal_hold_policy_assignment_id` in `path` required
|
|
- `marker` in `query`
|
|
- `limit` in `query`
|
|
- `fields` in `query`
|