engagementAsyncOperation resource type (Tipo de recurso engagementAsyncOperation)

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Representa o estado de uma operação assíncrona Viva Engage que é uma operação que transcende a duração de um único pedido de API. Estas operações são de execução prolongada ou são demasiado dispendiosas para serem concluídas dentro do período de tempo do pedido original.

Quando uma operação assíncrona é iniciada, o método devolve um 202 Accepted código de resposta e um Operation-Location cabeçalho que contém a localização de engagementAsyncOperation. Verifique periodicamente o estado da operação ao fazer um pedido GET para esta localização; aguarde >30 segundos entre as verificações. Quando o pedido for concluído com êxito, o estado da operação indica succeeded e resourceLocation aponta para o recurso criado ou modificado.

Herda de longRunningOperation.

Métodos

Método	Tipo de retorno	Descrição
Get	engagementAsyncOperation	Obtenha um engagementAsyncOperation para controlar um pedido de operação de execução prolongada.

Propriedades

Propriedade	Tipo	Descrição
createdDateTime	DateTimeOffset	Data e hora em que a operação foi criada. O tipo de carimbo de data/hora representa informações de data e hora com o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z. Herdado de longRunningOperation.
id	Cadeia de caracteres	O identificador exclusivo da operação. Herdado de longRunningOperation.
lastActionDateTime	DateTimeOffset	Data e hora em que a operação assíncrona foi atualizada pela última vez. O tipo de carimbo de data/hora representa informações de data e hora com o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z. Herdado de longRunningOperation.
operationType	engagementAsyncOperationType	O tipo da operação de execução prolongada. Os valores possíveis são: createCommunity, unknownFutureValue.
resourceId	Cadeia de caracteres	O ID do objeto criado ou modificado como resultado desta operação assíncrona.
resourceLocation	Cadeia de caracteres	A localização do objeto criado ou modificado como resultado desta operação assíncrona. Herdado de longRunningOperation.
status	longRunningOperationStatus	O estado da operação. Os valores possíveis são: notStarted, running, succeeded, failed, skipped, unknownFutureValue. Herdado de longRunningOperation.
statusDetail	Cadeia de caracteres	Detalhes sobre o estado da operação. Herdado de longRunningOperation.

engagementAsyncOperationType valores

Member	Descrição
createCommunity	Operação para criar uma comunidade Viva Engage.
unknownFutureValue	Valor da sentinela de enumeração evoluível. Não usar.

Representação JSON

A representação JSON seguinte mostra o tipo de recurso.

{
  "@odata.type": "#microsoft.graph.engagementAsyncOperation",
  "createdDateTime": "String (timestamp)",
  "id": "String (identifier)",
  "lastActionDateTime": "String (timestamp)",
  "operationType": "String",
  "resourceId": "String",
  "resourceLocation": "String",
  "status": "String",
  "statusDetail": "String"
}