Jump to

• Request
• Response

Upsert Combo Side Groups Lite

post

/config/sim/v2/menuItems/upsertComboSideGroupsLite

Updates provided fields if comboMealGroupId is specified in the request body, else inserts a new combo side group.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

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

Body ()

Upsert Request body

Root Schema : schema

Type: object

Show Source

• alternateGroups: array alternateGroups
  An array of alternate groups associated with combo side group.
• comboMealGroupId: integer
  Unique ID of combo side group. Required to update an existing combo side group.

  Example: 2
• hierUnitId(required): integer
  Unique hierarchy unit value.

  Example: 2
• name: object name
  Name of the combo side group. Required to insert a new combo side group.
• objectNum: integer
  Object number of the combo side group. Required to insert a new combo side group.

  Example: 1
• options: string
  A string value of 0s & 1s of length 8 representing enabled or disabled options

  Example: 00000000

{
    "type":"object",
    "required":[
        "hierUnitId"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique hierarchy unit value."
        },
        "comboMealGroupId":{
            "type":"integer",
            "example":2,
            "description":"Unique ID of combo side group. Required to update an existing combo side group."
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the combo side group. Required to insert a new combo side group."
        },
        "name":{
            "type":"object",
            "description":"Name of the combo side group. Required to insert a new combo side group.",
            "example":{
                "1":"Enterprise",
                "2":"Unternehmen",
                "3":"Empresa"
            }
        },
        "options":{
            "type":"string",
            "example":"00000000",
            "description":"A string value of 0s & 1s of length 8 representing enabled or disabled options"
        },
        "alternateGroups":{
            "type":"array",
            "description":"An array of alternate groups associated with combo side group.",
            "items":{
                "type":"object",
                "properties":{
                    "sequenceNum":{
                        "type":"integer",
                        "example":1,
                        "description":"Sequence number of the alternate combo side group."
                    },
                    "alternateGroupObjNum":{
                        "type":"integer",
                        "example":2,
                        "description":"Object number of the alternate combo side group."
                    }
                }
            }
        }
    }
}

Nested Schema : alternateGroups

Type: array

An array of alternate groups associated with combo side group.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"An array of alternate groups associated with combo side group.",
    "items":{
        "type":"object",
        "properties":{
            "sequenceNum":{
                "type":"integer",
                "example":1,
                "description":"Sequence number of the alternate combo side group."
            },
            "alternateGroupObjNum":{
                "type":"integer",
                "example":2,
                "description":"Object number of the alternate combo side group."
            }
        }
    }
}

Nested Schema : name

Type: object

Name of the combo side group. Required to insert a new combo side group.

Example:

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

Nested Schema : items

Type: object

Show Source

• alternateGroupObjNum: integer
  Object number of the alternate combo side group.

  Example: 2
• sequenceNum: integer
  Sequence number of the alternate combo side group.

  Example: 1

{
    "type":"object",
    "properties":{
        "sequenceNum":{
            "type":"integer",
            "example":1,
            "description":"Sequence number of the alternate combo side group."
        },
        "alternateGroupObjNum":{
            "type":"integer",
            "example":2,
            "description":"Object number of the alternate combo side group."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Combo Side Group Updated.

Body ()

Root Schema : schema

Type: object

Show Source

• comboMealGroupId: integer
  Unique ID of combo side group.

  Example: 2
• hierUnitId: integer
  Unique hierarchy unit value.

  Example: 1
• objectNum: integer
  Object number of the combo side group.

  Example: 2

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value."
        },
        "objectNum":{
            "type":"integer",
            "example":2,
            "description":"Object number of the combo side group."
        },
        "comboMealGroupId":{
            "type":"integer",
            "example":2,
            "description":"Unique ID of combo side group."
        }
    }
}

201 Response

Combo Side Group Added.

Body ()

Root Schema : schema

Type: object

Show Source

• comboMealGroupId: integer
  Unique ID of combo side group.

  Example: 2
• hierUnitId: integer
  Unique hierarchy unit value.

  Example: 1
• objectNum: integer
  Object number of the combo side group.

  Example: 2

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value."
        },
        "objectNum":{
            "type":"integer",
            "example":2,
            "description":"Object number of the combo side group."
        },
        "comboMealGroupId":{
            "type":"integer",
            "example":2,
            "description":"Unique ID of combo side group."
        }
    }
}

Back to Top