Jump to

• Request
• Response

Create a Device Type Category

post

/api/device/Categories

Creates a new device type category.

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.

  Example: Appliance
• ImageName: string
  The image name.

  Example: fugue/drive-network.png
• Source: string
  Type of icon. Possible values: - Font Awesome Icon - Unified Assurance Icon - Image

  Example: Image

{
    "type":"object",
    "properties":{
        "DeviceTypeCategoryName":{
            "description":"The device type category name.",
            "type":"string",
            "example":"Appliance"
        },
        "Source":{
            "description":"Type of icon. \nPossible values: \n- Font Awesome Icon\n- Unified Assurance Icon\n- Image",
            "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
• 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

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

{
    "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
  Icon name/ Fontawesome name/ Icon path name

  Example: fugue/drive-network.png
• Source: string
  Type of icon. Possible values: - Font Awesome Icon - Unified Assurance Icon - 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":"Type of icon.   \nPossible values: \n- Font Awesome Icon\n- Unified Assurance Icon\n- Image",
            "type":"string",
            "example":"Image"
        },
        "ImageName":{
            "description":"Icon name/ Fontawesome name/ Icon path name",
            "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":{
                "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