resource-governance-retention
Operations of the Resource Governance API. Paths are relative to your deployment's API host.
POST /api/resource-governance-api/resources/governance/retention/choices
CAS-activate a retention choice, refused outside its bounds
Authentication: bearer token (Authorization: Bearer <token>)
Request body: application/json ActivateRetentionChoiceRequestDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json RetentionActivationResultDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
POST /api/resource-governance-api/resources/governance/retention/effective
Resolve the active organization's effective retention window
Authentication: bearer token (Authorization: Bearer <token>)
Request body: application/json OrgRetentionDecisionRequestDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json EffectiveRetentionDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
POST /api/resource-governance-api/resources/governance/retention/legal-holds
Place a legal hold on the organization's own data
Authentication: bearer token (Authorization: Bearer <token>)
Request body: application/json PlaceOwnLegalHoldRequestDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json LegalHoldRecordDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
POST /api/resource-governance-api/resources/governance/retention/legal-holds/list
List the organization's own holds
Authentication: bearer token (Authorization: Bearer <token>)
Request body: application/json ListOwnLegalHoldsRequestDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json LegalHoldRecordDtoDataArrayEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |