Configuration and Content API Guide

Get Tags and Dietary Labels

post

/config/sim/v1/setup/getTags

Get Tags and Dietary Labels

Request

Supported Media Types

application/json
multipart/form-data

Root Schema : schema

Type: object

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
include: string

Objects included in the response.

Example: hierUnitId
includeAll: string

This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.

Example: detailed
languages: string

If specified, limits the translated strings returned.

Example: en-US, es-ES, es-MX
limit: integer

If using paging, number of results returned in this page.

Example: 10
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 values are hierUnitId, objectNum, name, tagGroupObjNum.

Example: objectNum:asc
searchCriteria: string

Search criteria to filter results based on field value. Allowed values are hierUnitId, objectNum, name, tagGroupObjNum.

Example: where equals(objectNum,1)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(objectNum,1)",
            "description":"Search criteria to filter results based on field value. Allowed values are hierUnitId, objectNum, name, tagGroupObjNum."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId",
            "description":"Objects included in the response."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n"
        },
        "languages":{
            "type":"string",
            "example":"en-US, es-ES, es-MX",
            "description":"If specified, limits the translated strings returned."
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index. Not required if paging parameters are not supported."
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"string",
            "example":"objectNum:asc",
            "description":"Sorts the response by the specified field name and sort order. Allowed values are hierUnitId, objectNum, name, tagGroupObjNum."
        },
        "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
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : TagsGetResponse

Type: object

Show Source

count: integer

Current response record count.

Example: 1
hasMore: boolean

Flag indicating if there are more objects to fetch.

Example: true
items: array items

Array of Tag objects.
limit: integer

Server page size

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: integer

Total number of rows (excluding the paging parameters)

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":1,
            "description":"Current response record count."
        },
        "items":{
            "type":"array",
            "description":"Array of Tag objects.",
            "items":{
                "$ref":"#/definitions/TagsGetResponseBody"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of Tag objects.

Show Source

Array of: object TagsGetResponseBody

Model for Tag Object

{
    "type":"array",
    "description":"Array of Tag objects.",
    "items":{
        "$ref":"#/definitions/TagsGetResponseBody"
    }
}

Nested Schema : TagsGetResponseBody

Type: object

Model for Tag Object

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: integer

Unique reference of the hierarchy unit where the Tag or the Dietary Label is configured. Only Enterprise hierUnitId is allowed.

Example: 3599
name: string

Minimum Length: 1

Maximum Length: 255

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

Example: Tag
objectNum: 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

{
    "description":"Model for Tag Object",
    "type":"object",
    "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
        },
        "objectNum":{
            "type":"integer",
            "description":"Object Number of a Tag or a Dietary Label.",
            "example":200
        },
        "name":{
            "description":"A string representing the name of the Tag or a Dietary Label.",
            "type":"string",
            "maxLength":255,
            "minLength":1,
            "example":"Tag"
        },
        "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
        }
    }
}