Jump to

• Request
• Response

Update a File

put

/api/file/Files/{id}

Updates the file in Unified Assurance file storage that matches the specified ID.

Request

Path Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root 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
  Unique identifier for the file type. Allowed Values: - 1 => Other - 2 => Image - 3 => Report - 4 => Sound

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

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

  Example: 1
• OwnerUserID: integer
  The user owner of the file.

  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":{
            "$ref":"#/components/schemas/fileFilesRead/properties/FileTypeID"
        },
        "MimeType":{
            "$ref":"#/components/schemas/fileFilesRead/properties/MimeType"
        },
        "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 SuccessfulUpdateOperation
• object type

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

Nested Schema : SuccessfulUpdateOperation

Type: object

Show Source

• message: string
  The response message.

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

  Example: true

{
    "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":"Updated record"
        }
    },
    "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/fileFileTypesRead"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object fileFileTypesRead

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

Nested Schema : fileFileTypesRead

Type: object

Show Source

• FileTypeID: integer
  File Type ID specified for individual CRUD operations

  Example: 2
• FileTypeName: string
  File Type Name

  Example: Image

{
    "type":"object",
    "properties":{
        "FileTypeID":{
            "description":"File Type ID specified for individual CRUD operations",
            "type":"integer",
            "example":"2"
        },
        "FileTypeName":{
            "description":"File Type Name",
            "type":"string",
            "example":"Image"
        }
    }
}

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":{
                "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

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

Nested Schema : items

Type: object

Back to Top