Azure IoT Central V3 (preview)
Met Azure IoT Central kunt u eenvoudig uw IoT-apparaten op schaal verbinden, bewaken en beheren. Met de IoT Central V3-connector kunt u werkstromen activeren wanneer een regel is geactiveerd en acties ondernemen door opdrachten uit te voeren, eigenschappen bij te werken, telemetrie van apparaten op te halen en meer. Gebruik deze connector met uw Azure IoT Central V3-toepassing.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standaard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contactpersoon | |
|---|---|
| Naam | Technische ondersteuning voor Azure IoT Central |
| URL | https://aka.ms/iotcentral-create-technical-support-ticket-trial |
| Connectormetagegevens | |
|---|---|
| Uitgever | Microsoft Corporation |
| Webpagina | https://azure.microsoft.com/services/iot-central/ |
| Privacybeleid | https://privacy.microsoft.com |
| Categorieën | Internet of Things |
De Azure IoT Central V3-connector kan worden gebruikt om uw Azure IoT Central V3-toepassing te verbinden met uw werkstromen. U kunt de connector gebruiken om werkstromen uit te voeren wanneer een regel wordt geactiveerd. U kunt deze gebruiken om de meest recente informatie op te halen van uw IoT-apparaten, zoals telemetriegegevens en eigenschappen. En u kunt deze ook gebruiken om uw IoT-apparaten bij te werken door opdrachten te verzenden en de juiste gegevens bij te werken.
Vereiste voorwaarden
- U moet een gebruiker zijn in een Azure IoT Central V3 Pay-As-You-Go-toepassing om deze connector te kunnen gebruiken.
- U moet een werk- of schoolaccount van Microsoft Entra ID gebruiken.
Referenties ophalen
Als u deze connector wilt toevoegen aan uw werkstroom, moet u zich eerst aanmelden bij het werk- of schoolaccount van Microsoft Entra ID dat een gebruiker is in de Azure IoT Central-toepassing waarmee u verbinding wilt maken.
Opmerkingen bij de uitgave
September 2021
- De Azure IoT Central V3-connector is nu bijgewerkt zodat deze overeenkomt met het algemeen beschikbare 1.0 REST API-oppervlak . Alle connectoracties ondersteunen nu de DTDLv2-indeling en ondersteuning voor op DTDLv1 gebaseerde modellen worden afgeschaft.
- De acties voor
Run a device command,Get/Update device propertiesenGet device telemetry valuezijn bijgewerkt om ondersteuning toe te voegen aan de nieuwste apparaatsjabloonfuncties in Azure IoT Central. Deze acties ondersteunen nu zowel hoofd- als onderdeelmogelijkheden. - Er is een nieuwe set apparaatmoduleacties toegevoegd. Met deze acties kunt u werkstromen maken die communiceren met opdrachten, eigenschappen, telemetrieën van zowel apparaatmodules als moduleonderdelen.
- Acties die
Get/Create/Update/Delete a devicemoeten worden bijgewerkt om te worden afgestemd op de nieuwste Azure IoT Central REST API. - De acties
Get device cloud propertiesenUpdate device cloud propertiesmaken nu deel uit vanGet device propertiesenUpdate device properties. Met de nieuwe acties kunnen werkstromen tegelijkertijd communiceren met apparaateigenschappen en cloudeigenschappen.
Afschaffingsmelding: aan het einde van CY21 zijn de acties die zijn gemarkeerd als afgeschaft in de onderstaande lijst niet meer beschikbaar bij het bouwen van nieuwe werkstromen. Bestaande werkstromen die naar deze acties verwijzen, blijven tot maart 2022 werken. We raden u aan uw werkstromen bij te werken om te profiteren van de zojuist aangekondigde acties die nu worden ondersteund in Azure IoT Central.
November 2021
- Er zijn nieuwe acties toegevoegd voor het weergeven van apparaten en apparaatsjablonen voor een Azure IoT Central-toepassing. Deze acties omvatten ondersteuning voor paginering.
- Er is een nieuwe set acties voor gebruikersbeheer toegevoegd aan de connector, zodat werkstromen gebruikers van een toepassing kunnen maken, bijwerken, vermelden en verwijderen.
- Werkstromen kunnen nu de meest recente uitvoering van een apparaatopdracht krijgen met behulp van de nieuwe
Get device command responseacties. Deze set acties ondersteunt hoofd-, onderdeel- en moduleopdrachten.
Bekende problemen en beperkingen
- Als u deze connector in Microsoft Power Automate wilt gebruiken, moet u zich ten minste één keer hebben aangemeld bij de IoT Central-toepassing. Anders wordt de toepassing niet weergegeven in de vervolgkeuzelijst Toepassing
- Persoonlijke Microsoft-accounts (zoals @hotmail.com, @live.com@outlook.com domeinen) worden niet ondersteund om u aan te melden bij de IoT Central-connector. U moet een werk- of schoolaccount van Microsoft Entra ID gebruiken.
Een verbinding maken
De connector ondersteunt de volgende verificatietypen:
| Credentials | Credentials | Alle regio's | Niet deelbaar |
| Standaard [AFGESCHAFT] | Deze optie is alleen bedoeld voor oudere verbindingen zonder expliciet verificatietype en is alleen beschikbaar voor compatibiliteit met eerdere versies. | Alle regio's | Niet deelbaar |
Credentials
Verificatie-id: 1stparty
Van toepassing: Alle regio's
Credentials
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
Standaard [AFGESCHAFT]
Van toepassing: Alle regio's
Deze optie is alleen bedoeld voor oudere verbindingen zonder expliciet verificatietype en is alleen beschikbaar voor compatibiliteit met eerdere versies.
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Antwoord van apparaatopdracht ophalen |
Haal het laatste antwoord op voor een apparaatopdracht. |
| Antwoord van moduleopdracht ophalen |
Het laatste antwoord voor een apparaatmoduleopdracht ophalen |
| Antwoord van onderdeelopdracht ophalen |
Haal het laatste antwoord op voor een apparaatonderdeelopdracht. |
| Apparaatcloudeigenschappen bijwerken (afgeschaft) |
Werk alle waarden van de cloudeigenschap van een apparaat bij op basis van apparaat-id (afgeschaft). |
| Apparaateigenschappen bijwerken |
Werk alle eigenschapswaarden van een apparaat bij op apparaat-id. |
| Apparaateigenschappen bijwerken (afgeschaft) |
Werk alle eigenschapswaarden van een apparaat bij op apparaat-id (afgeschaft). |
| Apparaateigenschappen ophalen |
Alle eigenschapswaarden van een apparaat ophalen op basis van apparaat-id. |
| Apparaateigenschappen ophalen (afgeschaft) |
Alle eigenschapswaarden van een apparaat ophalen op basis van apparaat-id (afgeschaft). |
| Apparaatgroep verwijderen |
Een bestaande apparaatgroep op id verwijderen |
| Apparaatgroepen weergeven |
Haal de lijst met apparaatgroepen in een toepassing op. |
| Apparaatrelatie ophalen |
Meer informatie over een bestaande apparaatrelatie op basis van apparaat-id en relatie-id. |
| Apparaatsjablonen weergeven |
Haal de lijst met apparaatsjablonen in een toepassing op. |
| Apparaatstatussen ophalen |
Haal de lijst met afzonderlijke apparaatstatussen op op taak-id. |
| Apparaten ophalen op apparaatgroep-id |
Haal de lijst met apparaten op in een apparaatgroep in een toepassing. |
| Apparaten vermelden |
Haal de lijst met apparaten in een toepassing op. |
| Cloud-eigenschappen van apparaat ophalen (verouderd) |
Alle waarden voor cloudeigenschappen van een apparaat ophalen op basis van apparaat-id (afgeschaft). |
| Een actieve taak stoppen |
Stop de uitvoering van een taak die momenteel wordt uitgevoerd. |
| Een apparaat maken of bijwerken |
Maak een nieuw apparaat of werk een bestaand apparaat bij op apparaat-id. |
| Een apparaat maken of bijwerken (afgeschaft) |
Maak een nieuw apparaat of werk een bestaand apparaat bij op apparaat-id. (afgeschaft) |
| Een apparaat maken of bijwerken (afgeschaft) |
Maak een nieuw apparaat of werk een bestaand apparaat bij op apparaat-id (afgeschaft). |
| Een apparaat ophalen aan de hand van ID |
Meer informatie over een bestaand apparaat op basis van apparaat-id. |
| Een apparaat ophalen op basis van id (afgeschaft) |
Meer informatie over een bestaand apparaat op apparaat-id (afgeschaft). |
| Een apparaat verwijderen |
Verwijder een bestaand apparaat op apparaat-id. |
| Een apparaat verwijderen (afgeschaft) |
Een bestaand apparaat verwijderen op apparaat-id (afgeschaft). |
| Een apparaatgroep maken |
Een apparaatgroep maken of bijwerken. |
| Een apparaatgroep ophalen |
Meer informatie over een bestaande apparaatgroep op id. |
| Een apparaatopdracht uitvoeren |
Voer een opdracht uit op een apparaat. |
| Een apparaatopdracht uitvoeren (afgeschaft) |
Voer een opdracht uit op een apparaat (afgeschaft). |
| Een apparaatrelatie bijwerken |
Werk een bestaande apparaatrelatie bij tussen het opgegeven apparaat en een nieuw apparaat met een apparaat-id en een relatie-id. |
| Een apparaatrelatie maken |
Maak een nieuwe apparaatrelatie tussen het opgegeven apparaat en een nieuw apparaat op basis van een apparaat-id en een relatie-id. |
| Een apparaatrelatie verwijderen |
Verwijder een bestaande apparaatrelatie op basis van apparaat-id en relatie-id. |
| Een apparaatsjabloon ophalen op basis van id |
Meer informatie over een bestaande apparaatsjabloon op basis van id. |
| Een apparaatsjabloon verwijderen |
Verwijder een bestaande apparaatsjabloon op id. |
| Een geplande taak bijwerken |
Werk een bestaande geplande taak bij op id. |
| Een geplande taak maken |
Maak en voer een nieuwe geplande taak uit via de taakdefinitie. |
| Een geplande taak ophalen |
Meer informatie over een bestaande geplande taak op id. |
| Een geplande taak verwijderen |
Verwijder een bestaande geplande taak op id. |
| Een gestopte taak hervatten |
De uitvoering van een bestaande gestopte taak hervatten. |
| Een moduleonderdeelopdracht uitvoeren |
Voer een opdracht uit op een moduleonderdeel. |
| Een moduleopdracht uitvoeren |
Voer een opdracht uit op een module. |
| Een onderdeelopdracht uitvoeren |
Voer een opdracht uit op een onderdeel. |
| Een organisatie maken |
Maak een nieuwe organisatie. |
| Een organisatie ophalen |
Meer informatie over een bestaande organisatie op basis van id. |
| Een taak hervatten op mislukte apparaten |
Voer een nieuwe uitvoering van een bestaande taak uit op alle mislukte apparaten. |
| Een taak maken |
Maak en voer een nieuwe taak uit via de taakdefinitie. |
| Een taak ophalen |
Details over een bestaande taak op id ophalen. |
| Gebruiker bijwerken |
Een gebruiker in de toepassing bijwerken via patch |
| Gebruiker maken |
Een gebruiker maken in de toepassing |
| Gebruiker ophalen |
Een gebruiker ophalen op basis van id |
| Gebruiker verwijderen |
Een gebruiker verwijderen |
| Gebruikers weergeven |
De lijst met gebruikers in een toepassing ophalen |
| Geplande taken weergeven |
Haal de lijst met geplande taken in een toepassing op. |
| Lijst met relaties |
Alle relaties weergeven op basis van de apparaat-id. |
| Module-eigenschappen bijwerken |
Werk alle eigenschapswaarden van een module bij. |
| Module-eigenschappen ophalen |
Haal alle eigenschapswaarden van een module op. |
| Moduletelemetriewaarde ophalen |
Haal de laatste telemetriewaarde op uit een module. |
| Opdrachtantwoord moduleonderdeel ophalen |
Haal het laatste antwoord op voor een moduleonderdeelopdracht. |
| Organisatie verwijderen |
Een bestaande organisatie verwijderen op id |
| Organisaties vermelden |
Haal de lijst met organisaties in een toepassing op. |
| Rol ophalen |
Haal een rol op id op. |
| Rollen vermelden |
Haal de lijst met rollen in een toepassing op. |
| Taken ophalen op geplande taak-id |
Haal de lijst met taken op voor een geplande taakdefinitie. |
| Taken weergeven |
Haal de lijst met taken in een toepassing op. |
| Telemetriewaarde van apparaat ophalen |
Haal de laatste telemetriewaarde op van een apparaat. |
| Telemetriewaarde van apparaat ophalen (afgeschaft) |
Haal de laatste telemetriewaarde op van een apparaat (afgeschaft). |
| Telemetriewaarde voor moduleonderdelen ophalen |
Haal de laatste telemetriewaarde op uit een moduleonderdeel. |
| Telemetriewaarde voor onderdelen ophalen |
Haal de laatste telemetriewaarde van een onderdeel op. |
Antwoord van apparaatopdracht ophalen
Haal het laatste antwoord op voor een apparaatopdracht.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatopdracht
|
command_name | True | string |
Naam van deze apparaatopdracht. |
|
Apparaatsjabloon
|
template | string |
De definitie van de apparaatsjabloon voor het apparaat. |
Retouren
Antwoord van moduleopdracht ophalen
Het laatste antwoord voor een apparaatmoduleopdracht ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatmodule
|
module | True | string |
Naam van de apparaatmodule. |
|
Apparaatopdracht
|
command_name | True | string |
Naam van deze apparaatopdracht. |
|
Apparaatsjabloon
|
template | string |
De definitie van de apparaatsjabloon voor het apparaat. |
Retouren
Antwoord van onderdeelopdracht ophalen
Haal het laatste antwoord op voor een apparaatonderdeelopdracht.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatonderdeel
|
component_name | True | string |
Naam van het apparaatonderdeel. |
|
Apparaatopdracht
|
command_name | True | string |
Naam van deze apparaatopdracht. |
|
Apparaatsjabloon
|
template | string |
De definitie van de apparaatsjabloon voor het apparaat. |
Retouren
Apparaatcloudeigenschappen bijwerken (afgeschaft)
Werk alle waarden van de cloudeigenschap van een apparaat bij op basis van apparaat-id (afgeschaft).
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatsjabloon-id
|
instanceOf | string |
De definitie van de apparaatsjabloon voor het apparaat. |
|
|
body
|
body | True | dynamic |
Apparaateigenschappen. |
Retouren
Apparaateigenschappen bijwerken
Werk alle eigenschapswaarden van een apparaat bij op apparaat-id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatsjabloon
|
template | string |
De definitie van de apparaatsjabloon voor het apparaat. |
|
|
body
|
body | True | dynamic |
Apparaateigenschappen. |
Retouren
Apparaateigenschappen bijwerken (afgeschaft)
Werk alle eigenschapswaarden van een apparaat bij op apparaat-id (afgeschaft).
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatsjabloon-id
|
instanceOf | string |
De definitie van de apparaatsjabloon voor het apparaat. |
|
|
body
|
body | True | dynamic |
Apparaateigenschappen. |
Retouren
Apparaateigenschappen ophalen
Alle eigenschapswaarden van een apparaat ophalen op basis van apparaat-id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatsjabloon
|
template | string |
De definitie van de apparaatsjabloon voor het apparaat. |
Retouren
Apparaateigenschappen ophalen (afgeschaft)
Alle eigenschapswaarden van een apparaat ophalen op basis van apparaat-id (afgeschaft).
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatsjabloon-id
|
instanceOf | string |
De definitie van de apparaatsjabloon voor het apparaat. |
Retouren
Apparaatgroep verwijderen
Een bestaande apparaatgroep op id verwijderen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaatgroep-id
|
device_group_id | True | string |
Unieke id van de apparaatgroep. |
Apparaatgroepen weergeven
Haal de lijst met apparaatgroepen in een toepassing op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
Retouren
De paginaresultaten van apparaatgroepen.
Apparaatrelatie ophalen
Meer informatie over een bestaande apparaatrelatie op basis van apparaat-id en relatie-id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Relatie-id
|
relationship_id | True | string |
Unieke id van de apparaatrelatie. |
Retouren
Apparaatsjablonen weergeven
Haal de lijst met apparaatsjablonen in een toepassing op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
Retouren
Apparaatstatussen ophalen
Haal de lijst met afzonderlijke apparaatstatussen op op taak-id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Functie-ID
|
job_id | True | string |
Unieke id van de taak. |
Retouren
De paginaresultaten van de status van het taakapparaat.
Apparaten ophalen op apparaatgroep-id
Haal de lijst met apparaten op in een apparaatgroep in een toepassing.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaatgroep-id
|
device_group_id | True | string |
Unieke id van de apparaatgroep. |
Retouren
De paginaresultaten van apparaten die behoren tot de apparaatgroep.
Apparaten vermelden
Haal de lijst met apparaten in een toepassing op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
Retouren
- Body
- DeviceCollectionV1
Cloud-eigenschappen van apparaat ophalen (verouderd)
Alle waarden voor cloudeigenschappen van een apparaat ophalen op basis van apparaat-id (afgeschaft).
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatsjabloon-id
|
instanceOf | string |
De definitie van de apparaatsjabloon voor het apparaat. |
Retouren
Een actieve taak stoppen
Stop de uitvoering van een taak die momenteel wordt uitgevoerd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Functie-ID
|
job_id | True | string |
Unieke id van de taak. |
Een apparaat maken of bijwerken
Maak een nieuw apparaat of werk een bestaand apparaat bij op apparaat-id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaat-id
|
id | string |
Unieke id van het apparaat. |
|
|
Apparaatnaam
|
displayName | string |
Weergavenaam van het apparaat. |
|
|
Apparaatsjabloon
|
template | string |
De definitie van de apparaatsjabloon voor het apparaat. |
|
|
Gesimuleerd
|
simulated | boolean |
Of het apparaat wordt gesimuleerd. |
|
|
Ingeschakeld
|
enabled | boolean |
Of de apparaatverbinding met IoT Central is ingeschakeld. |
|
|
Organizations
|
organizations | array of string |
Lijst met organisaties van het apparaat, er wordt momenteel slechts één organisatie ondersteund. Meerdere organisaties worden binnenkort ondersteund. |
|
|
Geconfigureerd
|
provisioned | boolean |
Of resources zijn toegewezen voor het apparaat. |
Retouren
- Body
- DeviceV2
Een apparaat maken of bijwerken (afgeschaft)
Maak een nieuw apparaat of werk een bestaand apparaat bij op apparaat-id. (afgeschaft)
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaat-id
|
id | string |
Unieke id van het apparaat. |
|
|
Apparaatnaam
|
displayName | string |
Weergavenaam van het apparaat. |
|
|
Apparaatsjabloon
|
template | string |
De definitie van de apparaatsjabloon voor het apparaat. |
|
|
Gesimuleerd
|
simulated | boolean |
Of het apparaat wordt gesimuleerd. |
|
|
Ingeschakeld
|
enabled | boolean |
Of de apparaatverbinding met IoT Central is ingeschakeld. |
|
|
Geconfigureerd
|
provisioned | boolean |
Of resources zijn toegewezen voor het apparaat. |
Retouren
- Body
- DeviceV1
Een apparaat maken of bijwerken (afgeschaft)
Maak een nieuw apparaat of werk een bestaand apparaat bij op apparaat-id (afgeschaft).
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaat-id
|
id | string |
Unieke id van het apparaat. |
|
|
Apparaatnaam
|
displayName | string |
Weergavenaam van het apparaat. |
|
|
Apparaatsjabloon
|
instanceOf | string |
De definitie van de apparaatsjabloon voor het apparaat. |
|
|
Gesimuleerd
|
simulated | boolean |
Of het apparaat wordt gesimuleerd. |
|
|
Goedgekeurd
|
approved | boolean |
Of het apparaat is goedgekeurd om verbinding te maken met IoT Central. |
|
|
Geconfigureerd
|
provisioned | boolean |
Of resources zijn toegewezen voor het apparaat. |
Retouren
- Body
- Device
Een apparaat ophalen aan de hand van ID
Meer informatie over een bestaand apparaat op basis van apparaat-id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
Retouren
- Body
- DeviceV1
Een apparaat ophalen op basis van id (afgeschaft)
Meer informatie over een bestaand apparaat op apparaat-id (afgeschaft).
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
Retouren
- Body
- Device
Een apparaat verwijderen
Verwijder een bestaand apparaat op apparaat-id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
Een apparaat verwijderen (afgeschaft)
Een bestaand apparaat verwijderen op apparaat-id (afgeschaft).
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
Een apparaatgroep maken
Een apparaatgroep maken of bijwerken.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaatgroep-id
|
device_group_id | True | string |
Unieke id van de apparaatgroep. |
|
Apparaatgroep-id
|
id | string |
Unieke id van de apparaatgroep. |
|
|
Weergavenaam
|
displayName | True | string |
Weergavenaam van de apparaatgroep. |
|
Filter
|
filter | True | string |
Query definiëren welke apparaten zich in deze groep moeten bevinden. |
|
Description
|
description | string |
Korte samenvatting van apparaatgroep. |
|
|
ETag
|
etag | string |
ETag gebruikt om conflicten in apparaatgroepupdates te voorkomen. |
|
|
Organizations
|
organizations | array of string |
Lijst met organisaties van de apparaatgroep, er wordt momenteel slechts één organisatie ondersteund. Meerdere organisaties worden binnenkort ondersteund. |
Retouren
De definitie van de apparaatgroep.
- Body
- DeviceGroup
Een apparaatgroep ophalen
Meer informatie over een bestaande apparaatgroep op id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaatgroep-id
|
device_group_id | True | string |
Unieke id van de apparaatgroep. |
Retouren
De definitie van de apparaatgroep.
- Body
- DeviceGroup
Een apparaatopdracht uitvoeren
Voer een opdracht uit op een apparaat.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatopdracht
|
command_name | True | string |
Naam van deze apparaatopdracht. |
|
Apparaatsjabloon
|
template | string |
De definitie van de apparaatsjabloon voor het apparaat. |
|
|
body
|
body | True | dynamic |
Hoofdtekst van apparaatopdracht. |
Retouren
Een apparaatopdracht uitvoeren (afgeschaft)
Voer een opdracht uit op een apparaat (afgeschaft).
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatonderdeel
|
component_name | True | string |
Naam van het apparaatonderdeel. |
|
Apparaatopdracht
|
command_name | True | string |
Naam van deze apparaatopdracht. |
|
Apparaatsjabloon-id
|
instanceOf | string |
De definitie van de apparaatsjabloon voor het apparaat. |
|
|
body
|
body | True | dynamic |
Hoofdtekst van apparaatopdracht. |
Retouren
Een apparaatrelatie bijwerken
Werk een bestaande apparaatrelatie bij tussen het opgegeven apparaat en een nieuw apparaat met een apparaat-id en een relatie-id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Relatie-id
|
relationship_id | True | string |
Unieke id van de apparaatrelatie. |
|
Apparaatrelatie-id
|
id | string |
Unieke id van de apparaatrelatie. |
|
|
Doel-id van apparaatrelatie
|
target | True | string |
De apparaat-id van het bronapparaat (onderliggend). |
Retouren
Een apparaatrelatie maken
Maak een nieuwe apparaatrelatie tussen het opgegeven apparaat en een nieuw apparaat op basis van een apparaat-id en een relatie-id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Relatie-id
|
relationship_id | True | string |
Unieke id van de apparaatrelatie. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatrelatie-id
|
id | string |
Unieke id van de apparaatrelatie. |
|
|
Doel-id van apparaatrelatie
|
target | True | string |
De apparaat-id van het bronapparaat (onderliggend). |
Retouren
Een apparaatrelatie verwijderen
Verwijder een bestaande apparaatrelatie op basis van apparaat-id en relatie-id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Relatie-id
|
relationship_id | True | string |
Unieke id van de apparaatrelatie. |
Een apparaatsjabloon ophalen op basis van id
Meer informatie over een bestaande apparaatsjabloon op basis van id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Template
|
template_id | True | string |
Unieke id van de sjabloon. |
Retouren
- Body
- DeviceTemplateV1
Een apparaatsjabloon verwijderen
Verwijder een bestaande apparaatsjabloon op id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Template
|
template_id | True | string |
Unieke id van de sjabloon. |
Een geplande taak bijwerken
Werk een bestaande geplande taak bij op id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Geplande taak-id
|
scheduled_job_id | True | string |
Unieke id van de geplande taak. |
|
Eindetype planning
|
scheduled_job_end_type | string |
Hoe de geplande taak moet eindigen (niet toegepast op migraties van apparaatsjablonen). |
|
|
Body
|
body | True | dynamic |
Hoofdtekst voor geplande taak maken. |
Retouren
De geplande taakdefinitie.
- Body
- ScheduledJobStatic
Een geplande taak maken
Maak en voer een nieuwe geplande taak uit via de taakdefinitie.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Geplande taak-id
|
scheduled_job_id | True | string |
Unieke id van de geplande taak. |
|
Functietype
|
job_type | string |
Type taak. |
|
|
Eindetype planning
|
scheduled_job_end_type | string |
Hoe de geplande taak moet eindigen (niet toegepast op migraties van apparaatsjablonen). |
|
|
Body
|
body | True | dynamic |
Hoofdtekst voor geplande taak maken. |
Retouren
Een geplande taak ophalen
Meer informatie over een bestaande geplande taak op id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Geplande taak-id
|
scheduled_job_id | True | string |
Unieke id van de geplande taak. |
Retouren
Een geplande taak verwijderen
Verwijder een bestaande geplande taak op id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Geplande taak-id
|
scheduled_job_id | True | string |
Unieke id van de geplande taak. |
Een gestopte taak hervatten
De uitvoering van een bestaande gestopte taak hervatten.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Functie-ID
|
job_id | True | string |
Unieke id van de taak. |
Een moduleonderdeelopdracht uitvoeren
Voer een opdracht uit op een moduleonderdeel.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatmodule
|
module | True | string |
Naam van de apparaatmodule. |
|
Apparaatonderdeel
|
component_name | True | string |
Naam van het apparaatonderdeel. |
|
Apparaatopdracht
|
command_name | True | string |
Naam van deze apparaatopdracht. |
|
Apparaatsjabloon
|
template | string |
De definitie van de apparaatsjabloon voor het apparaat. |
|
|
body
|
body | True | dynamic |
Hoofdtekst van apparaatopdracht. |
Retouren
Een moduleopdracht uitvoeren
Voer een opdracht uit op een module.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatmodule
|
module | True | string |
Naam van de apparaatmodule. |
|
Apparaatopdracht
|
command_name | True | string |
Naam van deze apparaatopdracht. |
|
Apparaatsjabloon
|
template | string |
De definitie van de apparaatsjabloon voor het apparaat. |
|
|
body
|
body | True | dynamic |
Hoofdtekst van apparaatopdracht. |
Retouren
Een onderdeelopdracht uitvoeren
Voer een opdracht uit op een onderdeel.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatonderdeel
|
component_name | True | string |
Naam van het apparaatonderdeel. |
|
Apparaatopdracht
|
command_name | True | string |
Naam van deze apparaatopdracht. |
|
Apparaatsjabloon
|
template | string |
De definitie van de apparaatsjabloon voor het apparaat. |
|
|
body
|
body | True | dynamic |
Hoofdtekst van apparaatopdracht. |
Retouren
Een organisatie maken
Maak een nieuwe organisatie.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Organisatie-id
|
organization_id | True | string |
Unieke id van de organisatie. |
|
Organisatie-id
|
id | string |
Unieke id van de organisatie. |
|
|
Organisatienaam
|
displayName | string |
Weergavenaam van de organisatie. |
|
|
Parent
|
parent | string |
Weergavenaam van de bovenliggende organisatie. |
Retouren
- Body
- Organization
Een organisatie ophalen
Meer informatie over een bestaande organisatie op basis van id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Organisatie-id
|
organization_id | True | string |
Unieke id van de organisatie. |
Retouren
- Body
- Organization
Een taak hervatten op mislukte apparaten
Voer een nieuwe uitvoering van een bestaande taak uit op alle mislukte apparaten.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Functie-ID
|
job_id | True | string |
Unieke id van de taak. |
|
Id opnieuw uitvoeren
|
rerun_id | True | string |
Unieke id van het opnieuw uitvoeren. |
Retouren
De taakdefinitie.
- Body
- JobStatic
Een taak maken
Maak en voer een nieuwe taak uit via de taakdefinitie.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Functie-ID
|
job_id | True | string |
Unieke id van de taak. |
|
Functietype
|
job_type | string |
Type taak. |
|
|
Body
|
body | True | dynamic |
Hoofdtekst voor taak maken. |
Retouren
Een taak ophalen
Details over een bestaande taak op id ophalen.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Functie-ID
|
job_id | True | string |
Unieke id van de taak. |
Retouren
De taakdefinitie.
- Body
- JobStatic
Gebruiker bijwerken
Een gebruiker in de toepassing bijwerken via patch
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
User
|
user_id | True | string |
Unieke id van de gebruiker. |
|
Gebruikerstype
|
user_type | string |
Type gebruiker. |
|
|
Body
|
body | True | dynamic |
Hoofdtekst van gebruikersupdate. |
Retouren
Gebruiker maken
Een gebruiker maken in de toepassing
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
User
|
user_id | True | string |
Unieke id van de gebruiker. |
|
Gebruikerstype
|
user_type | string |
Type gebruiker. |
|
|
Body
|
body | True | dynamic |
Hoofdtekst van gebruiker maken. |
Retouren
Gebruiker ophalen
Een gebruiker ophalen op basis van id
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
User
|
user_id | True | string |
Unieke id van de gebruiker. |
Retouren
- Body
- UserStaticV1
Gebruiker verwijderen
Een gebruiker verwijderen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
User
|
user_id | True | string |
Unieke id van de gebruiker. |
Gebruikers weergeven
De lijst met gebruikers in een toepassing ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
Retouren
- Body
- UserCollectionV1
Geplande taken weergeven
Haal de lijst met geplande taken in een toepassing op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
Retouren
Lijst met relaties
Alle relaties weergeven op basis van de apparaat-id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
Retouren
Module-eigenschappen bijwerken
Werk alle eigenschapswaarden van een module bij.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatmodule
|
module | True | string |
Naam van de apparaatmodule. |
|
Apparaatsjabloon
|
template | string |
De definitie van de apparaatsjabloon voor het apparaat. |
|
|
body
|
body | True | dynamic |
Apparaateigenschappen. |
Retouren
Module-eigenschappen ophalen
Haal alle eigenschapswaarden van een module op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatmodule
|
module | True | string |
Naam van de apparaatmodule. |
|
Apparaatsjabloon
|
template | string |
De definitie van de apparaatsjabloon voor het apparaat. |
Retouren
Moduletelemetriewaarde ophalen
Haal de laatste telemetriewaarde op uit een module.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatmodule
|
module | True | string |
Naam van de apparaatmodule. |
|
Apparaattelemetrie
|
telemetry_name | True | string |
Naam van dit apparaattelemetrie. |
|
Apparaatsjabloon
|
template | string |
De definitie van de apparaatsjabloon voor het apparaat. |
Retouren
Opdrachtantwoord moduleonderdeel ophalen
Haal het laatste antwoord op voor een moduleonderdeelopdracht.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatmodule
|
module | True | string |
Naam van de apparaatmodule. |
|
Apparaatonderdeel
|
component_name | True | string |
Naam van het apparaatonderdeel. |
|
Apparaatopdracht
|
command_name | True | string |
Naam van deze apparaatopdracht. |
|
Apparaatsjabloon
|
template | string |
De definitie van de apparaatsjabloon voor het apparaat. |
Retouren
Organisatie verwijderen
Een bestaande organisatie verwijderen op id
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Organisatie-id
|
organization_id | True | string |
Unieke id van de organisatie. |
Organisaties vermelden
Haal de lijst met organisaties in een toepassing op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
Retouren
Rol ophalen
Haal een rol op id op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Rol
|
role_id | True | string |
Unieke id voor de rol. |
Retouren
- Body
- RoleV1
Rollen vermelden
Haal de lijst met rollen in een toepassing op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
Retouren
- Body
- RoleCollectionV1
Taken ophalen op geplande taak-id
Haal de lijst met taken op voor een geplande taakdefinitie.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Geplande taak-id
|
scheduled_job_id | True | string |
Unieke id van de geplande taak. |
Retouren
De paginaresultaten van taakdefinities die behoren tot een geplande taak.
Taken weergeven
Haal de lijst met taken in een toepassing op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
Retouren
De paginaresultaten van taken.
- Body
- JobCollection
Telemetriewaarde van apparaat ophalen
Haal de laatste telemetriewaarde op van een apparaat.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaattelemetrie
|
telemetry_name | True | string |
Naam van dit apparaattelemetrie. |
|
Apparaatsjabloon
|
template | string |
De definitie van de apparaatsjabloon voor het apparaat. |
Retouren
Telemetriewaarde van apparaat ophalen (afgeschaft)
Haal de laatste telemetriewaarde op van een apparaat (afgeschaft).
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatonderdeel
|
component_name | True | string |
Naam van het apparaatonderdeel. |
|
Apparaattelemetrie
|
telemetry_name | True | string |
Naam van dit apparaattelemetrie. |
|
Apparaatsjabloon-id
|
instanceOf | string |
De definitie van de apparaatsjabloon voor het apparaat. |
Retouren
Telemetriewaarde voor moduleonderdelen ophalen
Haal de laatste telemetriewaarde op uit een moduleonderdeel.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatmodule
|
module | True | string |
Naam van de apparaatmodule. |
|
Apparaatonderdeel
|
component_name | True | string |
Naam van het apparaatonderdeel. |
|
Apparaattelemetrie
|
telemetry_name | True | string |
Naam van dit apparaattelemetrie. |
|
Apparaatsjabloon
|
template | string |
De definitie van de apparaatsjabloon voor het apparaat. |
Retouren
Telemetriewaarde voor onderdelen ophalen
Haal de laatste telemetriewaarde van een onderdeel op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Apparaat-id
|
device_id | True | string |
Unieke id van het apparaat. |
|
Apparaatonderdeel
|
component_name | True | string |
Naam van het apparaatonderdeel. |
|
Apparaattelemetrie
|
telemetry_name | True | string |
Naam van dit apparaattelemetrie. |
|
Apparaatsjabloon
|
template | string |
De definitie van de apparaatsjabloon voor het apparaat. |
Retouren
Triggers
| Wanneer een regel wordt geactiveerd |
Maak een actie die wordt geactiveerd wanneer een regel wordt geactiveerd in IoT Central. |
Wanneer een regel wordt geactiveerd
Maak een actie die wordt geactiveerd wanneer een regel wordt geactiveerd in IoT Central.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
Unieke id van de toepassing. |
|
Werkstroomtrigger-id
|
id | string |
Unieke id van de werkstroomtrigger. |
|
|
Regel
|
rule | True | string |
Unieke id van de regel die is gekoppeld aan de werkstroomtrigger. |
Retouren
Definities
Apparaat
| Name | Pad | Type | Description |
|---|---|---|---|
|
Apparaat-id
|
id | string |
Unieke id van het apparaat. |
|
Apparaatnaam
|
displayName | string |
Weergavenaam van het apparaat. |
|
Apparaatsjabloon
|
instanceOf | string |
De definitie van de apparaatsjabloon voor het apparaat. |
|
Gesimuleerd
|
simulated | boolean |
Of het apparaat wordt gesimuleerd. |
|
Goedgekeurd
|
approved | boolean |
Of het apparaat is goedgekeurd om verbinding te maken met IoT Central. |
|
Geconfigureerd
|
provisioned | boolean |
Of resources zijn toegewezen voor het apparaat. |
DeviceV1
| Name | Pad | Type | Description |
|---|---|---|---|
|
Apparaat-id
|
id | string |
Unieke id van het apparaat. |
|
Apparaatnaam
|
displayName | string |
Weergavenaam van het apparaat. |
|
Apparaatsjabloon
|
template | string |
De definitie van de apparaatsjabloon voor het apparaat. |
|
Gesimuleerd
|
simulated | boolean |
Of het apparaat wordt gesimuleerd. |
|
Ingeschakeld
|
enabled | boolean |
Of de apparaatverbinding met IoT Central is ingeschakeld. |
|
Geconfigureerd
|
provisioned | boolean |
Of resources zijn toegewezen voor het apparaat. |
DeviceV2
| Name | Pad | Type | Description |
|---|---|---|---|
|
Apparaat-id
|
id | string |
Unieke id van het apparaat. |
|
Apparaatnaam
|
displayName | string |
Weergavenaam van het apparaat. |
|
Apparaatsjabloon
|
template | string |
De definitie van de apparaatsjabloon voor het apparaat. |
|
Gesimuleerd
|
simulated | boolean |
Of het apparaat wordt gesimuleerd. |
|
Ingeschakeld
|
enabled | boolean |
Of de apparaatverbinding met IoT Central is ingeschakeld. |
|
Organizations
|
organizations | array of string |
Lijst met organisaties van het apparaat, er wordt momenteel slechts één organisatie ondersteund. Meerdere organisaties worden binnenkort ondersteund. |
|
Geconfigureerd
|
provisioned | boolean |
Of resources zijn toegewezen voor het apparaat. |
DeviceCollectionV1
| Name | Pad | Type | Description |
|---|---|---|---|
|
waarde
|
value | array of DeviceV1 |
De verzameling apparaten. |
|
nextLink
|
nextLink | string |
URL voor het ophalen van de volgende pagina met apparaten. |
DeviceGroup
De definitie van de apparaatgroep.
| Name | Pad | Type | Description |
|---|---|---|---|
|
Apparaatgroep-id
|
id | string |
Unieke id van de apparaatgroep. |
|
Weergavenaam
|
displayName | string |
Weergavenaam van de apparaatgroep. |
|
Filter
|
filter | string |
Query definiëren welke apparaten zich in deze groep moeten bevinden. |
|
Description
|
description | string |
Korte samenvatting van apparaatgroep. |
|
ETag
|
etag | string |
ETag gebruikt om conflicten in apparaatgroepupdates te voorkomen. |
|
Organizations
|
organizations | array of string |
Lijst met organisaties van de apparaatgroep, er wordt momenteel slechts één organisatie ondersteund. Meerdere organisaties worden binnenkort ondersteund. |
DeviceGroupCollection
De paginaresultaten van apparaatgroepen.
| Name | Pad | Type | Description |
|---|---|---|---|
|
Apparaatgroep-id
|
value | array of DeviceGroup |
De verzameling apparaatgroepen. |
|
nextLink
|
nextLink | string |
URL voor het ophalen van de volgende pagina van apparaatgroepen. |
DeviceGroupDeviceCollection
De paginaresultaten van apparaten die behoren tot de apparaatgroep.
| Name | Pad | Type | Description |
|---|---|---|---|
|
waarde
|
value | array of DeviceV1 |
De verzameling apparaten die behoren tot de apparaatgroep. |
|
nextLink
|
nextLink | string |
URL voor het ophalen van de volgende pagina met apparaten in de groep. |
DeviceRelationshipStatic
| Name | Pad | Type | Description |
|---|---|---|---|
|
Apparaatrelatie-id
|
id | string |
Unieke id van de apparaatrelatie. |
|
Bron-id van apparaatrelatie
|
source | string |
De apparaat-id van het bronapparaat (bovenliggend) apparaat. |
|
Doel-id van apparaatrelatie
|
target | string |
De apparaat-id van het bronapparaat (onderliggend). |
DeviceRelationshipCollection
| Name | Pad | Type | Description |
|---|---|---|---|
|
waarde
|
value | array of DeviceRelationshipStatic |
De verzameling apparaatrelaties. |
|
nextLink
|
nextLink | string |
URL voor het ophalen van de volgende pagina met apparaatrelaties. |
DeviceTemplateV1
| Name | Pad | Type | Description |
|---|---|---|---|
|
Apparaatsjabloon-id
|
@id | string |
Unieke id van de apparaatsjabloon. |
|
Apparaatsjabloontypen
|
@type | array of string |
De JSON-LD typen van deze apparaatsjabloon. |
|
Naam van apparaatsjabloon
|
displayName | string |
Weergavenaam van de apparaatsjabloon. |
|
Beschrijving van apparaatsjabloon
|
description | string |
Gedetailleerde beschrijving van de apparaatsjabloon. |
|
Mogelijkheidsmodel voor apparaatsjablonen
|
capabilityModel |
Het mogelijkheidsmodel dat wordt gebruikt door deze apparaatsjabloon. |
DeviceTemplateCollectionV1
| Name | Pad | Type | Description |
|---|---|---|---|
|
waarde
|
value | array of DeviceTemplateV1 |
De verzameling apparaatsjablonen. |
|
nextLink
|
nextLink | string |
URL voor het ophalen van de volgende pagina met apparaatsjablonen. |
JobDeviceStatus
De statusdefinitie van het taakapparaat.
| Name | Pad | Type | Description |
|---|---|---|---|
|
Apparaat-id
|
id | string |
Id van het apparaat waarvan de taakstatus wordt opgegeven. |
|
Apparaatstatus
|
status | string |
Geeft aan of de taak wordt gestart, uitgevoerd, enzovoort voor het opgegeven apparaat. |
JobDeviceStatusCollection
De paginaresultaten van de status van het taakapparaat.
| Name | Pad | Type | Description |
|---|---|---|---|
|
waarde
|
value | array of JobDeviceStatus |
De verzameling taakapparaatstatussen. |
|
nextLink
|
nextLink | string |
URL voor het ophalen van de volgende pagina met taakapparaatstatussen. |
JobBatch
De taakbatchdefinitie.
| Name | Pad | Type | Description |
|---|---|---|---|
|
Batchtype
|
type | string |
Of batchverwerking wordt uitgevoerd op een opgegeven aantal apparaten of een percentage van het totale aantal apparaten. |
|
Batchwaarde
|
value | number |
Het aantal of het percentage apparaten waarop batchverwerking wordt uitgevoerd. |
JobCancellationThreshold
De definitie van de drempelwaarde voor taakannulering.
| Name | Pad | Type | Description |
|---|---|---|---|
|
Type annuleringsdrempel
|
type | string |
Of de annuleringsdrempel per opgegeven aantal apparaten of een percentage van het totale aantal apparaten is. |
|
Drempelwaarde voor annulering
|
value | number |
Het aantal of het percentage apparaten waarop de annuleringsdrempel wordt toegepast. |
|
Batch met annuleringsdrempel
|
batch | boolean |
Of de annuleringsdrempel per batch of op de algehele taak van toepassing is. |
JobStatic
De taakdefinitie.
| Name | Pad | Type | Description |
|---|---|---|---|
|
Functie-ID
|
id | string |
Unieke id van de taak. |
|
Weergavenaam
|
displayName | string |
Weergavenaam van de taak. |
|
Description
|
description | string |
Gedetailleerde beschrijving van de taak. |
|
Apparaatgroep
|
group | string |
De id van de apparaatgroep waarop de taak moet worden uitgevoerd. |
|
batch
|
batch | JobBatch |
De taakbatchdefinitie. |
|
annuleringThreshold
|
cancellationThreshold | JobCancellationThreshold |
De definitie van de drempelwaarde voor taakannulering. |
|
Gegevens
|
data | array of object |
Gegevens met betrekking tot de bewerking die door deze taak wordt uitgevoerd. Alle vermeldingen moeten van hetzelfde type zijn. |
|
items
|
data | object | |
|
Organizations
|
organizations | array of string |
Lijst met organisaties van de taak, slechts één organisatie wordt momenteel ondersteund, meerdere organisaties worden binnenkort ondersteund. |
|
Geplande taak-id
|
scheduledJobId | string |
Id van de geplande taakdefinitie die deze taak heeft gemaakt. |
JobCollection
De paginaresultaten van taken.
| Name | Pad | Type | Description |
|---|---|---|---|
|
waarde
|
value | array of JobStatic |
De verzameling taken. |
|
nextLink
|
nextLink | string |
URL voor het ophalen van de volgende pagina met taken. |
Organisatie
| Name | Pad | Type | Description |
|---|---|---|---|
|
Organisatie-id
|
id | string |
Unieke id van de organisatie. |
|
Organisatienaam
|
displayName | string |
Weergavenaam van de organisatie. |
|
Parent
|
parent | string |
Weergavenaam van de bovenliggende organisatie. |
OrganizationCollection
| Name | Pad | Type | Description |
|---|---|---|---|
|
waarde
|
value | array of Organization |
De verzameling organisaties. |
|
nextLink
|
nextLink | string |
URL voor het ophalen van de volgende pagina van organisaties. |
RoleV1
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | string |
Unieke id van de rol. |
|
displayName
|
displayName | string |
Weergavenaam van de rol. |
RoleCollectionV1
| Name | Pad | Type | Description |
|---|---|---|---|
|
waarde
|
value | array of RoleV1 |
De verzameling rollen. |
ScheduledJobStatic
De geplande taakdefinitie.
| Name | Pad | Type | Description |
|---|---|---|---|
|
ETag
|
etag | string |
ETag die wordt gebruikt om conflicten in geplande taakupdates te voorkomen. |
|
Geplande taak-id
|
id | string |
Unieke id van de geplande taak. |
|
Weergavenaam
|
displayName | string |
Weergavenaam van de geplande taak. |
|
Description
|
description | string |
Gedetailleerde beschrijving van de geplande taak. |
|
Apparaatgroep
|
group | string |
De id van de apparaatgroep waarop de taak moet worden uitgevoerd. |
|
batch
|
batch | JobBatch |
De taakbatchdefinitie. |
|
annuleringThreshold
|
cancellationThreshold | JobCancellationThreshold |
De definitie van de drempelwaarde voor taakannulering. |
|
Gegevens
|
data | array of object |
Gegevens met betrekking tot de bewerking die door deze taak wordt uitgevoerd. Alle vermeldingen moeten van hetzelfde type zijn. |
|
items
|
data | object | |
|
Organizations
|
organizations | array of string |
Lijst met organisaties van de taak, slechts één organisatie wordt momenteel ondersteund, meerdere organisaties worden binnenkort ondersteund. |
|
Schema
|
schedule | object |
Het schema waarop de taak moet worden uitgevoerd. |
|
Ingeschakeld
|
enabled | boolean |
Of de geplande taak is ingeschakeld. |
|
Volbracht
|
completed | boolean |
Of de geplande taak is voltooid. |
ScheduledJobCollection
De paginaresultaten van taakdefinities die behoren tot een geplande taak.
| Name | Pad | Type | Description |
|---|---|---|---|
|
waarde
|
value | array of JobStatic |
De verzameling taken. |
|
nextLink
|
nextLink | string |
URL voor het ophalen van de volgende pagina met taken. |
UserStaticV1
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebruikers-ID
|
id | string |
Unieke id van de gebruiker. |
|
Gebruikerstype
|
type | string |
Type gebruiker. |
|
Rollen
|
roles | array of RoleAssignmentV1 |
Lijst met roltoewijzingen waarmee de machtigingen voor toegang tot de toepassing worden opgegeven. |
UserCollectionV1
| Name | Pad | Type | Description |
|---|---|---|---|
|
Users
|
value | array of UserStaticV1 |
De verzameling gebruikers. |
RoleAssignmentV1
| Name | Pad | Type | Description |
|---|---|---|---|
|
Rol
|
role | string |
Id van de rol voor deze roltoewijzing. |