Udostępnij za pośrednictwem


Organizations - Create

Tworzenie organizacji w aplikacji

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
baseDomain
path True

string

Domena podstawowa dla wszystkich żądań usług usługi Azure IoT Central.

organizationId
path True

string

Unikatowy identyfikator organizacji.

Wzorzec wyrażenia regularnego: ^(?!-)[a-z0-9-]{1,48}[a-z0-9]$

subdomain
path True

string

Poddomena aplikacji.

api-version
query True

string

Wywoływana wersja interfejsu API.

Treść żądania

Nazwa Typ Opis
displayName

string

Nazwa wyświetlana organizacji.

parent

string

Identyfikator elementu nadrzędnego organizacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

Organization

Powodzenie

Other Status Codes

Error

Odpowiedź o błędzie odebrana z usługi IoT Central.

Nagłówki

x-ms-error-code: string

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Add or update organization

Przykładowe żądanie

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

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
Error

Definicja błędu odpowiedzi.

ErrorDetails

Szczegółowe informacje o błędzie.

Organization

Definicja organizacji.

Error

Definicja błędu odpowiedzi.

Nazwa Typ Opis
error

ErrorDetails

Szczegóły błędu dla bieżącego żądania.

ErrorDetails

Szczegółowe informacje o błędzie.

Nazwa Typ Opis
code

string

Kod błędu.

message

string

Szczegóły komunikatu o błędzie.

requestId

string

Identyfikator korelacji dla bieżącego żądania.

time

string

Czas niepowodzenia żądania błędu.

Organization

Definicja organizacji.

Nazwa Typ Opis
displayName

string

Nazwa wyświetlana organizacji.

id

string

Unikatowy identyfikator organizacji.

parent

string

Identyfikator elementu nadrzędnego organizacji.