Create or remove litigations for a path
Suggest changes
PDFs
POST /storage/snaplock/litigations/{litigation.id}/operations
Introduced In: 9.7
Creates or removes litigations for the specified path.
Required properties
-
type- Legal-Hold operation type. -
path- Litigation path.
Related ONTAP commands
-
snaplock legal-hold begin -
snaplock legal-hold end
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
litigation.id |
string |
path |
True |
Litigation ID |
return_records |
boolean |
query |
False |
The default is false. If set to true, the records are returned.
|
Request Body
| Name | Type | Description |
|---|---|---|
id |
integer |
Operation ID. |
num_files_failed |
string |
Specifies the number of files on which legal-hold operation failed. |
num_files_processed |
string |
Specifies the number of files on which legal-hold operation was successful. |
num_files_skipped |
string |
Specifies the number of files on which legal-hold begin operation was skipped. The legal-hold begin operation is skipped on a file if it is already under hold for a given litigation. |
num_inodes_ignored |
string |
Specifies the number of inodes on which the legal-hold operation was not attempted because they were not regular files. |
path |
string |
Specifies the path on which legal-hold operation is applied. |
state |
string |
Specifies the status of legal-hold operation. |
Example request
{
"id": "16842759",
"num_files_failed": "0",
"num_files_processed": "30",
"num_files_skipped": "10",
"num_inodes_ignored": "10",
"path": "/dir1",
"state": "completed"
}Response
Status: 201, Created| Name | Type | Description |
|---|---|---|
id |
integer |
Operation ID. |
num_files_failed |
string |
Specifies the number of files on which legal-hold operation failed. |
num_files_processed |
string |
Specifies the number of files on which legal-hold operation was successful. |
num_files_skipped |
string |
Specifies the number of files on which legal-hold begin operation was skipped. The legal-hold begin operation is skipped on a file if it is already under hold for a given litigation. |
num_inodes_ignored |
string |
Specifies the number of inodes on which the legal-hold operation was not attempted because they were not regular files. |
path |
string |
Specifies the path on which legal-hold operation is applied. |
state |
string |
Specifies the status of legal-hold operation. |
Example response
{
"id": "16842759",
"num_files_failed": "0",
"num_files_processed": "30",
"num_files_skipped": "10",
"num_inodes_ignored": "10",
"path": "/dir1",
"state": "completed"
}Error
Status: DefaultONTAP Error Response codes
| Error code | Description |
|---|---|
14090346 |
Internal Error. Wait a few minutes, then try the command again |
14090343 |
Invalid Field |
Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
snaplock_legal_hold_operation
| Name | Type | Description |
|---|---|---|
id |
integer |
Operation ID. |
num_files_failed |
string |
Specifies the number of files on which legal-hold operation failed. |
num_files_processed |
string |
Specifies the number of files on which legal-hold operation was successful. |
num_files_skipped |
string |
Specifies the number of files on which legal-hold begin operation was skipped. The legal-hold begin operation is skipped on a file if it is already under hold for a given litigation. |
num_inodes_ignored |
string |
Specifies the number of inodes on which the legal-hold operation was not attempted because they were not regular files. |
path |
string |
Specifies the path on which legal-hold operation is applied. |
state |
string |
Specifies the status of legal-hold operation. |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |