Jump to

• Request
• Response

Update a Tenant

put

/api/AAA/Tenants/{id}

Updates the properties of the tenant that matches the specified ID.

Request

Path Parameters

• id(required): integer(int32)
  The tenant ID.

  Example:

  1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DeviceZones: array DeviceZones
  The list of device zones ID.
• TenantName: string
  The tenant 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: Oracle
• UserGroups: array UserGroups
  The list of user groups ID.

{
    "properties":{
        "TenantName":{
            "description":"The tenant 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":"Oracle"
        },
        "UserGroups":{
            "description":"The list of user groups ID.",
            "type":"array",
            "items":{
                "type":"integer"
            },
            "example":[
                1,
                3
            ]
        },
        "DeviceZones":{
            "description":"The list of device zones ID.",
            "type":"array",
            "items":{
                "type":"integer"
            },
            "example":[
                2,
                3
            ]
        }
    }
}

Nested Schema : DeviceZones

Type: array

The list of device zones ID.

Show Source

• Array of: integer

{
    "description":"The list of device zones ID.",
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
        2,
        3
    ]
}

Example:

[
    2,
    3
]

Nested Schema : UserGroups

Type: array

The list of user groups ID.

Show Source

• Array of: integer

{
    "description":"The list of user groups ID.",
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
        1,
        3
    ]
}

Example:

[
    1,
    3
]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulUpdateOperation
  The response body for a successful update operation.
• object type

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

Nested Schema : SuccessfulUpdateOperation

Type: object

The response body for a successful update operation.

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

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

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

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

Nested Schema : data

Type: array

Show Source

• Array of: object AAATenantsRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AAATenantsRead"
    }
}

Nested Schema : AAATenantsRead

Type: object

Show Source

• DeviceZones: array DeviceZones
  The list of device zones associated with the tenant
• TenantID: integer
  The tenant ID.

  Example: 1
• TenantName: string
  The tenant name.

  Example: Oracle
• UserGroups: array UserGroups
  The list of user groups associated with the tenant

{
    "properties":{
        "TenantID":{
            "description":"The tenant ID.",
            "type":"integer",
            "example":"1"
        },
        "TenantName":{
            "description":"The tenant name.",
            "type":"string",
            "example":"Oracle"
        },
        "UserGroups":{
            "description":"The list of user groups associated with the tenant",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "UserGroupID":{
                        "description":"The user group ID",
                        "type":"integer",
                        "example":"2"
                    },
                    "UserGroupName":{
                        "description":"The user group name.",
                        "type":"string",
                        "example":"Operators"
                    }
                }
            }
        },
        "DeviceZones":{
            "description":"The list of device zones associated with the tenant",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "DeviceZoneID":{
                        "description":"The device zone ID",
                        "type":"integer",
                        "example":"1"
                    },
                    "DeviceZoneName":{
                        "description":"The device zone name.",
                        "type":"string",
                        "example":"Default First Zone"
                    }
                }
            }
        }
    }
}

Nested Schema : DeviceZones

Type: array

The list of device zones associated with the tenant

Show Source

• Array of: object items

{
    "description":"The list of device zones associated with the tenant",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "DeviceZoneID":{
                "description":"The device zone ID",
                "type":"integer",
                "example":"1"
            },
            "DeviceZoneName":{
                "description":"The device zone name.",
                "type":"string",
                "example":"Default First Zone"
            }
        }
    }
}

Nested Schema : UserGroups

Type: array

The list of user groups associated with the tenant

Show Source

• Array of: object items

{
    "description":"The list of user groups associated with the tenant",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "UserGroupID":{
                "description":"The user group ID",
                "type":"integer",
                "example":"2"
            },
            "UserGroupName":{
                "description":"The user group name.",
                "type":"string",
                "example":"Operators"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• DeviceZoneID: integer
  The device zone ID

  Example: 1
• DeviceZoneName: string
  The device zone name.

  Example: Default First Zone

{
    "type":"object",
    "properties":{
        "DeviceZoneID":{
            "description":"The device zone ID",
            "type":"integer",
            "example":"1"
        },
        "DeviceZoneName":{
            "description":"The device zone name.",
            "type":"string",
            "example":"Default First Zone"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• UserGroupID: integer
  The user group ID

  Example: 2
• UserGroupName: string
  The user group name.

  Example: Operators

{
    "type":"object",
    "properties":{
        "UserGroupID":{
            "description":"The user group ID",
            "type":"integer",
            "example":"2"
        },
        "UserGroupName":{
            "description":"The user group name.",
            "type":"string",
            "example":"Operators"
        }
    }
}

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