multi_export
El método exchange/multi_export permite exportar unidades y grupos de unidades a un archivo ZIP, junto con sus mensajes si es necesario. Para crear unidades a partir de este archivo, use el método exchange/multi_import.
Para utilizar el método, el servicio Importar/Exportar debe estar habilitado para la cuenta. Cada ID especificado en el parámetro ids cuenta como un uso del servicio.
En Wialon Local, este método está disponible a partir de la versión 2304.
Endpoint
svc=exchange/multi_export¶ms={
"ids": [<long>],
"props": <uint>,
"time_from": <uint>,
"time_to": <uint>
}
El método es una solicitud que consume muchos recursos, por lo que se le aplica la restricción de solicitudes simultáneas de este tipo durante una sesión. Si se alcanza la restricción, se devuelve el error 1003 con la causa
LIMIT api_concurrent. Para ver la lista de solicitudes que consumen muchos recursos, consulte Restricciones.
Parámetros
Los parámetros obligatorios están marcados con un asterisco (*).
| Parámetro | Descripción |
|---|---|
ids* |
Array de ID de unidades y grupos de unidades. Para un grupo de unidades, se exportan todas sus unidades. Cada unidad se exporta una sola vez, aunque se especifique varias veces o pertenezca a varios grupos. |
props |
Propiedades de la unidad que se deben exportar. El valor es la suma de los flags de propiedades. El valor predeterminado es 0xFFFF (todas las propiedades). |
time_from |
Inicio del intervalo para el que se exportan los mensajes de la unidad (tiempo UNIX). |
time_to |
Fin del intervalo para el que se exportan los mensajes de la unidad (tiempo UNIX). |
Los mensajes se exportan solo si se especifican tanto time_from como time_to. Si falta uno de ellos, solo se exportan las propiedades de la unidad.
Flags de propiedades
En la tabla a continuación se muestran los flags disponibles y los derechos de acceso a la unidad que se requieren para exportar las propiedades correspondientes.
| Flag | Propiedades | Derecho de acceso requerido |
|---|---|---|
0x1 |
Propiedades básicas. | Ver objeto y sus propiedades básicas |
0x2 |
Sensores. | Ver objeto y sus propiedades básicas |
0x4 |
Campos personalizados. | Ver campos personalizados |
0x8 |
Campos administrativos. | Ver campos administrativos |
0x10 |
Comandos. | Ver comandos |
0x20 |
Intervalos de servicio. | Ver intervalos de servicio |
0x40 |
Perfil. | Ver campos personalizados |
0x80 |
Contadores. | Ver objeto y sus propiedades básicas |
0x100 |
Configuración del dispositivo. | Modificar propiedades de conexión |
0x200 |
Configuración de informes. | Ver detalle de propiedades del objeto |
0x400 |
Propiedades avanzadas. | Ver detalle de propiedades del objeto |
0x800 |
Configuración de detección de viajes. | Ver detalle de propiedades del objeto |
0x1000 |
Configuración de conducción eficiente. | Ver detalle de propiedades del objeto |
0x2000 |
Ícono de la unidad. Se exporta solo junto con el flag 0x1, 0x2 o 0x80. |
Ver objeto y sus propiedades básicas |
La configuración del consumo de combustible siempre se exporta.
Si no tiene el derecho de acceso requerido para un flag, las propiedades correspondientes no se exportan y no se devuelve ningún error. Si no tiene derechos de acceso a ninguna de las propiedades solicitadas, la unidad no se exporta. Para exportar los mensajes de la unidad, se requiere el derecho de acceso Exportar mensajes.
Respuesta
Si la solicitud se completa correctamente, se devuelve el archivo comprimido multi_export.zip. Para cada unidad, el archivo comprimido contiene los siguientes archivos:
| Archivo | Contenido |
|---|---|
<nombre de la unidad>_<ID de la unidad>.wlp |
Propiedades de la unidad. |
<nombre de la unidad>_<ID de la unidad>.wlb |
Mensajes de la unidad. El archivo se agrega solo si se especifica el intervalo y la unidad tiene mensajes en este intervalo. |
En los nombres de los archivos, los caracteres / del nombre de la unidad se reemplazan por _.
Si la solicitud falla, se devuelve un código de error.
Códigos de error
| Código de error | Descripción |
|---|---|
| 4 | Parámetros de entrada incorrectos. |
| 6 | No se exportó ninguna unidad. Por ejemplo, los ID especificados no pertenecen a unidades ni a grupos de unidades, el usuario no tiene derechos de acceso a las unidades o el servicio Importar/Exportar no está disponible para la cuenta. |
| 1003 | Se alcanzó la restricción de solicitudes simultáneas que consumen muchos recursos (causa LIMIT api_concurrent). |