Описание : Список ОЗ, отсортированный по имени.
Метод: GET
Ресурс: event/protectedDocument
Параметры:
start - с какой позиции начать отдавать ОЗ, по-умолчанию 0limit - сколько ОЗ отдавать, по-умолчанию 100, не может быть больше 1000with[] — список дополнительных сущностей, которые должны быть добавлены к ОЗ:pd2pc — связь объекта защиты к каталогу объекта защиты
Ответ: Список ОЗ, описанный следующей JSON схемой отдачи списка ОЗ:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Массив ОЗ",
"items": {
"type": "object",
"description": "ОЗ",
"properties": {
"DOCUMENT_ID": {
"type": "string",
"description": "Идентификатор"
},
"DISPLAY_NAME": {
"type": "string",
"description": "Имя"
},
"CREATE_DATE": {
"type": "string",
"description": "Дата создания"
},
"IS_DELETED": {
"type": "integer",
"description": "Удален ли из активной конфигурации",
"enum": [
0,
1
]
},
"pd2pc": {
"description": "Массив связи с каталогами ОЗ",
"type": "array",
"items": {
"description": "Связь с каталогом ОЗ",
"type": "object",
"required": [
"CATALOG_ID",
"DOCUMENT_ID"
],
"properties": {
"CATALOG_ID": {
"description": "Уникальный идентификатор каталога ОЗ",
"type": "string"
},
"DOCUMENT_ID": {
"description": "Уникальный идентификатор ОЗ",
"type": "string"
}
}
}
}
},
"required": [
"DOCUMENT_ID",
"DISPLAY_NAME",
"CREATE_DATE",
"IS_DELETED"
]
}
},
"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/protectedDocument?start=0&limit=10
X-API-Version: 1
X-API-CompanyId: iw
X-API-ImporterName: dome
X-API-Auth-Token: brse99dugp1cdbr69axz
|
Ответ
{
"data": [{
"DOCUMENT_ID": "C78E821A67C7F34A1B1D63A4151CEF6300000000",
"DISPLAY_NAME": "Грифованная информация",
"CREATE_DATE": "2016-05-12 10:24:41.342554",
"IS_DELETED": 0
}],
"meta": {
"totalCount": 1,
"start": 0,
"limit": 10
}
}
|