export_file
Para exportar los resultados de una búsqueda de elementos a un archivo XLSX, utilice el método core/export_file.
El método busca elementos según los criterios de spec de la misma manera que core/search_items. Si en la misma sesión se llamó antes a core/search_items con los mismos criterios, el método utiliza su resultado en lugar de volver a realizar la búsqueda, a menos que force sea 1. El archivo incluye todos los elementos encontrados, no solo una página de resultados.
Endpoint
svc=core/export_file¶ms={
"spec": {
"itemsType": "<text>",
"propName": "<text>",
"propValueMask": "<text>",
"sortType": "<text>"
},
"force": <uint>,
"flags": <long> /* Flags de columnas. */
}
Parámetros
Los parámetros spec y force se describen en la página core/search_items.
El parámetro flags determina qué columnas se incluyen en el archivo. Los flags disponibles dependen del valor de itemsType.
Usuarios (user)
| Valor | Descripción |
|---|---|
0x0001 |
Nombre. |
0x0002 |
Creador. |
0x0004 |
Cuenta. |
0x0008 |
Plan de facturación. |
0x0010 |
Última visita. |
0x0020 |
Email. |
0x0040 |
Máscara de IP. |
0x0080 |
Tipo de autenticación. |
0x0100 |
Número de teléfono para la autenticación de dos factores. |
0x0200 |
Estado: si la opción Habilitado está activada en las propiedades del usuario. |
0x0400 |
Permiso para cambiar la contraseña. |
0x0800 |
Permiso para crear elementos. |
0x1000 |
Permiso para cambiar los ajustes. |
0x2000 |
Permiso para enviar SMS. |
0x4000 |
Zona horaria. |
Unidades (avl_unit)
| Valor | Descripción |
|---|---|
0x0001 |
Nombre. |
0x0002 |
Creador. |
0x0004 |
Cuenta. |
0x0008 |
Tipo de dispositivo. |
0x0010 |
ID único. |
0x0020 |
Teléfono. |
0x0040 |
Último mensaje. |
0x0080 |
Fecha de creación. |
0x0100 |
Campos personalizados. |
0x0200 |
Grupos. |
0x0400 |
Desactivación. |
Grupos de unidades (avl_unit_group)
| Valor | Descripción |
|---|---|
0x0001 |
Nombre. |
0x0002 |
Creador. |
0x0004 |
Cuenta. |
0x0008 |
Unidades. |
Cuentas (avl_resource)
| Valor | Descripción |
|---|---|
0x0001 |
Nombre. |
0x0002 |
Creador. |
0x0004 |
Cuenta principal. |
0x0008 |
Plan de facturación. |
0x0010 |
Derechos de distribuidor. |
0x0020 |
Unidades. |
0x0040 |
Saldo. |
0x0080 |
Días. |
0x0100 |
Estado. |
0x0200 |
Bloqueada. |
0x0400 |
Unidades activadas. |
Repetidores (avl_retranslator)
| Valor | Descripción |
|---|---|
0x0001 |
Nombre. |
0x0002 |
Creador. |
0x0004 |
Cuenta. |
0x0008 |
Protocolo. |
0x0010 |
Servidor. |
0x0020 |
Estado. |
0x0040 |
Unidades para retransmisión. |
0x0080 |
ID único de la unidad. |
Respuesta
Si la solicitud se completa con éxito, se devuelve un archivo XLSX.
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, error al obtener el usuario actual o error en la búsqueda. |
| 5 | Error al crear el archivo. |