REST API for Unified Assurance Core

Create a Device Metatype

post

/api/device/MetaTypes

Creates a new device metatype.
The minimum required properties in the request body are:

DeviceMetaTypeName
RenderTypeID

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

DeviceMetaTypeName: string

The device metatype 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: ADBaseDN
Filterable: integer

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

Example: 1
RenderTypeID: integer

The ID of property value renderer for the metatag.

Example: 1

{
    "type":"object",
    "properties":{
        "DeviceMetaTypeName":{
            "description":"The device metatype 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.\n",
            "type":"string",
            "example":"ADBaseDN"
        },
        "RenderTypeID":{
            "description":"The ID of property value renderer for the metatag.",
            "type":"integer",
            "example":"1"
        },
        "Filterable":{
            "description":"Whether a meta type can be used to filter events (<b>1</b> for true) or not (<b>0</b> for false).",
            "type":"integer",
            "example":"1"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulAddOperation

The response body for a successful add operation.
object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The properties of the new device metatype.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/deviceMetaTypesRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

Show Source

message: string

The response message.

Example: Added record
success: boolean

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

Example: true

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

Nested Schema : type

Type: object

Show Source

data: array data

The properties of the new device metatype.
total: integer

The total number of results regardless of paging.

Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the new device metatype.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deviceMetaTypesRead"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

The properties of the new device metatype.

Show Source

Array of: object deviceMetaTypesRead

{
    "description":"The properties of the new device metatype.",
    "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.