Get resource metadata

v1.0.0

Returns metadata for specified file/folder path, including upload date, size and type. For the full list of returned properties, see the response syntax, below.

Notes:

Authenticated user should have list permission.

Input

{
  "type": "object",
  "properties": {
    "ev-access-token": {
      "type": "string"
    },
    "ev-api-key": {
      "type": "string"
    },
    "include": {
      "type": "string"
    }
  },
  "required": [
    "ev-access-token",
    "ev-api-key"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Response object for resources.",
  "properties": {
    "data": {
      "type": "object",
      "description": "All properties of the resource.",
      "properties": {
        "attributes": {
          "type": "object",
          "description": "Attributes of resource",
          "properties": {
            "accessedAt": {
              "type": "string",
              "format": "date-time",
              "description": "Date-time of the time when resource was accessed."
            },
            "accessedTime": {
              "type": "integer",
              "format": "int32",
              "description": "UNIX timestamp of last access"
            },
            "createdAt": {
              "type": "string",
              "format": "date-time",
              "description": "Date-time of resource creation."
            },
            "createdBy": {
              "type": "string",
              "description": "Username of the creator."
            },
            "createdTime": {
              "type": "integer",
              "format": "int32",
              "description": "UNIX timestamp of resource creation"
            },
            "extension": {
              "type": "string",
              "description": "Resource extension. Property exists only if resource `type` is file."
            },
            "fileCount": {
              "type": "integer",
              "description": "Number of files within folder. null if resource type is a file."
            },
            "hash": {
              "type": "string",
              "description": "Unique hash of the resource."
            },
            "name": {
              "type": "string",
              "description": "Resource name, e.g. the name of the file or folder."
            },
            "path": {
              "type": "string",
              "description": "Full path to the resource."
            },
            "previewable": {
              "type": "boolean",
              "description": "Can resource be previewed. Property equals `null` if resource `type` is dir.",
              "enum": [
                true,
                false
              ]
            },
            "size": {
              "type": "integer",
              "format": "int64",
              "description": "Resource size in bytes"
            },
            "type": {
              "type": "string",
              "description": "Type of the resource.",
              "enum": [
                "file",
                "dir"
              ]
            },
            "updatedAt": {
              "type": "string",
              "format": "date-time",
              "description": "Date-time of resource modification."
            },
            "updatedTime": {
              "type": "integer",
              "format": "int32",
              "description": "UNIX timestamp of resource modification"
            },
            "uploadDate": {
              "type": "string",
              "format": "date-time",
              "description": "Timestamp of resource upload."
            }
          }
        },
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "relationships": {
          "type": "object",
          "properties": {
            "directFile": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "type": {
                      "type": "string"
                    }
                  }
                }
              }
            },
            "notifications": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "data": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "integer",
                        "format": "int32"
                      },
                      "type": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            },
            "parentResource": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "format": "int64"
                    },
                    "type": {
                      "type": "string"
                    }
                  }
                }
              }
            },
            "share": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "type": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "type": {
          "type": "string",
          "description": "Type of item. \"resource\"",
          "enum": [
            "resource"
          ]
        }
      }
    },
    "included": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "responseStatus": {
      "type": "integer",
      "description": "Http status code of the response. "
    }
  }
}