Описание: Получение списка дополнительных полей события.
Метод: GET
Ресурс: event/header
Параметры:
start - с какой позиции начать отдавать заголовки, по-умолчанию 0limit - сколько заголовков отдавать, по-умолчанию 100, не может быть больше 1000Ответ: Список дополнительный полей, описанных следующей JSON схемой отдачи:
{ "$id": "http://infowatch.com/iwtm/xapi/event/header.json", "type": "object", "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "NAME": { "type": "string", "title": "Код атрибута, который будет использоваться в заголовках события и для идентификации в xAPI/PushAPI", "examples": [ "mac_level" ] }, "NOTE": { "type": "string", "title": "Отображаемое в консоли ТМ название атрибута", "examples": [ "Уровень мандатного доступа" ] }, "TYPE": { "type": "string", "title": "Одно из следующих значений: число (целое, дробное, строка), дата и время в UTC + указание смещение часового пояса, длительность, гиперссылка", "enum": [ "integer", "float", "string", "date", "UTC", "duration", "link" ] }, "IS_DELETED": { "type": "integer", "title": "Является ли заголовок удаленным из системы (у старых объектов он остаётся)", "default": 0, "enum": [ 0, 1 ] }, "FORMAT": { "type": "string", "title": "Тип значения (с версии 1.2)", "enum": [ "string", "date", "number" ] }, "IS_SYSTEM": { "type": "integer", "title": "Является ли заголовок системным (с версии 1.1)", "default": 1, "enum": [ 0, 1 ] }, "IS_MULTIPLE_VALUE": { "type": "integer", "title": "Может ли заголовок содержать несколько значений (с версии 1.1)", "default": 0, "enum": [ 0, 1 ] }, "locale": { "type": "array", "title": "Локализация для заголовков (с версии 1.2)", "items": { "type": "object", "title": "Локализация для заголовка", "properties": { "NAME": { "type": "string", "title": "Код атрибута, который будет использоваться в заголовках события и для идентификации в xAPI/PushAPI" }, "LANGUAGE": { "type": "string", "title": "Название языка", "enum": [ "rus", "eng" ] }, "DISPLAY_NAME": { "type": "string", "title": "Отображаемое в консоли ТМ название атрибута" } } } } } } }, "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/headerX-API-Version: 1.1X-API-CompanyId: iwX-API-ImporterName: domeX-API-Auth-Token: brse99dugp1cdbr69axz |
Ответ
{ "data": [ { "NAME": "device_type", "NOTE": "Тип устройства", "TYPE": "enum", "IS_DELETED": 0, "IS_SYSTEM": 1, "IS_MULTIPLE_VALUE": 0 }, { "NAME": "destination_type", "NOTE": "Тип источника сканирования", "TYPE": "enum", "IS_DELETED": 0, "IS_SYSTEM": 1, "IS_MULTIPLE_VALUE": 0 }, { "NAME": "destination_url", "NOTE": "URL", "TYPE": "string", "IS_DELETED": 0, "IS_SYSTEM": 1, "IS_MULTIPLE_VALUE": 0 }, { "NAME": "print_server", "NOTE": "Имя сервера печати", "TYPE": "string", "IS_DELETED": 0, "IS_SYSTEM": 1, "IS_MULTIPLE_VALUE": 0 }, { "NAME": "location", "NOTE": "Расположение принтера", "TYPE": "string", "IS_DELETED": 0, "IS_SYSTEM": 1, "IS_MULTIPLE_VALUE": 0 }, { "NAME": "comment", "NOTE": "Комментарий к принтеру", "TYPE": "string", "IS_DELETED": 0, "IS_SYSTEM": 1, "IS_MULTIPLE_VALUE": 0 }, { "NAME": "port_name", "NOTE": "Имя порта принтера", "TYPE": "string", "IS_DELETED": 0, "IS_SYSTEM": 1, "IS_MULTIPLE_VALUE": 0 }, { "NAME": "copies", "NOTE": "Количество копий", "TYPE": "number", "IS_DELETED": 0, "IS_SYSTEM": 1, "IS_MULTIPLE_VALUE": 0 }, { "NAME": "task_name", "NOTE": "Имя задания", "TYPE": "string", "IS_DELETED": 0, "IS_SYSTEM": 1, "IS_MULTIPLE_VALUE": 0 }, { "NAME": "print_task_name", "NOTE": "Имя задания на печать", "TYPE": "string", "IS_DELETED": 0, "IS_SYSTEM": 1, "IS_MULTIPLE_VALUE": 0 }, { "NAME": "task_run_date", "NOTE": "Дата запуска задания", "TYPE": "date", "IS_DELETED": 0, "IS_SYSTEM": 1, "IS_MULTIPLE_VALUE": 0 }, { "NAME": "create_date", "NOTE": "Дата создания файла", "TYPE": "date", "IS_DELETED": 0, "IS_SYSTEM": 1, "IS_MULTIPLE_VALUE": 0 }, { "NAME": "modify_date", "NOTE": "Дата модификации файла", "TYPE": "date", "IS_DELETED": 0, "IS_SYSTEM": 1, "IS_MULTIPLE_VALUE": 0 }, { "NAME": "source_ip", "NOTE": "IP адрес источника", "TYPE": "string", "IS_DELETED": 0, "IS_SYSTEM": 1, "IS_MULTIPLE_VALUE": 0 }, { "NAME": "workstation_type", "NOTE": "Тип рабочей станции", "TYPE": "enum", "IS_DELETED": 0, "IS_SYSTEM": 1, "IS_MULTIPLE_VALUE": 0 }, { "NAME": "application_path_from", "NOTE": "Путь к приложению из которого скопировано событие", "TYPE": "string", "IS_DELETED": 0, "IS_SYSTEM": 1, "IS_MULTIPLE_VALUE": 0 }, { "NAME": "application_path_to", "NOTE": "Путь к приложению в которое скопировано событие", "TYPE": "string", "IS_DELETED": 0, "IS_SYSTEM": 1, "IS_MULTIPLE_VALUE": 0 }, { "NAME": "terminal_session", "NOTE": "Признак терминальной сессии", "TYPE": "number", "IS_DELETED": 0, "IS_SYSTEM": 1, "IS_MULTIPLE_VALUE": 0 }, { "NAME": "emitter", "NOTE": "Источник события", "TYPE": "enum", "IS_DELETED": 0, "IS_SYSTEM": 1, "IS_MULTIPLE_VALUE": 0 }, { "NAME": "charset", "NOTE": "Кодировка текста вложения", "TYPE": "string", "IS_DELETED": 0, "IS_SYSTEM": 1, "IS_MULTIPLE_VALUE": 0 } ], "meta": { "totalCount": 20, "start": 0, "limit": 100 } } |