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

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

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

• Array of: object databaseDatabasesRead

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

• DatabaseID: integer
  The database ID for individual CRUD operations.

  Example: 1002
• DatabaseName: string
  The database display name.

  Example: Primary Graph Database on someone.example.com
• DBHost: string
  The database FQDN host name.

  Example: someone.example.com
• DBName: string
  The database schema name.

  Example: Graph
• DBPort: integer
  The database port. The default is 3306.

  Example: 7687
• DBType: string
  The database type used in the connection string. The possible values are:

  • mysql: MySQL. This is the default.
  • Sybase: MS SQL Server/Sybase
  • Neo4j: Neo4j Graph Database
  • influxDB: InfluxDB Metric Database

  Example: Neo4j
• Description: string
  The description of the database.

  Example: Graph database
• FailoverTypeID: integer
  The failover type ID. Either 1 for a primary database or 2 for a backup or redundant database.

  Example: 1
• IsAssure1Database:
  Whether the database is a Unified Assurance database (1) or not (0). If the database name is Assure1, Event, Graph, Metric, or Vision, then it is a Unified Assurance database.

  Example: 1
• ShardID: integer
  The database shard ID.

  Example: 1
• State: string
  The state.

  Example: Loading...
• StateIcon: string
  The state icon.

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

  The status.

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

  The status icon.

  Example: OrbGreen.png
• StatusID: integer
  The database status ID. Either 0 (disabled) or 1 (enabled).

  Example: 1
• Timeout: integer
  The database connection timeout value in seconds. The default is 30.

  Example: 30
• Username: string
  The database login username.

  Example:

{
    "type":"object",
    "properties":{
        "DatabaseID":{
            "description":"The database ID for individual CRUD operations.",
            "type":"integer",
            "example":"1002"
        },
        "DatabaseName":{
            "description":"The database display name.",
            "type":"string",
            "example":"Primary Graph Database on someone.example.com"
        },
        "FailoverTypeID":{
            "description":"The failover type ID. Either <b>1</b> for a primary database or <b>2</b> for a backup or redundant database.",
            "type":"integer",
            "example":"1"
        },
        "ShardID":{
            "description":"The database shard ID.",
            "type":"integer",
            "example":"1"
        },
        "DBType":{
            "description":"The database type used in the connection string.\n The possible values are:\n <ul><li><b>mysql</b>: MySQL. This is the default.</li>\n <li><b>Sybase</b>: MS SQL Server/Sybase</li>\n <li><b>Neo4j</b>: Neo4j Graph Database</li>\n <li><b>influxDB</b>: InfluxDB Metric Database</li></ul>",
            "type":"string",
            "example":"Neo4j"
        },
        "Description":{
            "description":"The description of the database.",
            "type":"string",
            "example":"Graph database"
        },
        "DBName":{
            "description":"The database schema name.",
            "type":"string",
            "example":"Graph"
        },
        "DBHost":{
            "description":"The database FQDN host name.",
            "type":"string",
            "example":"someone.example.com"
        },
        "DBPort":{
            "description":"The database port. The default is 3306.",
            "type":"integer",
            "example":"7687"
        },
        "Username":{
            "description":"The database login username.",
            "type":"string",
            "example":""
        },
        "Timeout":{
            "description":"The database connection timeout value in seconds. The default is 30.",
            "type":"integer",
            "example":"30"
        },
        "StatusID":{
            "description":"The database status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":"1"
        },
        "IsAssure1Database":{
            "description":"Whether the database is a Unified Assurance database (<b>1</b>) or not (<b>0</b>). If the database name is Assure1, Event, Graph, Metric, or Vision, then it is a Unified Assurance database.",
            "example":"1"
        },
        "Status":{
            "description":"The status.",
            "type":"string",
            "example":"Enabled",
            "enum":[
                "Enabled",
                "Disabled"
            ]
        },
        "StatusIcon":{
            "description":"The status icon.",
            "type":"string",
            "example":"OrbGreen.png",
            "enum":[
                "OrbGreen.png",
                "OrbRed.png"
            ]
        },
        "State":{
            "description":"The state.",
            "type":"string",
            "example":"Loading..."
        },
        "StateIcon":{
            "description":"The state icon.",
            "type":"string",
            "example":"barSpinner.gif"
        }
    }
}

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

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