Jak provádět dotazy na rozhraní API služby Azure Digital Twins pro běžné úlohy

Důležité

Byla vydána nová verze služby Azure Digital Twins. Vzhledem k rozšířeným funkcím nové služby se původní služba Azure Digital Twins (popsaná v této sadě dokumentace) vyřadila z provozu.

Pokud chcete zobrazit dokumentaci k nové službě, navštivte aktivní dokumentaci ke službě Azure Digital Twins.

Tento článek ukazuje vzory dotazů, které vám pomůžou s prováděním běžných scénářů pro instanci služby Azure Digital Twins. Předpokládá se, že vaše instance Služby Digital Twins už běží. Můžete použít libovolného klienta REST, například Postman.

V následujících příkladech YOUR_MANAGEMENT_API_URL odkazuje na identifikátor URI rozhraní API služby Digital Twins:

https://YOUR_INSTANCE_NAME.YOUR_LOCATION.azuresmartspaces.net/management/api/v1.0

Název	Nahradit za
NÁZEV_VAŠEHO_INSTANCE	Název instance služby Azure Digital Twins
VAŠE_MÍSTO	Oblast, ve které je vaše instance hostovaná

Dotazy na prostory a typy

Tato část ukazuje ukázkové dotazy, které vám pomůžou získat další informace o zřízených prostorech. Proveďte ověřené požadavky GET HTTP pomocí ukázkových dotazů a nahraďte zástupné symboly hodnotami z vašeho nastavení.

Získejte prostory, které jsou kořenovými uzly.

YOUR_MANAGEMENT_API_URL/spaces?$filter=ParentSpaceId eq null

Získejte prostor podle názvu a uveďte zařízení, senzory, vypočítané hodnoty a hodnoty senzorů.

YOUR_MANAGEMENT_API_URL/spaces?name=Focus Room A1&includes=fullpath,devices,sensors,values,sensorsvalues

Získejte prostory a informace o zařízeních/senzorech, jejichž nadřazeným objektem je dané ID prostoru a které se nacházejí na úrovních 2 až 5 vzhledem k danému prostoru.
```
YOUR_MANAGEMENT_API_URL/spaces?spaceId=YOUR_SPACE_ID&includes=fullpath,devices,sensors,values,sensorsvalues&traverse=Down&minLevel=1&minRelative=true&maxLevel=5&maxRelative=true
```

Získejte prostor s daným ID a zahrňte vypočítané a senzorové hodnoty.

YOUR_MANAGEMENT_API_URL/spaces?ids=YOUR_SPACE_ID&includes=Values,sensors,SensorsValues

Získejte klíče vlastností pro konkrétní prostor.

YOUR_MANAGEMENT_API_URL/propertykeys?spaceId=YOUR_SPACE_ID

Získejte prostory s klíčem vlastnosti nazvaným AreaInSqMeters, jehož hodnota je 30. Můžete také provádět řetězcové operace, například získat mezery obsahující klíč vlastnosti s name = X contains Y.
```
YOUR_MANAGEMENT_API_URL/spaces?propertyKey=AreaInSqMeters&propertyValue=30
```

Získejte všechny názvy s názvem Temperature a přidruženými závislostmi a ontologiemi.

YOUR_MANAGEMENT_API_URL/types?names=Temperature&includes=space,ontologies,description,fullpath

Dotazy na role a přiřazení rolí

Tato část ukazuje některé dotazy, které vám pomůžou získat další informace o rolích a jejich přiřazeních.

Získejte všechny role podporované službou Azure Digital Twins.
```
YOUR_MANAGEMENT_API_URL/system/roles
```
Získejte všechna přiřazení rolí v instanci služby Digital Twins.
```
YOUR_MANAGEMENT_API_URL/roleassignments?path=/&traverse=down
```

Získejte přiřazení rolí na konkrétní cestě.

YOUR_MANAGEMENT_API_URL/roleassignments?path=/A_SPATIAL_PATH

Dotazy na zařízení

Tato část ukazuje některé příklady použití rozhraní API pro správu k získání konkrétních informací o vašich zařízeních. Všechna volání API musí být autentizována pomocí GET HTTP požadavků.

Získejte všechna zařízení.
```
YOUR_MANAGEMENT_API_URL/devices
```

Vyhledejte všechny stavy zařízení.

YOUR_MANAGEMENT_API_URL/system/devices/statuses

Získejte konkrétní zařízení.

YOUR_MANAGEMENT_API_URL/devices/YOUR_DEVICE_ID

