Resource URL: /platform/<<version=2>>/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=2>>/protocols/nfs/nlm/locks

Query arguments:
  sort=<string> The field that will be used for sorting.
limit=<integer> Return no more than this many results at once (see resume).
     dir=<enum> Where <enum> is one of ASC, DESC.  The direction of the sort.
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).

GET response body schema:
{
  "type": "object", 
  "properties": {
    "locks": {
      "items": {
        "type": "object", 
        "description": "Information for an NLM lock on NFS.", 
        "properties": {
          "created": {
            "type": "integer", 
            "description": "Specifies the UNIX EPoch time that the lock was created."
          }, 
          "lock_type": {
            "type": "string", 
            "description": "Specifies the lock type."
          }, 
          "lin": {
            "type": "string", 
            "description": "Specifies the LIN in /ifs that is locked."
          }, 
          "range": {
            "items": {
              "type": "integer"
            }, 
            "type": "array", 
            "description": "Specifies the byte range within the locked file."
          }, 
          "client": {
            "type": "string", 
            "description": "Specifies the client host name and IP address."
          }, 
          "client_id": {
            "type": "string", 
            "description": "Specifies the client ID."
          }, 
          "path": {
            "type": "string", 
            "description": "Specifies the path under /ifs that is locked."
          }, 
          "id": {
            "type": "string", 
            "description": "Specifies the system-assigned ID given to the lock. This value is returned when the lock is created with the POST method."
          }
        }
      }, 
      "type": "array"
    }, 
    "total": {
      "type": "integer", 
      "description": "Total number of items available."
    }, 
    "resume": {
      "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)."
    }
  }
}
