Response model for file request by ID (Retrieving file information by ID)

Methods

  • GET — Retrieving file information by ID

Resource

{
    "error": "string",
    "file": {
        "__createdAt": "date-time",
        "__createdBy": "string",
        "__id": "string",
        "__name": "string",
        "__updatedAt": "date-time",
        "__updatedBy": "string",
        "hash": "string",
        "version": "int32"
    },
    "success": "boolean"
}

Properties

Name Type Description Additional
error string

Error text if success == false

 Optional
file object

File model in response to request by ID

 Optional
file.__createdAt date-time

Date created

 Optional
file.__createdBy string

Creator ID

 Optional
file.__id string

Identifier

 Optional
file.__name string

File name in the system

 Optional
file.__updatedAt date-time

Last edited

 Optional
file.__updatedBy string

Editor ID

 Optional
file.hash string

File hash

 Optional
file.version int32

File version

 Optional
success boolean

Successful request flag

 Optional