Resource URL: /platform/<<version=1>>/protocols/nfs/nlm/locks

    Overview: This resource applies the standard collection pattern to NLM
              locks on NFS.

     Methods: GET

********************************************************************************

Method GET: List all NLM locks.

       URL: GET /platform/<<version=1>>/protocols/nfs/nlm/locks

Query arguments:
     sort=<string> The field that will be used for sorting.
   resume=<string> Continue returning results from previous call using this
                   token (token should come from the previous call, resume
                   cannot be used with other options).
      lin=<string> Filter locks by the specified LIN in /ifs that is locked.
  created=<string> Return locks created after the specified unix epoch time.
   client=<string> Filter locks by the specified client host name and IP
                   address.
   limit=<integer> Return no more than this many results at once (see resume).
client_id=<string> Filter locks by the specified client ID.
     path=<string> Filter locks by the specified path under /ifs.
        dir=<enum> Where <enum> is one of ASC, DESC.  The direction of the sort.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "locks": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Information for an NLM lock on NFS.", 
            "properties": {
              "created": {
                "type": "integer", 
                "description": "Time of lock creation."
              }, 
              "lock_type": {
                "type": "string", 
                "description": "The type of lock."
              }, 
              "lin": {
                "type": "string", 
                "description": "The LIN in ifs that is locked."
              }, 
              "range": {
                "items": {
                  "type": "integer"
                }, 
                "type": "array", 
                "description": "The byte range within the file that is locked."
              }, 
              "client": {
                "type": "string", 
                "description": "The client host name."
              }, 
              "client_id": {
                "type": "string", 
                "description": "The client ID."
              }, 
              "path": {
                "type": "string", 
                "description": "The path in ifs that is locked."
              }, 
              "id": {
                "type": "string", 
                "description": "The lock ID."
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }, 
        "total": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Total number of items available.", 
          "maximum": 4294967295
        }, 
        "resume": {
          "minLength": 0, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options)."
        }
      }
    }
  ]
}
