Wialon para desarrolladores Manual de usuario Documentación de API core update_data_flags

update_data_flags

Para agregar objetos a una sesión o eliminarlos de ella, utilice el método core/update_data_flags. Los objetos se agregan a una sesión para recibir eventos de ellos.

Endpoint

Copied!
svc=core/update_data_flags&params={
  "spec": [
    {
      "type": "<text>",
      "data": <long|text|[long]>,
      "flags": <long>,
      "mode": <uint>,
      "max_items": <uint>
    }
  ]
}

Parámetros

La solicitud debe contener los siguientes parámetros:

Parámetro Descripción
spec Matriz de objetos. Cada objeto describe qué objetos de la sesión cambiar y cómo.
type Método de transferencia de objetos a la sesión:
  • id: por ID. Indique el ID del objeto en el parámetro data.
  • type: por tipo. Indique el tipo de objetos en el parámetro data (consulte core/search_items).
  • col: por lista de ID. Indique la matriz de ID de los objetos en el parámetro data.
  • access: suscripción a los eventos sobre la creación y eliminación de objetos, y sobre la recepción y anulación de derechos de acceso a ellos. En el parámetro data, indique 1 para activar o 0 para desactivar.
data Datos. Depende del parámetro type.
flags Flags que determinan qué información sobre los objetos se agrega a la sesión. Los flags de objetos de cada tipo se describen en la sección Formato de datos.
mode Modo de aplicación de flags:
  • 0: determinar de nuevo los flags para los objetos indicados.
  • 1: agregar los flags indicados a los que ya están en la sesión.
  • 2: eliminar los flags indicados de la sesión. Al eliminar el flag básico, el objeto se elimina de la sesión.
Los flags determinan qué propiedades del objeto se siguen. Indique los flags que necesita; para recibir todos los eventos, indique todos los flags. Para recibir los eventos, utilice el método avl_evts.
max_items Cantidad máxima de objetos suscritos. Disponible solo si type es type.

Respuesta

Si la solicitud se completa correctamente, la respuesta se devuelve en el siguiente formato:

Copied!
[             /* Matriz de objetos. */
  {
    "i": <long>,  /* ID. */
    "d": {        /* Otros campos. */
      ...
    },
    "f": <long>   /* Flags aplicados. */
  },
  ...
]

El formato del campo d depende del tipo del objeto devuelto. d es null si la solicitud no agrega flags nuevos (por ejemplo, en el modo 2); los objetos cuyos flags no cambian se omiten. Los formatos de todos los tipos de objetos se describen en la sección Formato de datos.

Si la sesión tiene un límite de la cantidad de parámetros del mensaje, la solicitud devuelve los parámetros de la unidad cada vez que agrega el flag de los parámetros del mensaje en el modo 1. Para obtener más información, consulte Lista limitada de parámetros.

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

Códigos de error

Código de error Descripción
1 Sesión no válida.
4 Parámetros de entrada incorrectos o error al actualizar los flags.

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