Microsoft 365 Places.workspace API

openapi: 3.2.0
info:
  title: Calendar Places.workspace API
  version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
  description: Core
security:
- azureaadv2: []
tags:
- name: places.workspace
paths:
  /places/{place-id}/microsoft.graph.roomList/workspaces:
    get:
      tags:
      - places.workspace
      summary: Get workspaces from places
      operationId: placeAsRoomList_ListWorkspace
      parameters:
      - name: place-id
        in: path
        description: The unique identifier of place
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: place
      - $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.workspaceCollectionResponse'
        default:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    post:
      tags:
      - places.workspace
      summary: Create new navigation property to workspaces for places
      operationId: placeAsRoomList_CreateWorkspace
      parameters:
      - name: place-id
        in: path
        description: The unique identifier of place
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: place
      requestBody:
        description: New navigation property
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.workspace'
        required: true
      responses:
        2XX:
          description: Created navigation property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.workspace'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /places/{place-id}/microsoft.graph.roomList/workspaces/{workspace-id}:
    get:
      tags:
      - places.workspace
      summary: Get workspaces from places
      operationId: placeAsRoomList_GetWorkspace
      parameters:
      - name: place-id
        in: path
        description: The unique identifier of place
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: place
      - name: workspace-id
        in: path
        description: The unique identifier of workspace
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: workspace
      - 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.workspace'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
      - places.workspace
      summary: Update the navigation property workspaces in places
      operationId: placeAsRoomList_UpdateWorkspace
      parameters:
      - name: place-id
        in: path
        description: The unique identifier of place
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: place
      - name: workspace-id
        in: path
        description: The unique identifier of workspace
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: workspace
      requestBody:
        description: New navigation property values
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.workspace'
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.workspace'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
      - places.workspace
      summary: Delete navigation property workspaces for places
      operationId: placeAsRoomList_DeleteWorkspace
      parameters:
      - name: place-id
        in: path
        description: The unique identifier of place
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: place
      - name: workspace-id
        in: path
        description: The unique identifier of workspace
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: workspace
      - 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
  /places/{place-id}/microsoft.graph.roomList/workspaces/{workspace-id}/checkIns:
    get:
      tags:
      - places.workspace
      summary: Get checkIns from places
      description: A subresource of a place object that indicates the check-in status of an Outlook calendar event booked at the place.
      operationId: placeAsRoomList.workspace_ListCheckIn
      parameters:
      - name: place-id
        in: path
        description: The unique identifier of place
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: place
      - name: workspace-id
        in: path
        description: The unique identifier of workspace
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: workspace
      - $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.checkInClaimCollectionResponse'
        default:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    post:
      tags:
      - places.workspace
      summary: Create new navigation property to checkIns for places
      operationId: placeAsRoomList.workspace_CreateCheckIn
      parameters:
      - name: place-id
        in: path
        description: The unique identifier of place
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: place
      - name: workspace-id
        in: path
        description: The unique identifier of workspace
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: workspace
      requestBody:
        description: New navigation property
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.checkInClaim'
        required: true
      responses:
        2XX:
          description: Created navigation property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.checkInClaim'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /places/{place-id}/microsoft.graph.roomList/workspaces/{workspace-id}/checkIns/{checkInClaim-calendarEventId}:
    get:
      tags:
      - places.workspace
      summary: Get checkIns from places
      description: A subresource of a place object that indicates the check-in status of an Outlook calendar event booked at the place.
      operationId: placeAsRoomList.workspace_GetCheckIn
      parameters:
      - name: place-id
        in: path
        description: The unique identifier of place
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: place
      - name: workspace-id
        in: path
        description: The unique identifier of workspace
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: workspace
      - name: checkInClaim-calendarEventId
        in: path
        description: The unique identifier of checkInClaim
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: checkInClaim
      - 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.checkInClaim'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
      - places.workspace
      summary: Update the navigation property checkIns in places
      operationId: placeAsRoomList.workspace_UpdateCheckIn
      parameters:
      - name: place-id
        in: path
        description: The unique identifier of place
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: place
      - name: workspace-id
        in: path
        description: The unique identifier of workspace
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: workspace
      - name: checkInClaim-calendarEventId
        in: path
        description: The unique identifier of checkInClaim
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: checkInClaim
      requestBody:
        description: New navigation property values
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.checkInClaim'
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.checkInClaim'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
      - places.workspace
      summary: Delete navigation property checkIns for places
      operationId: placeAsRoomList.workspace_DeleteCheckIn
      parameters:
      - name: place-id
        in: path
        description: The unique identifier of place
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: place
      - name: workspace-id
        in: path
        description: The unique identifier of workspace
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: workspace
      - name: checkInClaim-calendarEventId
        in: path
        description: The unique identifier of checkInClaim
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: checkInClaim
      - 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
  /places/{place-id}/microsoft.graph.roomList/workspaces/{workspace-id}/checkIns/$count:
    get:
      tags:
      - places.workspace
      summary: Get the number of the resource
      operationId: placeAsRoomList.workspace.checkIn_GetCount
      parameters:
      - name: place-id
        in: path
        description: The unique identifier of place
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: place
      - name: workspace-id
        in: path
        description: The unique identifier of workspace
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: workspace
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      responses:
        2XX:
          $ref: '#/components/responses/ODataCountResponse'
        default:
          $ref: '#/components/responses/error'
  /places/{place-id}/microsoft.graph.roomList/workspaces/$count:
    get:
      tags:
      - places.workspace
      summary: Get the number of the resource
      operationId: placeAsRoomList.workspace_GetCount
      parameters:
      - name: place-id
        in: path
        description: The unique identifier of place
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: place
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      responses:
        2XX:
          $ref: '#/components/responses/ODataCountResponse'
        default:
          $ref: '#/components/responses/error'
