export_messages

Para exportar mensajes (cargados en una capa o directamente) a un archivo, use el método exchange/export_messages.

Endpoint

Copied!
svc=exchange/export_messages&params={
  "layerName": <text>,
  "format": <text>,
  "itemId": <long>,
  "timeFrom": <uint>,
  "timeTo": <uint>,
  "compress": <bool>
}

Parámetros

Los parámetros obligatorios están marcados con un asterisco (*).

Parámetro Descripción
layerName Nombre de la capa de mensajes. Especifíquelo para exportar mensajes desde una capa.
itemId ID de la unidad en el sistema. Especifíquelo para exportar mensajes directamente.
format* Formato del archivo: txt, kml, plt, wln o wlb.
timeFrom Inicio del intervalo. Especifíquelo para exportar mensajes directamente.
timeTo Fin del intervalo. Especifíquelo para exportar mensajes directamente.
compress* Especifique 1 para comprimir el archivo o 0 para obtener el archivo sin comprimir.

Respuesta

Se devuelve un archivo del formato especificado.

Si en la solicitud se especifican los campos itemId, timeFrom, timeTo, format y compress a la vez, la unidad se obtiene según el valor de itemId y, a continuación, se obtienen los mensajes de la unidad desde timeFrom hasta timeTo y se devuelven en la respuesta. En este caso, el campo layerName se ignora, aunque se haya especificado en la solicitud. De lo contrario, si falta al menos uno de los campos itemId, timeFrom, timeTo, format y compress en la solicitud, la capa se obtiene según el valor de layerName y, después, la unidad se obtiene de la capa y se devuelven todos sus mensajes. En este caso, los campos timeFrom y timeTo se ignoran. En otras palabras, el método funciona en dos modos. El primer modo requiere los valores de itemId, timeFrom, timeTo, format y compress en la solicitud. El segundo modo requiere los valores de layerName, format y compress en la solicitud.

Si la solicitud falla, se devuelve un código de error.

Códigos de error

Código de error Descripción
1 SID de solicitud no válido u obsoleto.
4 Uno de los siguientes errores:
  • error de validación de parámetros;
  • no se encontró la capa;
  • no se pudieron guardar los mensajes en el archivo temporal.
6 Uno de los siguientes errores:
  • no se pudo obtener el usuario;
  • no se pudo obtener el renderizador;
  • problemas relacionados con la compresión.
7 Uno de los siguientes errores:
  • no se encontró la unidad;
  • el usuario no tiene el derecho de acceso requerido a la unidad: Solicitar informes y mensajes para el primer modo, Exportar mensajes para el segundo modo.
1001 La unidad no tiene mensajes en el intervalo especificado o no tiene ningún mensaje.

Si nota un error en el texto, por favor resáltelo y presione Ctrl+Intro.