Configuration and Content API Guide

Get Tag Groups

post

/config/sim/v1/setup/getTagGroups

Request

Supported Media Types

application/json
multipart/form-data

The input Body model that needs to be given.

Root Schema : schema

Type: object

Show Source

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.

Example: objectNum:asc
searchCriteria: string

Search criteria to filter results based on field value.

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."
        },
        "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."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A collection of Tag Groups.

Root Schema : TagGroupsGetResponse

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 Group objects of the organization.
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 Group objects of the organization.",
            "items":{
                "$ref":"#/definitions/TagGroups"
            }
        },
        "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 Group objects of the organization.

Show Source

Array of: object TagGroups

Model for Tag Groups Object

{
    "type":"array",
    "description":"Array of Tag Group objects of the organization.",
    "items":{
        "$ref":"#/definitions/TagGroups"
    }
}

Nested Schema : TagGroups

Type: object

Model for Tag Groups Object

Show Source

hierUnitId: integer

Unique reference of the hierarchy unit where the Tag Groups is configured. Only root hierUnitId is allowed.

Example: 3599
objectNum: integer

Object Number of the Tag Groups.

Example: 1
tagGroupName: string

A string representing the name of the Tag Group

Example: Tag Group 1

{
    "description":"Model for Tag Groups Object",
    "type":"object",
    "properties":{
        "objectNum":{
            "description":"Object Number of the Tag Groups.",
            "type":"integer",
            "example":1
        },
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit where the Tag Groups is configured. Only root hierUnitId is allowed.",
            "type":"integer",
            "example":3599
        },
        "tagGroupName":{
            "description":"A string representing the name of the Tag Group",
            "type":"string",
            "example":"Tag Group 1"
        }
    }
}