Zobrazte všechna zařízení připojená ke kořenovému prostoru.
```
YOUR_MANAGEMENT_API_URL/devices?maxLevel=1
```
Získejte všechna zařízení připojená k prostorům na úrovních 2 až 4.
```
YOUR_MANAGEMENT_API_URL/devices?minLevel=2&maxLevel=4
```
Získejte všechna zařízení přímo připojená k určitému ID místa.
```
YOUR_MANAGEMENT_API_URL/devices?spaceId=YOUR_SPACE_ID
```
Získejte všechna zařízení připojená k určitému prostoru a jeho následníkům.
```
YOUR_MANAGEMENT_API_URL/devices?spaceId=YOUR_SPACE_ID&traverse=Down
```

Získejte všechna zařízení připojená k potomkům prostoru s výjimkou tohoto prostoru.

YOUR_MANAGEMENT_API_URL/devices?spaceId=YOUR_SPACE_ID&traverse=Down&minLevel=1&minRelative=true

Získejte všechna připojená zařízení k přímým podřízeným položkám prostoru.

YOUR_MANAGEMENT_API_URL/devices?spaceId=YOUR_SPACE_ID&traverse=Down&minLevel=1&minRelative=true&maxLevel=1&maxRelative=true

Získejte všechna zařízení připojená k některému z předků prostoru.

YOUR_MANAGEMENT_API_URL/devices?spaceId=YOUR_SPACE_ID&traverse=Up&maxLevel=-1&maxRelative=true

Získejte všechna zařízení připojená k potomkům prostoru, která mají úroveň menší než nebo rovnou 5.
```
YOUR_MANAGEMENT_API_URL/devices?spaceId=YOUR_SPACE_ID&traverse=Down&maxLevel=5
```

Získejte všechna zařízení připojená k prostorům, které jsou na stejné úrovni jako prostor s ID YOUR_SPACE_ID.

YOUR_MANAGEMENT_API_URL/devices?spaceId=YOUR_SPACE_ID&traverse=Span&minLevel=0&minRelative=true&maxLevel=0&maxRelative=true

Získejte připojovací řetězec zařízení IoT Hub pro vaše zařízení.
```
YOUR_MANAGEMENT_API_URL/devices/YOUR_DEVICE_ID?includes=ConnectionString
```

Získejte zařízení s daným ID hardwaru, včetně připojených senzorů.

YOUR_MANAGEMENT_API_URL/devices?hardwareIds=YOUR_DEVICE_HARDWARE_ID&includes=sensors

Získejte senzory pro konkrétní datové typy, v tomto případě pohyb a teplota.
```
YOUR_MANAGEMENT_API_URL/sensors?dataTypes=Motion,Temperature
```

Dotazy na porovnávače a uživatelsky definované funkce

Získejte všechny zřízené porovnávací komponenty a jejich ID.
```
  YOUR_MANAGEMENT_API_URL/matchers
```

Získejte podrobnosti o konkrétním matcheru, včetně mezer a uživatelsky definované funkce.

YOUR_MANAGEMENT_API_URL/matchers/YOUR_MATCHER_ID?includes=description, conditions, fullpath, userdefinedfunctions, space

Vyhodnoťte porovnávač vůči senzoru a povolte protokolování pro účely ladění. Návrat této zprávy HTTP GET vám oznámí, zda matcher a senzor patří k danému datovému typu.
```
  YOUR_MANAGEMENT_API_URL/matchers/YOUR_MATCHER_ID/evaluate/YOUR_SENSOR_ID?enableLogging=true
```

Získejte ID uživatelem definovaných funkcí.

  YOUR_MANAGEMENT_API_URL/userdefinedfunctions

Získání obsahu konkrétní uživatelem definované funkce

  YOUR_MANAGEMENT_API_URL/userdefinedfunctions/YOUR_USER_DEFINED_FUNCTION_ID/contents

Dotazy pro uživatele

Tato část ukazuje několik ukázkových dotazů rozhraní API pro správu uživatelů ve službě Azure Digital Twins. Vytvořte požadavek HTTP GET a nahraďte zástupné symboly hodnotami z vašeho nastavení.

Zobrazit všechny uživatele.
```
YOUR_MANAGEMENT_API_URL/users
```

Získejte konkrétního uživatele.

YOUR_MANAGEMENT_API_URL/users/ANY_USER_ID

Další kroky

Informace o ověřování pomocí rozhraní API pro správu najdete v tématu Ověřování pomocí rozhraní API.

Další informace o koncových bodech rozhraní API najdete v tématu Použití služby Digital Twins Swagger.

Last updated on 2020-02-24

Sdílet prostřednictvím