Jump to

• Request
• Response

Get a Permission by ID

get

/api/AAA/Permissions/{id}

Gets the permission that matches the specified ID.

Request

Path Parameters

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

  Example:

  1001

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
  The response body for a successful get operation.
• object type

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

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

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

{
    "description":"The response body for a successful get 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":"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/AAAPermissionsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object AAAPermissionsRead
  Permission details.

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

Nested Schema : AAAPermissionsRead

Type: object

Permission details.

Show Source

• Description: string
  The permission description.

  Example: Assigns administrative rights to view and modify items even if not the owner
• Multitenant: integer
  The multitenancy flag for the permission.

  Example: 0
• PackageName: string
  The package name.

  Example: global
• PermissionID: integer
  The permission ID.

  Example: 10001
• PermissionName: string
  The permission name.

  Example: SUPER

{
    "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"
        },
        "Multitenant":{
            "description":"The multitenancy flag for the permission.",
            "type":"integer",
            "example":"0"
        },
        "Description":{
            "description":"The permission description.",
            "type":"string",
            "example":"Assigns administrative rights to view and modify items even if not the owner"
        }
    },
    "type":"object",
    "description":"Permission details."
}

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