Jump to

• Request
• Response

Create a Device Type Category

post

/api/device/Categories

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

• DeviceTypeCategoryName
• ImageName

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DeviceTypeCategoryName: string
  The device type category 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: Appliance
• ImageName: string
  The image name.

  Example: fugue/drive-network.png
• Source: string
  The type of icon. The possible values are Font Awesome Icon, Unified Assurance Icon, and Image.

  Example: Image

{
    "type":"object",
    "properties":{
        "DeviceTypeCategoryName":{
            "description":"The device type category 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.",
            "type":"string",
            "example":"Appliance"
        },
        "Source":{
            "description":"The type of icon. The possible values are <b>Font Awesome Icon</b>, <b>Unified Assurance Icon</b>, and <b>Image</b>.",
            "type":"string",
            "example":"Image"
        },
        "ImageName":{
            "description":"The image name.",
            "type":"string",
            "example":"fugue/drive-network.png"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

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 type category.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/deviceCategoriesRead"
                    }
                },
                "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 type category.
• total: integer
  The total number of results regardless of paging.

  Example: 1

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

Show Source

• Array of: object deviceCategoriesRead

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

Nested Schema : deviceCategoriesRead

Type: object

Show Source

• DeviceTypeCategoryID: integer
  The device type category IDs specified for individual CRUD operations.

  Example: 13
• DeviceTypeCategoryName: string
  The device type category name.

  Example: Appliance
• ImageName: string
  The name of the icon, Font Awesome icon, or path to the icon.

  Example: fugue/drive-network.png
• Source: string
  The type of icon. The possible values are Font Awesome Icon, Unified Assurance Icon, and Image.

  Example: Image

{
    "type":"object",
    "properties":{
        "DeviceTypeCategoryID":{
            "description":"The device type category IDs specified for individual CRUD operations.",
            "type":"integer",
            "example":"13"
        },
        "DeviceTypeCategoryName":{
            "description":"The device type category name.",
            "type":"string",
            "example":"Appliance"
        },
        "Source":{
            "description":"The type of icon. The possible values are <b>Font Awesome Icon</b>, <b>Unified Assurance Icon</b>, and <b>Image</b>.",
            "type":"string",
            "example":"Image"
        },
        "ImageName":{
            "description":"The name of the icon, Font Awesome icon, or path to the icon.",
            "type":"string",
            "example":"fugue/drive-network.png"
        }
    }
}

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":{
                "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.

Back to Top