Jump to

• Request
• Response

Download a File

get

/api/file/Files/executeDownload/{id}

Downloads the file.

Request

Path Parameters

• id(required): integer
  The file ID used to download the file.

Query Parameters

• FileName: string
  The file name used for downloading the file instead of ID.

  Example:

  Test.pdf

• MimeType: string
  Mime Type

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/pdf

200 Response

Successful operation

Body ()

Root Schema : schema

Type: string(binary)

404 Response

File not found.

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