Jump to

• Request
• Response

Get a File by ID

get

/api/file/Files/{id}

Gets the file that matches the specified ID.

Request

Path Parameters

• id(required): integer(int32)
  The file ID specified for individual CRUD operations.

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/fileFilesRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/fileFilesRead"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object fileFilesRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/fileFilesRead"
    }
}

Nested Schema : fileFilesRead

Type: object

Show Source

• Expired: integer
  If file is expired or not. If the value is 1, then the file expiration time has exceeded.

  Example: 0
• ExpireTime: string
  Allowed Values: [ "Never", "2023-02-28 05:02:00" ]

  Expire time of file. Can be used to create a cleanup policy of expired files.

  Example: Never
• ExpireTimeFormatted: string
  Allowed Values: [ "Never", "28 Feb 2023 05:02:00" ]

  Expire Time after formatting

  Example: Never
• FileExtension: string
  Type of extension for the file.

  Example: png
• FileID: integer
  Unique identifier for the file.

  Example: 1000
• FileName: string
  Name of the uploaded file, determined from Content-Disposition filename.

  Example: AccessPoint.png
• FileType: string
  The type of the file.

  Example: Image
• FileTypeID: integer
  The ID of the file type. The following default integer values are mapped to a string in the FileType property:

  • 1: Other
  • 2: Image
  • 3: Report
  • 4: Sound

  Any additional custom file types are mapped to values 1000 and up.
  This may, but does not have to, match the type indicated by the file's extension.

  Example: 2
• MimeType: string
  The MIME type of the file.

  Example: image/png
• Owner: string
  Owner for the file.

  Example: Group: Administrators
• OwnerUserGroupID: integer
  The user group owner of the file.

  Example: 1
• OwnerUserID: integer
  The ID of the user that owns the file. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.

  Example: 0
• Viewers: array Viewers
  Selection of user groups that have read-only access to file.

{
    "type":"object",
    "properties":{
        "MimeType":{
            "description":"The MIME type of the file.",
            "type":"string",
            "example":"image/png"
        },
        "FileID":{
            "description":"Unique identifier for the file.",
            "type":"integer",
            "example":"1000"
        },
        "FileName":{
            "description":"Name of the uploaded file, determined from Content-Disposition filename.",
            "type":"string",
            "example":"AccessPoint.png"
        },
        "OwnerUserID":{
            "description":"The ID of the user that owns the file. This can never be an externally-authenticated transient user. <b>0</b> means it is public to all users in the owning group.",
            "type":"integer",
            "example":"0"
        },
        "OwnerUserGroupID":{
            "description":"The user group owner of the file.",
            "type":"integer",
            "example":"1"
        },
        "FileTypeID":{
            "description":"The ID of the file type. The following default integer values are mapped to a string in the <b>FileType</b> property: \n<ul>\n<li><b>1</b>: Other</li>\n<li><b>2</b>: Image</li>\n<li><b>3</b>: Report</li>\n<li><b>4</b>: Sound</li>\n</ul>\nAny additional custom file types are mapped to values 1000 and up.<br>This may, but does not have to, match the type indicated by the file's extension.",
            "type":"integer",
            "example":"2"
        },
        "FileType":{
            "description":"The type of the file.",
            "type":"string",
            "example":"Image"
        },
        "ExpireTime":{
            "description":"Expire time of file. Can be used to create a cleanup policy of expired files.",
            "type":"string",
            "example":"Never",
            "enum":[
                "Never",
                "2023-02-28 05:02:00"
            ]
        },
        "ExpireTimeFormatted":{
            "description":"Expire Time after formatting",
            "type":"string",
            "example":"Never",
            "enum":[
                "Never",
                "28 Feb 2023 05:02:00"
            ]
        },
        "Expired":{
            "description":"If file is expired or not. If the value is 1, then the file expiration time has exceeded.",
            "type":"integer",
            "example":"0"
        },
        "Owner":{
            "description":"Owner for the file.",
            "type":"string",
            "example":"Group: Administrators"
        },
        "Viewers":{
            "description":"Selection of user groups that have read-only access to file.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "UserGroupID":{
                        "description":"User Group ID",
                        "type":"integer"
                    },
                    "UserGroupName":{
                        "description":"User Group Name",
                        "type":"string"
                    }
                }
            },
            "example":[
                {
                    "UserGroupID":"0",
                    "UserGroupName":"[Public to All Groups]"
                }
            ]
        },
        "FileExtension":{
            "description":"Type of extension for the file.",
            "type":"string",
            "example":"png"
        }
    }
}

Nested Schema : Viewers

Type: array

Selection of user groups that have read-only access to file.

Show Source

• Array of: object items

{
    "description":"Selection of user groups that have read-only access to file.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "UserGroupID":{
                "description":"User Group ID",
                "type":"integer"
            },
            "UserGroupName":{
                "description":"User Group Name",
                "type":"string"
            }
        }
    },
    "example":[
        {
            "UserGroupID":"0",
            "UserGroupName":"[Public to All Groups]"
        }
    ]
}

Example:

[
    {
        "UserGroupID":"0",
        "UserGroupName":"[Public to All Groups]"
    }
]

Nested Schema : items

Type: object

Show Source

• UserGroupID: integer
  User Group ID
• UserGroupName: string
  User Group Name

{
    "type":"object",
    "properties":{
        "UserGroupID":{
            "description":"User Group ID",
            "type":"integer"
        },
        "UserGroupName":{
            "description":"User Group Name",
            "type":"string"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top