REST API for Unified Assurance Core

Get Dashboards

get

/api/dashboard/Dashboards

Gets the dashboards that match the specified parameters. If no parameters are specified, all dashboards are returned.

Request

Query Parameters

The fields to filter the results by. You cannot filter by fields that contain a state.
This parameter's value uses the following JSON format:
{ "property": "property", "value": "propertyValue", "operator": "operator", "conjunction": "conjunction" }
If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.

conjunction: string

Default Value: OR

Allowed Values: [ "AND", "OR" ]

The conjunction between filters.

Example: AND
operator: string

Default Value: LIKE

Allowed Values: [ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]

The filter operation to use.

Example: eq
property(required): string

The name of the field to filter on.

Example: name
value(required): string

The value of the field to filter on.

Example: test

{
    "required":[
        "property",
        "value"
    ],
    "properties":{
        "property":{
            "description":"The name of the field to filter on.",
            "type":"string",
            "example":"name"
        },
        "value":{
            "description":"The value of the field to filter on.",
            "type":"string",
            "example":"test"
        },
        "operator":{
            "description":"The filter operation to use.",
            "type":"string",
            "default":"LIKE",
            "enum":[
                "eq",
                "ne",
                "gte",
                "gt",
                "lte",
                "lt",
                "LIKE",
                "NOT LIKE",
                "re",
                "not re",
                "NOT IN"
            ],
            "example":"eq"
        },
        "conjunction":{
            "description":"The conjunction between filters.",
            "type":"string",
            "default":"OR",
            "enum":[
                "AND",
                "OR"
            ],
            "example":"AND"
        }
    },
    "type":"object"
}

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
```

sort: object

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 dashboards that match the specified parameters.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/dashboardDashboardsRead"
                    }
                }
            }
        }
    ]
}

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 dashboards that match the specified parameters.
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 dashboards that match the specified parameters.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/dashboardDashboardsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of dashboards that match the specified parameters.

Show Source

Array of: object dashboardDashboardsRead

{
    "description":"The list of dashboards that match the specified parameters.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/dashboardDashboardsRead"
    }
}

Nested Schema : dashboardDashboardsRead

Type: object

Show Source

DashboardID: integer

The dashboard ID.

Example: 12
DashboardName: string

The dashboard name.

Example: Basic Services Dashboard
DashboardTypeID: integer

Dashboard Type ID

Example: 1
DashboardTypeName: string

The dashboard type name.

Example: Basic
HideHeader: integer

Whether the header should be shown when the dashboard is rendered (1) or not (0).

Example: 0
MaxColumns: integer

The maximum number of columns the dashboard will render before wrapping additional panels onto the next row.

Example: 4
Owner: string

The name of the owner.

Example: [Public to All Users and Groups]
OwnerUserGroupID: integer

The owner user group ID.

Example: 0
OwnerUserID: integer

The ID of the user that owns the dashboard. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.

Example: 0
PanelParams: string

A JSON string of parameters relating to the panel.

Example: [{"PartTypeID":"6","width":100,"DashboardName":"Basic Services Dashboard","InitialExpansion":"0","InitialExpansionDynamic":"1","InitialView":"Summary","InitialViewDynamic":"1","LinkTarget":"NewWindow","LinkTargetDynamic":"1","PanelName":"Test","PartTypeID":"6","RefreshRate":"","RootID":"root","RootIDDynamic":"1","ShowToolbar":"1","SummaryInitialExpansion":"all","SummaryInitialExpansionDynamic":"1","SummaryNodeSize":"Normal","SummaryNodeSizeDynamic":"1","SummaryTreeType":"LeftToRight","SummaryTreeTypeDynamic":"1","TimeRangeDynamic":"1","TimeRange":"now-24h..now..","Width":"1","recordID":"DashboardsDashboard","width":"1","AutoHeight":1}]
ReloadRate: integer

The number of seconds between automatically refreshing the content of panels on the dashboard. Use null to prevent the dashboard from auto refreshing.

Example: oracle.doceng.json.BetterJsonNull@740fefc6
Viewers: array Viewers

The list of user groups that can view the dashboard.

{
    "type":"object",
    "properties":{
        "DashboardTypeID":{
            "description":"Dashboard Type ID",
            "type":"integer",
            "example":"1"
        },
        "PanelParams":{
            "description":"A JSON string of parameters relating to the panel.",
            "type":"string",
            "example":"[{\"PartTypeID\":\"6\",\"width\":100,\"DashboardName\":\"Basic Services Dashboard\",\"InitialExpansion\":\"0\",\"InitialExpansionDynamic\":\"1\",\"InitialView\":\"Summary\",\"InitialViewDynamic\":\"1\",\"LinkTarget\":\"NewWindow\",\"LinkTargetDynamic\":\"1\",\"PanelName\":\"Test\",\"PartTypeID\":\"6\",\"RefreshRate\":\"\",\"RootID\":\"root\",\"RootIDDynamic\":\"1\",\"ShowToolbar\":\"1\",\"SummaryInitialExpansion\":\"all\",\"SummaryInitialExpansionDynamic\":\"1\",\"SummaryNodeSize\":\"Normal\",\"SummaryNodeSizeDynamic\":\"1\",\"SummaryTreeType\":\"LeftToRight\",\"SummaryTreeTypeDynamic\":\"1\",\"TimeRangeDynamic\":\"1\",\"TimeRange\":\"now-24h..now..\",\"Width\":\"1\",\"recordID\":\"DashboardsDashboard\",\"width\":\"1\",\"AutoHeight\":1}]"
        },
        "HideHeader":{
            "description":"Whether the header should be shown when the dashboard is rendered (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "ReloadRate":{
            "description":"The number of seconds between automatically refreshing the content of panels on the dashboard. Use <b>null</b> to prevent the dashboard from auto refreshing.",
            "type":"integer",
            "nullable":true,
            "example":null
        },
        "MaxColumns":{
            "description":"The maximum number of columns the dashboard will render before wrapping additional panels onto the next row.",
            "type":"integer",
            "example":"4"
        },
        "DashboardID":{
            "description":"The dashboard ID.",
            "type":"integer",
            "example":"12"
        },
        "DashboardName":{
            "description":"The dashboard name.",
            "type":"string",
            "example":"Basic Services Dashboard"
        },
        "OwnerUserID":{
            "description":"The ID of the user that owns the dashboard. This can never be an externally-authenticated transient user. <b>0</b> means it is public to all users in the owning group.",
            "type":"integer",
            "example":"0"
        },
        "OwnerUserGroupID":{
            "description":"The owner user group ID.",
            "type":"integer",
            "example":"0"
        },
        "DashboardTypeName":{
            "description":"The dashboard type name.",
            "type":"string",
            "example":"Basic"
        },
        "Owner":{
            "description":"The name of the owner.",
            "type":"string",
            "example":"[Public to All Users and Groups]"
        },
        "Viewers":{
            "description":"The list of user groups that can view the dashboard.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "UserGroupID":{
                        "description":"The user group ID.",
                        "type":"integer"
                    },
                    "UserGroupName":{
                        "description":"The user group name.",
                        "type":"string"
                    }
                }
            },
            "example":[
            ]
        }
    }
}

Nested Schema : Viewers

Type: array

The list of user groups that can view the dashboard.

Show Source

Array of: object items

{
    "description":"The list of user groups that can view the dashboard.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "UserGroupID":{
                "description":"The user group ID.",
                "type":"integer"
            },
            "UserGroupName":{
                "description":"The user group name.",
                "type":"string"
            }
        }
    },
    "example":[
    ]
}

Nested Schema : items

Type: object

Show Source

UserGroupID: integer

The user group ID.
UserGroupName: string

The user group name.

{
    "type":"object",
    "properties":{
        "UserGroupID":{
            "description":"The user group ID.",
            "type":"integer"
        },
        "UserGroupName":{
            "description":"The user group name.",
            "type":"string"
        }
    }
}

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.