Jump to

• Request
• Response

Add Menu Level Entries

post

/config/sim/v2/setup/menuLevels/menuLevelEntries

Add a Menu Level Entry for the specified menu level set

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string
  Detail that identifies, who made the change.

Body ()

Request body

Root Schema : schema

Type: object

Model for a Menu Level Entry CUD Request

Show Source

• hierUnitId(required): integer
  Unique reference of the hierarchy unit

  Example: 1
• index(required): integer
  Object number of the menu level entry

  Example: 1
• name(required): object name
  Menu Level Entry Name
• objectNum(required): 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
• prefix: object prefix
  Prefix for Menu Level Entry
• suffix: object suffix
  Suffix for Menu Level Entry

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "index",
        "name"
    ],
    "properties":{
        "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"
        },
        "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 for Menu Level Entry",
            "example":{
                "1":"Enterprise",
                "2":"Unternehmen",
                "3":"Empresa"
            }
        },
        "suffix":{
            "type":"object",
            "description":"Suffix for Menu Level Entry",
            "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"
        }
    },
    "description":"Model for a Menu Level Entry CUD Request"
}

Nested Schema : name

Type: object

Menu Level Entry Name

Example:

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

Nested Schema : prefix

Type: object

Prefix for Menu Level Entry

Example:

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

Nested Schema : suffix

Type: object

Suffix for Menu Level Entry

Example:

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Menu Level Entry Added.

Body ()

Root Schema : schema

Type: object

Model for a Menu Level Entry Response

Show Source

• hierUnitId: integer
  Unique reference of the hierarchy unit

  Example: 1
• index: integer
  Object number of the menu level entry

  Example: 1
• objectNum: integer
  Object number of the menu level set

  Example: 1

{
    "type":"object",
    "properties":{
        "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"
        },
        "index":{
            "type":"integer",
            "example":1,
            "description":"Object number of the menu level entry"
        }
    },
    "description":"Model for a Menu Level Entry Response"
}

Back to Top