Organizations - List

Szolgáltatás:

IoT Central

API-verzió:

2022-07-31

Azoknak a szervezeteknek a listájának lekérése, amelyhez a felhasználó hozzáféréssel rendelkezik egy alkalmazásban

GET https://{subdomain}.{baseDomain}/api/organizations?api-version=2022-07-31

URI-paraméterek

Name	In	Kötelező	Típus	Description
baseDomain	path	True	string	Az összes Azure IoT Central-szolgáltatáskérés alaptartománya.
subdomain	path	True	string	Az alkalmazás altartománya.
api-version	query	True	string	A meghívott API verziója.

Válaszok

Name	Típus	Description
200 OK	OrganizationCollection	Siker
Other Status Codes	Error	Hibaválasz érkezett az IoT Central szolgáltatástól. Fejlécek x-ms-error-code: string

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

List organizations

Mintakérelem

HTTP

GET https://appsubdomain.azureiotcentral.com/api/organizations?api-version=2022-07-31

Mintaválasz

Állapotkód:

200

{
  "value": [
    {
      "id": "us",
      "displayName": "United States"
    },
    {
      "id": "washington",
      "displayName": "Washington",
      "parent": "us"
    },
    {
      "id": "seattle",
      "displayName": "Seattle",
      "parent": "washington"
    }
  ]
}

Definíciók

Name	Description
Error	A válaszhiba definíciója.
ErrorDetails	A hiba részletes információi.
Organization	A szervezet definíciója.
OrganizationCollection	A szervezetek lapozott eredményei.

Error

A válaszhiba definíciója.

Name	Típus	Description
error	ErrorDetails	Az aktuális kérelem hibaadatai.

ErrorDetails

A hiba részletes információi.

Name	Típus	Description
code	string	Hibakód.
message	string	Hibaüzenet részletei.
requestId	string	Az aktuális kérés korrelációs azonosítója.
time	string	A hibakérés sikertelen volt.

Organization

A szervezet definíciója.

Name	Típus	Description
displayName	string	A szervezet megjelenített neve.
id	string	A szervezet egyedi azonosítója.
parent	string	A szervezet szülőjének azonosítója.

OrganizationCollection

A szervezetek lapozott eredményei.

Name	Típus	Description
nextLink	string	URL-cím a szervezetek következő oldalának lekéréséhez.
value	Organization[]	Szervezetek gyűjteménye.