REST API for Unified Assurance Core

Get Device Metatypes

get

/api/device/MetaTypes

Gets the device metatypes that match the specified parameters. If no parameters are specified, all device metatypes 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. If you do not also set the start parameter, records start at 0.
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",
    "example":[
        {
            "property":"Name",
            "direction":"ASC"
        },
        {
            "property":"Value",
            "direction":"DESC"
        }
    ]
}

Example:

[
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]

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":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The list of all the device metatypes that match the specified parameters.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/deviceMetaTypesRead"
                    }
                }
            }
        }
    ]
}

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 all the device metatypes 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 all the device metatypes that match the specified parameters.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deviceMetaTypesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of all the device metatypes that match the specified parameters.

Show Source

Array of: object deviceMetaTypesRead

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

Nested Schema : deviceMetaTypesRead

Type: object

Show Source

DeviceCount: integer

The total number of devices that contain this meta type.

Example: 1
DeviceMetaTypeID: integer

The device metatype ID.

Example: 12
DeviceMetaTypeName: string

The device metatype name.

Example: ADBaseDN
Filterable: integer

Whether a metatype can be used to filter events (1 for true) or not (0 for false).

Example: 1
FilterableIcon: string

The icon indicating whether the metatype is filterable. When Filterable is set to 0, this is set to OrbRed.png. When Filterable is set to 1, this is set to OrbGreen.png.

Example: OrbGreen.png
RenderTypeID: integer

The ID of the property value renderer for the metatag.

Example: 1
RenderTypeName: string

The display name of the property value renderer for the metatag.

Example: String

{
    "type":"object",
    "properties":{
        "RenderTypeID":{
            "description":"The ID of the property value renderer for the metatag.",
            "type":"integer",
            "example":"1"
        },
        "DeviceMetaTypeID":{
            "description":"The device metatype ID.",
            "type":"integer",
            "example":"12"
        },
        "DeviceMetaTypeName":{
            "description":"The device metatype name.",
            "type":"string",
            "example":"ADBaseDN"
        },
        "Filterable":{
            "description":"Whether a metatype can be used to filter events (<b>1</b> for true) or not (<b>0</b> for false).",
            "type":"integer",
            "example":"1"
        },
        "FilterableIcon":{
            "description":"The icon indicating whether the metatype is filterable. When <b>Filterable</b> is set to <b>0</b>, this is set to <b>OrbRed.png</b>. When <b>Filterable</b> is set to <b>1</b>, this is set to <b>OrbGreen.png</b>.",
            "type":"string",
            "example":"OrbGreen.png"
        },
        "RenderTypeName":{
            "description":"The display name of the property value renderer for the metatag.",
            "type":"string",
            "example":"String"
        },
        "DeviceCount":{
            "description":"The total number of devices that contain this meta type.",
            "type":"integer",
            "example":"1"
        }
    }
}

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.