REST API for Unified Assurance Core

Get Queries

get

/api/database/Queries

Gets the queries that match the specified parameters. If no parameters are specified, all queries 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 queries that match the specified parameters.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/databaseQueriesRead"
                    }
                }
            }
        }
    ]
}

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

Nested Schema : data

Type: array

The list of queries that match the specified parameters.

Show Source

Array of: object databaseQueriesRead

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

Nested Schema : databaseQueriesRead

Type: object

Show Source

Description: string

The description of the query.

Example: Devices in catalog with a blank DNS name
Owner: string

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

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

The owner's user group ID.

Example: 0
OwnerUserID: integer

The owner's user ID.

Example: 0
Query: string

The query SQL.

Example: -- Blank DNS -- SELECT D.DeviceID AS 'ID', D.CustomName AS 'Device Name', INET_NTOA(D.IPAddress) AS 'IP Address', FROM_UNIXTIME(D.TimestampAdded) AS 'First Found', FROM_UNIXTIME(D.TimestampLastFound) AS 'Last Found', FROM_UNIXTIME(D.TimestampModified) AS 'Last Modified', DTC.DeviceTypeCategoryName AS 'Category', DZ.DeviceZoneName AS 'Zone' FROM Devices AS D, DeviceTypeCategories AS DTC, DeviceZones AS DZ WHERE D.DeviceTypeCategoryID = DTC.DeviceTypeCategoryID AND D.DeviceZoneID = DZ.DeviceZoneID AND D.DNSName = '' ORDER BY D.CustomName ASC
QueryDBName: string

The database schema.

Example: Assure1
QueryID: integer

The query ID for individual CRUD operations.

Example: 1000
QueryName: string

The query name.

Example: Devices Missing DNS
QueryShardID: integer

The shard ID. The default is 1.

Example: 1
Tokens: array Tokens

The optional array of tokens or placeholders to dynamically replace when the query is run.
Viewers: array Viewers

The list of user groups that can view.

{
    "type":"object",
    "properties":{
        "Description":{
            "description":"The description of the query.",
            "type":"string",
            "example":"Devices in catalog with a blank DNS name"
        },
        "QueryID":{
            "description":"The query ID for individual CRUD operations.",
            "type":"integer",
            "example":"1000"
        },
        "QueryName":{
            "description":"The query name.",
            "type":"string",
            "example":"Devices Missing DNS"
        },
        "QueryDBName":{
            "description":"The database schema.",
            "type":"string",
            "example":"Assure1"
        },
        "QueryShardID":{
            "description":"The shard ID. The default is <b>1</b>.",
            "type":"integer",
            "example":"1"
        },
        "Query":{
            "description":"The query SQL.",
            "type":"string",
            "example":"-- Blank DNS --\n SELECT D.DeviceID                          AS 'ID',\n        D.CustomName                        AS 'Device Name',\n        INET_NTOA(D.IPAddress)              AS 'IP Address',\n        FROM_UNIXTIME(D.TimestampAdded)     AS 'First Found',\n        FROM_UNIXTIME(D.TimestampLastFound) AS 'Last Found',\n        FROM_UNIXTIME(D.TimestampModified)  AS 'Last Modified',\n        DTC.DeviceTypeCategoryName          AS 'Category',\n        DZ.DeviceZoneName                   AS 'Zone'\n   FROM Devices              AS D,\n        DeviceTypeCategories AS DTC,\n        DeviceZones          AS DZ\n  WHERE D.DeviceTypeCategoryID = DTC.DeviceTypeCategoryID\n    AND D.DeviceZoneID         = DZ.DeviceZoneID\n    AND D.DNSName              = ''\n ORDER BY D.CustomName ASC"
        },
        "OwnerUserID":{
            "description":"The owner's user ID.",
            "type":"integer",
            "example":"0"
        },
        "OwnerUserGroupID":{
            "description":"The owner's user group ID.",
            "type":"integer",
            "example":"0"
        },
        "Owner":{
            "description":"The ID of the user that owns the query. This can never be an externally-authenticated transient user. <b>0</b> means it is public to all users in the owning group.",
            "type":"string",
            "example":"[Public to All Users and Groups]"
        },
        "Viewers":{
            "description":"The list of user groups that can view.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "UserGroupID":{
                        "description":"The user group ID.",
                        "type":"integer"
                    },
                    "UserGroupName":{
                        "description":"The user group name.",
                        "type":"string"
                    }
                }
            },
            "example":[
            ]
        },
        "Tokens":{
            "description":"The optional array of tokens or placeholders to dynamically replace when the query is run.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "TokenName":{
                        "description":"The token name to replace.",
                        "type":"string",
                        "example":"DeviceName"
                    },
                    "TokenIndex":{
                        "description":"The ID of the token in the tokens array.",
                        "type":"integer",
                        "example":"1"
                    },
                    "DefaultValue":{
                        "description":"The value to replace the token with if no value is provided.",
                        "type":"string",
                        "example":"pg-someone.example.com"
                    }
                }
            }
        }
    }
}

Nested Schema : Tokens

Type: array

The optional array of tokens or placeholders to dynamically replace when the query is run.

Show Source

Array of: object items

{
    "description":"The optional array of tokens or placeholders to dynamically replace when the query is run.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "TokenName":{
                "description":"The token name to replace.",
                "type":"string",
                "example":"DeviceName"
            },
            "TokenIndex":{
                "description":"The ID of the token in the tokens array.",
                "type":"integer",
                "example":"1"
            },
            "DefaultValue":{
                "description":"The value to replace the token with if no value is provided.",
                "type":"string",
                "example":"pg-someone.example.com"
            }
        }
    }
}

Nested Schema : Viewers

Type: array

The list of user groups that can view.

Show Source

Array of: object items

{
    "description":"The list of user groups that can view.",
    "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

DefaultValue: string

The value to replace the token with if no value is provided.

Example: pg-someone.example.com
TokenIndex: integer

The ID of the token in the tokens array.

Example: 1
TokenName: string

The token name to replace.

Example: DeviceName

{
    "type":"object",
    "properties":{
        "TokenName":{
            "description":"The token name to replace.",
            "type":"string",
            "example":"DeviceName"
        },
        "TokenIndex":{
            "description":"The ID of the token in the tokens array.",
            "type":"integer",
            "example":"1"
        },
        "DefaultValue":{
            "description":"The value to replace the token with if no value is provided.",
            "type":"string",
            "example":"pg-someone.example.com"
        }
    }
}

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.