export_messages

To export messages (loaded to a layer or directly) to a file, use the exchange/export_messages method.

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

The method is a resource-intensive request, so the limit on simultaneous resource-intensive requests during one session applies to it. If the limit is reached, the error 1003 with the LIMIT api_concurrent reason is returned. For the list of resource-intensive requests, see Limitations.

The required parameters are marked with an asterisk (*).

Returns a file of the specified format.

If the request parameters have the itemId, timeFrom, timeTo, format, and compress fields, the unit is obtained by the value of the itemId field and then the unit messages from timeFrom to timeTo are returned. The layerName field is ignored in this case, even if it is specified in the request. Otherwise (if at least one of the itemId, timeFrom, timeTo, format, and compress fields is missing), the layer is obtained by the value of the layerName field; after that, the unit is obtained from the layer and all the unit messages are returned (in this case the timeFrom and timeTo fields are ignored). In other words, the method operates in two modes. The first one requires the itemId, timeFrom, timeTo, format, and compress fields; the second one requires the layerName, format, and compress fields.

If the request fails, an error code is returned.