Jump to

• Request
• Response

Get a Role by ID

get

/api/AAA/Roles/{id}

Gets the role that matches the specified ID.

Request

Path Parameters

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

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AAARolesRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• 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":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AAARolesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object AAARolesRead

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

Nested Schema : AAARolesRead

Type: object

Show Source

• Description: string
  The role description.

  Example: Administrators have complete access to all user interfaces
• Permissions: array Permissions
  The permissions associated with the role.
• RoleID: integer
  The role ID.

  Example: 1
• RoleName: string
  The role name.

  Example: Administrator

{
    "properties":{
        "RoleID":{
            "description":"The role ID.",
            "type":"integer",
            "example":"1"
        },
        "RoleName":{
            "description":"The role name.",
            "type":"string",
            "example":"Administrator"
        },
        "Description":{
            "description":"The role description.",
            "type":"string",
            "example":"Administrators have complete access to all user interfaces"
        },
        "Permissions":{
            "description":"The permissions associated with the role.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PermissionID":{
                        "description":"The permission ID.",
                        "type":"integer",
                        "example":"10001"
                    },
                    "PermissionName":{
                        "description":"The permission name.",
                        "type":"string",
                        "example":"SUPER"
                    },
                    "PackageName":{
                        "description":"The package name.",
                        "type":"string",
                        "example":"global"
                    },
                    "ReadAvailable":{
                        "description":"Read Available (Uses a tinyint type)",
                        "type":"integer",
                        "example":"0"
                    },
                    "CreateAvailable":{
                        "description":"Create Available (Uses a tinyint type)",
                        "type":"integer",
                        "example":"0"
                    },
                    "UpdateAvailable":{
                        "description":"Update Available (Uses a tinyint type)",
                        "type":"integer",
                        "example":"0"
                    },
                    "DeleteAvailable":{
                        "description":"Delete Available (Uses a tinyint type)",
                        "type":"integer",
                        "example":"0"
                    },
                    "ExecuteAvailable":{
                        "description":"Execute Available (Uses a tinyint type)",
                        "type":"integer",
                        "example":"0"
                    },
                    "Description":{
                        "description":"Description",
                        "type":"string",
                        "example":"Assigns administrative rights to view and modify items even if not the owner"
                    },
                    "ReadFlag":{
                        "description":"Read Flag (a tinyint-like flag)",
                        "type":"integer",
                        "example":"0"
                    },
                    "CreateFlag":{
                        "description":"Create Flag (a tinyint-like flag)",
                        "type":"integer",
                        "example":"0"
                    },
                    "UpdateFlag":{
                        "description":"Update Flag (a tinyint-like flag)",
                        "type":"integer",
                        "example":"0"
                    },
                    "DeleteFlag":{
                        "description":"Delete Flag (a tinyint-like flag)",
                        "type":"integer",
                        "example":"0"
                    },
                    "ExecuteFlag":{
                        "description":"Execute Flag (a tinyint-like flag)",
                        "type":"integer",
                        "example":"0"
                    }
                }
            }
        }
    },
    "type":"object"
}

Nested Schema : Permissions

Type: array

The permissions associated with the role.

Show Source

• Array of: object items

