Microsoft 365 Teams.teams Async Operation API

openapi: 3.2.0
info:
  title: Teams.teams Async Operation API
  version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
  description: Core
security:
- azureaadv2: []
tags:
- name: teams.teamsAsyncOperation
paths:
  /teams/{team-id}/operations:
    get:
      tags:
      - teams.teamsAsyncOperation
      summary: Get operations from teams
      description: The async operations that ran or are running on this team.
      operationId: team_ListOperation
      parameters:
      - name: team-id
        in: path
        description: The unique identifier of team
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: team
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/count'
      - name: $orderby
        in: query
        description: Order items by property values
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          $ref: '#/components/responses/microsoft.graph.teamsAsyncOperationCollectionResponse'
        default:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    post:
      tags:
      - teams.teamsAsyncOperation
      summary: Create new navigation property to operations for teams
      operationId: team_CreateOperation
      parameters:
      - name: team-id
        in: path
        description: The unique identifier of team
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: team
      requestBody:
        description: New navigation property
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.teamsAsyncOperation'
        required: true
      responses:
        2XX:
          description: Created navigation property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.teamsAsyncOperation'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /teams/{team-id}/operations/{teamsAsyncOperation-id}:
    get:
      tags:
      - teams.teamsAsyncOperation
      summary: Get operations from teams
      description: The async operations that ran or are running on this team.
      operationId: team_GetOperation
      parameters:
      - name: team-id
        in: path
        description: The unique identifier of team
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: team
      - name: teamsAsyncOperation-id
        in: path
        description: The unique identifier of teamsAsyncOperation
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: teamsAsyncOperation
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          description: Retrieved navigation property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.teamsAsyncOperation'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
      - teams.teamsAsyncOperation
      summary: Update the navigation property operations in teams
      operationId: team_UpdateOperation
      parameters:
      - name: team-id
        in: path
        description: The unique identifier of team
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: team
      - name: teamsAsyncOperation-id
        in: path
        description: The unique identifier of teamsAsyncOperation
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: teamsAsyncOperation
      requestBody:
        description: New navigation property values
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.teamsAsyncOperation'
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.teamsAsyncOperation'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
      - teams.teamsAsyncOperation
      summary: Delete navigation property operations for teams
      operationId: team_DeleteOperation
      parameters:
      - name: team-id
        in: path
        description: The unique identifier of team
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: team
      - name: teamsAsyncOperation-id
        in: path
        description: The unique identifier of teamsAsyncOperation
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: teamsAsyncOperation
      - name: If-Match
        in: header
        description: ETag
        style: simple
        schema:
          type: string
      responses:
        2XX:
          description: Success
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /teams/{team-id}/operations/$count:
    get:
      tags:
      - teams.teamsAsyncOperation
      summary: Get the number of the resource
      operationId: team.operation_GetCount
      parameters:
      - name: team-id
        in: path
        description: The unique identifier of team
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: team
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      responses:
        2XX:
          $ref: '#/components/responses/ODataCountResponse'
        default:
          $ref: '#/components/responses/error'
components:
  schemas:
    microsoft.graph.teamsAsyncOperationCollectionResponse:
      title: Collection of teamsAsyncOperation
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.teamsAsyncOperation'
        '@odata.nextLink':
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.MainError:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
          x-ms-primary-error-message: true
        target:
          type:
          - string
          - 'null'
        details:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails'
        innerError:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError'
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.ODataError:
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.ErrorDetails:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        target:
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
    microsoft.graph.teamsAsyncOperation:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.entity'
      - title: teamsAsyncOperation
        type: object
        properties:
          attemptsCount:
            maximum: 2147483647
            minimum: -2147483648
            type: number
            description: Number of times the operation was attempted before being marked successful or failed.
            format: int32
          createdDateTime:
            pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
            type: string
            description: Time when the operation was created.
            format: date-time
          error:
            $ref: '#/components/schemas/microsoft.graph.operationError'
          lastActionDateTime:
            pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
            type: string
            description: Time when the async operation was last updated.
            format: date-time
          operationType:
            $ref: '#/components/schemas/microsoft.graph.teamsAsyncOperationType'
          status:
            $ref: '#/components/schemas/microsoft.graph.teamsAsyncOperationStatus'
          targetResourceId:
            type:
            - string
            - 'null'
            description: The ID of the object that's created or modified as result of this async operation, typically a team.
          targetResourceLocation:
            type:
            - string
            - 'null'
            description: 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.
        additionalProperties:
          type: object
    microsoft.graph.ODataErrors.InnerError:
      type: object
      additionalProperties:
        type: object
      description: The structure of this object is service-specific
    microsoft.graph.teamsAsyncOperationStatus:
      title: teamsAsyncOperationStatus
      enum:
      - invalid
      - notStarted
      - inProgress
      - succeeded
      - failed
      - unknownFutureValue
      type: string
    microsoft.graph.operationError:
      title: operationError
      type: object
      properties:
        code:
          type:
          - string
          - 'null'
          description: Operation error code.
        message:
          type:
          - string
          - 'null'
          description: Operation error message.
      additionalProperties:
        type: object
    ODataCountResponse:
      type: integer
      format: int32
    microsoft.graph.entity:
      title: entity
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for an entity. Read-only.
      additionalProperties:
        type: object
    microsoft.graph.teamsAsyncOperationType:
      title: teamsAsyncOperationType
      enum:
      - invalid
      - cloneTeam
      - archiveTeam
      - unarchiveTeam
      - createTeam
      - unknownFutureValue
      - teamifyGroup
      - createChannel
      - archiveChannel
      - unarchiveChannel
      type: string
  parameters:
    top:
      name: $top
      in: query
      description: Show only the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
      example: 50
    search:
      name: $search
      in: query
      description: Search items by search phrases
      style: form
      explode: false
      schema:
        type: string
    skip:
      name: $skip
      in: query
      description: Skip the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
    filter:
      name: $filter
      in: query
      description: Filter items by property values
      style: form
      explode: false
      schema:
        type: string
    count:
      name: $count
      in: query
      description: Include count of items
      style: form
      explode: false
      schema:
        type: boolean
  responses:
    microsoft.graph.teamsAsyncOperationCollectionResponse:
      description: Retrieved collection
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.teamsAsyncOperationCollectionResponse'
    ODataCountResponse:
      description: The count of the resource
      content:
        text/plain:
          schema:
            $ref: '#/components/schemas/ODataCountResponse'
    error:
      description: error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError'
  securitySchemes:
    azureaadv2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes: {}