REST API for Unified Assurance Core

Get Logs for a Device

get

/api/config/ViewConfigs/readView

Gets the logs for the device specified by either the configuration collection name or the configuration collection ID.

Request

Query Parameters

ConfigCollectionID: integer
The configuration collection ID. Provide either ConfigCollectionName or ConfigCollectionID, but not both.
Example:
```
1001
```
ConfigCollectionName: string
The configuration collection name. Provide either ConfigCollectionName or ConfigCollectionID, but not both.
Example:
```
SSH Actions
```
limit: integer(int32)
The number of records to limit results by. If you do not also set the start parameter, records start at 0.
Example:
```
100
```
start: integer(int32)
The page of results to start from. This parameter is ignored if you do not also set the limit parameter.

Default Value: 0
Example:
```
1
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

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":{
                    "description":"The logs for the specified device.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/configViewConfigsReadView"
                    }
                },
                "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

The logs for the specified device.
total: integer

The total number of results regardless of paging.

Example: 1

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

Nested Schema : data

Type: array

The logs for the specified device.

Show Source

Array of: object configViewConfigsReadView

{
    "description":"The logs for the specified device.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/configViewConfigsReadView"
    }
}

Nested Schema : configViewConfigsReadView

Type: object

Show Source

CommitDate: string

The commit date.

Example: 2023-03-15 10:59:09
Message: string

The message showing details like configuration changes.

Example: Config Mgr Commit
Revision: integer

The revision ID.

Example: 2340
Username: string

The username.

Example: admin

{
    "properties":{
        "Revision":{
            "description":"The revision ID.",
            "type":"integer",
            "example":"2340"
        },
        "CommitDate":{
            "description":"The commit date.",
            "type":"string",
            "example":"2023-03-15 10:59:09"
        },
        "Username":{
            "description":"The username.",
            "type":"string",
            "example":"admin"
        },
        "Message":{
            "description":"The message showing details like configuration changes.",
            "type":"string",
            "example":"Config Mgr Commit"
        }
    }
}

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