Azure IoT Central V3 (versión preliminar)
Azure IoT Central facilita la conexión, supervisión y administración de los dispositivos IoT a escala. Con el conector de IoT Central V3, puede desencadenar flujos de trabajo cuando se ha desencadenado una regla y realizar acciones mediante la ejecución de comandos, la actualización de propiedades, la obtención de telemetría de los dispositivos, etc. Use este conector con la aplicación Azure IoT Central V3.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Soporte técnico de Azure IoT Central |
| URL | https://aka.ms/iotcentral-create-technical-support-ticket-trial |
| Metadatos del conector | |
|---|---|
| Publicador | Microsoft Corporation |
| Sitio web | https://azure.microsoft.com/services/iot-central/ |
| Directiva de privacidad | https://privacy.microsoft.com |
| Categorías | Internet de las cosas |
El conector de Azure IoT Central V3 se puede usar para conectar la aplicación de Azure IoT Central V3 a los flujos de trabajo. Puede usar el conector para ejecutar flujos de trabajo cuando se desencadena una regla. Puede usarlo para obtener la información más reciente de los dispositivos IoT, como datos de telemetría y propiedades. También puede usarlo para actualizar los dispositivos IoT mediante el envío de comandos y la actualización de los sitios adecuados.
Prerrequisitos
- Debe ser un usuario de una aplicación de pago porYou-Go de Azure IoT Central V3 para usar este conector.
- Debe usar una cuenta profesional o educativa de Microsoft Entra ID.
Obtención de credenciales
Para agregar este conector al flujo de trabajo, primero debe iniciar sesión en la cuenta profesional o educativa de Microsoft Entra ID que sea un usuario de la aplicación de Azure IoT Central a la que desea conectarse.
Notas de lanzamiento
Septiembre de 2021
- El conector de Azure IoT Central V3 ahora se ha actualizado para alinearse con nuestra superficie de API REST 1.0 disponible con carácter general. Todas las acciones del conector ahora admiten el formato DTDLv2 y la compatibilidad con modelos basados en DTDLv1 está en desuso.
- Las acciones a
Run a device command,Get/Update device propertiesyGet device telemetry valuese han actualizado para agregar compatibilidad a las características de plantilla de dispositivo más recientes en Azure IoT Central. Estas acciones ahora admiten las funcionalidades raíz y de componente. - Se ha agregado un nuevo conjunto de acciones de módulo de dispositivo. Estas acciones permiten la creación de flujos de trabajo que interactúan con comandos, propiedades, telemetría de los módulos de dispositivo y los componentes del módulo.
- Se han actualizado las acciones que
Get/Create/Update/Delete a devicese deben actualizar para alinearse con la API REST de Azure IoT Central más reciente. - Las acciones
Get device cloud propertiesyUpdate device cloud propertiesahora forman parte deGet device propertiesyUpdate device properties. Las nuevas acciones permiten que los flujos de trabajo interactúen simultáneamente con las propiedades del dispositivo y las propiedades de la nube.
Aviso de desuso: al final de CY21, las acciones marcadas como en desuso en la lista siguiente ya no estarán disponibles al compilar nuevos flujos de trabajo. Los flujos de trabajo existentes que hacen referencia a estas acciones seguirán funcionando hasta marzo de 2022. Le recomendamos que actualice los flujos de trabajo para aprovechar las acciones recién anunciadas que ahora se admiten en Azure IoT Central.
Noviembre de 2021
- Se han agregado nuevas acciones para enumerar dispositivos y plantillas de dispositivo para una aplicación de Azure IoT Central. Estas acciones incluyen compatibilidad con la paginación.
- Se ha agregado un nuevo conjunto de acciones de administración de usuarios al conector, lo que permite a los flujos de trabajo crear, actualizar, enumerar y eliminar usuarios de una aplicación.
- Los flujos de trabajo ahora pueden obtener la ejecución más reciente de un comando de dispositivo mediante las nuevas
Get device command responseacciones. Este conjunto de acciones admite comandos raíz, componente y módulo.
Problemas y limitaciones conocidos
- Para usar este conector en Microsoft Power Automate, debe haber iniciado sesión en la aplicación de IoT Central al menos una vez. De lo contrario, la aplicación no aparecerá en la lista desplegable Aplicación.
- Las cuentas personales de Microsoft (como @hotmail.com, @live.com, @outlook.com dominios) no se admiten para iniciar sesión en el conector de IoT Central. Debe usar una cuenta profesional o educativa de Microsoft Entra ID.
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Credenciales | Credentials | Todas las regiones | No se puede compartir |
| Valor predeterminado [EN DESUSO] | Esta opción solo es para conexiones anteriores sin un tipo de autenticación explícito y solo se proporciona para la compatibilidad con versiones anteriores. | Todas las regiones | No se puede compartir |
Credentials
Identificador de autenticación: 1stparty
Aplicable: Todas las regiones
Credentials
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
Valor predeterminado [EN DESUSO]
Aplicable: Todas las regiones
Esta opción solo es para conexiones anteriores sin un tipo de autenticación explícito y solo se proporciona para la compatibilidad con versiones anteriores.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualización de las propiedades del módulo |
Actualice todos los valores de propiedad de un módulo. |
| Actualización de un trabajo programado |
Actualice un trabajo programado existente por identificador. |
| Actualización de una relación de dispositivo |
Actualice una relación de dispositivo existente entre el dispositivo dado y un nuevo dispositivo dado un identificador de dispositivo y un identificador de relación. |
| Actualizar las propiedades de la nube del dispositivo (en desuso) |
Actualice todos los valores de propiedad en la nube de un dispositivo por identificador de dispositivo (en desuso). |
| Actualizar las propiedades del dispositivo |
Actualice todos los valores de propiedad de un dispositivo por identificador de dispositivo. |
| Actualizar las propiedades del dispositivo (en desuso) |
Actualice todos los valores de propiedad de un dispositivo por identificador de dispositivo (en desuso). |
| Actualizar usuario |
Actualización de un usuario en la aplicación a través de la revisión |
| Creación de un usuario |
Creación de un usuario en la aplicación |
| Creación de una organización |
Crea una organización nueva. |
| Creación de una relación de dispositivo |
Cree una nueva relación de dispositivo entre el dispositivo especificado y un nuevo dispositivo dado un identificador de dispositivo y un identificador de relación. |
| Creación o actualización de un dispositivo |
Cree un nuevo dispositivo o actualice uno existente por identificador de dispositivo. |
| Crear o actualizar un dispositivo (en desuso) |
Cree un nuevo dispositivo o actualice uno existente por identificador de dispositivo. (en desuso) |
| Crear o actualizar un dispositivo (en desuso) |
Cree un nuevo dispositivo o actualice uno existente por identificador de dispositivo (en desuso). |
| Crear un grupo de dispositivos |
Cree o actualice un grupo de dispositivos. |
| Crear un trabajo |
Cree y ejecute un nuevo trabajo a través de su definición de trabajo. |
| Crear un trabajo programado |
Cree y ejecute un nuevo trabajo programado a través de su definición de trabajo. |
| Detener un trabajo en ejecución |
Detenga la ejecución de un trabajo que se está ejecutando actualmente. |
| Ejecución de un comando de componente |
Ejecute un comando en un componente. |
| Ejecución de un comando de componente de módulo |
Ejecute un comando en un componente de módulo. |
| Ejecución de un comando de dispositivo |
Ejecute un comando en un dispositivo. |
| Ejecución de un comando de módulo |
Ejecute un comando en un módulo. |
| Ejecutar un comando de dispositivo (en desuso) |
Ejecute un comando en un dispositivo (en desuso). |
| Eliminación de un trabajo programado |
Elimine un trabajo programado existente por identificador. |
| Eliminación de usuario |
Eliminar un usuario |
| Eliminar grupo de dispositivos |
Eliminación de un grupo de dispositivos existente por identificador |
| Eliminar organización |
Eliminación de una organización existente por identificador |
| Eliminar un dispositivo |
Elimine un dispositivo existente por identificador de dispositivo. |
| Eliminar un dispositivo (en desuso) |
Elimine un dispositivo existente por identificador de dispositivo (en desuso). |
| Eliminar una plantilla de dispositivo |
Elimine una plantilla de dispositivo existente por identificador. |
| Eliminar una relación de dispositivo |
Elimine una relación de dispositivo existente por identificador de dispositivo e identificador de relación. |
| Enumeración de grupos de dispositivos |
Obtenga la lista de grupos de dispositivos en una aplicación. |
| Enumeración de las relaciones |
Enumera todas las relaciones basadas en el identificador de dispositivo. |
| Enumeración de trabajos programados |
Obtenga la lista de trabajos programados en una aplicación. |
| Enumerar dispositivos |
Obtenga la lista de dispositivos de una aplicación. |
| Enumerar organizaciones |
Obtenga la lista de organizaciones de una aplicación. |
| Enumerar roles |
Obtenga la lista de roles de una aplicación. |
| Enumerar trabajos |
Obtenga la lista de trabajos de una aplicación. |
| Enumerar usuarios |
Obtener la lista de usuarios de una aplicación |
| Lista de plantillas de dispositivo |
Obtenga la lista de plantillas de dispositivo en una aplicación. |
| Obtención de dispositivos por identificador de grupo de dispositivos |
Obtenga la lista de dispositivos de un grupo de dispositivos en una aplicación. |
| Obtención de estados de dispositivo |
Obtenga la lista de estados de dispositivo individuales por identificador de trabajo. |
| Obtención de la relación de dispositivo |
Obtenga detalles sobre una relación de dispositivo existente por identificador de dispositivo y por identificador de relación. |
| Obtención de la respuesta de comandos del componente |
Obtenga la última respuesta para un comando de componente de dispositivo. |
| Obtención de la respuesta de comandos del componente de módulo |
Obtenga la última respuesta para un comando de componente de módulo. |
| Obtención de la respuesta de comandos del módulo |
Obtención de la última respuesta para un comando de módulo de dispositivo |
| Obtención de la respuesta del comando del dispositivo |
Obtenga la última respuesta de un comando de dispositivo. |
| Obtención de las propiedades del dispositivo |
Obtiene todos los valores de propiedad de un dispositivo por identificador de dispositivo. |
| Obtención de las propiedades del módulo |
Obtiene todos los valores de propiedad de un módulo. |
| Obtención de propiedades en la nube del dispositivo (obsoleto) |
Obtenga todos los valores de propiedad en la nube de un dispositivo por identificador de dispositivo (en desuso). |
| Obtención de trabajos por identificador de trabajo programado |
Obtenga la lista de trabajos de una definición de trabajo programada. |
| Obtención de un dispositivo por identificador |
Obtenga detalles sobre un dispositivo existente por identificador de dispositivo. |
| Obtención de un grupo de dispositivos |
Obtenga detalles sobre un grupo de dispositivos existente por identificador. |
| Obtención de un trabajo programado |
Obtenga detalles sobre un trabajo programado existente por identificador. |
| Obtención de una organización |
Obtenga detalles sobre una organización existente por identificador. |
| Obtención del valor de telemetría de componentes |
Obtenga el último valor de telemetría de un componente. |
| Obtención del valor de telemetría del componente del módulo |
Obtenga el último valor de telemetría de un componente de módulo. |
| Obtención del valor de telemetría del dispositivo |
Obtenga el último valor de telemetría de un dispositivo. |
| Obtención del valor de telemetría del dispositivo (en desuso) |
Obtenga el último valor de telemetría de un dispositivo (en desuso). |
| Obtención del valor de telemetría del módulo |
Obtenga el último valor de telemetría de un módulo. |
| Obtener las propiedades del dispositivo (en desuso) |
Obtiene todos los valores de propiedad de un dispositivo por identificador de dispositivo (en desuso). |
| Obtener rol |
Obtenga un rol por identificador. |
| Obtener un dispositivo por identificador (en desuso) |
Obtenga detalles sobre un dispositivo existente por identificador de dispositivo (en desuso). |
| Obtener un trabajo |
Obtenga detalles sobre un trabajo existente por identificador. |
| Obtener una plantilla de dispositivo por identificador |
Obtenga detalles sobre una plantilla de dispositivo existente por identificador. |
| Obtener usuario |
Obtención de un usuario por identificador |
| Reanudación de un trabajo en dispositivos con errores |
Ejecute una nueva ejecución de un trabajo existente en todos los dispositivos con errores. |
| Reanudar un trabajo detenido |
Reanude la ejecución de un trabajo detenido existente. |
Actualización de las propiedades del módulo
Actualice todos los valores de propiedad de un módulo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Módulo de dispositivo
|
module | True | string |
Nombre del módulo de dispositivo. |
|
Plantilla de dispositivo
|
template | string |
Definición de plantilla de dispositivo para el dispositivo. |
|
|
body
|
body | True | dynamic |
Propiedades del dispositivo. |
Devoluciones
Actualización de un trabajo programado
Actualice un trabajo programado existente por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de trabajo programado
|
scheduled_job_id | True | string |
Identificador único del trabajo programado. |
|
Tipo de fin de programación
|
scheduled_job_end_type | string |
Cómo debe finalizar el trabajo programado (no se aplica a las migraciones de plantillas de dispositivo). |
|
|
Body
|
body | True | dynamic |
Cuerpo de creación de trabajos programados. |
Devoluciones
Definición del trabajo programado.
- Body
- ScheduledJobStatic
Actualización de una relación de dispositivo
Actualice una relación de dispositivo existente entre el dispositivo dado y un nuevo dispositivo dado un identificador de dispositivo y un identificador de relación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Id. de relación
|
relationship_id | True | string |
Identificador único de la relación del dispositivo. |
|
Id. de relación de dispositivo
|
id | string |
Identificador único de la relación del dispositivo. |
|
|
Id. de destino de relación de dispositivo
|
target | True | string |
Identificador de dispositivo del dispositivo de origen (secundario). |
Devoluciones
Actualizar las propiedades de la nube del dispositivo (en desuso)
Actualice todos los valores de propiedad en la nube de un dispositivo por identificador de dispositivo (en desuso).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Id. de plantilla de dispositivo
|
instanceOf | string |
Definición de plantilla de dispositivo para el dispositivo. |
|
|
body
|
body | True | dynamic |
Propiedades del dispositivo. |
Devoluciones
Actualizar las propiedades del dispositivo
Actualice todos los valores de propiedad de un dispositivo por identificador de dispositivo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Plantilla de dispositivo
|
template | string |
Definición de plantilla de dispositivo para el dispositivo. |
|
|
body
|
body | True | dynamic |
Propiedades del dispositivo. |
Devoluciones
Actualizar las propiedades del dispositivo (en desuso)
Actualice todos los valores de propiedad de un dispositivo por identificador de dispositivo (en desuso).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Id. de plantilla de dispositivo
|
instanceOf | string |
Definición de plantilla de dispositivo para el dispositivo. |
|
|
body
|
body | True | dynamic |
Propiedades del dispositivo. |
Devoluciones
Actualizar usuario
Actualización de un usuario en la aplicación a través de la revisión
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Usuario
|
user_id | True | string |
Identificador único del usuario. |
|
Tipo de usuario
|
user_type | string |
Tipo del usuario. |
|
|
Body
|
body | True | dynamic |
Cuerpo de actualización del usuario. |
Devoluciones
Creación de un usuario
Creación de un usuario en la aplicación
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Usuario
|
user_id | True | string |
Identificador único del usuario. |
|
Tipo de usuario
|
user_type | string |
Tipo del usuario. |
|
|
Body
|
body | True | dynamic |
Cuerpo de creación del usuario. |
Devoluciones
Creación de una organización
Crea una organización nueva.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Identificador de la organización
|
organization_id | True | string |
Identificador único de la organización. |
|
Identificador de la organización
|
id | string |
Identificador único de la organización. |
|
|
Nombre de la organización
|
displayName | string |
Nombre para mostrar de la organización. |
|
|
Parent
|
parent | string |
Nombre para mostrar de la organización primaria. |
Devoluciones
- Body
- Organization
Creación de una relación de dispositivo
Cree una nueva relación de dispositivo entre el dispositivo especificado y un nuevo dispositivo dado un identificador de dispositivo y un identificador de relación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de relación
|
relationship_id | True | string |
Identificador único de la relación del dispositivo. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Id. de relación de dispositivo
|
id | string |
Identificador único de la relación del dispositivo. |
|
|
Id. de destino de relación de dispositivo
|
target | True | string |
Identificador de dispositivo del dispositivo de origen (secundario). |
Devoluciones
Creación o actualización de un dispositivo
Cree un nuevo dispositivo o actualice uno existente por identificador de dispositivo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Id. de dispositivo
|
id | string |
Identificador único del dispositivo. |
|
|
Nombre del dispositivo
|
displayName | string |
Nombre para mostrar del dispositivo. |
|
|
Plantilla de dispositivo
|
template | string |
Definición de plantilla de dispositivo para el dispositivo. |
|
|
Simulado
|
simulated | boolean |
Si el dispositivo está simulado. |
|
|
Enabled
|
enabled | boolean |
Indica si se ha habilitado la conexión del dispositivo a IoT Central. |
|
|
Organizations
|
organizations | array of string |
Lista de organizaciones del dispositivo, actualmente solo se admite una organización, pronto se admitirán varias organizaciones. |
|
|
Aprovisionado
|
provisioned | boolean |
Si se han asignado recursos para el dispositivo. |
Devoluciones
- Body
- DeviceV2
Crear o actualizar un dispositivo (en desuso)
Cree un nuevo dispositivo o actualice uno existente por identificador de dispositivo. (en desuso)
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Id. de dispositivo
|
id | string |
Identificador único del dispositivo. |
|
|
Nombre del dispositivo
|
displayName | string |
Nombre para mostrar del dispositivo. |
|
|
Plantilla de dispositivo
|
template | string |
Definición de plantilla de dispositivo para el dispositivo. |
|
|
Simulado
|
simulated | boolean |
Si el dispositivo está simulado. |
|
|
Enabled
|
enabled | boolean |
Indica si se ha habilitado la conexión del dispositivo a IoT Central. |
|
|
Aprovisionado
|
provisioned | boolean |
Si se han asignado recursos para el dispositivo. |
Devoluciones
- Body
- DeviceV1
Crear o actualizar un dispositivo (en desuso)
Cree un nuevo dispositivo o actualice uno existente por identificador de dispositivo (en desuso).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Id. de dispositivo
|
id | string |
Identificador único del dispositivo. |
|
|
Nombre del dispositivo
|
displayName | string |
Nombre para mostrar del dispositivo. |
|
|
Plantilla de dispositivo
|
instanceOf | string |
Definición de plantilla de dispositivo para el dispositivo. |
|
|
Simulado
|
simulated | boolean |
Si el dispositivo está simulado. |
|
|
Aprobado
|
approved | boolean |
Si el dispositivo se ha aprobado para conectarse a IoT Central. |
|
|
Aprovisionado
|
provisioned | boolean |
Si se han asignado recursos para el dispositivo. |
Devoluciones
- Body
- Device
Crear un grupo de dispositivos
Cree o actualice un grupo de dispositivos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de grupo de dispositivos
|
device_group_id | True | string |
Identificador único del grupo de dispositivos. |
|
Id. de grupo de dispositivos
|
id | string |
Identificador único del grupo de dispositivos. |
|
|
Nombre de pantalla
|
displayName | True | string |
Nombre para mostrar del grupo de dispositivos. |
|
Filter
|
filter | True | string |
Consulta que define qué dispositivos deben estar en este grupo. |
|
Description
|
description | string |
Resumen breve del grupo de dispositivos. |
|
|
ETag
|
etag | string |
ETag usado para evitar conflictos en las actualizaciones del grupo de dispositivos. |
|
|
Organizations
|
organizations | array of string |
Lista de organizaciones del grupo de dispositivos, actualmente solo se admite una organización, pronto se admitirán varias organizaciones. |
Devoluciones
Definición del grupo de dispositivos.
- Body
- DeviceGroup
Crear un trabajo
Cree y ejecute un nuevo trabajo a través de su definición de trabajo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. del trabajo
|
job_id | True | string |
Identificador único del trabajo. |
|
Tipo de trabajo
|
job_type | string |
Tipo del trabajo. |
|
|
Body
|
body | True | dynamic |
Cuerpo de creación de trabajos. |
Devoluciones
Crear un trabajo programado
Cree y ejecute un nuevo trabajo programado a través de su definición de trabajo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de trabajo programado
|
scheduled_job_id | True | string |
Identificador único del trabajo programado. |
|
Tipo de trabajo
|
job_type | string |
Tipo del trabajo. |
|
|
Tipo de fin de programación
|
scheduled_job_end_type | string |
Cómo debe finalizar el trabajo programado (no se aplica a las migraciones de plantillas de dispositivo). |
|
|
Body
|
body | True | dynamic |
Cuerpo de creación de trabajos programados. |
Devoluciones
Detener un trabajo en ejecución
Detenga la ejecución de un trabajo que se está ejecutando actualmente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. del trabajo
|
job_id | True | string |
Identificador único del trabajo. |
Ejecución de un comando de componente
Ejecute un comando en un componente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Componente de dispositivo
|
component_name | True | string |
Nombre del componente de dispositivo. |
|
Comando de dispositivo
|
command_name | True | string |
Nombre de este comando de dispositivo. |
|
Plantilla de dispositivo
|
template | string |
Definición de plantilla de dispositivo para el dispositivo. |
|
|
body
|
body | True | dynamic |
Cuerpo del comando del dispositivo. |
Devoluciones
Ejecución de un comando de componente de módulo
Ejecute un comando en un componente de módulo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Módulo de dispositivo
|
module | True | string |
Nombre del módulo de dispositivo. |
|
Componente de dispositivo
|
component_name | True | string |
Nombre del componente de dispositivo. |
|
Comando de dispositivo
|
command_name | True | string |
Nombre de este comando de dispositivo. |
|
Plantilla de dispositivo
|
template | string |
Definición de plantilla de dispositivo para el dispositivo. |
|
|
body
|
body | True | dynamic |
Cuerpo del comando del dispositivo. |
Devoluciones
Ejecución de un comando de dispositivo
Ejecute un comando en un dispositivo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Comando de dispositivo
|
command_name | True | string |
Nombre de este comando de dispositivo. |
|
Plantilla de dispositivo
|
template | string |
Definición de plantilla de dispositivo para el dispositivo. |
|
|
body
|
body | True | dynamic |
Cuerpo del comando del dispositivo. |
Devoluciones
Ejecución de un comando de módulo
Ejecute un comando en un módulo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Módulo de dispositivo
|
module | True | string |
Nombre del módulo de dispositivo. |
|
Comando de dispositivo
|
command_name | True | string |
Nombre de este comando de dispositivo. |
|
Plantilla de dispositivo
|
template | string |
Definición de plantilla de dispositivo para el dispositivo. |
|
|
body
|
body | True | dynamic |
Cuerpo del comando del dispositivo. |
Devoluciones
Ejecutar un comando de dispositivo (en desuso)
Ejecute un comando en un dispositivo (en desuso).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Componente de dispositivo
|
component_name | True | string |
Nombre del componente de dispositivo. |
|
Comando de dispositivo
|
command_name | True | string |
Nombre de este comando de dispositivo. |
|
Id. de plantilla de dispositivo
|
instanceOf | string |
Definición de plantilla de dispositivo para el dispositivo. |
|
|
body
|
body | True | dynamic |
Cuerpo del comando del dispositivo. |
Devoluciones
Eliminación de un trabajo programado
Elimine un trabajo programado existente por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de trabajo programado
|
scheduled_job_id | True | string |
Identificador único del trabajo programado. |
Eliminación de usuario
Eliminar un usuario
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Usuario
|
user_id | True | string |
Identificador único del usuario. |
Eliminar grupo de dispositivos
Eliminación de un grupo de dispositivos existente por identificador
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de grupo de dispositivos
|
device_group_id | True | string |
Identificador único del grupo de dispositivos. |
Eliminar organización
Eliminación de una organización existente por identificador
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Identificador de la organización
|
organization_id | True | string |
Identificador único de la organización. |
Eliminar un dispositivo
Elimine un dispositivo existente por identificador de dispositivo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
Eliminar un dispositivo (en desuso)
Elimine un dispositivo existente por identificador de dispositivo (en desuso).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
Eliminar una plantilla de dispositivo
Elimine una plantilla de dispositivo existente por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Template
|
template_id | True | string |
Identificador único de la plantilla. |
Eliminar una relación de dispositivo
Elimine una relación de dispositivo existente por identificador de dispositivo e identificador de relación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Id. de relación
|
relationship_id | True | string |
Identificador único de la relación del dispositivo. |
Enumeración de grupos de dispositivos
Obtenga la lista de grupos de dispositivos en una aplicación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
Devoluciones
Resultados paginados de grupos de dispositivos.
Enumeración de las relaciones
Enumera todas las relaciones basadas en el identificador de dispositivo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
Devoluciones
Enumeración de trabajos programados
Obtenga la lista de trabajos programados en una aplicación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
Devoluciones
Enumerar dispositivos
Obtenga la lista de dispositivos de una aplicación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
Devoluciones
- Body
- DeviceCollectionV1
Enumerar organizaciones
Obtenga la lista de organizaciones de una aplicación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
Devoluciones
Enumerar roles
Obtenga la lista de roles de una aplicación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
Devoluciones
- Body
- RoleCollectionV1
Enumerar trabajos
Obtenga la lista de trabajos de una aplicación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
Devoluciones
Resultados paginados de trabajos.
- Body
- JobCollection
Enumerar usuarios
Obtener la lista de usuarios de una aplicación
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
Devoluciones
- Body
- UserCollectionV1
Lista de plantillas de dispositivo
Obtenga la lista de plantillas de dispositivo en una aplicación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
Devoluciones
Obtención de dispositivos por identificador de grupo de dispositivos
Obtenga la lista de dispositivos de un grupo de dispositivos en una aplicación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de grupo de dispositivos
|
device_group_id | True | string |
Identificador único del grupo de dispositivos. |
Devoluciones
Resultados paginados de los dispositivos que pertenecen al grupo de dispositivos.
Obtención de estados de dispositivo
Obtenga la lista de estados de dispositivo individuales por identificador de trabajo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. del trabajo
|
job_id | True | string |
Identificador único del trabajo. |
Devoluciones
Resultados paginados de los estados del dispositivo de trabajo.
Obtención de la relación de dispositivo
Obtenga detalles sobre una relación de dispositivo existente por identificador de dispositivo y por identificador de relación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Id. de relación
|
relationship_id | True | string |
Identificador único de la relación del dispositivo. |
Devoluciones
Obtención de la respuesta de comandos del componente
Obtenga la última respuesta para un comando de componente de dispositivo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Componente de dispositivo
|
component_name | True | string |
Nombre del componente de dispositivo. |
|
Comando de dispositivo
|
command_name | True | string |
Nombre de este comando de dispositivo. |
|
Plantilla de dispositivo
|
template | string |
Definición de plantilla de dispositivo para el dispositivo. |
Devoluciones
Obtención de la respuesta de comandos del componente de módulo
Obtenga la última respuesta para un comando de componente de módulo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Módulo de dispositivo
|
module | True | string |
Nombre del módulo de dispositivo. |
|
Componente de dispositivo
|
component_name | True | string |
Nombre del componente de dispositivo. |
|
Comando de dispositivo
|
command_name | True | string |
Nombre de este comando de dispositivo. |
|
Plantilla de dispositivo
|
template | string |
Definición de plantilla de dispositivo para el dispositivo. |
Devoluciones
Obtención de la respuesta de comandos del módulo
Obtención de la última respuesta para un comando de módulo de dispositivo
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Módulo de dispositivo
|
module | True | string |
Nombre del módulo de dispositivo. |
|
Comando de dispositivo
|
command_name | True | string |
Nombre de este comando de dispositivo. |
|
Plantilla de dispositivo
|
template | string |
Definición de plantilla de dispositivo para el dispositivo. |
Devoluciones
Obtención de la respuesta del comando del dispositivo
Obtenga la última respuesta de un comando de dispositivo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Comando de dispositivo
|
command_name | True | string |
Nombre de este comando de dispositivo. |
|
Plantilla de dispositivo
|
template | string |
Definición de plantilla de dispositivo para el dispositivo. |
Devoluciones
Obtención de las propiedades del dispositivo
Obtiene todos los valores de propiedad de un dispositivo por identificador de dispositivo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Plantilla de dispositivo
|
template | string |
Definición de plantilla de dispositivo para el dispositivo. |
Devoluciones
Obtención de las propiedades del módulo
Obtiene todos los valores de propiedad de un módulo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Módulo de dispositivo
|
module | True | string |
Nombre del módulo de dispositivo. |
|
Plantilla de dispositivo
|
template | string |
Definición de plantilla de dispositivo para el dispositivo. |
Devoluciones
Obtención de propiedades en la nube del dispositivo (obsoleto)
Obtenga todos los valores de propiedad en la nube de un dispositivo por identificador de dispositivo (en desuso).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Id. de plantilla de dispositivo
|
instanceOf | string |
Definición de plantilla de dispositivo para el dispositivo. |
Devoluciones
Obtención de trabajos por identificador de trabajo programado
Obtenga la lista de trabajos de una definición de trabajo programada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de trabajo programado
|
scheduled_job_id | True | string |
Identificador único del trabajo programado. |
Devoluciones
Resultados paginados de definiciones de trabajo que pertenecen a un trabajo programado.
Obtención de un dispositivo por identificador
Obtenga detalles sobre un dispositivo existente por identificador de dispositivo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
Devoluciones
- Body
- DeviceV1
Obtención de un grupo de dispositivos
Obtenga detalles sobre un grupo de dispositivos existente por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de grupo de dispositivos
|
device_group_id | True | string |
Identificador único del grupo de dispositivos. |
Devoluciones
Definición del grupo de dispositivos.
- Body
- DeviceGroup
Obtención de un trabajo programado
Obtenga detalles sobre un trabajo programado existente por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de trabajo programado
|
scheduled_job_id | True | string |
Identificador único del trabajo programado. |
Devoluciones
Obtención de una organización
Obtenga detalles sobre una organización existente por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Identificador de la organización
|
organization_id | True | string |
Identificador único de la organización. |
Devoluciones
- Body
- Organization
Obtención del valor de telemetría de componentes
Obtenga el último valor de telemetría de un componente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Componente de dispositivo
|
component_name | True | string |
Nombre del componente de dispositivo. |
|
Telemetría del dispositivo
|
telemetry_name | True | string |
Nombre de esta telemetría del dispositivo. |
|
Plantilla de dispositivo
|
template | string |
Definición de plantilla de dispositivo para el dispositivo. |
Devoluciones
Obtención del valor de telemetría del componente del módulo
Obtenga el último valor de telemetría de un componente de módulo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Módulo de dispositivo
|
module | True | string |
Nombre del módulo de dispositivo. |
|
Componente de dispositivo
|
component_name | True | string |
Nombre del componente de dispositivo. |
|
Telemetría del dispositivo
|
telemetry_name | True | string |
Nombre de esta telemetría del dispositivo. |
|
Plantilla de dispositivo
|
template | string |
Definición de plantilla de dispositivo para el dispositivo. |
Devoluciones
Obtención del valor de telemetría del dispositivo
Obtenga el último valor de telemetría de un dispositivo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Telemetría del dispositivo
|
telemetry_name | True | string |
Nombre de esta telemetría del dispositivo. |
|
Plantilla de dispositivo
|
template | string |
Definición de plantilla de dispositivo para el dispositivo. |
Devoluciones
Obtención del valor de telemetría del dispositivo (en desuso)
Obtenga el último valor de telemetría de un dispositivo (en desuso).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Componente de dispositivo
|
component_name | True | string |
Nombre del componente de dispositivo. |
|
Telemetría del dispositivo
|
telemetry_name | True | string |
Nombre de esta telemetría del dispositivo. |
|
Id. de plantilla de dispositivo
|
instanceOf | string |
Definición de plantilla de dispositivo para el dispositivo. |
Devoluciones
Obtención del valor de telemetría del módulo
Obtenga el último valor de telemetría de un módulo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Módulo de dispositivo
|
module | True | string |
Nombre del módulo de dispositivo. |
|
Telemetría del dispositivo
|
telemetry_name | True | string |
Nombre de esta telemetría del dispositivo. |
|
Plantilla de dispositivo
|
template | string |
Definición de plantilla de dispositivo para el dispositivo. |
Devoluciones
Obtener las propiedades del dispositivo (en desuso)
Obtiene todos los valores de propiedad de un dispositivo por identificador de dispositivo (en desuso).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
|
Id. de plantilla de dispositivo
|
instanceOf | string |
Definición de plantilla de dispositivo para el dispositivo. |
Devoluciones
Obtener rol
Obtenga un rol por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Rol
|
role_id | True | string |
Identificador único del rol. |
Devoluciones
- Body
- RoleV1
Obtener un dispositivo por identificador (en desuso)
Obtenga detalles sobre un dispositivo existente por identificador de dispositivo (en desuso).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. de dispositivo
|
device_id | True | string |
Identificador único del dispositivo. |
Devoluciones
- Body
- Device
Obtener un trabajo
Obtenga detalles sobre un trabajo existente por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. del trabajo
|
job_id | True | string |
Identificador único del trabajo. |
Devoluciones
Definición del trabajo.
- Body
- JobStatic
Obtener una plantilla de dispositivo por identificador
Obtenga detalles sobre una plantilla de dispositivo existente por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Template
|
template_id | True | string |
Identificador único de la plantilla. |
Devoluciones
- Body
- DeviceTemplateV1
Obtener usuario
Obtención de un usuario por identificador
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Usuario
|
user_id | True | string |
Identificador único del usuario. |
Devoluciones
- Body
- UserStaticV1
Reanudación de un trabajo en dispositivos con errores
Ejecute una nueva ejecución de un trabajo existente en todos los dispositivos con errores.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. del trabajo
|
job_id | True | string |
Identificador único del trabajo. |
|
Volver a ejecutar el identificador
|
rerun_id | True | string |
Identificador único de la repetición. |
Devoluciones
Definición del trabajo.
- Body
- JobStatic
Reanudar un trabajo detenido
Reanude la ejecución de un trabajo detenido existente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Id. del trabajo
|
job_id | True | string |
Identificador único del trabajo. |
Desencadenadores
| Cuando se desencadena una regla |
Cree una acción que se desencadene cuando se active una regla en IoT Central. |
Cuando se desencadena una regla
Cree una acción que se desencadene cuando se active una regla en IoT Central.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Identificador único de la aplicación. |
|
Identificador del desencadenador de flujo de trabajo
|
id | string |
Identificador único del desencadenador de flujo de trabajo. |
|
|
Rule
|
rule | True | string |
Identificador único de la regla asociada al desencadenador de flujo de trabajo. |
Devoluciones
Definiciones
Device
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de dispositivo
|
id | string |
Identificador único del dispositivo. |
|
Nombre del dispositivo
|
displayName | string |
Nombre para mostrar del dispositivo. |
|
Plantilla de dispositivo
|
instanceOf | string |
Definición de plantilla de dispositivo para el dispositivo. |
|
Simulado
|
simulated | boolean |
Si el dispositivo está simulado. |
|
Aprobado
|
approved | boolean |
Si el dispositivo se ha aprobado para conectarse a IoT Central. |
|
Aprovisionado
|
provisioned | boolean |
Si se han asignado recursos para el dispositivo. |
DeviceV1
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de dispositivo
|
id | string |
Identificador único del dispositivo. |
|
Nombre del dispositivo
|
displayName | string |
Nombre para mostrar del dispositivo. |
|
Plantilla de dispositivo
|
template | string |
Definición de plantilla de dispositivo para el dispositivo. |
|
Simulado
|
simulated | boolean |
Si el dispositivo está simulado. |
|
Enabled
|
enabled | boolean |
Indica si se ha habilitado la conexión del dispositivo a IoT Central. |
|
Aprovisionado
|
provisioned | boolean |
Si se han asignado recursos para el dispositivo. |
DeviceV2
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de dispositivo
|
id | string |
Identificador único del dispositivo. |
|
Nombre del dispositivo
|
displayName | string |
Nombre para mostrar del dispositivo. |
|
Plantilla de dispositivo
|
template | string |
Definición de plantilla de dispositivo para el dispositivo. |
|
Simulado
|
simulated | boolean |
Si el dispositivo está simulado. |
|
Enabled
|
enabled | boolean |
Indica si se ha habilitado la conexión del dispositivo a IoT Central. |
|
Organizations
|
organizations | array of string |
Lista de organizaciones del dispositivo, actualmente solo se admite una organización, pronto se admitirán varias organizaciones. |
|
Aprovisionado
|
provisioned | boolean |
Si se han asignado recursos para el dispositivo. |
DeviceCollectionV1
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
value | array of DeviceV1 |
Colección de dispositivos. |
|
nextLink
|
nextLink | string |
Dirección URL para obtener la siguiente página de dispositivos. |
DeviceGroup
Definición del grupo de dispositivos.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de grupo de dispositivos
|
id | string |
Identificador único del grupo de dispositivos. |
|
Nombre de pantalla
|
displayName | string |
Nombre para mostrar del grupo de dispositivos. |
|
Filter
|
filter | string |
Consulta que define qué dispositivos deben estar en este grupo. |
|
Description
|
description | string |
Resumen breve del grupo de dispositivos. |
|
ETag
|
etag | string |
ETag usado para evitar conflictos en las actualizaciones del grupo de dispositivos. |
|
Organizations
|
organizations | array of string |
Lista de organizaciones del grupo de dispositivos, actualmente solo se admite una organización, pronto se admitirán varias organizaciones. |
DeviceGroupCollection
Resultados paginados de grupos de dispositivos.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de grupo de dispositivos
|
value | array of DeviceGroup |
Colección de grupos de dispositivos. |
|
nextLink
|
nextLink | string |
Dirección URL para obtener la siguiente página de grupos de dispositivos. |
DeviceGroupDeviceCollection
Resultados paginados de los dispositivos que pertenecen al grupo de dispositivos.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
value | array of DeviceV1 |
Colección de dispositivos que pertenecen al grupo de dispositivos. |
|
nextLink
|
nextLink | string |
Dirección URL para obtener la siguiente página de dispositivos del grupo. |
DeviceRelationshipStatic
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de relación de dispositivo
|
id | string |
Identificador único de la relación del dispositivo. |
|
Id. de origen de relación de dispositivo
|
source | string |
Identificador de dispositivo del dispositivo de origen (primario). |
|
Id. de destino de relación de dispositivo
|
target | string |
Identificador de dispositivo del dispositivo de origen (secundario). |
DeviceRelationshipCollection
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
value | array of DeviceRelationshipStatic |
Colección de relaciones de dispositivo. |
|
nextLink
|
nextLink | string |
Dirección URL para obtener la siguiente página de relaciones de dispositivo. |
DeviceTemplateV1
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de plantilla de dispositivo
|
@id | string |
Identificador único de la plantilla de dispositivo. |
|
Tipos de plantilla de dispositivo
|
@type | array of string |
Los tipos JSON-LD de esta plantilla de dispositivo. |
|
Nombre de plantilla de dispositivo
|
displayName | string |
Nombre para mostrar de la plantilla de dispositivo. |
|
Descripción de la plantilla de dispositivo
|
description | string |
Descripción detallada de la plantilla de dispositivo. |
|
Modelo de funcionalidad de plantilla de dispositivo
|
capabilityModel |
Modelo de funcionalidad utilizado por esta plantilla de dispositivo. |
DeviceTemplateCollectionV1
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
value | array of DeviceTemplateV1 |
Colección de plantillas de dispositivo. |
|
nextLink
|
nextLink | string |
Dirección URL para obtener la página siguiente de plantillas de dispositivo. |
JobDeviceStatus
Definición de estado del dispositivo de trabajo.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de dispositivo
|
id | string |
Identificador del dispositivo cuyo estado de trabajo se proporciona. |
|
Estado del dispositivo
|
status | string |
Indica si el trabajo se está iniciando, ejecutando, etc. para el dispositivo determinado. |
JobDeviceStatusCollection
Resultados paginados de los estados del dispositivo de trabajo.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
value | array of JobDeviceStatus |
Colección de estados del dispositivo de trabajo. |
|
nextLink
|
nextLink | string |
Dirección URL para obtener la página siguiente de los estados del dispositivo de trabajo. |
JobBatch
Definición del lote del trabajo.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Tipo de lote
|
type | string |
Indica si el procesamiento por lotes se realiza en un número especificado de dispositivos o en un porcentaje del total de dispositivos. |
|
Valor del lote
|
value | number |
Número o porcentaje de dispositivos en los que se realiza el procesamiento por lotes. |
JobCancellationThreshold
Definición del umbral de cancelación del trabajo.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Tipo de umbral de cancelación
|
type | string |
Si el umbral de cancelación es por un número especificado de dispositivos o un porcentaje del total de dispositivos. |
|
Valor de umbral de cancelación
|
value | number |
Número o porcentaje de dispositivos en los que se aplica el umbral de cancelación. |
|
Lote de umbral de cancelación
|
batch | boolean |
Si el umbral de cancelación se aplica por lote o al trabajo general. |
JobStatic
Definición del trabajo.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. del trabajo
|
id | string |
Identificador único del trabajo. |
|
Nombre de pantalla
|
displayName | string |
Nombre para mostrar del trabajo. |
|
Description
|
description | string |
Descripción detallada del trabajo. |
|
Grupo de dispositivos
|
group | string |
Identificador del grupo de dispositivos en el que se va a ejecutar el trabajo. |
|
proceso por lotes
|
batch | JobBatch |
Definición del lote del trabajo. |
|
cancellationThreshold
|
cancellationThreshold | JobCancellationThreshold |
Definición del umbral de cancelación del trabajo. |
|
Data
|
data | array of object |
Datos relacionados con la operación que realiza este trabajo. Todas las entradas deben ser del mismo tipo. |
|
items
|
data | object | |
|
Organizations
|
organizations | array of string |
Lista de organizaciones del trabajo, solo se admite una organización hoy en día, pronto se admitirán varias organizaciones. |
|
Id. de trabajo programado
|
scheduledJobId | string |
Identificador de la definición de trabajo programada que creó este trabajo. |
JobCollection
Resultados paginados de trabajos.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
value | array of JobStatic |
Colección de trabajos. |
|
nextLink
|
nextLink | string |
Dirección URL para obtener la página siguiente de trabajos. |
Organización
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Identificador de la organización
|
id | string |
Identificador único de la organización. |
|
Nombre de la organización
|
displayName | string |
Nombre para mostrar de la organización. |
|
Parent
|
parent | string |
Nombre para mostrar de la organización primaria. |
OrganizationCollection
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
value | array of Organization |
Colección de organizaciones. |
|
nextLink
|
nextLink | string |
Dirección URL para obtener la página siguiente de las organizaciones. |
RoleV1
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador único del rol. |
|
Nombre para mostrar
|
displayName | string |
Nombre para mostrar del rol. |
RoleCollectionV1
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
value | array of RoleV1 |
Colección de roles. |
ScheduledJobStatic
Definición del trabajo programado.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
ETag
|
etag | string |
ETag usado para evitar conflictos en las actualizaciones de trabajos programadas. |
|
Id. de trabajo programado
|
id | string |
Identificador único del trabajo programado. |
|
Nombre de pantalla
|
displayName | string |
Nombre para mostrar del trabajo programado. |
|
Description
|
description | string |
Descripción detallada del trabajo programado. |
|
Grupo de dispositivos
|
group | string |
Identificador del grupo de dispositivos en el que se va a ejecutar el trabajo. |
|
proceso por lotes
|
batch | JobBatch |
Definición del lote del trabajo. |
|
cancellationThreshold
|
cancellationThreshold | JobCancellationThreshold |
Definición del umbral de cancelación del trabajo. |
|
Data
|
data | array of object |
Datos relacionados con la operación que realiza este trabajo. Todas las entradas deben ser del mismo tipo. |
|
items
|
data | object | |
|
Organizations
|
organizations | array of string |
Lista de organizaciones del trabajo, solo se admite una organización hoy en día, pronto se admitirán varias organizaciones. |
|
Programación
|
schedule | object |
Programación en la que se va a ejecutar el trabajo. |
|
Enabled
|
enabled | boolean |
Indica si el trabajo programado está habilitado. |
|
Completado
|
completed | boolean |
Si se ha completado el trabajo programado. |
ScheduledJobJobCollection
Resultados paginados de definiciones de trabajo que pertenecen a un trabajo programado.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
value | array of JobStatic |
Colección de trabajos. |
|
nextLink
|
nextLink | string |
Dirección URL para obtener la página siguiente de trabajos. |
UserStaticV1
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de usuario
|
id | string |
Identificador único del usuario. |
|
Tipo de usuario
|
type | string |
Tipo del usuario. |
|
Funciones
|
roles | array of RoleAssignmentV1 |
Lista de asignaciones de roles que especifican los permisos para acceder a la aplicación. |
UserCollectionV1
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Users
|
value | array of UserStaticV1 |
Colección de usuarios. |
RoleAssignmentV1
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Rol
|
role | string |
Identificador del rol para esta asignación de roles. |