Microsoft 365 Teamwork.workforce Integration API

openapi: 3.2.0
info:
  title: Teams Teamwork.workforce Integration API
  version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
  description: Core
security:
- azureaadv2: []
tags:
- name: teamwork.workforceIntegration
paths:
  /teamwork/workforceIntegrations:
    get:
      tags:
      - teamwork.workforceIntegration
      summary: List workforceIntegrations
      description: Retrieve a list of workforceIntegration objects.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/workforceintegration-list?view=graph-rest-1.0
      operationId: teamwork_ListWorkforceIntegration
      parameters:
      - $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.workforceIntegrationCollectionResponse'
        default:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    post:
      tags:
      - teamwork.workforceIntegration
      summary: Create workforceIntegration
      description: Create a new workforceIntegration object.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/workforceintegration-post?view=graph-rest-1.0
      operationId: teamwork_CreateWorkforceIntegration
      requestBody:
        description: New navigation property
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.workforceIntegration'
        required: true
      responses:
        2XX:
          description: Created navigation property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.workforceIntegration'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /teamwork/workforceIntegrations/{workforceIntegration-id}:
    get:
      tags:
      - teamwork.workforceIntegration
      summary: Get workforceIntegration
      description: Retrieve the properties and relationships of a workforceIntegration object.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/workforceintegration-get?view=graph-rest-1.0
      operationId: teamwork_GetWorkforceIntegration
      parameters:
      - name: workforceIntegration-id
        in: path
        description: The unique identifier of workforceIntegration
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: workforceIntegration
      - 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.workforceIntegration'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
      - teamwork.workforceIntegration
      summary: Update workforceIntegration
      description: Update the properties of a workforceIntegration object.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/workforceintegration-update?view=graph-rest-1.0
      operationId: teamwork_UpdateWorkforceIntegration
      parameters:
      - name: workforceIntegration-id
        in: path
        description: The unique identifier of workforceIntegration
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: workforceIntegration
      requestBody:
        description: New navigation property values
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.workforceIntegration'
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.workforceIntegration'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
      - teamwork.workforceIntegration
      summary: Delete workforceIntegration
      description: Delete an instance of a workforceIntegration.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/workforceintegration-delete?view=graph-rest-1.0
      operationId: teamwork_DeleteWorkforceIntegration
      parameters:
      - name: workforceIntegration-id
        in: path
        description: The unique identifier of workforceIntegration
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: workforceIntegration
      - 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
  /teamwork/workforceIntegrations/$count:
    get:
      tags:
      - teamwork.workforceIntegration
      summary: Get the number of the resource
      operationId: teamwork.workforceIntegration_GetCount
      parameters:
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      responses:
        2XX:
          $ref: '#/components/responses/ODataCountResponse'
        default:
          $ref: '#/components/responses/error'
components:
  schemas:
    microsoft.graph.identitySet:
      title: identitySet
      type: object
      properties:
        application:
          $ref: '#/components/schemas/microsoft.graph.identity'
        device:
          $ref: '#/components/schemas/microsoft.graph.identity'
        user:
          $ref: '#/components/schemas/microsoft.graph.identity'
      additionalProperties:
        type: object
    microsoft.graph.identity:
      title: identity
      type: object
      properties:
        displayName:
          type:
          - string
          - 'null'
          description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta.
        id:
          type:
          - string
          - 'null'
          description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
      additionalProperties:
        type: object
    microsoft.graph.eligibilityFilteringEnabledEntities:
      title: eligibilityFilteringEnabledEntities
      enum:
      - none
      - swapRequest
      - offerShiftRequest
      - unknownFutureValue
      - timeOffReason
      type: string
      x-ms-enum-flags:
        isFlags: true
    microsoft.graph.workforceIntegrationEncryption:
      title: workforceIntegrationEncryption
      type: object
      properties:
        protocol:
          $ref: '#/components/schemas/microsoft.graph.workforceIntegrationEncryptionProtocol'
        secret:
          type:
          - string
          - 'null'
          description: Encryption shared secret.
      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.ODataErrors.InnerError:
      type: object
      additionalProperties:
        type: object
      description: The structure of this object is service-specific
    microsoft.graph.changeTrackedEntity:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.entity'
      - title: changeTrackedEntity
        type: object
        properties:
          createdBy:
            $ref: '#/components/schemas/microsoft.graph.identitySet'
          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
            - 'null'
            description: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
            format: date-time
            readOnly: true
          lastModifiedBy:
            $ref: '#/components/schemas/microsoft.graph.identitySet'
          lastModifiedDateTime:
            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
            - 'null'
            description: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
            format: date-time
            readOnly: true
        additionalProperties:
          type: object
    microsoft.graph.workforceIntegrationCollectionResponse:
      title: Collection of workforceIntegration
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.workforceIntegration'
        '@odata.nextLink':
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
    microsoft.graph.workforceIntegrationSupportedEntities:
      title: workforceIntegrationSupportedEntities
      enum:
      - none
      - shift
      - swapRequest
      - userShiftPreferences
      - openShift
      - openShiftRequest
      - offerShiftRequest
      - unknownFutureValue
      - timeCard
      - timeOffReason
      - timeOff
      - timeOffRequest
      type: string
      x-ms-enum-flags:
        isFlags: true
    microsoft.graph.workforceIntegrationEncryptionProtocol:
      title: workforceIntegrationEncryptionProtocol
      enum:
      - sharedSecret
      - unknownFutureValue
      type: string
    microsoft.graph.workforceIntegration:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.changeTrackedEntity'
      - title: workforceIntegration
        type: object
        properties:
          apiVersion:
            maximum: 2147483647
            minimum: -2147483648
            type:
            - number
            - 'null'
            description: API version for the callback URL. Start with 1.
            format: int32
          displayName:
            type:
            - string
            - 'null'
            description: Name of the workforce integration.
          eligibilityFilteringEnabledEntities:
            $ref: '#/components/schemas/microsoft.graph.eligibilityFilteringEnabledEntities'
          encryption:
            $ref: '#/components/schemas/microsoft.graph.workforceIntegrationEncryption'
          isActive:
            type:
            - boolean
            - 'null'
            description: Indicates whether this workforce integration is currently active and available.
          supportedEntities:
            $ref: '#/components/schemas/microsoft.graph.workforceIntegrationSupportedEntities'
          url:
            type:
            - string
            - 'null'
            description: Workforce Integration URL for callbacks from the Shifts service.
        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
  responses:
    microsoft.graph.workforceIntegrationCollectionResponse:
      description: Retrieved collection
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.workforceIntegrationCollectionResponse'
    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'
  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
  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: {}