components:
  schemas:
    microsoft.graph.checkInClaim:
      title: checkInClaim
      type: object
      properties:
        calendarEventId:
          type: string
          description: The unique identifier for an Outlook calendar event associated with the checkInClaim object. For more information, see the iCalUId property in event.
        checkInMethod:
          $ref: '#/components/schemas/microsoft.graph.checkInMethod'
        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 date and time when the checkInClaim object was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
          format: date-time
      additionalProperties:
        type: object
    microsoft.graph.physicalAddress:
      title: physicalAddress
      type: object
      properties:
        city:
          type:
          - string
          - 'null'
          description: The city.
        countryOrRegion:
          type:
          - string
          - 'null'
          description: The country or region. It's a free-format string value, for example, 'United States'.
        postalCode:
          type:
          - string
          - 'null'
          description: The postal code.
        state:
          type:
          - string
          - 'null'
          description: The state.
        street:
          type:
          - string
          - 'null'
          description: The street.
      additionalProperties:
        type: object
    microsoft.graph.checkInClaimCollectionResponse:
      title: Collection of checkInClaim
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.checkInClaim'
        '@odata.nextLink':
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
    microsoft.graph.outlookGeoCoordinates:
      title: outlookGeoCoordinates
      type: object
      properties:
        accuracy:
          type:
          - number
          - 'null'
          description: The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.
          format: double
        altitude:
          type:
          - number
          - 'null'
          description: The altitude of the location.
          format: double
        altitudeAccuracy:
          type:
          - number
          - 'null'
          description: The accuracy of the altitude.
          format: double
        latitude:
          type:
          - number
          - 'null'
          description: The latitude of the location.
          format: double
        longitude:
          type:
          - number
          - 'null'
          description: The longitude of the location.
          format: double
      additionalProperties:
        type: object
    microsoft.graph.workspace:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.place'
      - title: workspace
        type: object
        properties:
          capacity:
            maximum: 2147483647
            minimum: -2147483648
            type:
            - number
            - 'null'
            description: The maximum number of individual desks within a workspace.
            format: int32
          displayDeviceName:
            type:
            - string
            - 'null'
            description: The name of the display device (for example, monitor or projector) that is available in the workspace.
          emailAddress:
            type:
            - string
            - 'null'
            description: The email address that is associated with the workspace. This email address is used for booking.
          mode:
            $ref: '#/components/schemas/microsoft.graph.placeMode'
          nickname:
            type: string
            description: A short, friendly name for the workspace, often used for easier identification or display in the UI.
        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.workspaceCollectionResponse:
      title: Collection of workspace
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.workspace'
        '@odata.nextLink':
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
    microsoft.graph.placeMode:
      title: placeMode
      type: object
      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.place:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.entity'
      - title: place
        type: object
        properties:
          address:
            $ref: '#/components/schemas/microsoft.graph.physicalAddress'
          displayName:
            type: string
            description: The name that is associated with the place.
          geoCoordinates:
            $ref: '#/components/schemas/microsoft.graph.outlookGeoCoordinates'
          isWheelChairAccessible:
            type:
            - boolean
            - 'null'
            description: Indicates whether the place is wheelchair accessible.
          label:
            type:
            - string
            - 'null'
            description: User-defined description of the place.
          parentId:
            type:
            - string
            - 'null'
            description: The ID of a parent place.
          phone:
            type:
            - string
            - 'null'
            description: The phone number of the place.
          placeId:
            type:
            - string
            - 'null'
            description: A stable service-level identifier for the place object used by Places workloads.
          tags:
            type: array
            items:
              type: string
            description: Custom tags that are associated with the place for categorization or filtering.
          checkIns:
            type: array
            items:
              $ref: '#/components/schemas/microsoft.graph.checkInClaim'
            description: A subresource of a place object that indicates the check-in status of an Outlook calendar event booked at the place.
            x-ms-navigationProperty: true
        additionalProperties:
          type: object
    microsoft.graph.ODataErrors.InnerError:
      type: object
      additionalProperties:
        type: object
      description: The structure of this object is service-specific
    microsoft.graph.checkInMethod:
      title: checkInMethod
      enum:
      - unspecified
      - manual
      - inferred
      - verified
      - unknownFutureValue
      type: string
    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.checkInClaimCollectionResponse:
      description: Retrieved collection
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.checkInClaimCollectionResponse'
    microsoft.graph.workspaceCollectionResponse:
      description: Retrieved collection
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.workspaceCollectionResponse'
    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: {}