{
    "description":"The permissions associated with the role.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PermissionID":{
                "description":"The permission ID.",
                "type":"integer",
                "example":"10001"
            },
            "PermissionName":{
                "description":"The permission name.",
                "type":"string",
                "example":"SUPER"
            },
            "PackageName":{
                "description":"The package name.",
                "type":"string",
                "example":"global"
            },
            "ReadAvailable":{
                "description":"Read Available (Uses a tinyint type)",
                "type":"integer",
                "example":"0"
            },
            "CreateAvailable":{
                "description":"Create Available (Uses a tinyint type)",
                "type":"integer",
                "example":"0"
            },
            "UpdateAvailable":{
                "description":"Update Available (Uses a tinyint type)",
                "type":"integer",
                "example":"0"
            },
            "DeleteAvailable":{
                "description":"Delete Available (Uses a tinyint type)",
                "type":"integer",
                "example":"0"
            },
            "ExecuteAvailable":{
                "description":"Execute Available (Uses a tinyint type)",
                "type":"integer",
                "example":"0"
            },
            "Description":{
                "description":"Description",
                "type":"string",
                "example":"Assigns administrative rights to view and modify items even if not the owner"
            },
            "ReadFlag":{
                "description":"Read Flag (a tinyint-like flag)",
                "type":"integer",
                "example":"0"
            },
            "CreateFlag":{
                "description":"Create Flag (a tinyint-like flag)",
                "type":"integer",
                "example":"0"
            },
            "UpdateFlag":{
                "description":"Update Flag (a tinyint-like flag)",
                "type":"integer",
                "example":"0"
            },
            "DeleteFlag":{
                "description":"Delete Flag (a tinyint-like flag)",
                "type":"integer",
                "example":"0"
            },
            "ExecuteFlag":{
                "description":"Execute Flag (a tinyint-like flag)",
                "type":"integer",
                "example":"0"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• CreateAvailable: integer
  Create Available (Uses a tinyint type)

  Example: 0
• CreateFlag: integer
  Create Flag (a tinyint-like flag)

  Example: 0
• DeleteAvailable: integer
  Delete Available (Uses a tinyint type)

  Example: 0
• DeleteFlag: integer
  Delete Flag (a tinyint-like flag)

  Example: 0
• Description: string
  Description

  Example: Assigns administrative rights to view and modify items even if not the owner
• ExecuteAvailable: integer
  Execute Available (Uses a tinyint type)

  Example: 0
• ExecuteFlag: integer
  Execute Flag (a tinyint-like flag)

  Example: 0
• PackageName: string
  The package name.

  Example: global
• PermissionID: integer
  The permission ID.

  Example: 10001
• PermissionName: string
  The permission name.

  Example: SUPER
• ReadAvailable: integer
  Read Available (Uses a tinyint type)

  Example: 0
• ReadFlag: integer
  Read Flag (a tinyint-like flag)

  Example: 0
• UpdateAvailable: integer
  Update Available (Uses a tinyint type)

  Example: 0
• UpdateFlag: integer
  Update Flag (a tinyint-like flag)

  Example: 0

{
    "type":"object",
    "properties":{
        "PermissionID":{
            "description":"The permission ID.",
            "type":"integer",
            "example":"10001"
        },
        "PermissionName":{
            "description":"The permission name.",
            "type":"string",
            "example":"SUPER"
        },
        "PackageName":{
            "description":"The package name.",
            "type":"string",
            "example":"global"
        },
        "ReadAvailable":{
            "description":"Read Available (Uses a tinyint type)",
            "type":"integer",
            "example":"0"
        },
        "CreateAvailable":{
            "description":"Create Available (Uses a tinyint type)",
            "type":"integer",
            "example":"0"
        },
        "UpdateAvailable":{
            "description":"Update Available (Uses a tinyint type)",
            "type":"integer",
            "example":"0"
        },
        "DeleteAvailable":{
            "description":"Delete Available (Uses a tinyint type)",
            "type":"integer",
            "example":"0"
        },
        "ExecuteAvailable":{
            "description":"Execute Available (Uses a tinyint type)",
            "type":"integer",
            "example":"0"
        },
        "Description":{
            "description":"Description",
            "type":"string",
            "example":"Assigns administrative rights to view and modify items even if not the owner"
        },
        "ReadFlag":{
            "description":"Read Flag (a tinyint-like flag)",
            "type":"integer",
            "example":"0"
        },
        "CreateFlag":{
            "description":"Create Flag (a tinyint-like flag)",
            "type":"integer",
            "example":"0"
        },
        "UpdateFlag":{
            "description":"Update Flag (a tinyint-like flag)",
            "type":"integer",
            "example":"0"
        },
        "DeleteFlag":{
            "description":"Delete Flag (a tinyint-like flag)",
            "type":"integer",
            "example":"0"
        },
        "ExecuteFlag":{
            "description":"Execute Flag (a tinyint-like flag)",
            "type":"integer",
            "example":"0"
        }
    }
}

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