REST API for Unified Assurance Core

Create a Dashboard Group

post

/api/dashboard/DashboardGroups

Creates a new dashboard group.
The minimum required properties in the request body are:

DashboardGroupName
Dashboards

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

DashboardGroupName: string

The name of the dashboard group.
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

Example: Adhoc Dashboards
Dashboards: array Dashboards

The list of dashboard IDs.
ParentDashboardGroupID: integer

The parent dashboard group ID.

Example: 1
Remove: boolean

Whether to remove the dashboard from other dashboard groups (1) or not (0).

Example: 1

{
    "type":"object",
    "properties":{
        "DashboardGroupName":{
            "description":"The name of the dashboard group.\n<br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"Adhoc Dashboards"
        },
        "ParentDashboardGroupID":{
            "$ref":"#/components/schemas/dashboardDashboardGroupsReadByID/properties/ParentDashboardGroupID"
        },
        "Dashboards":{
            "description":"The list of dashboard IDs.",
            "type":"array",
            "items":{
                "type":"integer"
            },
            "example":[
                27,
                28,
                39,
                29
            ]
        },
        "Remove":{
            "description":"Whether to remove the dashboard from other dashboard groups (<b>1</b>) or not (<b>0</b>).",
            "type":"boolean",
            "example":1
        }
    }
}

Nested Schema : Dashboards

Type: array

The list of dashboard IDs.

Show Source

Array of: integer

{
    "description":"The list of dashboard IDs.",
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
        27,
        28,
        39,
        29
    ]
}

Example:

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulAddOperation

The response body for a successful add operation.
object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The properties of the new dashboard group.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/dashboardDashboardGroupsReadByID"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

Show Source

message: string

The response message.

Example: Added record
success: boolean

Whether the operation was a success (true) or a failure (false).

Example: true

{
    "description":"The response body for a successful add 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":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

data: array data

The properties of the new dashboard group.
total: integer

The total number of results regardless of paging.

Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the new dashboard group.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/dashboardDashboardGroupsReadByID"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

The properties of the new dashboard group.

Show Source

Array of: object dashboardDashboardGroupsReadByID

{
    "description":"The properties of the new dashboard group.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/dashboardDashboardGroupsReadByID"
    }
}

Nested Schema : dashboardDashboardGroupsReadByID

Type: object

Show Source

DashboardGroupID: integer

The dashboard group ID.

Example: 1
DashboardGroupName: string

The dashboard group name.

Example: Adhoc
Dashboards: array Dashboards

The list of dashboard IDs.
ParentDashboardGroupID: integer

The parent dashboard group ID.

Example: 1

{
    "type":"object",
    "properties":{
        "DashboardGroupID":{
            "description":"The dashboard group ID.",
            "type":"integer",
            "example":"1"
        },
        "DashboardGroupName":{
            "description":"The dashboard group name.",
            "type":"string",
            "example":"Adhoc"
        },
        "ParentDashboardGroupID":{
            "description":"The parent dashboard group ID.",
            "type":"integer",
            "example":"1"
        },
        "Dashboards":{
            "description":"The list of dashboard IDs.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "DashboardID":{
                        "description":"The dashboard ID.",
                        "type":"integer"
                    },
                    "DashboardName":{
                        "description":"The dashboard name.",
                        "type":"string"
                    }
                }
            },
            "example":[
                {
                    "DashboardID":"27",
                    "DashboardName":"Adhoc Metric Dashboard"
                },
                {
                    "DashboardID":"28",
                    "DashboardName":"Adhoc Event Dashboard"
                },
                {
                    "DashboardID":"39",
                    "DashboardName":"Adhoc View Config Dashboard"
                },
                {
                    "DashboardID":"29",
                    "DashboardName":"Adhoc Graph Dashboard"
                }
            ]
        }
    }
}

Nested Schema : Dashboards

Type: array

The list of dashboard IDs.

Show Source

Array of: object items

{
    "description":"The list of dashboard IDs.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "DashboardID":{
                "description":"The dashboard ID.",
                "type":"integer"
            },
            "DashboardName":{
                "description":"The dashboard name.",
                "type":"string"
            }
        }
    },
    "example":[
        {
            "DashboardID":"27",
            "DashboardName":"Adhoc Metric Dashboard"
        },
        {
            "DashboardID":"28",
            "DashboardName":"Adhoc Event Dashboard"
        },
        {
            "DashboardID":"39",
            "DashboardName":"Adhoc View Config Dashboard"
        },
        {
            "DashboardID":"29",
            "DashboardName":"Adhoc Graph Dashboard"
        }
    ]
}

Example:

[
    {
        "DashboardID":"27",
        "DashboardName":"Adhoc Metric Dashboard"
    },
    {
        "DashboardID":"28",
        "DashboardName":"Adhoc Event Dashboard"
    },
    {
        "DashboardID":"39",
        "DashboardName":"Adhoc View Config Dashboard"
    },
    {
        "DashboardID":"29",
        "DashboardName":"Adhoc Graph Dashboard"
    }
]

Nested Schema : items

Type: object

Show Source

DashboardID: integer

The dashboard ID.
DashboardName: string

The dashboard name.

{
    "type":"object",
    "properties":{
        "DashboardID":{
            "description":"The dashboard ID.",
            "type":"integer"
        },
        "DashboardName":{
            "description":"The dashboard 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.