teamsAsyncOperation resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

A Microsoft Teams async operation is an operation that transcends the lifetime of a single API request. These operations are long-running or too expensive to complete within the timeframe of their originating request.

When an async operation is initiated, the method returns a 202 Accepted response code. The response will also contain a Location header, which contains the location of the teamsAsyncOperation. Periodically check the status of the operation by making a GET request to this location; wait >30 seconds between checks. When the request completes successfully, the status will be "succeeded" and the targetResourceLocation will point to the created/modified resource.

Properties

Property Type Description
id string Unique operation id.
operationType teamsAsyncOperationType Denotes which type of operation is being described.
createdDateTime DateTimeOffset Time when the operation was created.
status teamsAsyncOperationStatus Operation status.
lastActionDateTime DateTimeOffset Time when the async operation was last updated.
attemptsCount Int32 Number of times the operation was attempted before being marked successful or failed.
targetResourceId guid The ID of the object that's created or modified as result of this async operation, typically a team.
targetResourceLocation string The location of the object that's created or modified as result of this async operation. This URL should be treated as an opaque value and not parsed into its component paths.
error operationError Any error that causes the async operation to fail.

JSON representation

The following is a JSON representation of the resource.

{
    "id": "string",
    "operationType": "archiveTeam",
    "createdDateTime": "2018-01-01T00:00:00.0000000Z",
    "status": "succeeded",
    "lastActionDateTime": "2018-01-01T00:00:00.0000000Z",
    "attemptsCount": 1,
    "targetResourceId": "fa4aa5a2-a75b-4769-86f4-9e2742a18fda",
    "targetResourceLocation": "/groups('fa4aa5a2-a75b-4769-86f4-9e2742a18fda')/team",
    "error": null
}