Organizations - Update

Service:

IoT Central

API Version:

2022-07-31

Atualizar uma organização na aplicação através de patch

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
baseDomain	path	True	string	O domínio base para todos os pedidos de serviço do Azure IoT Central.
organizationId	path	True	string	ID exclusivo da organização. Regex pattern: ^(?!-)[a-z0-9-]{1,48}[a-z0-9]$
subdomain	path	True	string	O subdomínio da aplicação.
api-version	query	True	string	A versão da API que está a ser chamada.

Corpo do Pedido

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

Name	Tipo	Description
body	object	Corpo do patch da organização.

Respostas

Name	Tipo	Description
200 OK	Organization	Com êxito
Other Status Codes	Error	Uma resposta de erro recebida do Serviço Central do IoT. Headers x-ms-error-code: string

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

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"
}

Definições

Name	Description
Error	A definição de erro de resposta.
ErrorDetails	As informações detalhadas do erro.
Organization	A definição da organização.

Error

A definição de erro de resposta.

Name	Tipo	Description
error	ErrorDetails	Detalhes do erro do pedido atual.

ErrorDetails

As informações detalhadas do erro.

Name	Tipo	Description
code	string	Código de erro.
message	string	Detalhes da mensagem de erro.
requestId	string	ID de correlação do pedido atual.
time	string	A hora em que o pedido de erro falhou.

Organization

A definição da organização.

Name	Tipo	Description
displayName	string	Nome a apresentar da organização.
id	string	ID exclusivo da organização.
parent	string	ID do encarregado de educação da organização.