Jump to

• Request
• Response

Update Nutrient

post

/config/sim/v2/menuItems/nutrientSets/updateNutrients

Updates an existing nutrient in the nutrient set

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

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

Body ()

Nutrient update request body.

Root Schema : schema

Type: object

Show Source

• hierUnitId(required): integer
  Unique reference of the hierarchy unit. Only Enterprise hierarchy is allowed.

  Example: 3599
• nutrientSetNutrientId(required): integer
  Unique Id of the nutrient.

  Example: 101
• nutritionNameObjNum: integer
  Default Value: 0

  Object number of the nutrition name.

  Example: 8
• quantity: integer
  Default Value: 0

  quantity of the nutrient.

  Example: 10
• unitOfMeasure: integer
  Minimum Value: 1

  Maximum Value: 4

  Default Value: 1

  An integer representing the unit of measurement for quantity. Acceptable values range from 1 to 4 (both inclusive).

  Unit Of Measurement	Description
  1	Calories
  2	KiloJoules
  3	Grams
  4	Milligrams

  Example: 2

{
    "type":"object",
    "required":[
        "hierUnitId",
        "nutrientSetNutrientId"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit. Only Enterprise hierarchy is allowed.",
            "type":"integer",
            "example":3599
        },
        "nutrientSetNutrientId":{
            "description":"Unique Id of the nutrient.",
            "type":"integer",
            "example":101
        },
        "nutritionNameObjNum":{
            "description":"Object number of the nutrition name.",
            "default":0,
            "type":"integer",
            "example":8
        },
        "unitOfMeasure":{
            "description":"An integer representing the unit of measurement for quantity. Acceptable values range from 1 to 4 (both inclusive). <table> <tr><th>Unit Of Measurement</th><th>Description</th></tr> <tr><td> 1 </td><td> Calories </td></tr> <tr><td> 2 </td><td> KiloJoules </td></tr> <tr><td> 3 </td><td> Grams </td></tr> <tr><td> 4 </td><td> Milligrams </td></tr> </table>",
            "type":"integer",
            "minimum":1,
            "maximum":4,
            "default":1,
            "example":2
        },
        "quantity":{
            "description":"quantity of the nutrient.",
            "default":0,
            "type":"integer",
            "example":10
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Nutrient updated.

Body ()

Root Schema : schema

Type: object

Show Source

• nutrientSetNutrientId: integer
  Unique Id of the nutrient.

  Example: 101

{
    "type":"object",
    "properties":{
        "nutrientSetNutrientId":{
            "description":"Unique Id of the nutrient.",
            "type":"integer",
            "example":101
        }
    }
}

Back to Top