Configuration and Content API Guide

Get Menu Level Entries

post

/config/sim/v2/setup/menuLevels/getMenuLevelEntries

Gets a list of all the menu levels entries for the specified menu level set

Request

Supported Media Types

application/json
multipart/form-data

Request body

Root Schema : schema

Type: object

Show Source

hierUnitId: integer

Unique reference of the hierarchy unit

Example: 1
include: string

If specified, limits the data returned to these fields.

Example: hierUnitId, objectNum, name
includeAll: string

If this value is specified, the include parameter is ignored.

Value Description

basic Forces the response to include all fields except option string details

detailed Forces the response to include all fields including option string details

Example: detailed
langIds: string

If specified, limits translated strings returned

Example: 1,2,3
limit: integer

If using paging, number of results returned in this page.

Example: 100
objectNum(required): integer

Object number of the menu level set

Example: 1
offset: integer

Starting resource record index. Not required if paging parameters are not supported

Example: 0
orderBy: string

Sorts the response by the specified field name and sort order.

Example: hierUnitId:asc
searchCriteria: string

If specified, returns records that match the criteria.

Example: where equals(hierUnitId, 7)

{
    "type":"object",
    "required":[
        "objectNum"
    ],
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(hierUnitId, 7)",
            "description":"If specified, returns records that match the criteria."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId, objectNum, name",
            "description":"If specified, limits the data returned to these fields."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"If this value is specified, the include parameter is ignored.\n<table>\n<tr>\n  <td><b>Value</b></td>\n  <td><b>Description</b></td>\n</tr>\n<tr>\n  <td>basic</td>\n  <td>Forces the response to include all fields except option string details</td>\n</tr>\n<tr>\n  <td>detailed</td>\n  <td>Forces the response to include all fields including option string details</td>\n</tr>\n</table>\n"
        },
        "langIds":{
            "type":"string",
            "description":"If specified, limits translated strings returned",
            "example":"1,2,3"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported",
            "example":0
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page.",
            "example":100
        },
        "orderBy":{
            "type":"string",
            "description":"Sorts the response by the specified field name and sort order.",
            "example":"hierUnitId:asc"
        },
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique reference of the hierarchy unit"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the menu level set"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A collection of menu level entries

Root Schema : schema

Type: object

Show Source

count: integer

Current response record count.

Example: 9
hasMore: boolean

Flag indicating if there are more objects to fetch.

Example: true
items: array items

Array of Menu Level Entry objects of the organization.
limit: integer

Server page size

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: integer

Total number of rows (excluding the paging parameters)

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":9,
            "description":"Current response record count."
        },
        "items":{
            "type":"array",
            "description":"Array of Menu Level Entry objects of the organization.",
            "items":{
                "$ref":"#/definitions/MenuLevelEntryv2"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of Menu Level Entry objects of the organization.

Show Source

Array of: object MenuLevelEntryv2

Model for a Menu Level Entry

{
    "type":"array",
    "description":"Array of Menu Level Entry objects of the organization.",
    "items":{
        "$ref":"#/definitions/MenuLevelEntryv2"
    }
}

Nested Schema : MenuLevelEntryv2

Type: object

Model for a Menu Level Entry

Show Source

hierUnitId: integer

Unique reference of the hierarchy unit

Example: 1
hierUnitObjNum: integer

Object number of the hierarchy unit

Example: 1
index: integer

Object number of the menu level entry

Example: 1
name: object name

Menu Level Entry Name
objectNum: integer

Object number of the menu level set

Example: 1
options: string

A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated

Example: 00000000
optionsExt: object OptionsExt_MenuLevelEntry

An object containing the descriptive options list associated with the Menu Level Entry
prefix: object prefix

Prefix
suffix: object suffix

Suffix

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique reference of the hierarchy unit"
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the hierarchy unit"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the menu level set"
        },
        "index":{
            "type":"integer",
            "example":1,
            "description":"Object number of the menu level entry"
        },
        "name":{
            "type":"object",
            "description":"Menu Level Entry Name",
            "example":{
                "1":"Enterprise",
                "2":"Unternehmen",
                "3":"Empresa"
            }
        },
        "prefix":{
            "type":"object",
            "description":"Prefix",
            "example":{
                "1":"Enterprise",
                "2":"Unternehmen",
                "3":"Empresa"
            }
        },
        "suffix":{
            "type":"object",
            "description":"Suffix",
            "example":{
                "1":"Enterprise",
                "2":"Unternehmen",
                "3":"Empresa"
            }
        },
        "options":{
            "type":"string",
            "example":"00000000",
            "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated"
        },
        "optionsExt":{
            "$ref":"#/definitions/OptionsExt_MenuLevelEntry"
        }
    },
    "description":"Model for a Menu Level Entry"
}

Nested Schema : name

Type: object

Menu Level Entry Name

Example:

{
    "1":"Enterprise",
    "2":"Unternehmen",
    "3":"Empresa"
}

Nested Schema : OptionsExt_MenuLevelEntry

Type: object

An object containing the descriptive options list associated with the Menu Level Entry

Show Source

anonymous: boolean

Select to mark this menu level as anonymous for the Menu Level Set.

Example: false
default: boolean

Select to mark this menu level as the default level for the Menu Level Set.

Example: false

{
    "type":"object",
    "properties":{
        "default":{
            "type":"boolean",
            "example":false,
            "description":"Select to mark this menu level as the default level for the Menu Level Set."
        },
        "anonymous":{
            "type":"boolean",
            "example":false,
            "description":"Select to mark this menu level as anonymous for the Menu Level Set."
        }
    },
    "description":"An object containing the descriptive options list associated with the Menu Level Entry"
}

Nested Schema : prefix

Type: object

Prefix

Example:

{
    "1":"Enterprise",
    "2":"Unternehmen",
    "3":"Empresa"
}

Nested Schema : suffix

Type: object

Suffix

Example:

{
    "1":"Enterprise",
    "2":"Unternehmen",
    "3":"Empresa"
}

Value	Description
basic	Forces the response to include all fields except option string details
detailed	Forces the response to include all fields including option string details