REST API for Unified Assurance Core

Get Servers with Specified Package and Job Configuration

get

/api/discovery/Discover/readDiscoveryJobs

Gets the servers that have a specific package installed and a certain job configured.

Request

Query Parameters

JobProg: string

The name of the required job. The default value is DeviceSNMPDiscovery.
Package: string

The servers that have the package installed. The default value is coreCollection-app.
ServerID: integer

The server ID. If specified, only the array of jobs is returned. If not, only the array of servers is returned.

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
```
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":{
                "data":{
                    "description":"The list of servers and jobs. It returns server array when the ServerID is not provided, and job array when the ServerID is provided.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/discoveryDiscoverReadDiscoveryJobs"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

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 servers and jobs. It returns server array when the ServerID is not provided, and job array when the ServerID is provided.
total: integer

The total number of results regardless of paging.

Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The list of servers and jobs. It returns server array when the ServerID is not provided, and job array when the ServerID is provided.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/discoveryDiscoverReadDiscoveryJobs"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

The list of servers and jobs. It returns server array when the ServerID is not provided, and job array when the ServerID is provided.

Show Source

Array of: object discoveryDiscoverReadDiscoveryJobs

{
    "description":"The list of servers and jobs. It returns server array when the ServerID is not provided, and job array when the ServerID is provided.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/discoveryDiscoverReadDiscoveryJobs"
    }
}

Nested Schema : discoveryDiscoverReadDiscoveryJobs

Type: object

Show Source

Jobs: array Jobs

The list of jobs.
ServerID: integer

The server ID.

Example: 9
ServerName: string

The server name.

Example: server1.example.com

{
    "type":"object",
    "properties":{
        "ServerID":{
            "description":"The server ID.",
            "type":"integer",
            "example":"9"
        },
        "ServerName":{
            "description":"The server name.",
            "type":"string",
            "example":"server1.example.com"
        },
        "Jobs":{
            "description":"The list of jobs.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "JobID":{
                        "description":"The job ID.",
                        "type":"integer"
                    },
                    "JobName":{
                        "description":"The job name.",
                        "type":"string"
                    }
                }
            },
            "example":[
                {
                    "JobID":"35",
                    "JobName":"Device Auto Discovery"
                },
                {
                    "JobID":"133",
                    "JobName":"Device Auto Discovery - Dev Playgrounds and QA"
                }
            ]
        }
    }
}

Nested Schema : Jobs

Type: array

The list of jobs.

Show Source

Array of: object items

{
    "description":"The list of jobs.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "JobID":{
                "description":"The job ID.",
                "type":"integer"
            },
            "JobName":{
                "description":"The job name.",
                "type":"string"
            }
        }
    },
    "example":[
        {
            "JobID":"35",
            "JobName":"Device Auto Discovery"
        },
        {
            "JobID":"133",
            "JobName":"Device Auto Discovery - Dev Playgrounds and QA"
        }
    ]
}

Example:

[
    {
        "JobID":"35",
        "JobName":"Device Auto Discovery"
    },
    {
        "JobID":"133",
        "JobName":"Device Auto Discovery - Dev Playgrounds and QA"
    }
]

Nested Schema : items

Type: object

Show Source

JobID: integer

The job ID.
JobName: string

The job name.

{
    "type":"object",
    "properties":{
        "JobID":{
            "description":"The job ID.",
            "type":"integer"
        },
        "JobName":{
            "description":"The job 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.