REST API for Unified Assurance Core

Get Dashboard Part Configurations

get

/api/dashboard/Dashboards/readParts

Gets dashboard part configurations. Parts is the internal name for the dashboard panel types.

Request

Query Parameters

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
```
query: string
A string to search for. This is a primitive filter, generally applied as a filter on a name parameter, but each endpoint implements it differently.
Example:
```
text
```

The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format: { "property": "property", "direction": "direction" }

direction(required): string

Allowed Values: [ "ASC", "DESC" ]

The direction of the sort.

Example: ASC
property(required): string

The field to sort on.

Example: name

{
    "required":[
        "property",
        "direction"
    ],
    "properties":{
        "property":{
            "description":"The field to sort on.",
            "type":"string",
            "example":"name"
        },
        "direction":{
            "description":"The direction of the sort.",
            "type":"string",
            "enum":[
                "ASC",
                "DESC"
            ],
            "example":"ASC"
        }
    },
    "type":"object",
    "example":[
        {
            "property":"Name",
            "direction":"ASC"
        },
        {
            "property":"Value",
            "direction":"DESC"
        }
    ]
}

Example:

[
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]

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":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The list of dashboard part configurations.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/dashboardDashboardsReadParts"
                    }
                }
            }
        }
    ]
}

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 list of dashboard part configurations.
total: integer

The total number of results regardless of paging.

Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "description":"The list of dashboard part configurations.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/dashboardDashboardsReadParts"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of dashboard part configurations.

Show Source

Array of: object dashboardDashboardsReadParts

{
    "description":"The list of dashboard part configurations.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/dashboardDashboardsReadParts"
    }
}

Nested Schema : dashboardDashboardsReadParts

Type: object

Show Source

PanelTypeID: integer

The panel Type ID.

Example: 17
PanelTypeName: string

The panel type name.

Example: View Config
PartDefinition: string

The configuration definition that the dashboard needs in order to render the part.

Example: {17: {viewTemplate: {title: "View Config",form: "Config.viewConfigs.crud.view.ConfigsPanelForm",iconCls: "fa-eye",dockedItems: [],items: [{xtype: "configspanelview"}]}}}
pkg: string

The Unified Assurance package that the part belongs to.

Example: config

{
    "type":"object",
    "properties":{
        "PanelTypeID":{
            "description":"The panel Type ID.",
            "type":"integer",
            "example":"17"
        },
        "PanelTypeName":{
            "description":"The panel type name.",
            "type":"string",
            "example":"View Config"
        },
        "pkg":{
            "description":"The Unified Assurance package that the part belongs to.",
            "type":"string",
            "example":"config"
        },
        "PartDefinition":{
            "description":"The configuration definition that the dashboard needs in order to render the part.",
            "type":"string",
            "example":"{17: {viewTemplate: {title: \"View Config\",form: \"Config.viewConfigs.crud.view.ConfigsPanelForm\",iconCls: \"fa-eye\",dockedItems: [],items: [{xtype: \"configspanelview\"}]}}}"
        }
    }
}

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.