Skip to main content
A newer release of this product is available.

Create or remove litigations for a path

Contributors
PDFs

POST /storage/snaplock/litigations/{litigation.id}/operations

Creates or removes litigations for the specified path.

Required properties

  • type - Legal-Hold operation type.

  • path - Litigation path.

  • snaplock legal-hold begin

  • snaplock legal-hold end

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

litigation.id

string

path

True

Litigation ID

Request Body

Name Type Description

_links

_links

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.

type

string

Specifies the type of legal-hold operation.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "id": 16842759,
  "num_files_failed": 0,
  "num_files_processed": 30,
  "num_files_skipped": 10,
  "num_inodes_ignored": 10,
  "path": "/dir1",
  "state": "completed",
  "type": "begin"
}

Response

Status: 201, Created
Name Type Description

_links

_links

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.

type

string

Specifies the type of legal-hold operation.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "id": 16842759,
  "num_files_failed": 0,
  "num_files_processed": 30,
  "num_files_skipped": 10,
  "num_inodes_ignored": 10,
  "path": "/dir1",
  "state": "completed",
  "type": "begin"
}

Error

Status: Default

ONTAP Error Response codes

Error code Description

14090346

Internal Error. Wait a few minutes, then try the command again

14090343

Invalid Field
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href
Name Type Description

_links

_links

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.

type

string

Specifies the type 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.