Jump to

• Request
• Response

Get Links and Link Groups Under a Specific Node

get

/api/link/LinkNavigation/readForTree

Gets links and link groups under a specific node.

Request

Query Parameters

• node(required): string
  The node from the tree selection. It can be root or LinkGroupID.

  Example:

  root

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":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The list of links and link groups.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/linkNavigationRead"
                    }
                }
            }
        }
    ]
}

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
  The list of links and link groups.
• 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":{
            "description":"The list of links and link groups.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/linkNavigationRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of links and link groups.

Show Source

• Array of: object linkNavigationRead

{
    "description":"The list of links and link groups.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/linkNavigationRead"
    }
}

Nested Schema : linkNavigationRead

Type: object

Show Source

• data: array data
  List of LinkGroup
• expanded: boolean
  Expanded or not

  Example: true
• id: string
  Node ID

  Example: root
• PortalGroupID: integer
  Portal Group ID

  Example: 1
• text: string
  Node Text

  Example: Root
• total: integer
  Total data elements

  Example: 3

{
    "type":"object",
    "properties":{
        "PortalGroupID":{
            "description":"Portal Group ID",
            "type":"integer",
            "example":"1"
        },
        "id":{
            "description":"Node ID",
            "type":"string",
            "example":"root"
        },
        "text":{
            "description":"Node Text",
            "type":"string",
            "example":"Root"
        },
        "expanded":{
            "description":"Expanded or not",
            "type":"boolean",
            "example":true
        },
        "data":{
            "description":"List of LinkGroup",
            "type":"array",
            "items":{
                "type":"object"
            },
            "example":[
                {
                    "id":"4",
                    "LinkGroupID":"4",
                    "text":"Admin",
                    "expanded":false
                },
                {
                    "id":"3",
                    "LinkGroupID":"3",
                    "text":"Operators",
                    "expanded":false
                },
                {
                    "id":"2",
                    "LinkGroupID":"2",
                    "text":"Public",
                    "expanded":false
                }
            ]
        },
        "total":{
            "description":"Total data elements",
            "type":"integer",
            "example":3
        }
    }
}

Nested Schema : data

Type: array

List of LinkGroup

Show Source

• Array of: object items

{
    "description":"List of LinkGroup",
    "type":"array",
    "items":{
        "type":"object"
    },
    "example":[
        {
            "id":"4",
            "LinkGroupID":"4",
            "text":"Admin",
            "expanded":false
        },
        {
            "id":"3",
            "LinkGroupID":"3",
            "text":"Operators",
            "expanded":false
        },
        {
            "id":"2",
            "LinkGroupID":"2",
            "text":"Public",
            "expanded":false
        }
    ]
}

Example:

[
    {
        "id":"4",
        "LinkGroupID":"4",
        "text":"Admin",
        "expanded":false
    },
    {
        "id":"3",
        "LinkGroupID":"3",
        "text":"Operators",
        "expanded":false
    },
    {
        "id":"2",
        "LinkGroupID":"2",
        "text":"Public",
        "expanded":false
    }
]

Nested Schema : items

Type: object

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