REST API for Unified Assurance Core

Update a Query

put

/api/database/Queries/{id}

Updates the properties of the query that matches the specified ID.

Request

Path Parameters

id(required): integer(int32)
The query ID.
Example:
```
1
```

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

Description: string

The description of the query.

Example: Devices in catalog with a blank DNS name
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
QueryName: string

The query name.
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: Devices Missing DNS
QueryShardID: integer

The shard ID. The default is 1.

Example: 1
Tokens: array Tokens

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

The list of user groups that can view.

{
    "type":"object",
    "properties":{
        "QueryName":{
            "description":"The query name.\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":"Devices Missing DNS"
        },
        "Description":{
            "$ref":"#/components/schemas/databaseQueriesRead/properties/Description"
        },
        "QueryDBName":{
            "$ref":"#/components/schemas/databaseQueriesRead/properties/QueryDBName"
        },
        "QueryShardID":{
            "$ref":"#/components/schemas/databaseQueriesRead/properties/QueryShardID"
        },
        "Query":{
            "$ref":"#/components/schemas/databaseQueriesRead/properties/Query"
        },
        "OwnerUserID":{
            "$ref":"#/components/schemas/databaseQueriesRead/properties/OwnerUserID"
        },
        "OwnerUserGroupID":{
            "$ref":"#/components/schemas/databaseQueriesRead/properties/OwnerUserGroupID"
        },
        "Viewers":{
            "$ref":"#/components/schemas/databaseQueriesRead/properties/Viewers"
        },
        "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":"The token name to replace.",
                        "type":"string",
                        "example":"DeviceName"
                    },
                    "DefaultValue":{
                        "description":"The value to replace the token with if no value is provided.",
                        "type":"string",
                        "example":"pg-someone.example.com"
                    },
                    "id":{
                        "description":"The unique ID of the token in the tokens array. The value is not important, but it must be unique.",
                        "type":"string",
                        "example":"Database.queries.crud.model.TokenModel-1"
                    }
                }
            }
        }
    }
}

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":"The token name to replace.",
                "type":"string",
                "example":"DeviceName"
            },
            "DefaultValue":{
                "description":"The value to replace the token with if no value is provided.",
                "type":"string",
                "example":"pg-someone.example.com"
            },
            "id":{
                "description":"The unique ID of the token in the tokens array. The value is not important, but it must be unique.",
                "type":"string",
                "example":"Database.queries.crud.model.TokenModel-1"
            }
        }
    }
}

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
id: string

The unique ID of the token in the tokens array. The value is not important, but it must be unique.

Example: Database.queries.crud.model.TokenModel-1
TokenName: string

The token name to replace.

Example: DeviceName

{
    "type":"object",
    "properties":{
        "TokenName":{
            "description":"The token name to replace.",
            "type":"string",
            "example":"DeviceName"
        },
        "DefaultValue":{
            "description":"The value to replace the token with if no value is provided.",
            "type":"string",
            "example":"pg-someone.example.com"
        },
        "id":{
            "description":"The unique ID of the token in the tokens array. The value is not important, but it must be unique.",
            "type":"string",
            "example":"Database.queries.crud.model.TokenModel-1"
        }
    }
}

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"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulUpdateOperation

The response body for a successful update operation.
object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The properties of the updated query.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/databaseQueriesRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulUpdateOperation

Type: object

The response body for a successful update operation.

Show Source

message: string

The response message.

Example: Updated record
success: boolean

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

Example: true

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

Nested Schema : type

Type: object

Show Source

data: array data

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

Nested Schema : data

Type: array

The properties of the updated query.

Show Source

Array of: object databaseQueriesRead

{
    "description":"The properties of the updated query.",
    "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.