Builtin Metadata Schema

The following is a complete listing of the metadata schema for builtin plugins.

For the live metadata schema, including all installed and enabled plugins, see the /api/schema/files REST endpoint. This can be viewed using the Swagger UI docs.

{
  "_plugin_lastupdate": [
    {
      "name": "default::DefaultPlugin",
      "prompt": "last successful update",
      "value": {
        "datatype": "datetime"
      }
    },
    {
      "name": "gpfs::GPFSPolicyPlugin",
      "prompt": "last successful update",
      "value": {
        "datatype": "datetime"
      }
    },
    {
      "name": "stat::StatPlugin",
      "prompt": "last successful update",
      "value": {
        "datatype": "datetime"
      }
    }
  ],
  "core": [
    {
      "name": "pathname",
      "prompt": "File fully-qualified path",
      "default_filter": false,
      "value": {
        "datatype": "String",
        "encoding": "UTF-8",
        "language": "en"
      }
    },
    {
      "name": "filename",
      "prompt": "File basename",
      "default_filter": false,
      "value": {
        "datatype": "String",
        "encoding": "UTF-8",
        "language": "en"
      }
    },
    {
      "name": "directory",
      "prompt": "Directory in which the file resides",
      "value": {
        "datatype": "String",
        "encoding": "UTF-8",
        "language": "en"
      }
    },
    {
      "name": "extension",
      "prompt": "File extension",
      "value": {
        "datatype": "String",
        "encoding": "UTF-8",
        "language": "en"
      }
    },
    {
      "name": "mimetype",
      "prompt": "File mime-type",
      "value": {
        "datatype": "String",
        "encoding": "UTF-8",
        "language": "en"
      }
    },
    {
      "name": "inode",
      "prompt": "File inode number",
      "default_filter": false,
      "value": {
        "datatype": "Long"
      }
    },
    {
      "name": "size",
      "prompt": "File size in bytes",
      "value": {
        "datatype": "Long"
      }
    },
    {
      "user": [
        {
          "name": "name",
          "prompt": "Name of the user that owns the file",
          "value": {
            "datatype": "String",
            "encoding": "UTF-8",
            "language": "en"
          }
        },
        {
          "name": "id",
          "prompt": "Numerical id of user that owns the file",
          "default_filter": false,
          "value": {
            "datatype": "Long"
          }
        }
      ]
    },
    {
      "group": [
        {
          "name": "name",
          "prompt": "Name of the group that owns the file",
          "value": {
            "datatype": "String",
            "encoding": "UTF-8",
            "language": "en"
          }
        },
        {
          "name": "id",
          "prompt": "Numerical id of group that owns the file",
          "default_filter": false,
          "value": {
            "datatype": "Long"
          }
        }
      ]
    },
    {
      "name": "nlink",
      "prompt": "Number of hard links to the file",
      "value": {
        "datatype": "Integer"
      }
    },
    {
      "name": "changetime",
      "prompt": "Time when the file was last changed",
      "value": {
        "datatype": "Datetime"
      }
    },
    {
      "name": "accesstime",
      "prompt": "Time when the file was last accessed",
      "value": {
        "datatype": "Datetime"
      }
    },
    {
      "name": "modificationtime",
      "prompt": "Time when the file was last modified",
      "value": {
        "datatype": "Datetime"
      }
    },
    {
      "name": "deviceid",
      "prompt": "ID of the device that contains the file",
      "default_filter": false,
      "value": {
        "datatype": "Integer"
      }
    },
    {
      "name": "blocksize",
      "prompt": "Size of file blocks in bytes",
      "value": {
        "datatype": "Long"
      }
    },
    {
      "name": "type",
      "prompt": "Type of file object",
      "value": {
        "datatype": "String",
        "valid_values": [
          "file",
          "directory",
          "link",
          "character device",
          "block device",
          "pipe",
          "socket",
          "unknown"
        ]
      }
    }
  ],
  "gpfs": [
    {
      "name": "poolname",
      "prompt": "Name of the pool the file belongs to",
      "value": {
        "datatype": "String"
      }
    },
    {
      "name": "filesetname",
      "prompt": "Name of the fileset the file belongs to",
      "value": {
        "datatype": "String"
      }
    },
    {
      "name": "miscattributes",
      "prompt": "File miscellaneous attributes",
      "value": {
        "datatype": "String"
      }
    },
    {
      "name": "generation",
      "prompt": "Inode generation number",
      "default_filter": false,
      "value": {
        "datatype": "Long"
      }
    },
    {
      "name": "creationtime",
      "prompt": "Time when the file was created",
      "value": {
        "datatype": "Datetime"
      }
    },
    {
      "name": "modificationsnapid",
      "prompt": "Id of last snapshot after which the file was modified",
      "value": {
        "datatype": "Long"
      }
    },
    {
      "name": "kballocated",
      "prompt": "Space allocated to the file in kb",
      "value": {
        "datatype": "Long"
      }
    },
    {
      "name": "rdeviceid",
      "prompt": "Type of the device the file belongs to",
      "default_filter": false,
      "value": {
        "datatype": "Integer"
      }
    }
  ]
}