export_messages
Чтобы экспортировать в файл сообщения, загруженные в слой или по времени, используйте метод exchange/export_messages.
Конечная точка
svc=exchange/export_messages¶ms={
"layerName": <text>,
"format": <text>,
"itemId": <long>,
"timeFrom": <uint>,
"timeTo": <uint>,
"compress": <bool>
}
Метод относится к ресурсоемким запросам, поэтому на него распространяется ограничение на количество одновременно обрабатываемых ресурсоемких запросов в одной сессии. При превышении ограничения возвращается ошибка 1003 с причиной
LIMIT api_concurrent. Список ресурсоемких запросов см. в разделе Ограничения.
Параметры
Обязательные параметры отмечены звездочкой (*).
| Параметр | Описание |
|---|---|
layerName |
Имя слоя с сообщениями. Укажите для экспорта сообщений из слоя. |
itemId |
ID объекта. Укажите для экспорта сообщений без загрузки в слой. |
format* |
Формат файла: txt, kml, plt, wln или wlb. |
timeFrom |
Начало интервала. Укажите для экспорта сообщений без загрузки в слой. |
timeTo |
Конец интервала. Укажите для экспорта сообщений без загрузки в слой. |
compress* |
Укажите 1, чтобы получить сжатый файл, или 0, чтобы получить файл в несжатом виде. |
Ответ
Возвращается файл в указанном формате.
Если в параметрах запроса содержатся поля itemId, timeFrom, timeTo, format и compress, то по значению поля itemId определяется объект, а затем возвращаются его сообщения от timeFrom до timeTo. Поле layerName в этом случае не учитывается, даже если оно указано в запросе. Если же хотя бы одно из полей itemId, timeFrom, timeTo, format, compress отсутствует, то по значению поля layerName определяется слой, затем по слою определяется объект и возвращаются все его сообщения (в этом случае поля timeFrom и timeTo не учитываются). Таким образом, метод работает в двух режимах. Для первого необходимы поля itemId, timeFrom, timeTo, format и compress, а для второго — layerName, format и compress.
При неудачном выполнении возвращается код ошибки.
Коды ошибок
| Код ошибки | Описание |
|---|---|
| 1 | Неверный или устаревший SID запроса. |
| 4 | Одна из следующих ошибок:
|
| 6 | Одна из следующих ошибок:
|
| 7 | Одна из следующих ошибок:
|
| 1001 | У объекта нет сообщений за указанный период или за все время. |