Jump to

• Request
• Response

Update a Device Metatype

put

/api/device/MetaTypes/{id}

Updates the properties of the device metatype that matches the specified ID.

Request

Path Parameters

• id(required): integer(int32)
  The device metatype ID.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DeviceMetaTypeName: string
  The device metatype name.

  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
  ID of property value renderer for the Meta Tag.

  Example: 1

{
    "type":"object",
    "properties":{
        "DeviceMetaTypeName":{
            "description":"The device metatype name.",
            "type":"string",
            "example":"ADBaseDN"
        },
        "RenderTypeID":{
            "description":"ID of property value renderer for the Meta Tag.",
            "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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulUpdateOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The properties of the updated 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 : SuccessfulUpdateOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Updated record
• 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":"Updated record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The properties of the updated device metatype.
• total: integer
  The total number of results regardless of paging.

  Example: 1

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

Show Source

• Array of: object deviceMetaTypesRead

{
    "description":"The properties of the updated 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 meta type can be used to filter events (1 for true) or not (0 for false).

  Example: 1
• FilterableIcon: string
  Icon for indicating filterable. Possible values: - 0 => "OrbRed.png" - 1 => "OrbGreen.png"

  Example: OrbGreen.png
• RenderTypeID: integer
  ID of property value renderer for the Meta Tag

  Example: 1
• RenderTypeName: string
  Display name of the property value renderer for the Meta Tag

  Example: String

{
    "type":"object",
    "properties":{
        "RenderTypeID":{
            "description":"ID of property value renderer for the Meta Tag",
            "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 meta type can be used to filter events (<b>1</b> for true) or not (<b>0</b> for false).",
            "type":"integer",
            "example":"1"
        },
        "FilterableIcon":{
            "description":"Icon for indicating filterable.             \nPossible values:\n- 0 => \"OrbRed.png\"\n- 1 => \"OrbGreen.png\"",
            "type":"string",
            "example":"OrbGreen.png"
        },
        "RenderTypeName":{
            "description":"Display name of the property value renderer for the Meta Tag",
            "type":"string",
            "example":"String"
        },
        "DeviceCount":{
            "description":"The total number of devices that contain this meta type.",
            "type":"integer",
            "example":"1"
        }
    }
}

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