Jump to

• Request
• Response

Get a List of Search Keywords for Menu

get

/api/navigation/Configurations/readKeywords

Gets the list of search keywords for the menu.

Request

There are no request parameters for this operation.

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

Type: object

Show Source

• data: object data
  Records
• message: string
  The response message in text.

  Example:
• 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 in text.",
            "type":"string",
            "example":""
        },
        "data":{
            "description":"Records",
            "type":"object",
            "example":{
                "/#AAA/authTypes":"authentication,saml,ldap,sso,radius,active directory,security",
                "/#AAA/roles":"roles,user,acl,access control,aaa,rbac,security,permissions",
                "/#AAA/users":"users,accounts,password,operators",
                "/#AAA/userGroups":"users,groups,accounts,roles,properties,permissions,restrictions",
                "/#broker/applicationConfigTypes":"application,config,datatype,services,jobs",
                "/#broker/failoverStates":"servers,failover,service,state,status",
                "/#broker/jobs":"servers,jobs,scheduled,processes,scripts,logs,start",
                "/#broker/licenses":"license,licence,licensing",
                "/#package/depots":"packages,updates,upgrades,edge,stable,nightly",
                "/#broker/servers":"servers,updates,upgrades,versions,software,broker,roles",
                "/#broker/services":"servers,services,processes,scripts,running,applications,logs,stop,start,restart,pid",
                "/#dashboard/dashboards":"dashboards,portals,reports,panel",
                "/#dashboard/groups":"dashboards,portals,groups",
                "/#database/database":"databases,sql,mysql,neo4j,influx,query",
                "/#database/queries":"query,queries,databases,sql,reports",
                "/#database/queryTool":"query,queries,sql",
                "/#device/devices":"devices,catalog,inventory,discover",
                "/#device/groups":"groups,grouping,devices,category",
                "/#device/deviceManagement":"device,edit,multiple,management,bulk,change",
                "/#device/categories":"devices,types,categories,category,icon",
                "/#device/types":"devices,types,category,sysoid,oid,enterprise,vendor",
                "/#device/zones":"zones,devices",
                "/#device/windows":"maintenance,windows,devices,outage,mtce",
                "/#device/metaTypes":"devices,types,metatype,label,tagging",
                "/#device/vendors":"vendor,devices,types,category,categories"
            }
        }
    },
    "type":"object"
}

Nested Schema : data

Type: object

Records

Example:

{
    "/#AAA/authTypes":"authentication,saml,ldap,sso,radius,active directory,security",
    "/#AAA/roles":"roles,user,acl,access control,aaa,rbac,security,permissions",
    "/#AAA/users":"users,accounts,password,operators",
    "/#AAA/userGroups":"users,groups,accounts,roles,properties,permissions,restrictions",
    "/#broker/applicationConfigTypes":"application,config,datatype,services,jobs",
    "/#broker/failoverStates":"servers,failover,service,state,status",
    "/#broker/jobs":"servers,jobs,scheduled,processes,scripts,logs,start",
    "/#broker/licenses":"license,licence,licensing",
    "/#package/depots":"packages,updates,upgrades,edge,stable,nightly",
    "/#broker/servers":"servers,updates,upgrades,versions,software,broker,roles",
    "/#broker/services":"servers,services,processes,scripts,running,applications,logs,stop,start,restart,pid",
    "/#dashboard/dashboards":"dashboards,portals,reports,panel",
    "/#dashboard/groups":"dashboards,portals,groups",
    "/#database/database":"databases,sql,mysql,neo4j,influx,query",
    "/#database/queries":"query,queries,databases,sql,reports",
    "/#database/queryTool":"query,queries,sql",
    "/#device/devices":"devices,catalog,inventory,discover",
    "/#device/groups":"groups,grouping,devices,category",
    "/#device/deviceManagement":"device,edit,multiple,management,bulk,change",
    "/#device/categories":"devices,types,categories,category,icon",
    "/#device/types":"devices,types,category,sysoid,oid,enterprise,vendor",
    "/#device/zones":"zones,devices",
    "/#device/windows":"maintenance,windows,devices,outage,mtce",
    "/#device/metaTypes":"devices,types,metatype,label,tagging",
    "/#device/vendors":"vendor,devices,types,category,categories"
}

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