Configuration and Content API Guide

Get Nutrient Sets

post

/config/sim/v2/menuItems/getNutrientSets

Gets all the Nutrient Sets

Request

Supported Media Types

application/json
multipart/form-data

Root Schema : schema

Type: object

Show Source

include: string

If specified, limits the data returned to these fields.

Example: hierUnitId, objectNum
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
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. Allowed fields are objectNum, name.

Example: objectNum:asc
searchCriteria: string

If specified, returns records that match the criteria. Allowed fields are objectNum, name.

Example: where equals(objectNum, 45)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(objectNum, 45)",
            "description":"If specified, returns records that match the criteria. Allowed fields are objectNum, name."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId, objectNum",
            "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. Allowed fields are objectNum, name.",
            "example":"objectNum:asc"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: object

Show Source

count: integer

Number of records returned on this page

Example: 10
hasMore: boolean

Indicates whether there are additional pages of records

Example: true
items: array items

Nutrient Set records
limit: integer

The maximum number of records returned on a page

Example: 10
offset: integer

The page number of this data. Starts at 0.

Example: 0
totalResults: integer

Total number of records in the data set

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "description":"Total number of records in the data set",
            "type":"integer",
            "example":100
        },
        "hasMore":{
            "description":"Indicates whether there are additional pages of records",
            "type":"boolean",
            "example":true
        },
        "count":{
            "description":"Number of records returned on this page",
            "type":"integer",
            "example":10
        },
        "offset":{
            "description":"The page number of this data. Starts at 0.",
            "type":"integer",
            "example":0
        },
        "limit":{
            "description":"The maximum number of records returned on a page",
            "type":"integer",
            "example":10
        },
        "items":{
            "description":"Nutrient Set records",
            "type":"array",
            "items":{
                "$ref":"#/definitions/NutrientSet"
            }
        }
    }
}

Nested Schema : items

Type: array

Nutrient Set records

Show Source

Array of: object NutrientSet

Nutrient Set record

{
    "description":"Nutrient Set records",
    "type":"array",
    "items":{
        "$ref":"#/definitions/NutrientSet"
    }
}

Nested Schema : NutrientSet

Type: object

Nutrient Set record

Show Source

hierUnitId: integer

Unique reference of the hierarchy unit. Only Enterprise hierarchy is allowed.

Example: 3599
name: object name

Name of the Nutrient Set
nutrients: array nutrients

An array of nutrients belonging to the nutrient set.
objectNum: integer

Object number of the nutrient set.

Example: 10

{
    "description":"Nutrient Set record",
    "type":"object",
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit. Only Enterprise hierarchy is allowed.",
            "type":"integer",
            "example":3599
        },
        "objectNum":{
            "description":"Object number of the nutrient set.",
            "type":"integer",
            "example":10
        },
        "name":{
            "type":"object",
            "description":"Name of the Nutrient Set",
            "example":{
                "1":"Entp",
                "2":"Untm",
                "3":"Emp"
            }
        },
        "nutrients":{
            "type":"array",
            "description":"An array of nutrients belonging to the nutrient set.",
            "items":{
                "type":"object",
                "description":"A nutrient belonging to the nutrient set.",
                "properties":{
                    "nutrientSetNutrientId":{
                        "description":"Unique Id of the nutrient.",
                        "type":"integer",
                        "example":101
                    },
                    "nutritionNameObjNum":{
                        "description":"Object number of the nutrition name.",
                        "type":"integer",
                        "example":8
                    },
                    "unitOfMeasure":{
                        "description":"An integer representing the unit of measurement for quantity. <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",
                        "example":2
                    },
                    "quantity":{
                        "description":"quantity of the nutrient.",
                        "type":"integer",
                        "example":10
                    }
                }
            }
        }
    }
}

Nested Schema : name

Type: object

Name of the Nutrient Set

Example:

{
    "1":"Entp",
    "2":"Untm",
    "3":"Emp"
}

Nested Schema : nutrients

Type: array

An array of nutrients belonging to the nutrient set.

Show Source

Array of: object items

A nutrient belonging to the nutrient set.

{
    "type":"array",
    "description":"An array of nutrients belonging to the nutrient set.",
    "items":{
        "type":"object",
        "description":"A nutrient belonging to the nutrient set.",
        "properties":{
            "nutrientSetNutrientId":{
                "description":"Unique Id of the nutrient.",
                "type":"integer",
                "example":101
            },
            "nutritionNameObjNum":{
                "description":"Object number of the nutrition name.",
                "type":"integer",
                "example":8
            },
            "unitOfMeasure":{
                "description":"An integer representing the unit of measurement for quantity. <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",
                "example":2
            },
            "quantity":{
                "description":"quantity of the nutrient.",
                "type":"integer",
                "example":10
            }
        }
    }
}

Nested Schema : items

Type: object

A nutrient belonging to the nutrient set.

Show Source

nutrientSetNutrientId: integer

Unique Id of the nutrient.

Example: 101
nutritionNameObjNum: integer

Object number of the nutrition name.

Example: 8
quantity: integer

quantity of the nutrient.

Example: 10
unitOfMeasure: integer

An integer representing the unit of measurement for quantity.

Unit Of Measurement Description

1 Calories

2 KiloJoules

3 Grams

4 Milligrams

Example: 2

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

{
    "type":"object",
    "description":"A nutrient belonging to the nutrient set.",
    "properties":{
        "nutrientSetNutrientId":{
            "description":"Unique Id of the nutrient.",
            "type":"integer",
            "example":101
        },
        "nutritionNameObjNum":{
            "description":"Object number of the nutrition name.",
            "type":"integer",
            "example":8
        },
        "unitOfMeasure":{
            "description":"An integer representing the unit of measurement for quantity. <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",
            "example":2
        },
        "quantity":{
            "description":"quantity of the nutrient.",
            "type":"integer",
            "example":10
        }
    }
}

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