Resource URL: /platform/<<version=1>>/protocols/smb/openfiles

    Overview: This resources allows listing all files currently open via SMB on
              the queried node.

     Methods: GET

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

Method GET: List open files.

       URL: GET /platform/<<version=1>>/protocols/smb/openfiles

Query arguments:
    sort=<enum> Where <enum> is one of id, file, user, locks.  Order results by
                this field. Default is id.
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": [
    {
      "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": {
        "total": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Total number of items available.", 
          "maximum": 4294967295
        }, 
        "openfiles": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "properties": {
              "locks": {
                "required": true, 
                "type": "integer", 
                "description": "Number of locks user holds on file."
              }, 
              "user": {
                "required": true, 
                "type": "string", 
                "description": "User holding file open."
              }, 
              "id": {
                "required": true, 
                "type": "integer", 
                "description": "The file ID."
              }, 
              "file": {
                "required": true, 
                "type": "string", 
                "description": "Path of file within /ifs."
              }, 
              "permissions": {
                "items": {
                  "enum": [
                    "read", 
                    "write", 
                    "create"
                  ], 
                  "type": "string"
                }, 
                "required": true, 
                "type": "array", 
                "description": "The user's permissions on file."
              }
            }
          }, 
          "type": "array", 
          "maxItems": 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)."
        }
      }
    }
  ]
}
