Описание: Список тегов, отсортированных по имени.
Метод: GET
Ресурс: event/tag
Параметры:
start- с какой позиции начать отдавать теги (по умолчанию 0)limit- сколько тегов отдавать (по умолчанию 100, не может быть больше 1000)
Ответ: Список тегов, описанный следующей JSON-Schema:
JSON схема отдачи списка тэгов
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Массив тегов",
"items": {
"type": "object",
"description": "Тег",
"properties": {
"TAG_ID": {
"type": "string",
"description": "Идентификатор"
},
"DISPLAY_NAME": {
"type": "string",
"description": "Имя"
},
"COLOR": {
"type": "string",
"description": "Цвет тега в HEX RGP, например #ffffff"
},
"CREATE_DATE": {
"type": "string",
"description": "Дата создания"
},
"IS_DELETED": {
"type": "integer",
"description": "Удален ли из активной конфигурации"
},
"IS_SYSTEM": {
"type": "integer",
"description": "Является ли тег системным"
}
},
"required": [
"TAG_ID",
"DISPLAY_NAME",
"COLOR",
"CREATE_DATE",
"IS_DELETED",
"IS_SYSTEM"
]
}
},
"meta": {
"description": "Дополнительные данные",
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"description": "Общее количество ОЗ"
},
"start": {
"type": "integer",
"description": "С какой позиции началось отдаваться"
},
"limit": {
"type": "integer",
"description": "Сколько всего отдалось"
}
},
"required": [
"totalCount",
"start",
"limit"
]
}
},
"required": [
"data",
"meta"
]
}
Пример:
Запрос
GET /xapi/event/tag?start=0&limit=10 X-API-Version: 1 X-API-CompanyId: iw X-API-ImporterName: aplab X-API-Auth-Token: gla20dos1pcdbr69caxz
Ответ
{
"data": [{
"TAG_ID": "0AF69DD5742E6977E0530100007F2BB700000000",
"DISPLAY_NAME": "VIP",
"COLOR": "#4e954e",
"CREATE_DATE": "2016-05-12 10:24:40.002673",
"IS_DELETED": 0,
"IS_SYSTEM": 1
}],
"meta": {
"totalCount": 1,
"start": 0,
"limit": 10
}
}