Organizations - Update

Služba:

IoT Central

Verze rozhraní API:

2022-07-31

Aktualizace organizace v aplikaci prostřednictvím opravy

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
baseDomain	path	True	string	Základní doména pro všechny žádosti o službu Azure IoT Central.
organizationId	path	True	string	Jedinečné ID organizace Vzor regulárního výrazu: ^(?!-)[a-z0-9-]{1,48}[a-z0-9]$
subdomain	path	True	string	Subdoména aplikace.
api-version	query	True	string	Verze volaného rozhraní API

Text požadavku

Media Types: "application/json", "application/merge-patch+json"

Name	Typ	Description
body	object	Tělo opravy organizace

Odpovědi

Name	Typ	Description
200 OK	Organization	Success
Other Status Codes	Error	Služba IoT Central přijala chybovou odpověď. Hlavičky x-ms-error-code: string

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Update organization

Ukázkový požadavek

HTTP

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

{
  "displayName": "Seattle",
  "parent": "washington"
}

Ukázková odpověď

Stavový kód:

200

{
  "id": "seattle",
  "displayName": "Seattle",
  "parent": "washington"
}

Definice

Name	Description
Error	Definice chyby odpovědi.
ErrorDetails	Podrobné informace o chybě.
Organization	Definice organizace

Error

Definice chyby odpovědi.

Name	Typ	Description
error	ErrorDetails	Podrobnosti o chybě pro aktuální požadavek

ErrorDetails

Podrobné informace o chybě.

Name	Typ	Description
code	string	Kód chyby
message	string	Podrobnosti o chybové zprávě
requestId	string	ID korelace pro aktuální požadavek.
time	string	Čas, kdy žádost o chybu selhala.

Organization

Definice organizace

Name	Typ	Description
displayName	string	Zobrazovaný název organizace.
id	string	Jedinečné ID organizace.
parent	string	ID nadřazeného objektu organizace.