Jump to

• Request
• Response

Get a Diagram Menu by ID

get

/api/diagram/Menus/{id}

Gets the diagram menu that matches the specified ID.

Request

Path Parameters

• id(required): integer
  The diagram menu ID specified for individual CRUD operations.

  Example:

  2

Query Parameters

• readChildren: boolean
  Allowed values - true -> Returns only children menu group information (for tree display). - false -> Returns children menus and menu tools details associated with the diagram menu (for form display).

  Example:

  false

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/diagramMenusReadByID"
                    }
                }
            }
        }
    ]
}

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/diagramMenusReadByID"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object diagramMenusReadByID

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

Nested Schema : diagramMenusReadByID

Type: object

Show Source

• MenuName: string
  The menu name.

  Example: Device Info
• ParentMenuID: integer
  The parent menu ID.

  Example: 1
• Tools: object Tools
  The list of tool IDs.
• UserGroupID: object UserGroupID
  The user group ID.

{
    "type":"object",
    "properties":{
        "MenuName":{
            "description":"The menu name.",
            "type":"string",
            "example":"Device Info"
        },
        "UserGroupID":{
            "description":"The user group ID.",
            "type":"object",
            "properties":{
                "id":{
                    "example":"1"
                },
                "name":{
                    "example":"Administrators"
                }
            }
        },
        "ParentMenuID":{
            "description":"The parent menu ID.",
            "type":"integer",
            "example":"1"
        },
        "Tools":{
            "description":"The list of tool IDs.",
            "type":"object",
            "properties":{
                "ToolID":{
                    "description":"The tool ID.",
                    "type":"integer",
                    "example":"2"
                },
                "ToolName":{
                    "description":"The tool name.",
                    "type":"string",
                    "example":"Device Health"
                }
            },
            "example":[
                {
                    "ToolID":"2",
                    "ToolName":"Device Health"
                },
                {
                    "ToolID":"1",
                    "ToolName":"Manage Device"
                },
                {
                    "ToolID":"3",
                    "ToolName":"Network Details"
                }
            ]
        }
    }
}

Nested Schema : Tools

Type: object

The list of tool IDs.

Show Source

• ToolID: integer
  The tool ID.

  Example: 2
• ToolName: string
  The tool name.

  Example: Device Health

{
    "description":"The list of tool IDs.",
    "type":"object",
    "properties":{
        "ToolID":{
            "description":"The tool ID.",
            "type":"integer",
            "example":"2"
        },
        "ToolName":{
            "description":"The tool name.",
            "type":"string",
            "example":"Device Health"
        }
    },
    "example":[
        {
            "ToolID":"2",
            "ToolName":"Device Health"
        },
        {
            "ToolID":"1",
            "ToolName":"Manage Device"
        },
        {
            "ToolID":"3",
            "ToolName":"Network Details"
        }
    ]
}

Example:

[
    {
        "ToolID":"2",
        "ToolName":"Device Health"
    },
    {
        "ToolID":"1",
        "ToolName":"Manage Device"
    },
    {
        "ToolID":"3",
        "ToolName":"Network Details"
    }
]

Nested Schema : UserGroupID

Type: object

The user group ID.

Show Source

• id:
  Example: 1
• name:
  Example: Administrators

{
    "description":"The user group ID.",
    "type":"object",
    "properties":{
        "id":{
            "example":"1"
        },
        "name":{
            "example":"Administrators"
        }
    }
}

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