Organizations - Update

Service:

IoT Central

API Version:

2022-07-31

Een organisatie in de toepassing bijwerken via een patch

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

URI-parameters

Name	In	Vereist	Type	Description
baseDomain	path	True	string	Het basisdomein voor alle Azure IoT Central-serviceaanvragen.
organizationId	path	True	string	Unieke id voor de organisatie. Regex pattern: ^(?!-)[a-z0-9-]{1,48}[a-z0-9]$
subdomain	path	True	string	Het subdomein van de toepassing.
api-version	query	True	string	De versie van de API die wordt aangeroepen.

Aanvraagbody

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

Name	Type	Description
body	object	Hoofdtekst van de patch voor de organisatie.

Antwoorden

Name	Type	Description
200 OK	Organization	Geslaagd
Other Status Codes	Error	Er is een foutbericht ontvangen van de IoT Central-service. Headers x-ms-error-code: string

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Update organization

Sample Request

HTTP

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

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

Sample Response

Status code:

200

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

Definities

Name	Description
Error	De antwoordfoutdefinitie.
ErrorDetails	De gedetailleerde informatie van de fout.
Organization	De organisatiedefinitie.

Error

De antwoordfoutdefinitie.

Name	Type	Description
error	ErrorDetails	Foutdetails voor de huidige aanvraag.

ErrorDetails

De gedetailleerde informatie van de fout.

Name	Type	Description
code	string	Foutcode.
message	string	Details van foutbericht.
requestId	string	Correlatie-id voor huidige aanvraag.
time	string	Het tijdstip waarop de foutaanvraag is mislukt.

Organization

De organisatiedefinitie.

Name	Type	Description
displayName	string	Weergavenaam van de organisatie.
id	string	Unieke id van de organisatie.
parent	string	Id van het bovenliggende item van de organisatie.