Jump to

• Request
• Response

Upload a File

post

/api/file/Files

Uploads a new file in the Unified Assurance file storage.
The minimum required properties in the request body are:

• FileTypeID
• ExpireTime
• OwnerUserID
• OwnerUserGroupID
• UploadFile

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• object schema

{
    "allOf":[
        {
            "$ref":"#/components/schemas/fileFiles"
        }
    ],
    "required":[
        "FileTypeID",
        "ExpireTime",
        "OwnerUserID",
        "OwnerUserGroupID",
        "UploadFile"
    ]
}

Nested Schema : schema

Type: object

Show Source

• 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. It should be of format "yyyy-mm-dd hh:mm:ss" or "Never".

  Example: Never
• FileTypeID: integer
  The ID of the file type. The following default integer values will be mapped to a string in the FileType property automatically:

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

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

  Example: 2
• MimeType: string
  The MIME type of the file. If you specify this parameter, it is used as specified, even if it does not match the type indicated by the file's extension. If you do not specify this property, it will be automatically detected based on the file's extension.

  Example: image/png
• 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
• UploadFile:
  Upload File contents. Filename is determined from Content-Disposition filename. Fake upload (add file already on server), by populating with $_FILES fields.
• Viewers: array Viewers
  Selection of user groups that have read-only access to file.

{
    "type":"object",
    "properties":{
        "FileTypeID":{
            "description":"The ID of the file type. The following default integer values will be mapped to a string in the <b>FileType</b> property automatically: \n<ul><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 should, but does not have to, match the type indicated by the file's extension.",
            "type":"integer",
            "example":"2"
        },
        "MimeType":{
            "description":"The MIME type of the file. If you specify this parameter, it is used as specified, even if it does not match the type indicated by the file's extension. If you do not specify this property, it will be automatically detected based on the file's extension.",
            "type":"string",
            "example":"image/png"
        },
        "ExpireTime":{
            "description":"Expire time of file. Can be used to create a cleanup policy of expired files. It should be of format \"yyyy-mm-dd hh:mm:ss\" or \"Never\".",
            "type":"string",
            "enum":[
                "Never",
                "2023-02-28 05:02:00"
            ],
            "example":"Never"
        },
        "OwnerUserID":{
            "$ref":"#/components/schemas/fileFilesRead/properties/OwnerUserID"
        },
        "OwnerUserGroupID":{
            "$ref":"#/components/schemas/fileFilesRead/properties/OwnerUserGroupID"
        },
        "UploadFile":{
            "description":"Upload File contents. Filename is determined from Content-Disposition filename. Fake upload (add file already on server), by populating with $_FILES fields."
        },
        "Viewers":{
            "$ref":"#/components/schemas/fileFilesRead/properties/Viewers"
        }
    }
}

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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
  The response body for a successful add operation.
• object type

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

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

Show Source

• message: string
  The response message.

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

  Example: true

{
    "description":"The response body for a successful add 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":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The properties of the new file.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the new file.",
            "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

The properties of the new file.

Show Source

• Array of: object fileFilesRead

{
    "description":"The properties of the new file.",
    "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