REST API for Unified Assurance Core

Return a File Based on ID or File Name

get

/api/file/Files/readContent

Returns the file content based on the file ID or the file name.

Request

Query Parameters

FileName(required): string
The file name used for fetching the content.
Example:
```
Test.pdf
```
id: integer
The file ID used for fetching the content.
Example:
```
1021
```

There's no request body for this operation.

Response

Supported Media Types

application/pdf

200 Response

Successful operation

Root Schema : schema

Type: string(binary)

404 Response

File not found.

Default Response

Failed operation

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