REST API for Unified Assurance Core

Create a Device Configuration Collection

post

/api/config/Collections

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

ConfigAgentProfileID
ConfigActionProfileID
Devices
DeviceName

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

ConfigActionProfileID: integer

The configuration action profile ID.

Example: 1002
ConfigAgentProfileID: integer

The configuration agent profile ID.

Example: 1001
DeviceName: string

The device the collection pertains to.

Example: Some Device
Devices: array Devices

The device ID array. Each collection must contain a unique combination of ConfigAgentProfileID, ConfigActionProfileID, and Devices. Specify only devices that are not already in a collection that has the same ConfigAgentProfileID and ConfigActionProfileID.
DeviceZoneName: string

The name of the zone the device is in.

Example: Default First Zone
StatusID: integer

The configuration collection status ID. Either 0 (disabled) or 1 (enabled).

Example: 0

{
    "properties":{
        "ConfigAgentProfileID":{
            "description":"The configuration agent profile ID.",
            "type":"integer",
            "example":"1001"
        },
        "ConfigActionProfileID":{
            "description":"The configuration action profile ID.",
            "type":"integer",
            "example":"1002"
        },
        "DeviceName":{
            "description":"The device the collection pertains to.",
            "type":"string",
            "example":"Some Device"
        },
        "DeviceZoneName":{
            "description":"The name of the zone the device is in.",
            "type":"string",
            "example":"Default First Zone"
        },
        "StatusID":{
            "description":"The configuration collection status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":"0"
        },
        "Devices":{
            "description":"The device ID array. Each collection must contain a unique combination of ConfigAgentProfileID, ConfigActionProfileID, and Devices. Specify only devices that are not already in a collection that has the same ConfigAgentProfileID and ConfigActionProfileID.",
            "type":"array",
            "example":"[50,19]"
        }
    }
}

Nested Schema : Devices

Type: array

The device ID array. Each collection must contain a unique combination of ConfigAgentProfileID, ConfigActionProfileID, and Devices. Specify only devices that are not already in a collection that has the same ConfigAgentProfileID and ConfigActionProfileID.

Example:

[50,19]

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 configuration collection.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/configCollectionsRead"
                    }
                },
                "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 configuration collection.
total: integer

The total number of results regardless of paging.

Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the new device configuration collection.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/configCollectionsRead"
            }
        },
        "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 configuration collection.

Show Source

Array of: object configCollectionsRead

{
    "description":"The properties of the new device configuration collection.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/configCollectionsRead"
    }
}

Nested Schema : configCollectionsRead

Type: object

Show Source

ActionName: string

The action name.

Example: Example Action Name
ConfigActionProfileID: integer

The configuration action profile ID.

Example: 1002
ConfigAgentProfileID: integer

The configuration agent profile ID.

Example: 1001
ConfigCollectionID: integer

The configuration collection ID.

Example: 1003
DeviceID: integer

The device ID.

Example: 303
DeviceName: string

The device name. Most commonly, this is the host FQDN.

Example: server.domain.com
DeviceZoneName: string

The device zone name.

Example: Default First Zone
ProfileName: string

The profile name.

Example: SSH Profile
Status: string

The status, based on the value of the StatusID property. When StatusID is 0, Status is Disabled. When StatusID is 1, Status is Enabled.

Example: Disabled
StatusIcon: string

The status image name based on the the statusID. If the statusID is 0, then the StatusIcon is OrbRed.png. If the statusID is 1, then the StatusIcon is OrbGreen.png.

Example: OrbRed.png
StatusID: integer

The configuration collection status ID. Either 0 (disabled) or 1 (enabled).

Example: 0

{
    "properties":{
        "ConfigCollectionID":{
            "description":"The configuration collection ID.",
            "type":"integer",
            "example":"1003"
        },
        "DeviceName":{
            "description":"The device name. Most commonly, this is the host FQDN.",
            "type":"string",
            "example":"server.domain.com"
        },
        "DeviceZoneName":{
            "description":"The device zone name.",
            "type":"string",
            "example":"Default First Zone"
        },
        "ProfileName":{
            "description":"The profile name.",
            "type":"string",
            "example":"SSH Profile"
        },
        "ActionName":{
            "description":"The action name.",
            "type":"string",
            "example":"Example Action Name"
        },
        "StatusID":{
            "description":"The configuration collection status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":"0"
        },
        "Status":{
            "description":"The status, based on the value of the <b>StatusID</b> property. When <b>StatusID</b> is <b>0</b>, <b>Status</b> is <b>Disabled</b>. When <b>StatusID</b> is <b>1</b>, <b>Status</b> is <b>Enabled</b>.",
            "type":"string",
            "example":"Disabled"
        },
        "StatusIcon":{
            "description":"The status image name based on the the <b>statusID</b>. If the <b>statusID</b> is <b>0</b>, then the <b>StatusIcon</b> is <b>OrbRed.png</b>. If the <b>statusID</b> is <b>1</b>, then the <b>StatusIcon</b> is <b>OrbGreen.png</b>.",
            "type":"string",
            "example":"OrbRed.png"
        },
        "DeviceID":{
            "description":"The device ID.",
            "type":"integer",
            "example":"303"
        },
        "ConfigAgentProfileID":{
            "description":"The configuration agent profile ID.",
            "type":"integer",
            "example":"1001"
        },
        "ConfigActionProfileID":{
            "description":"The configuration action profile ID.",
            "type":"integer",
            "example":"1002"
        }
    }
}

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.