名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
単一の API 要求の有効期間を超える操作である Viva Engage 非同期操作の状態を表します。 これらの操作は実行時間が長いか、元の要求の期間内に完了するにはコストがかかりすぎます。
非同期操作が開始されると、メソッドは202 Accepted応答コードと、engagementAsyncOperation の場所を含む Operation-Location ヘッダーを返します。 定期的にこの場所に GET 要求を送信して、操作の状態を定期的にチェックします。チェックの間に >30 秒待ちます。 要求が正常に完了すると、操作 の状態 に succeeded が示され、 resourceLocation は作成または変更されたリソースを指します。
longRunningOperation から継承します。
メソッド
| メソッド | 戻り値の種類 | 説明 |
|---|---|---|
| Get | engagementAsyncOperation | engagementAsyncOperation を取得して、長時間実行される操作要求を追跡します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| createdDateTime | DateTimeOffset | 操作が作成された日時。 タイムスタンプの種類は、ISO 8601 形式を使用して、常に UTC 形式の日付と時刻情報を表します。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。
longRunningOperation から継承されます。 |
| id | 文字列 | 操作の一意識別子。 longRunningOperation から継承されます。 |
| lastActionDateTime | DateTimeOffset | 非同期操作が最後に更新された日時。 タイムスタンプの種類は、ISO 8601 形式を使用して、常に UTC 形式の日付と時刻情報を表します。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。
longRunningOperation から継承されます。 |
| operationType | engagementAsyncOperationType | 長時間実行される操作の種類。 可能な値は createCommunity、 unknownFutureValue です。 |
| resourceId | String | この非同期操作の結果として作成または変更されたオブジェクトの ID。 |
| resourceLocation | 文字列 | この非同期操作の結果として作成または変更されたオブジェクトの場所。 longRunningOperation から継承されます。 |
| status | longRunningOperationStatus | 操作の状態。 使用可能な値: notStarted、running、succeeded、failed、skipped、unknownFutureValue。
longRunningOperation から継承されます。 |
| statusDetail | 文字列 | 操作の状態に関する詳細。 longRunningOperation から継承されます。 |
engagementAsyncOperationType の値
| メンバー | 説明 |
|---|---|
| createCommunity | Viva Engage コミュニティを作成する操作。 |
| unknownFutureValue | 進化可能な列挙センチネル値。 使用しないでください。 |
リレーションシップ
なし。
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"@odata.type": "#microsoft.graph.engagementAsyncOperation",
"createdDateTime": "String (timestamp)",
"id": "String (identifier)",
"lastActionDateTime": "String (timestamp)",
"operationType": "String",
"resourceId": "String",
"resourceLocation": "String",
"status": "String",
"statusDetail": "String"
}