Jump to

• Request
• Response

Get a Query by ID

get

/api/database/Queries/{id}

Gets the query that matches the specified ID.

Request

Path Parameters

• id(required): integer(int32)
  The query ID.

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
• 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 query properties.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/databaseQueriesRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

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

{
    "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 query properties.
• 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 query properties.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/databaseQueriesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The query properties.

Show Source

• Array of: object databaseQueriesRead

{
    "description":"The query properties.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/databaseQueriesRead"
    }
}

Nested Schema : databaseQueriesRead

Type: object

Show Source

• Description: string
  Description, human label of query

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

  Example: [Public to All Users and Groups]
• OwnerUserGroupID: integer
  Chosen user group owner

  Example: 0
• OwnerUserID: integer
  Chosen user owner

  Example: 0
• Query: string
  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
  Database Schema

  Example: Assure1
• QueryID: integer
  Query ID specified for individual CRUD operations

  Example: 1000
• QueryName: string
  Query Name

  Example: Devices Missing DNS
• QueryShardID: integer
  Shard ID, optional defaults to 1

  Example: 1
• Tokens: array Tokens
  Optional array of tokens, or placeholders, to be dynamically replaced when the query is used.
• Viewers: array Viewers
  List of user groups that can view

{
    "type":"object",
    "properties":{
        "Description":{
            "description":"Description, human label of query",
            "type":"string",
            "example":"Devices in catalog with a blank DNS name"
        },
        "QueryID":{
            "description":"Query ID specified for individual CRUD operations",
            "type":"integer",
            "example":"1000"
        },
        "QueryName":{
            "description":"Query Name",
            "type":"string",
            "example":"Devices Missing DNS"
        },
        "QueryDBName":{
            "description":"Database Schema",
            "type":"string",
            "example":"Assure1"
        },
        "QueryShardID":{
            "description":"Shard ID, optional defaults to 1",
            "type":"integer",
            "example":"1"
        },
        "Query":{
            "description":"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":"Chosen user owner",
            "type":"integer",
            "example":"0"
        },
        "OwnerUserGroupID":{
            "description":"Chosen user group owner",
            "type":"integer",
            "example":"0"
        },
        "Owner":{
            "description":"Owner",
            "type":"string",
            "example":"[Public to All Users and Groups]"
        },
        "Viewers":{
            "description":"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":"Optional array of tokens, or placeholders, to be dynamically replaced when the query is used.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "TokenName":{
                        "description":"Token name to be replaced.",
                        "type":"string",
                        "example":"DeviceName"
                    },
                    "TokenIndex":{
                        "description":"ID of the token in the Tokens array.",
                        "type":"integer",
                        "example":"1"
                    },
                    "DefaultValue":{
                        "description":"Value to replace the token with if no value is provided.",
                        "type":"string",
                        "example":"pg-someone.example.com"
                    }
                }
            }
        }
    }
}

Nested Schema : Tokens

Type: array

Optional array of tokens, or placeholders, to be dynamically replaced when the query is used.

Show Source

• Array of: object items

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

Nested Schema : Viewers

Type: array

List of user groups that can view

Show Source

• Array of: object items

{
    "description":"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
  Value to replace the token with if no value is provided.

  Example: pg-someone.example.com
• TokenIndex: integer
  ID of the token in the Tokens array.

  Example: 1
• TokenName: string
  Token name to be replaced.

  Example: DeviceName

{
    "type":"object",
    "properties":{
        "TokenName":{
            "description":"Token name to be replaced.",
            "type":"string",
            "example":"DeviceName"
        },
        "TokenIndex":{
            "description":"ID of the token in the Tokens array.",
            "type":"integer",
            "example":"1"
        },
        "DefaultValue":{
            "description":"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

Body ()

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

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top