Show Source

• dietaryLabel: integer
  Default Value: 0

  A flag indicating a dietary label when set to 1. Permissible values are 0 and 1. It cannot be updated once set. Introduced in C&C API v23.7.

  Example: 1
• hierUnitId(required): integer
  Unique reference of the hierarchy unit where the Tag or the Dietary Label is configured. Only Enterprise hierUnitId is allowed.

  Example: 3599
• name(required): string
  Minimum Length: 1

  Maximum Length: 255

  A string representing the name of the Tag or the Dietary Label.

  Example: Tag
• objectNum(required): integer
  Object Number of a Tag or a Dietary Label.

  Example: 200
• tagGroupObjNum: integer
  Object number of the Tag Group associated with the tag. It must not be included in the Insert request body and is ignored in the Update request body when dietaryLabel is set to 1.

  Example: 5

{
    "type":"object",
    "required":[
        "hierUnitId",
        "name",
        "objectNum"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit where the Tag or the Dietary Label is configured. Only Enterprise hierUnitId is allowed.",
            "type":"integer",
            "example":3599
        },
        "name":{
            "description":"A string representing the name of the Tag or the Dietary Label.",
            "type":"string",
            "maxLength":255,
            "minLength":1,
            "example":"Tag"
        },
        "objectNum":{
            "type":"integer",
            "description":"Object Number of a Tag or a Dietary Label.",
            "example":200
        },
        "tagGroupObjNum":{
            "type":"integer",
            "description":"Object number of the Tag Group associated with the tag. It must not be included in the Insert request body and is ignored in the Update request body when dietaryLabel is set to 1.",
            "example":5
        },
        "dietaryLabel":{
            "type":"integer",
            "default":0,
            "description":"A flag indicating a dietary label when set to 1. Permissible values are 0 and 1. It cannot be updated once set. Introduced in C&C API v23.7.",
            "example":1
        }
    }
}