Get Tags and Dietary Labels
post
/config/sim/v2/setup/getTags
Get Tags and Dietary Labels
Request
Supported Media Types
- application/json
- multipart/form-data
Root Schema : schema
Type:
Show Source
object-
dietaryLabel:
integer
Default Value:
0A 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
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum, name -
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 returnedExample:
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 supportedExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order. Allowed values are hierUnitId, objectNum, name, tagGroupObjNum.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria. Allowed values are hierUnitId, objectNum, name, tagGroupObjNum.Example:
where equals(hierUnitId, 7)
Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : schema
Type:
Show Source
object-
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 sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Tag objects.
Show Source
-
Array of:
object TagsGetResponseBody
Model for Tag Object
Nested Schema : TagsGetResponseBody
Type:
objectModel for Tag Object
Show Source
-
dietaryLabel:
integer
Default Value:
0A 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:
1Maximum Length:255A 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