Jump to

• Request
• Response

Get Databases

get

/api/database/Databases

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

Request

Query Parameters

• filter: object
  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.

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

• start: integer(int32)
  The page of results to start from.

  Default Value: 0

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

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

Nested Schema : data

Type: array

The list of databases that match the specified parameters.

Show Source

• Array of: object databaseDatabasesRead

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

Nested Schema : databaseDatabasesRead

Type: object

Show Source

• DatabaseID: integer
  Database ID specified for individual CRUD operations

  Example: 1002
• DatabaseName: string
  Database Display Name

  Example: Primary Graph Database on someone.example.com
• DBHost: string
  Database FQDN Host Name

  Example: someone.example.com
• DBName: string
  Database schema name e.g. Graph

  Example: Graph
• DBPort: integer
  Database Port (3306 is default)

  Example: 7687
• DBType: string
  DBType used in connection string (mysql is default) Allowed Values: - mysql => MySQL - Sybase => MS SQL Server/Sybase - Neo4j => Neo4j Graph Database - InfluxDB => InfluxDB Metric Database

  Example: Neo4j
• Description: string
  Description, human label of database

  Example: Graph database
• FailoverTypeID: integer
  Failover Type ID Allowed Values: - 1 => Primary - 2 => Backup/Redundant

  Example: 1
• IsAssure1Database:
  If the database name is Assure1, Event, Graph, Metric, or Vision, then it is an Assure1 database. 0 -> No 1 -> Yes

  Example: 1
• ShardID: integer
  Database Shard ID, Identification of database within the shard

  Example: 1
• State: string
  State

  Example: Loading...
• StateIcon: string
  State icon

  Example: barSpinner.gif
• Status: string
  Allowed Values: [ "Enabled", "Disabled" ]

  Status

  Example: Enabled
• StatusIcon: string
  Allowed Values: [ "OrbGreen.png", "OrbRed.png" ]

  Status Icon

  Example: OrbGreen.png
• StatusID: integer
  Status ID Allowed Values: - 0 => Disabled - 1 => Enabled

  Example: 1
• Timeout: integer
  Database connection timeout value in seconds (30 is default)

  Example: 30
• Username: string
  Database login user name

  Example:

{
    "type":"object",
    "properties":{
        "DatabaseID":{
            "description":"Database ID specified for individual CRUD operations",
            "type":"integer",
            "example":"1002"
        },
        "DatabaseName":{
            "description":"Database Display Name",
            "type":"string",
            "example":"Primary Graph Database on someone.example.com"
        },
        "FailoverTypeID":{
            "description":"Failover Type ID\n\nAllowed Values:\n-  1 => Primary\n-  2 => Backup/Redundant",
            "type":"integer",
            "example":"1"
        },
        "ShardID":{
            "description":"Database Shard ID, Identification of database within the shard",
            "type":"integer",
            "example":"1"
        },
        "DBType":{
            "description":"DBType used in connection string (mysql is default)\n\nAllowed Values:\n-  mysql  => MySQL\n-  Sybase => MS SQL Server/Sybase\n-  Neo4j  => Neo4j Graph Database\n-  InfluxDB  => InfluxDB Metric Database",
            "type":"string",
            "example":"Neo4j"
        },
        "Description":{
            "description":"Description, human label of database",
            "type":"string",
            "example":"Graph database"
        },
        "DBName":{
            "description":"Database schema name e.g. Graph",
            "type":"string",
            "example":"Graph"
        },
        "DBHost":{
            "description":"Database FQDN Host Name",
            "type":"string",
            "example":"someone.example.com"
        },
        "DBPort":{
            "description":"Database Port (3306 is default)",
            "type":"integer",
            "example":"7687"
        },
        "Username":{
            "description":"Database login user name",
            "type":"string",
            "example":""
        },
        "Timeout":{
            "description":"Database connection timeout value in seconds (30 is default)",
            "type":"integer",
            "example":"30"
        },
        "StatusID":{
            "description":"Status ID\n\nAllowed Values:\n-  0 => Disabled\n-  1 => Enabled",
            "type":"integer",
            "example":"1"
        },
        "IsAssure1Database":{
            "description":"If the database name is Assure1, Event, Graph, Metric, or Vision, then it is an Assure1 database.\n0 -> No\n1 -> Yes",
            "example":"1"
        },
        "Status":{
            "description":"Status",
            "type":"string",
            "example":"Enabled",
            "enum":[
                "Enabled",
                "Disabled"
            ]
        },
        "StatusIcon":{
            "description":"Status Icon",
            "type":"string",
            "example":"OrbGreen.png",
            "enum":[
                "OrbGreen.png",
                "OrbRed.png"
            ]
        },
        "State":{
            "description":"State",
            "type":"string",
            "example":"Loading..."
        },
        "StateIcon":{
            "description":"State icon",
            "type":"string",
            "example":"barSpinner.gif"
        }
    }
}

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