openapi: 3.0.4
info:
title: Calendar
version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
description: Core
paths:
'/groups/{group-id}/calendar':
get:
tags:
- groups.calendar
summary: Get calendar from groups
description: The group's calendar. Read-only.
operationId: group_GetCalendar
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- 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.calendar'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/groups/{group-id}/calendar/calendarPermissions':
get:
tags:
- groups.calendar
summary: Get calendarPermissions from groups
description: The permissions of the users with whom the calendar is shared.
operationId: group.calendar_ListCalendarPermission
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- $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.calendarPermissionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- groups.calendar
summary: Create new navigation property to calendarPermissions for groups
operationId: group.calendar_CreateCalendarPermission
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/groups/{group-id}/calendar/calendarPermissions/{calendarPermission-id}':
get:
tags:
- groups.calendar
summary: Get calendarPermissions from groups
description: The permissions of the users with whom the calendar is shared.
operationId: group.calendar_GetCalendarPermission
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: calendarPermission-id
in: path
description: The unique identifier of calendarPermission
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarPermission
- 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.calendarPermission'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- groups.calendar
summary: Update the navigation property calendarPermissions in groups
operationId: group.calendar_UpdateCalendarPermission
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: calendarPermission-id
in: path
description: The unique identifier of calendarPermission
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarPermission
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- groups.calendar
summary: Delete navigation property calendarPermissions for groups
operationId: group.calendar_DeleteCalendarPermission
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: calendarPermission-id
in: path
description: The unique identifier of calendarPermission
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarPermission
- 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
'/groups/{group-id}/calendar/calendarPermissions/$count':
get:
tags:
- groups.calendar
summary: Get the number of the resource
operationId: group.calendar.calendarPermission_GetCount
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/groups/{group-id}/calendar/calendarView':
get:
tags:
- groups.calendar
summary: Get calendarView from groups
description: The calendar view for the calendar. Navigation property. Read-only.
operationId: group.calendar_ListCalendarView
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: startDateTime
in: query
description: 'The start date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T19:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $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.eventCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/groups/{group-id}/calendar/calendarView/microsoft.graph.delta()':
get:
tags:
- groups.calendar
summary: Invoke function delta
description: 'Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user''s primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: group.calendar.calendarView_delta
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: startDateTime
in: query
description: 'The start date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of event
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/groups/{group-id}/calendar/events':
get:
tags:
- groups.calendar
summary: Get events from groups
description: The events in the calendar. Navigation property. Read-only.
operationId: group.calendar_ListEvent
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- $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.eventCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- groups.calendar
summary: Create new navigation property to events for groups
operationId: group.calendar_CreateEvent
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/groups/{group-id}/calendar/events/{event-id}':
get:
tags:
- groups.calendar
summary: Get events from groups
description: The events in the calendar. Navigation property. Read-only.
operationId: group.calendar_GetEvent
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- 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.event'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- groups.calendar
summary: Update event
description: Update an event object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-update-event?view=graph-rest-1.0
operationId: group.calendar_UpdateEvent
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- groups.calendar
summary: Delete navigation property events for groups
operationId: group.calendar_DeleteEvent
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- 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
'/groups/{group-id}/calendar/events/{event-id}/attachments':
get:
tags:
- groups.calendar
summary: Get attachments from groups
description: 'The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.'
operationId: group.calendar.event_ListAttachment
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $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.attachmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- groups.calendar
summary: Create new navigation property to attachments for groups
operationId: group.calendar.event_CreateAttachment
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/groups/{group-id}/calendar/events/{event-id}/attachments/{attachment-id}':
get:
tags:
- groups.calendar
summary: Get attachments from groups
description: 'The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.'
operationId: group.calendar.event_GetAttachment
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: attachment
- 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.attachment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- groups.calendar
summary: Delete navigation property attachments for groups
operationId: group.calendar.event_DeleteAttachment
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: attachment
- 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
'/groups/{group-id}/calendar/events/{event-id}/attachments/$count':
get:
tags:
- groups.calendar
summary: Get the number of the resource
operationId: group.calendar.event.attachment_GetCount
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/groups/{group-id}/calendar/events/{event-id}/attachments/microsoft.graph.createUploadSession':
post:
tags:
- groups.calendar
summary: Invoke action createUploadSession
description: 'Create an upload session that allows an app to iteratively upload ranges of a file, so as to attach the file to the specified Outlook item. The item can be a message or event. Use this approach to attach a file if the file size is between 3 MB and 150 MB. To attach a file that''s smaller than 3 MB, do a POST operation on the attachments navigation property of the Outlook item; see how to do this for a message or for an event. As part of the response, this action returns an upload URL that you can use in subsequent sequential PUT queries. Request headers for each PUT operation let you specify the exact range of bytes to be uploaded. This allows transfer to be resumed, in case the network connection is dropped during upload. The following are the steps to attach a file to an Outlook item using an upload session: See attach large files to Outlook messages or events for an example.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/attachment-createuploadsession?view=graph-rest-1.0
operationId: group.calendar.event.attachment_createUploadSession
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
AttachmentItem:
$ref: '#/components/schemas/microsoft.graph.attachmentItem'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.uploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups/{group-id}/calendar/events/{event-id}/calendar':
get:
tags:
- groups.calendar
summary: Get calendar from groups
description: The calendar that contains the event. Navigation property. Read-only.
operationId: group.calendar.event_GetCalendar
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- 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.calendar'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/groups/{group-id}/calendar/events/{event-id}/extensions':
get:
tags:
- groups.calendar
summary: Get extensions from groups
description: The collection of open extensions defined for the event. Nullable.
operationId: group.calendar.event_ListExtension
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $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.extensionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- groups.calendar
summary: Create new navigation property to extensions for groups
operationId: group.calendar.event_CreateExtension
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/groups/{group-id}/calendar/events/{event-id}/extensions/{extension-id}':
get:
tags:
- groups.calendar
summary: Get extensions from groups
description: The collection of open extensions defined for the event. Nullable.
operationId: group.calendar.event_GetExtension
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
- 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.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- groups.calendar
summary: Update the navigation property extensions in groups
operationId: group.calendar.event_UpdateExtension
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- groups.calendar
summary: Delete navigation property extensions for groups
operationId: group.calendar.event_DeleteExtension
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
- 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
'/groups/{group-id}/calendar/events/{event-id}/extensions/$count':
get:
tags:
- groups.calendar
summary: Get the number of the resource
operationId: group.calendar.event.extension_GetCount
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/groups/{group-id}/calendar/events/{event-id}/instances':
get:
tags:
- groups.calendar
summary: Get instances from groups
description: 'The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern, and exceptions modified, but doesn''t include occurrences canceled from the series. Navigation property. Read-only. Nullable.'
operationId: group.calendar.event_ListInstance
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: startDateTime
in: query
description: 'The start date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T19:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $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.eventCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/groups/{group-id}/calendar/events/{event-id}/instances/microsoft.graph.delta()':
get:
tags:
- groups.calendar
summary: Invoke function delta
description: 'Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user''s primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: group.calendar.event.instance_delta
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: startDateTime
in: query
description: 'The start date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of event
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/groups/{group-id}/calendar/events/{event-id}/microsoft.graph.accept':
post:
tags:
- groups.calendar
summary: Invoke action accept
description: Accept the specified event in a user calendar.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-accept?view=graph-rest-1.0
operationId: group.calendar.event_accept
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups/{group-id}/calendar/events/{event-id}/microsoft.graph.cancel':
post:
tags:
- groups.calendar
summary: Invoke action cancel
description: "This action allows the organizer of a meeting to send a cancellation message and cancel the event. The action moves the event to the Deleted Items folder. The organizer can also cancel an occurrence of a recurring meeting \r\nby providing the occurrence event ID. An attendee calling this action gets an error (HTTP 400 Bad Request), with the following\r\nerror message: 'Your request can't be completed. You need to be an organizer to cancel a meeting.' This action differs from Delete in that Cancel is available to only the organizer, and lets\r\nthe organizer send a custom message to the attendees about the cancellation."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-cancel?view=graph-rest-1.0
operationId: group.calendar.event_cancel
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups/{group-id}/calendar/events/{event-id}/microsoft.graph.decline':
post:
tags:
- groups.calendar
summary: Invoke action decline
description: 'Decline invitation to the specified event in a user calendar. If the event allows proposals for new times, on declining the event, an invitee can choose to suggest an alternative time by including the proposedNewTime parameter. For more information on how to propose a time, and how to receive and accept a new time proposal, see Propose new meeting times.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-decline?view=graph-rest-1.0
operationId: group.calendar.event_decline
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ProposedNewTime:
$ref: '#/components/schemas/microsoft.graph.timeSlot'
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups/{group-id}/calendar/events/{event-id}/microsoft.graph.dismissReminder':
post:
tags:
- groups.calendar
summary: Invoke action dismissReminder
description: Dismiss a reminder that has been triggered for an event in a user calendar.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-dismissreminder?view=graph-rest-1.0
operationId: group.calendar.event_dismissReminder
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups/{group-id}/calendar/events/{event-id}/microsoft.graph.forward':
post:
tags:
- groups.calendar
summary: Invoke action forward
description: "This action allows the organizer or attendee of a meeting event to forward the\r\nmeeting request to a new recipient. If the meeting event is forwarded from an attendee's Microsoft 365 mailbox to another recipient, this action\r\nalso sends a message to notify the organizer of the forwarding, and adds the recipient to the organizer's\r\ncopy of the meeting event. This convenience is not available when forwarding from an Outlook.com account."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-forward?view=graph-rest-1.0
operationId: group.calendar.event_forward
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups/{group-id}/calendar/events/{event-id}/microsoft.graph.permanentDelete':
post:
tags:
- groups.calendar
summary: Invoke action permanentDelete
operationId: group.calendar.event_permanentDelete
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups/{group-id}/calendar/events/{event-id}/microsoft.graph.snoozeReminder':
post:
tags:
- groups.calendar
summary: Invoke action snoozeReminder
description: Postpone a reminder for an event in a user calendar until a new time.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-snoozereminder?view=graph-rest-1.0
operationId: group.calendar.event_snoozeReminder
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
NewReminderTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups/{group-id}/calendar/events/{event-id}/microsoft.graph.tentativelyAccept':
post:
tags:
- groups.calendar
summary: Invoke action tentativelyAccept
description: 'Tentatively accept the specified event in a user calendar. If the event allows proposals for new times, on responding tentative to the event, an invitee can choose to suggest an alternative time by including the proposedNewTime parameter. For more information on how to propose a time, and how to receive and accept a new time proposal, see Propose new meeting times.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-tentativelyaccept?view=graph-rest-1.0
operationId: group.calendar.event_tentativelyAccept
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ProposedNewTime:
$ref: '#/components/schemas/microsoft.graph.timeSlot'
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups/{group-id}/calendar/events/$count':
get:
tags:
- groups.calendar
summary: Get the number of the resource
operationId: group.calendar.event_GetCount
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/groups/{group-id}/calendar/events/microsoft.graph.delta()':
get:
tags:
- groups.calendar
summary: Invoke function delta
description: 'Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user''s primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: group.calendar.event_delta
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: startDateTime
in: query
description: 'The start date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of event
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/groups/{group-id}/calendar/microsoft.graph.allowedCalendarSharingRoles(User=''{User}'')':
get:
tags:
- groups.calendar
summary: Invoke function allowedCalendarSharingRoles
operationId: group.calendar_allowedCalendarSharingRole
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: User
in: path
description: 'Usage: User=''{User}'''
required: true
style: simple
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarRoleType'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/groups/{group-id}/calendar/microsoft.graph.getSchedule':
post:
tags:
- groups.calendar
summary: Invoke action getSchedule
description: 'Get the free/busy availability information for a collection of users, distributions lists, or resources (rooms or equipment) for a specified time period.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/calendar-getschedule?view=graph-rest-1.0
operationId: group.calendar_getSchedule
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Schedules:
type: array
items:
type: string
nullable: true
EndTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
StartTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
AvailabilityViewInterval:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.scheduleInformation'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/groups/{group-id}/calendar/microsoft.graph.permanentDelete':
post:
tags:
- groups.calendar
summary: Invoke action permanentDelete
operationId: group.calendar_permanentDelete
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups/{group-id}/calendarView':
get:
tags:
- groups.event
summary: List group calendarView
description: "Get the occurrences, exceptions, and single instances of events in a calendar view defined by a time range,\r\nfrom the default calendar of a group."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-list-calendarview?view=graph-rest-1.0
operationId: group_ListCalendarView
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: startDateTime
in: query
description: 'The start date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T19:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $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.eventCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/groups/{group-id}/calendarView/microsoft.graph.delta()':
get:
tags:
- groups.event
summary: Invoke function delta
description: 'Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user''s primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: group.calendarView_delta
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: startDateTime
in: query
description: 'The start date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of event
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/groups/{group-id}/events':
get:
tags:
- groups.event
summary: List events
description: Retrieve a list of event objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-list-events?view=graph-rest-1.0
operationId: group_ListEvent
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- $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.eventCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- groups.event
summary: Create event
description: Use this API to create a new event.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-post-events?view=graph-rest-1.0
operationId: group_CreateEvent
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/groups/{group-id}/events/{event-id}':
get:
tags:
- groups.event
summary: Get event
description: Get an event object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-get-event?view=graph-rest-1.0
operationId: group_GetEvent
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- 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.event'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- groups.event
summary: Update the navigation property events in groups
operationId: group_UpdateEvent
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- groups.event
summary: Delete event
description: Delete an event object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-delete-event?view=graph-rest-1.0
operationId: group_DeleteEvent
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- 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
'/groups/{group-id}/events/{event-id}/attachments':
get:
tags:
- groups.event
summary: Get attachments from groups
description: 'The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.'
operationId: group.event_ListAttachment
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $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.attachmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- groups.event
summary: Create new navigation property to attachments for groups
operationId: group.event_CreateAttachment
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/groups/{group-id}/events/{event-id}/attachments/{attachment-id}':
get:
tags:
- groups.event
summary: Get attachments from groups
description: 'The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.'
operationId: group.event_GetAttachment
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: attachment
- 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.attachment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- groups.event
summary: Delete navigation property attachments for groups
operationId: group.event_DeleteAttachment
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: attachment
- 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
'/groups/{group-id}/events/{event-id}/attachments/$count':
get:
tags:
- groups.event
summary: Get the number of the resource
operationId: group.event.attachment_GetCount
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/groups/{group-id}/events/{event-id}/attachments/microsoft.graph.createUploadSession':
post:
tags:
- groups.event
summary: Invoke action createUploadSession
description: 'Create an upload session that allows an app to iteratively upload ranges of a file, so as to attach the file to the specified Outlook item. The item can be a message or event. Use this approach to attach a file if the file size is between 3 MB and 150 MB. To attach a file that''s smaller than 3 MB, do a POST operation on the attachments navigation property of the Outlook item; see how to do this for a message or for an event. As part of the response, this action returns an upload URL that you can use in subsequent sequential PUT queries. Request headers for each PUT operation let you specify the exact range of bytes to be uploaded. This allows transfer to be resumed, in case the network connection is dropped during upload. The following are the steps to attach a file to an Outlook item using an upload session: See attach large files to Outlook messages or events for an example.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/attachment-createuploadsession?view=graph-rest-1.0
operationId: group.event.attachment_createUploadSession
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
AttachmentItem:
$ref: '#/components/schemas/microsoft.graph.attachmentItem'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.uploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups/{group-id}/events/{event-id}/calendar':
get:
tags:
- groups.event
summary: Get calendar from groups
description: The calendar that contains the event. Navigation property. Read-only.
operationId: group.event_GetCalendar
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- 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.calendar'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/groups/{group-id}/events/{event-id}/extensions':
get:
tags:
- groups.event
summary: Get open extension
description: Get an open extension (openTypeExtension object) identified by name or fully qualified name. The table in the Permissions section lists the resources that support open extensions. The following table lists the three scenarios where you can get an open extension from a supported resource instance.
operationId: group.event_ListExtension
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $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.extensionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- groups.event
summary: Create open extension
description: 'Create an open extension (openTypeExtension object) and add custom properties in a new or existing instance of a resource. You can create an open extension in a resource instance and store custom data to it all in the same operation, except for specific resources. The table in the Permissions section lists the resources that support open extensions.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/opentypeextension-post-opentypeextension?view=graph-rest-1.0
operationId: group.event_CreateExtension
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/groups/{group-id}/events/{event-id}/extensions/{extension-id}':
get:
tags:
- groups.event
summary: Get open extension
description: Get an open extension (openTypeExtension object) identified by name or fully qualified name. The table in the Permissions section lists the resources that support open extensions. The following table lists the three scenarios where you can get an open extension from a supported resource instance.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/opentypeextension-get?view=graph-rest-1.0
operationId: group.event_GetExtension
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
- 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.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- groups.event
summary: Update the navigation property extensions in groups
operationId: group.event_UpdateExtension
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- groups.event
summary: Delete navigation property extensions for groups
operationId: group.event_DeleteExtension
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
- 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
'/groups/{group-id}/events/{event-id}/extensions/$count':
get:
tags:
- groups.event
summary: Get the number of the resource
operationId: group.event.extension_GetCount
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/groups/{group-id}/events/{event-id}/instances':
get:
tags:
- groups.event
summary: Get instances from groups
description: 'The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern, and exceptions modified, but doesn''t include occurrences canceled from the series. Navigation property. Read-only. Nullable.'
operationId: group.event_ListInstance
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: startDateTime
in: query
description: 'The start date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T19:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $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.eventCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/groups/{group-id}/events/{event-id}/instances/microsoft.graph.delta()':
get:
tags:
- groups.event
summary: Invoke function delta
description: 'Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user''s primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: group.event.instance_delta
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: startDateTime
in: query
description: 'The start date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of event
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/groups/{group-id}/events/{event-id}/microsoft.graph.accept':
post:
tags:
- groups.event
summary: Invoke action accept
description: Accept the specified event in a user calendar.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-accept?view=graph-rest-1.0
operationId: group.event_accept
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups/{group-id}/events/{event-id}/microsoft.graph.cancel':
post:
tags:
- groups.event
summary: Invoke action cancel
description: "This action allows the organizer of a meeting to send a cancellation message and cancel the event. The action moves the event to the Deleted Items folder. The organizer can also cancel an occurrence of a recurring meeting \r\nby providing the occurrence event ID. An attendee calling this action gets an error (HTTP 400 Bad Request), with the following\r\nerror message: 'Your request can't be completed. You need to be an organizer to cancel a meeting.' This action differs from Delete in that Cancel is available to only the organizer, and lets\r\nthe organizer send a custom message to the attendees about the cancellation."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-cancel?view=graph-rest-1.0
operationId: group.event_cancel
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups/{group-id}/events/{event-id}/microsoft.graph.decline':
post:
tags:
- groups.event
summary: Invoke action decline
description: 'Decline invitation to the specified event in a user calendar. If the event allows proposals for new times, on declining the event, an invitee can choose to suggest an alternative time by including the proposedNewTime parameter. For more information on how to propose a time, and how to receive and accept a new time proposal, see Propose new meeting times.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-decline?view=graph-rest-1.0
operationId: group.event_decline
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ProposedNewTime:
$ref: '#/components/schemas/microsoft.graph.timeSlot'
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups/{group-id}/events/{event-id}/microsoft.graph.dismissReminder':
post:
tags:
- groups.event
summary: Invoke action dismissReminder
description: Dismiss a reminder that has been triggered for an event in a user calendar.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-dismissreminder?view=graph-rest-1.0
operationId: group.event_dismissReminder
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups/{group-id}/events/{event-id}/microsoft.graph.forward':
post:
tags:
- groups.event
summary: Invoke action forward
description: "This action allows the organizer or attendee of a meeting event to forward the\r\nmeeting request to a new recipient. If the meeting event is forwarded from an attendee's Microsoft 365 mailbox to another recipient, this action\r\nalso sends a message to notify the organizer of the forwarding, and adds the recipient to the organizer's\r\ncopy of the meeting event. This convenience is not available when forwarding from an Outlook.com account."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-forward?view=graph-rest-1.0
operationId: group.event_forward
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups/{group-id}/events/{event-id}/microsoft.graph.permanentDelete':
post:
tags:
- groups.event
summary: Invoke action permanentDelete
operationId: group.event_permanentDelete
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups/{group-id}/events/{event-id}/microsoft.graph.snoozeReminder':
post:
tags:
- groups.event
summary: Invoke action snoozeReminder
description: Postpone a reminder for an event in a user calendar until a new time.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-snoozereminder?view=graph-rest-1.0
operationId: group.event_snoozeReminder
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
NewReminderTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups/{group-id}/events/{event-id}/microsoft.graph.tentativelyAccept':
post:
tags:
- groups.event
summary: Invoke action tentativelyAccept
description: 'Tentatively accept the specified event in a user calendar. If the event allows proposals for new times, on responding tentative to the event, an invitee can choose to suggest an alternative time by including the proposedNewTime parameter. For more information on how to propose a time, and how to receive and accept a new time proposal, see Propose new meeting times.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-tentativelyaccept?view=graph-rest-1.0
operationId: group.event_tentativelyAccept
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ProposedNewTime:
$ref: '#/components/schemas/microsoft.graph.timeSlot'
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups/{group-id}/events/$count':
get:
tags:
- groups.event
summary: Get the number of the resource
operationId: group.event_GetCount
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/groups/{group-id}/events/microsoft.graph.delta()':
get:
tags:
- groups.event
summary: Invoke function delta
description: 'Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user''s primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: group.event_delta
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: startDateTime
in: query
description: 'The start date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of event
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/places:
post:
tags:
- places.place
summary: Create place
description: 'Create a new place object. You can also use this method to create the following child object types: building, floor, section, room, workspace, or desk.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-post?view=graph-rest-1.0
operationId: place_CreatePlace
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.place'
required: true
responses:
2XX:
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.place'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/places/{place-id}':
patch:
tags:
- places.place
summary: Update place
description: 'Update the properties of place object that can be a building, floor, section, desk, room, workspace, or roomList. You can identify the place by specifying the id property.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-update?view=graph-rest-1.0
operationId: place_UpdatePlace
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 property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.place'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.place'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- places.place
summary: Delete place
description: 'Delete a place object. You can also use this method to delete the following child object types: building, floor, section, or desk.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-delete?view=graph-rest-1.0
operationId: place_DeletePlace
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: 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}/checkIns':
get:
tags:
- places.checkInClaim
summary: Get checkInClaim
description: 'Read the properties and relationships of a checkInClaim object. This API provides the check-in status for a specific place, such as a desk, room, or workspace, associated with a particular reservation.'
operationId: place_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
- $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.checkInClaim
summary: Create checkInClaim
description: 'Create a new checkInClaim object to record the check-in status for a specific place, such as a desk or a room, associated with a specific calendar reservation. This check-in confirms that the reserved space is in use and prevents automatic release if auto-release policies are configured for that place.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-post-checkins?view=graph-rest-1.0
operationId: place_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
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}/checkIns/{checkInClaim-calendarEventId}':
get:
tags:
- places.checkInClaim
summary: Get checkInClaim
description: 'Read the properties and relationships of a checkInClaim object. This API provides the check-in status for a specific place, such as a desk, room, or workspace, associated with a particular reservation.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/checkinclaim-get?view=graph-rest-1.0
operationId: place_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: 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.checkInClaim
summary: Update the navigation property checkIns in places
operationId: place_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: 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.checkInClaim
summary: Delete navigation property checkIns for places
operationId: place_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: 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}/checkIns/$count':
get:
tags:
- places.checkInClaim
summary: Get the number of the resource
operationId: place.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
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/places/{place-id}/microsoft.graph.building':
get:
tags:
- places.place
summary: List place objects
description: "Get a collection of the specified type of place objects defined in a tenant. You can do the following for a given tenant:\r\n- List all buildings.\r\n- List all floors.\r\n- List all sections.\r\n- List all desks.\r\n- List all rooms.\r\n- List all workspaces.\r\n- List all room lists.\r\n- List rooms in a specific room list.\r\n- List workspaces in a specific room list."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-list?view=graph-rest-1.0
operationId: place_GetPlaceAsBuilding
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: $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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.building'
default:
$ref: '#/components/responses/error'
'/places/{place-id}/microsoft.graph.building/checkIns':
get:
tags:
- places.checkInClaim
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: placeAsBuilding_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
- $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.checkInClaim
summary: Create new navigation property to checkIns for places
operationId: placeAsBuilding_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
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.building/checkIns/{checkInClaim-calendarEventId}':
get:
tags:
- places.checkInClaim
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: placeAsBuilding_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: 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.checkInClaim
summary: Update the navigation property checkIns in places
operationId: placeAsBuilding_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: 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.checkInClaim
summary: Delete navigation property checkIns for places
operationId: placeAsBuilding_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: 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.building/checkIns/$count':
get:
tags:
- places.checkInClaim
summary: Get the number of the resource
operationId: placeAsBuilding.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
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/places/{place-id}/microsoft.graph.building/map':
get:
tags:
- places.buildingMap
summary: Get buildingMap
description: Get the map of a building in IMDF format.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/buildingmap-get?view=graph-rest-1.0
operationId: placeAsBuilding_GetMap
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: $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.buildingMap'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- places.buildingMap
summary: Update the navigation property map in places
operationId: placeAsBuilding_UpdateMap
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 values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.buildingMap'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.buildingMap'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- places.buildingMap
summary: Delete buildingMap
description: Delete the map of a specific building.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/buildingmap-delete?view=graph-rest-1.0
operationId: placeAsBuilding_DeleteMap
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: 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.building/map/footprints':
get:
tags:
- places.buildingMap
summary: List footprints
description: Get a list of footprintMap objects for building footprints and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/buildingmap-list-footprints?view=graph-rest-1.0
operationId: placeAsBuilding.map_ListFootprint
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.footprintMapCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- places.buildingMap
summary: Create new navigation property to footprints for places
operationId: placeAsBuilding.map_CreateFootprint
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.footprintMap'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.footprintMap'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/places/{place-id}/microsoft.graph.building/map/footprints/{footprintMap-id}':
get:
tags:
- places.buildingMap
summary: Get footprints from places
description: Represents the approximate physical extent of a referenced building. It corresponds to footprint.geojson in IMDF format.
operationId: placeAsBuilding.map_GetFootprint
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: footprintMap-id
in: path
description: The unique identifier of footprintMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: footprintMap
- 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.footprintMap'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- places.buildingMap
summary: Update the navigation property footprints in places
operationId: placeAsBuilding.map_UpdateFootprint
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: footprintMap-id
in: path
description: The unique identifier of footprintMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: footprintMap
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.footprintMap'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.footprintMap'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- places.buildingMap
summary: Delete navigation property footprints for places
operationId: placeAsBuilding.map_DeleteFootprint
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: footprintMap-id
in: path
description: The unique identifier of footprintMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: footprintMap
- 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.building/map/footprints/$count':
get:
tags:
- places.buildingMap
summary: Get the number of the resource
operationId: placeAsBuilding.map.footprint_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'
'/places/{place-id}/microsoft.graph.building/map/levels':
get:
tags:
- places.buildingMap
summary: List levels
description: Get a list of the levelMap objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/buildingmap-list-levels?view=graph-rest-1.0
operationId: placeAsBuilding.map_ListLevel
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.levelMapCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- places.buildingMap
summary: Create new navigation property to levels for places
operationId: placeAsBuilding.map_CreateLevel
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.levelMap'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.levelMap'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/places/{place-id}/microsoft.graph.building/map/levels/{levelMap-id}':
get:
tags:
- places.buildingMap
summary: Get levels from places
description: Represents a physical floor structure within a building. It corresponds to level.geojson in IMDF format.
operationId: placeAsBuilding.map_GetLevel
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: levelMap-id
in: path
description: The unique identifier of levelMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: levelMap
- 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.levelMap'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- places.buildingMap
summary: Update the navigation property levels in places
operationId: placeAsBuilding.map_UpdateLevel
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: levelMap-id
in: path
description: The unique identifier of levelMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: levelMap
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.levelMap'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.levelMap'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- places.buildingMap
summary: Delete navigation property levels for places
operationId: placeAsBuilding.map_DeleteLevel
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: levelMap-id
in: path
description: The unique identifier of levelMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: levelMap
- 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.building/map/levels/{levelMap-id}/fixtures':
get:
tags:
- places.buildingMap
summary: List fixtures
description: Get a list of the fixtureMap objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/levelmap-list-fixtures?view=graph-rest-1.0
operationId: placeAsBuilding.map.level_ListFixture
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: levelMap-id
in: path
description: The unique identifier of levelMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: levelMap
- $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.fixtureMapCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- places.buildingMap
summary: Create new navigation property to fixtures for places
operationId: placeAsBuilding.map.level_CreateFixture
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: levelMap-id
in: path
description: The unique identifier of levelMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: levelMap
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.fixtureMap'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.fixtureMap'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/places/{place-id}/microsoft.graph.building/map/levels/{levelMap-id}/fixtures/{fixtureMap-id}':
get:
tags:
- places.buildingMap
summary: Get fixtures from places
description: Collection of fixtures (such as furniture or equipment) on this level. Supports upsert.
operationId: placeAsBuilding.map.level_GetFixture
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: levelMap-id
in: path
description: The unique identifier of levelMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: levelMap
- name: fixtureMap-id
in: path
description: The unique identifier of fixtureMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: fixtureMap
- 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.fixtureMap'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- places.buildingMap
summary: Update fixtureMap
description: 'Update the properties of an existing fixtureMap object in IMDF format on a specified floor, or create one if it doesn''t exist.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/fixturemap-update?view=graph-rest-1.0
operationId: placeAsBuilding.map.level_UpdateFixture
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: levelMap-id
in: path
description: The unique identifier of levelMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: levelMap
- name: fixtureMap-id
in: path
description: The unique identifier of fixtureMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: fixtureMap
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.fixtureMap'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.fixtureMap'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- places.buildingMap
summary: Delete fixtureMap
description: Delete a fixture on a specified floor.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/fixturemap-delete?view=graph-rest-1.0
operationId: placeAsBuilding.map.level_DeleteFixture
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: levelMap-id
in: path
description: The unique identifier of levelMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: levelMap
- name: fixtureMap-id
in: path
description: The unique identifier of fixtureMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: fixtureMap
- 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.building/map/levels/{levelMap-id}/fixtures/$count':
get:
tags:
- places.buildingMap
summary: Get the number of the resource
operationId: placeAsBuilding.map.level.fixture_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: levelMap-id
in: path
description: The unique identifier of levelMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: levelMap
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/places/{place-id}/microsoft.graph.building/map/levels/{levelMap-id}/sections':
get:
tags:
- places.buildingMap
summary: List sections
description: Get a list of the sectionMap objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/levelmap-list-sections?view=graph-rest-1.0
operationId: placeAsBuilding.map.level_ListSection
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: levelMap-id
in: path
description: The unique identifier of levelMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: levelMap
- $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.sectionMapCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- places.buildingMap
summary: Create new navigation property to sections for places
operationId: placeAsBuilding.map.level_CreateSection
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: levelMap-id
in: path
description: The unique identifier of levelMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: levelMap
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionMap'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionMap'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/places/{place-id}/microsoft.graph.building/map/levels/{levelMap-id}/sections/{sectionMap-id}':
get:
tags:
- places.buildingMap
summary: Get sections from places
description: Collection of sections (such as zones or partitions) on this level. Supports upsert.
operationId: placeAsBuilding.map.level_GetSection
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: levelMap-id
in: path
description: The unique identifier of levelMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: levelMap
- name: sectionMap-id
in: path
description: The unique identifier of sectionMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: sectionMap
- 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.sectionMap'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- places.buildingMap
summary: Update the navigation property sections in places
operationId: placeAsBuilding.map.level_UpdateSection
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: levelMap-id
in: path
description: The unique identifier of levelMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: levelMap
- name: sectionMap-id
in: path
description: The unique identifier of sectionMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: sectionMap
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionMap'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionMap'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- places.buildingMap
summary: Delete navigation property sections for places
operationId: placeAsBuilding.map.level_DeleteSection
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: levelMap-id
in: path
description: The unique identifier of levelMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: levelMap
- name: sectionMap-id
in: path
description: The unique identifier of sectionMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: sectionMap
- 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.building/map/levels/{levelMap-id}/sections/$count':
get:
tags:
- places.buildingMap
summary: Get the number of the resource
operationId: placeAsBuilding.map.level.section_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: levelMap-id
in: path
description: The unique identifier of levelMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: levelMap
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/places/{place-id}/microsoft.graph.building/map/levels/{levelMap-id}/units':
get:
tags:
- places.buildingMap
summary: List units
description: Get a list of the unitMap objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/levelmap-list-units?view=graph-rest-1.0
operationId: placeAsBuilding.map.level_ListUnit
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: levelMap-id
in: path
description: The unique identifier of levelMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: levelMap
- $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.unitMapCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- places.buildingMap
summary: Create new navigation property to units for places
operationId: placeAsBuilding.map.level_CreateUnit
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: levelMap-id
in: path
description: The unique identifier of levelMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: levelMap
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unitMap'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unitMap'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/places/{place-id}/microsoft.graph.building/map/levels/{levelMap-id}/units/{unitMap-id}':
get:
tags:
- places.buildingMap
summary: Get units from places
description: Collection of units (such as rooms or offices) on this level. Supports upsert.
operationId: placeAsBuilding.map.level_GetUnit
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: levelMap-id
in: path
description: The unique identifier of levelMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: levelMap
- name: unitMap-id
in: path
description: The unique identifier of unitMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unitMap
- 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.unitMap'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- places.buildingMap
summary: Update unitMap
description: 'Update the properties of an existing unitMap object in IMDF format on a specified floor, or create one if it doesn''t exist.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unitmap-update?view=graph-rest-1.0
operationId: placeAsBuilding.map.level_UpdateUnit
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: levelMap-id
in: path
description: The unique identifier of levelMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: levelMap
- name: unitMap-id
in: path
description: The unique identifier of unitMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unitMap
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unitMap'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unitMap'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- places.buildingMap
summary: Delete unitMap
description: Delete a unitMap object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unitmap-delete?view=graph-rest-1.0
operationId: placeAsBuilding.map.level_DeleteUnit
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: levelMap-id
in: path
description: The unique identifier of levelMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: levelMap
- name: unitMap-id
in: path
description: The unique identifier of unitMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unitMap
- 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.building/map/levels/{levelMap-id}/units/$count':
get:
tags:
- places.buildingMap
summary: Get the number of the resource
operationId: placeAsBuilding.map.level.unit_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: levelMap-id
in: path
description: The unique identifier of levelMap
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: levelMap
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/places/{place-id}/microsoft.graph.building/map/levels/$count':
get:
tags:
- places.buildingMap
summary: Get the number of the resource
operationId: placeAsBuilding.map.level_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'
'/places/{place-id}/microsoft.graph.descendants()':
get:
tags:
- places.place.Functions
summary: Invoke function descendants
operationId: place_descendant
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: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of place
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.place'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/places/{place-id}/microsoft.graph.desk':
get:
tags:
- places.place
summary: List place objects
description: "Get a collection of the specified type of place objects defined in a tenant. You can do the following for a given tenant:\r\n- List all buildings.\r\n- List all floors.\r\n- List all sections.\r\n- List all desks.\r\n- List all rooms.\r\n- List all workspaces.\r\n- List all room lists.\r\n- List rooms in a specific room list.\r\n- List workspaces in a specific room list."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-list?view=graph-rest-1.0
operationId: place_GetPlaceAsDesk
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: $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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.desk'
default:
$ref: '#/components/responses/error'
'/places/{place-id}/microsoft.graph.desk/checkIns':
get:
tags:
- places.checkInClaim
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: placeAsDesk_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
- $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.checkInClaim
summary: Create new navigation property to checkIns for places
operationId: placeAsDesk_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
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.desk/checkIns/{checkInClaim-calendarEventId}':
get:
tags:
- places.checkInClaim
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: placeAsDesk_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: 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.checkInClaim
summary: Update the navigation property checkIns in places
operationId: placeAsDesk_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: 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.checkInClaim
summary: Delete navigation property checkIns for places
operationId: placeAsDesk_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: 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.desk/checkIns/$count':
get:
tags:
- places.checkInClaim
summary: Get the number of the resource
operationId: placeAsDesk.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
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/places/{place-id}/microsoft.graph.floor':
get:
tags:
- places.place
summary: List place objects
description: "Get a collection of the specified type of place objects defined in a tenant. You can do the following for a given tenant:\r\n- List all buildings.\r\n- List all floors.\r\n- List all sections.\r\n- List all desks.\r\n- List all rooms.\r\n- List all workspaces.\r\n- List all room lists.\r\n- List rooms in a specific room list.\r\n- List workspaces in a specific room list."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-list?view=graph-rest-1.0
operationId: place_GetPlaceAsFloor
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: $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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.floor'
default:
$ref: '#/components/responses/error'
'/places/{place-id}/microsoft.graph.floor/checkIns':
get:
tags:
- places.checkInClaim
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: placeAsFloor_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
- $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.checkInClaim
summary: Create new navigation property to checkIns for places
operationId: placeAsFloor_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
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.floor/checkIns/{checkInClaim-calendarEventId}':
get:
tags:
- places.checkInClaim
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: placeAsFloor_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: 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.checkInClaim
summary: Update the navigation property checkIns in places
operationId: placeAsFloor_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: 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.checkInClaim
summary: Delete navigation property checkIns for places
operationId: placeAsFloor_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: 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.floor/checkIns/$count':
get:
tags:
- places.checkInClaim
summary: Get the number of the resource
operationId: placeAsFloor.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
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/places/{place-id}/microsoft.graph.room':
get:
tags:
- places.place
summary: List place objects
description: "Get a collection of the specified type of place objects defined in a tenant. You can do the following for a given tenant:\r\n- List all buildings.\r\n- List all floors.\r\n- List all sections.\r\n- List all desks.\r\n- List all rooms.\r\n- List all workspaces.\r\n- List all room lists.\r\n- List rooms in a specific room list.\r\n- List workspaces in a specific room list."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-list?view=graph-rest-1.0
operationId: place_GetPlaceAsRoom
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: $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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.room'
default:
$ref: '#/components/responses/error'
'/places/{place-id}/microsoft.graph.room/checkIns':
get:
tags:
- places.checkInClaim
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: placeAsRoom_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
- $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.checkInClaim
summary: Create new navigation property to checkIns for places
operationId: placeAsRoom_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
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.room/checkIns/{checkInClaim-calendarEventId}':
get:
tags:
- places.checkInClaim
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: placeAsRoom_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: 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.checkInClaim
summary: Update the navigation property checkIns in places
operationId: placeAsRoom_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: 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.checkInClaim
summary: Delete navigation property checkIns for places
operationId: placeAsRoom_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: 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.room/checkIns/$count':
get:
tags:
- places.checkInClaim
summary: Get the number of the resource
operationId: placeAsRoom.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
- $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':
get:
tags:
- places.place
summary: Get place
description: 'Read the properties of a place object specified by its ID. The place object can be one of the following types: The listed resources are derived from the place object.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-get?view=graph-rest-1.0
operationId: place_GetPlaceAsRoomList
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: $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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.roomList'
default:
$ref: '#/components/responses/error'
'/places/{place-id}/microsoft.graph.roomList/checkIns':
get:
tags:
- places.checkInClaim
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_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
- $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.checkInClaim
summary: Create new navigation property to checkIns for places
operationId: placeAsRoomList_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
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/checkIns/{checkInClaim-calendarEventId}':
get:
tags:
- places.checkInClaim
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_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: 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.checkInClaim
summary: Update the navigation property checkIns in places
operationId: placeAsRoomList_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: 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.checkInClaim
summary: Delete navigation property checkIns for places
operationId: placeAsRoomList_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: 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/checkIns/$count':
get:
tags:
- places.checkInClaim
summary: Get the number of the resource
operationId: placeAsRoomList.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
- $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/rooms':
get:
tags:
- places.room
summary: Get rooms from places
operationId: placeAsRoomList_ListRoom
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.roomCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- places.room
summary: Create new navigation property to rooms for places
operationId: placeAsRoomList_CreateRoom
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.room'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.room'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/places/{place-id}/microsoft.graph.roomList/rooms/{room-id}':
get:
tags:
- places.room
summary: Get rooms from places
operationId: placeAsRoomList_GetRoom
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: room-id
in: path
description: The unique identifier of room
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: room
- 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.room'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- places.room
summary: Update the navigation property rooms in places
operationId: placeAsRoomList_UpdateRoom
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: room-id
in: path
description: The unique identifier of room
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: room
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.room'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.room'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- places.room
summary: Delete navigation property rooms for places
operationId: placeAsRoomList_DeleteRoom
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: room-id
in: path
description: The unique identifier of room
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: room
- 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/rooms/{room-id}/checkIns':
get:
tags:
- places.room
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.room_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: room-id
in: path
description: The unique identifier of room
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: room
- $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.room
summary: Create new navigation property to checkIns for places
operationId: placeAsRoomList.room_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: room-id
in: path
description: The unique identifier of room
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: room
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/rooms/{room-id}/checkIns/{checkInClaim-calendarEventId}':
get:
tags:
- places.room
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.room_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: room-id
in: path
description: The unique identifier of room
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: room
- 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.room
summary: Update the navigation property checkIns in places
operationId: placeAsRoomList.room_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: room-id
in: path
description: The unique identifier of room
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: room
- 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.room
summary: Delete navigation property checkIns for places
operationId: placeAsRoomList.room_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: room-id
in: path
description: The unique identifier of room
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: room
- 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/rooms/{room-id}/checkIns/$count':
get:
tags:
- places.room
summary: Get the number of the resource
operationId: placeAsRoomList.room.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: room-id
in: path
description: The unique identifier of room
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: room
- $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/rooms/$count':
get:
tags:
- places.room
summary: Get the number of the resource
operationId: placeAsRoomList.room_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'
'/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'
'/places/{place-id}/microsoft.graph.section':
get:
tags:
- places.place
summary: List place objects
description: "Get a collection of the specified type of place objects defined in a tenant. You can do the following for a given tenant:\r\n- List all buildings.\r\n- List all floors.\r\n- List all sections.\r\n- List all desks.\r\n- List all rooms.\r\n- List all workspaces.\r\n- List all room lists.\r\n- List rooms in a specific room list.\r\n- List workspaces in a specific room list."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-list?view=graph-rest-1.0
operationId: place_GetPlaceAsSection
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: $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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.section'
default:
$ref: '#/components/responses/error'
'/places/{place-id}/microsoft.graph.section/checkIns':
get:
tags:
- places.checkInClaim
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: placeAsSection_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
- $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.checkInClaim
summary: Create new navigation property to checkIns for places
operationId: placeAsSection_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
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.section/checkIns/{checkInClaim-calendarEventId}':
get:
tags:
- places.checkInClaim
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: placeAsSection_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: 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.checkInClaim
summary: Update the navigation property checkIns in places
operationId: placeAsSection_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: 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.checkInClaim
summary: Delete navigation property checkIns for places
operationId: placeAsSection_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: 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.section/checkIns/$count':
get:
tags:
- places.checkInClaim
summary: Get the number of the resource
operationId: placeAsSection.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
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/places/{place-id}/microsoft.graph.workspace':
get:
tags:
- places.place
summary: List place objects
description: "Get a collection of the specified type of place objects defined in a tenant. You can do the following for a given tenant:\r\n- List all buildings.\r\n- List all floors.\r\n- List all sections.\r\n- List all desks.\r\n- List all rooms.\r\n- List all workspaces.\r\n- List all room lists.\r\n- List rooms in a specific room list.\r\n- List workspaces in a specific room list."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-list?view=graph-rest-1.0
operationId: place_GetPlaceAsWorkspace
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: $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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.workspace'
default:
$ref: '#/components/responses/error'
'/places/{place-id}/microsoft.graph.workspace/checkIns':
get:
tags:
- places.checkInClaim
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: placeAsWorkspace_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
- $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.checkInClaim
summary: Create new navigation property to checkIns for places
operationId: placeAsWorkspace_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
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.workspace/checkIns/{checkInClaim-calendarEventId}':
get:
tags:
- places.checkInClaim
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: placeAsWorkspace_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: 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.checkInClaim
summary: Update the navigation property checkIns in places
operationId: placeAsWorkspace_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: 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.checkInClaim
summary: Delete navigation property checkIns for places
operationId: placeAsWorkspace_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: 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.workspace/checkIns/$count':
get:
tags:
- places.checkInClaim
summary: Get the number of the resource
operationId: placeAsWorkspace.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
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/places/$count:
get:
tags:
- places.place
summary: Get the number of the resource
operationId: place_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/places/microsoft.graph.building:
get:
tags:
- places.place
summary: List place objects
description: "Get a collection of the specified type of place objects defined in a tenant. You can do the following for a given tenant:\r\n- List all buildings.\r\n- List all floors.\r\n- List all sections.\r\n- List all desks.\r\n- List all rooms.\r\n- List all workspaces.\r\n- List all room lists.\r\n- List rooms in a specific room list.\r\n- List workspaces in a specific room list."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-list?view=graph-rest-1.0
operationId: place_ListPlaceAsBuilding
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.buildingCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/places/microsoft.graph.building/$count:
get:
tags:
- places.place
summary: Get the number of the resource
operationId: place_GetCountAsBuilding
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/places/microsoft.graph.desk:
get:
tags:
- places.place
summary: List place objects
description: "Get a collection of the specified type of place objects defined in a tenant. You can do the following for a given tenant:\r\n- List all buildings.\r\n- List all floors.\r\n- List all sections.\r\n- List all desks.\r\n- List all rooms.\r\n- List all workspaces.\r\n- List all room lists.\r\n- List rooms in a specific room list.\r\n- List workspaces in a specific room list."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-list?view=graph-rest-1.0
operationId: place_ListPlaceAsDesk
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.deskCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/places/microsoft.graph.desk/$count:
get:
tags:
- places.place
summary: Get the number of the resource
operationId: place_GetCountAsDesk
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/places/microsoft.graph.floor:
get:
tags:
- places.place
summary: List place objects
description: "Get a collection of the specified type of place objects defined in a tenant. You can do the following for a given tenant:\r\n- List all buildings.\r\n- List all floors.\r\n- List all sections.\r\n- List all desks.\r\n- List all rooms.\r\n- List all workspaces.\r\n- List all room lists.\r\n- List rooms in a specific room list.\r\n- List workspaces in a specific room list."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-list?view=graph-rest-1.0
operationId: place_ListPlaceAsFloor
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.floorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/places/microsoft.graph.floor/$count:
get:
tags:
- places.place
summary: Get the number of the resource
operationId: place_GetCountAsFloor
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/places/microsoft.graph.room:
get:
tags:
- places.place
summary: List place objects
description: "Get a collection of the specified type of place objects defined in a tenant. You can do the following for a given tenant:\r\n- List all buildings.\r\n- List all floors.\r\n- List all sections.\r\n- List all desks.\r\n- List all rooms.\r\n- List all workspaces.\r\n- List all room lists.\r\n- List rooms in a specific room list.\r\n- List workspaces in a specific room list."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-list?view=graph-rest-1.0
operationId: place_ListPlaceAsRoom
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.roomCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/places/microsoft.graph.room/$count:
get:
tags:
- places.place
summary: Get the number of the resource
operationId: place_GetCountAsRoom
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/places/microsoft.graph.roomList:
get:
tags:
- places.place
summary: Get place
description: 'Read the properties of a place object specified by its ID. The place object can be one of the following types: The listed resources are derived from the place object.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-get?view=graph-rest-1.0
operationId: place_ListPlaceAsRoomList
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.roomListCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/places/microsoft.graph.roomList/$count:
get:
tags:
- places.place
summary: Get the number of the resource
operationId: place_GetCountAsRoomList
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/places/microsoft.graph.section:
get:
tags:
- places.place
summary: List place objects
description: "Get a collection of the specified type of place objects defined in a tenant. You can do the following for a given tenant:\r\n- List all buildings.\r\n- List all floors.\r\n- List all sections.\r\n- List all desks.\r\n- List all rooms.\r\n- List all workspaces.\r\n- List all room lists.\r\n- List rooms in a specific room list.\r\n- List workspaces in a specific room list."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-list?view=graph-rest-1.0
operationId: place_ListPlaceAsSection
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.sectionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/places/microsoft.graph.section/$count:
get:
tags:
- places.place
summary: Get the number of the resource
operationId: place_GetCountAsSection
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/places/microsoft.graph.workspace:
get:
tags:
- places.place
summary: List place objects
description: "Get a collection of the specified type of place objects defined in a tenant. You can do the following for a given tenant:\r\n- List all buildings.\r\n- List all floors.\r\n- List all sections.\r\n- List all desks.\r\n- List all rooms.\r\n- List all workspaces.\r\n- List all room lists.\r\n- List rooms in a specific room list.\r\n- List workspaces in a specific room list."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-list?view=graph-rest-1.0
operationId: place_ListPlaceAsWorkspace
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.workspaceCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/places/microsoft.graph.workspace/$count:
get:
tags:
- places.place
summary: Get the number of the resource
operationId: place_GetCountAsWorkspace
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/calendar':
get:
tags:
- users.calendar
summary: Get calendar from users
description: The user's primary calendar. Read-only.
operationId: user_GetCalendar
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- 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.calendar'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.calendar
summary: Update the navigation property calendar in users
operationId: user_UpdateCalendar
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/calendar/calendarPermissions':
get:
tags:
- users.calendar
summary: List calendarPermissions
description: 'Get a collection of calendarPermission resources that describe the identity and roles of users with whom the specified calendar has been shared or delegated. Here, the calendar can be a user calendar or group calendar.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/calendar-list-calendarpermissions?view=graph-rest-1.0
operationId: user.calendar_ListCalendarPermission
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- $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.calendarPermissionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.calendar
summary: Create new navigation property to calendarPermissions for users
operationId: user.calendar_CreateCalendarPermission
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/calendar/calendarPermissions/{calendarPermission-id}':
get:
tags:
- users.calendar
summary: Get calendarPermission
description: Get the specified permissions object of a user or group calendar that has been shared.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/calendarpermission-get?view=graph-rest-1.0
operationId: user.calendar_GetCalendarPermission
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarPermission-id
in: path
description: The unique identifier of calendarPermission
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarPermission
- 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.calendarPermission'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.calendar
summary: Update calendarPermission
description: 'Update the permissions assigned to an existing share recipient or delegate, through the corresponding calendarPermission object for a calendar.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/calendarpermission-update?view=graph-rest-1.0
operationId: user.calendar_UpdateCalendarPermission
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarPermission-id
in: path
description: The unique identifier of calendarPermission
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarPermission
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.calendar
summary: Delete calendarPermission
description: Delete calendarPermission.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/calendarpermission-delete?view=graph-rest-1.0
operationId: user.calendar_DeleteCalendarPermission
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarPermission-id
in: path
description: The unique identifier of calendarPermission
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarPermission
- 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
'/users/{user-id}/calendar/calendarPermissions/$count':
get:
tags:
- users.calendar
summary: Get the number of the resource
operationId: user.calendar.calendarPermission_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/calendar/calendarView':
get:
tags:
- users.calendar
summary: Get calendarView from users
description: The calendar view for the calendar. Navigation property. Read-only.
operationId: user.calendar_ListCalendarView
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: startDateTime
in: query
description: 'The start date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T19:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $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.eventCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/users/{user-id}/calendar/calendarView/microsoft.graph.delta()':
get:
tags:
- users.calendar
summary: Invoke function delta
description: 'Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user''s primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: user.calendar.calendarView_delta
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: startDateTime
in: query
description: 'The start date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of event
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/calendar/events':
get:
tags:
- users.calendar
summary: Get events from users
description: The events in the calendar. Navigation property. Read-only.
operationId: user.calendar_ListEvent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- $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.eventCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.calendar
summary: Create new navigation property to events for users
operationId: user.calendar_CreateEvent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/calendar/events/{event-id}':
get:
tags:
- users.calendar
summary: Get events from users
description: The events in the calendar. Navigation property. Read-only.
operationId: user.calendar_GetEvent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- 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.event'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.calendar
summary: Update the navigation property events in users
operationId: user.calendar_UpdateEvent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.calendar
summary: Delete navigation property events for users
operationId: user.calendar_DeleteEvent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- 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
'/users/{user-id}/calendar/events/{event-id}/attachments':
get:
tags:
- users.calendar
summary: Get attachments from users
description: 'The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.'
operationId: user.calendar.event_ListAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $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.attachmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.calendar
summary: Create new navigation property to attachments for users
operationId: user.calendar.event_CreateAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/calendar/events/{event-id}/attachments/{attachment-id}':
get:
tags:
- users.calendar
summary: Get attachments from users
description: 'The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.'
operationId: user.calendar.event_GetAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: attachment
- 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.attachment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.calendar
summary: Delete navigation property attachments for users
operationId: user.calendar.event_DeleteAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: attachment
- 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
'/users/{user-id}/calendar/events/{event-id}/attachments/$count':
get:
tags:
- users.calendar
summary: Get the number of the resource
operationId: user.calendar.event.attachment_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/calendar/events/{event-id}/attachments/microsoft.graph.createUploadSession':
post:
tags:
- users.calendar
summary: Invoke action createUploadSession
description: 'Create an upload session that allows an app to iteratively upload ranges of a file, so as to attach the file to the specified Outlook item. The item can be a message or event. Use this approach to attach a file if the file size is between 3 MB and 150 MB. To attach a file that''s smaller than 3 MB, do a POST operation on the attachments navigation property of the Outlook item; see how to do this for a message or for an event. As part of the response, this action returns an upload URL that you can use in subsequent sequential PUT queries. Request headers for each PUT operation let you specify the exact range of bytes to be uploaded. This allows transfer to be resumed, in case the network connection is dropped during upload. The following are the steps to attach a file to an Outlook item using an upload session: See attach large files to Outlook messages or events for an example.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/attachment-createuploadsession?view=graph-rest-1.0
operationId: user.calendar.event.attachment_createUploadSession
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
AttachmentItem:
$ref: '#/components/schemas/microsoft.graph.attachmentItem'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.uploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendar/events/{event-id}/calendar':
get:
tags:
- users.calendar
summary: Get calendar from users
description: The calendar that contains the event. Navigation property. Read-only.
operationId: user.calendar.event_GetCalendar
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- 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.calendar'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/calendar/events/{event-id}/extensions':
get:
tags:
- users.calendar
summary: Get extensions from users
description: The collection of open extensions defined for the event. Nullable.
operationId: user.calendar.event_ListExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $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.extensionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.calendar
summary: Create new navigation property to extensions for users
operationId: user.calendar.event_CreateExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/calendar/events/{event-id}/extensions/{extension-id}':
get:
tags:
- users.calendar
summary: Get extensions from users
description: The collection of open extensions defined for the event. Nullable.
operationId: user.calendar.event_GetExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
- 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.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.calendar
summary: Update the navigation property extensions in users
operationId: user.calendar.event_UpdateExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.calendar
summary: Delete navigation property extensions for users
operationId: user.calendar.event_DeleteExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
- 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
'/users/{user-id}/calendar/events/{event-id}/extensions/$count':
get:
tags:
- users.calendar
summary: Get the number of the resource
operationId: user.calendar.event.extension_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/calendar/events/{event-id}/instances':
get:
tags:
- users.calendar
summary: Get instances from users
description: 'The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern, and exceptions modified, but doesn''t include occurrences canceled from the series. Navigation property. Read-only. Nullable.'
operationId: user.calendar.event_ListInstance
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: startDateTime
in: query
description: 'The start date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T19:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $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.eventCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/users/{user-id}/calendar/events/{event-id}/instances/microsoft.graph.delta()':
get:
tags:
- users.calendar
summary: Invoke function delta
description: 'Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user''s primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: user.calendar.event.instance_delta
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: startDateTime
in: query
description: 'The start date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of event
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/calendar/events/{event-id}/microsoft.graph.accept':
post:
tags:
- users.calendar
summary: Invoke action accept
description: Accept the specified event in a user calendar.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-accept?view=graph-rest-1.0
operationId: user.calendar.event_accept
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendar/events/{event-id}/microsoft.graph.cancel':
post:
tags:
- users.calendar
summary: Invoke action cancel
description: "This action allows the organizer of a meeting to send a cancellation message and cancel the event. The action moves the event to the Deleted Items folder. The organizer can also cancel an occurrence of a recurring meeting \r\nby providing the occurrence event ID. An attendee calling this action gets an error (HTTP 400 Bad Request), with the following\r\nerror message: 'Your request can't be completed. You need to be an organizer to cancel a meeting.' This action differs from Delete in that Cancel is available to only the organizer, and lets\r\nthe organizer send a custom message to the attendees about the cancellation."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-cancel?view=graph-rest-1.0
operationId: user.calendar.event_cancel
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendar/events/{event-id}/microsoft.graph.decline':
post:
tags:
- users.calendar
summary: Invoke action decline
description: 'Decline invitation to the specified event in a user calendar. If the event allows proposals for new times, on declining the event, an invitee can choose to suggest an alternative time by including the proposedNewTime parameter. For more information on how to propose a time, and how to receive and accept a new time proposal, see Propose new meeting times.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-decline?view=graph-rest-1.0
operationId: user.calendar.event_decline
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ProposedNewTime:
$ref: '#/components/schemas/microsoft.graph.timeSlot'
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendar/events/{event-id}/microsoft.graph.dismissReminder':
post:
tags:
- users.calendar
summary: Invoke action dismissReminder
description: Dismiss a reminder that has been triggered for an event in a user calendar.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-dismissreminder?view=graph-rest-1.0
operationId: user.calendar.event_dismissReminder
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendar/events/{event-id}/microsoft.graph.forward':
post:
tags:
- users.calendar
summary: Invoke action forward
description: "This action allows the organizer or attendee of a meeting event to forward the\r\nmeeting request to a new recipient. If the meeting event is forwarded from an attendee's Microsoft 365 mailbox to another recipient, this action\r\nalso sends a message to notify the organizer of the forwarding, and adds the recipient to the organizer's\r\ncopy of the meeting event. This convenience is not available when forwarding from an Outlook.com account."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-forward?view=graph-rest-1.0
operationId: user.calendar.event_forward
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendar/events/{event-id}/microsoft.graph.permanentDelete':
post:
tags:
- users.calendar
summary: Invoke action permanentDelete
operationId: user.calendar.event_permanentDelete
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendar/events/{event-id}/microsoft.graph.snoozeReminder':
post:
tags:
- users.calendar
summary: Invoke action snoozeReminder
description: Postpone a reminder for an event in a user calendar until a new time.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-snoozereminder?view=graph-rest-1.0
operationId: user.calendar.event_snoozeReminder
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
NewReminderTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendar/events/{event-id}/microsoft.graph.tentativelyAccept':
post:
tags:
- users.calendar
summary: Invoke action tentativelyAccept
description: 'Tentatively accept the specified event in a user calendar. If the event allows proposals for new times, on responding tentative to the event, an invitee can choose to suggest an alternative time by including the proposedNewTime parameter. For more information on how to propose a time, and how to receive and accept a new time proposal, see Propose new meeting times.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-tentativelyaccept?view=graph-rest-1.0
operationId: user.calendar.event_tentativelyAccept
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ProposedNewTime:
$ref: '#/components/schemas/microsoft.graph.timeSlot'
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendar/events/$count':
get:
tags:
- users.calendar
summary: Get the number of the resource
operationId: user.calendar.event_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/calendar/events/microsoft.graph.delta()':
get:
tags:
- users.calendar
summary: Invoke function delta
description: 'Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user''s primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: user.calendar.event_delta
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: startDateTime
in: query
description: 'The start date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of event
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/calendar/microsoft.graph.allowedCalendarSharingRoles(User=''{User}'')':
get:
tags:
- users.calendar
summary: Invoke function allowedCalendarSharingRoles
operationId: user.calendar_allowedCalendarSharingRole
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: User
in: path
description: 'Usage: User=''{User}'''
required: true
style: simple
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarRoleType'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/calendar/microsoft.graph.getSchedule':
post:
tags:
- users.calendar
summary: Invoke action getSchedule
description: 'Get the free/busy availability information for a collection of users, distributions lists, or resources (rooms or equipment) for a specified time period.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/calendar-getschedule?view=graph-rest-1.0
operationId: user.calendar_getSchedule
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Schedules:
type: array
items:
type: string
nullable: true
EndTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
StartTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
AvailabilityViewInterval:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.scheduleInformation'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/calendar/microsoft.graph.permanentDelete':
post:
tags:
- users.calendar
summary: Invoke action permanentDelete
operationId: user.calendar_permanentDelete
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendarGroups':
get:
tags:
- users.calendarGroup
summary: Get calendarGroups from users
description: The user's calendar groups. Read-only. Nullable.
operationId: user_ListCalendarGroup
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- $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.calendarGroupCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.calendarGroup
summary: Create new navigation property to calendarGroups for users
operationId: user_CreateCalendarGroup
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarGroup'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarGroup'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/calendarGroups/{calendarGroup-id}':
get:
tags:
- users.calendarGroup
summary: Get calendarGroups from users
description: The user's calendar groups. Read-only. Nullable.
operationId: user_GetCalendarGroup
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- 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.calendarGroup'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.calendarGroup
summary: Update the navigation property calendarGroups in users
operationId: user_UpdateCalendarGroup
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarGroup'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarGroup'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.calendarGroup
summary: Delete navigation property calendarGroups for users
operationId: user_DeleteCalendarGroup
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- 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
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars':
get:
tags:
- users.calendarGroup
summary: Get calendars from users
description: The calendars in the calendar group. Navigation property. Read-only. Nullable.
operationId: user.calendarGroup_ListCalendar
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- $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.calendarCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.calendarGroup
summary: Create new navigation property to calendars for users
operationId: user.calendarGroup_CreateCalendar
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}':
get:
tags:
- users.calendarGroup
summary: Get calendars from users
description: The calendars in the calendar group. Navigation property. Read-only. Nullable.
operationId: user.calendarGroup_GetCalendar
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- 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.calendar'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.calendarGroup
summary: Update the navigation property calendars in users
operationId: user.calendarGroup_UpdateCalendar
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.calendarGroup
summary: Delete navigation property calendars for users
operationId: user.calendarGroup_DeleteCalendar
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- 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
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarPermissions':
get:
tags:
- users.calendarGroup
summary: Get calendarPermissions from users
description: The permissions of the users with whom the calendar is shared.
operationId: user.calendarGroup.calendar_ListCalendarPermission
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- $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.calendarPermissionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.calendarGroup
summary: Create new navigation property to calendarPermissions for users
operationId: user.calendarGroup.calendar_CreateCalendarPermission
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarPermissions/{calendarPermission-id}':
get:
tags:
- users.calendarGroup
summary: Get calendarPermissions from users
description: The permissions of the users with whom the calendar is shared.
operationId: user.calendarGroup.calendar_GetCalendarPermission
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: calendarPermission-id
in: path
description: The unique identifier of calendarPermission
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarPermission
- 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.calendarPermission'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.calendarGroup
summary: Update the navigation property calendarPermissions in users
operationId: user.calendarGroup.calendar_UpdateCalendarPermission
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: calendarPermission-id
in: path
description: The unique identifier of calendarPermission
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarPermission
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.calendarGroup
summary: Delete navigation property calendarPermissions for users
operationId: user.calendarGroup.calendar_DeleteCalendarPermission
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: calendarPermission-id
in: path
description: The unique identifier of calendarPermission
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarPermission
- 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
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarPermissions/$count':
get:
tags:
- users.calendarGroup
summary: Get the number of the resource
operationId: user.calendarGroup.calendar.calendarPermission_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView':
get:
tags:
- users.calendarGroup
summary: Get calendarView from users
description: The calendar view for the calendar. Navigation property. Read-only.
operationId: user.calendarGroup.calendar_ListCalendarView
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: startDateTime
in: query
description: 'The start date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T19:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $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.eventCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/microsoft.graph.delta()':
get:
tags:
- users.calendarGroup
summary: Invoke function delta
description: 'Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user''s primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: user.calendarGroup.calendar.calendarView_delta
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: startDateTime
in: query
description: 'The start date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of event
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events':
get:
tags:
- users.calendarGroup
summary: Get events from users
description: The events in the calendar. Navigation property. Read-only.
operationId: user.calendarGroup.calendar_ListEvent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- $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.eventCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.calendarGroup
summary: Create new navigation property to events for users
operationId: user.calendarGroup.calendar_CreateEvent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}':
get:
tags:
- users.calendarGroup
summary: Get events from users
description: The events in the calendar. Navigation property. Read-only.
operationId: user.calendarGroup.calendar_GetEvent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- 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.event'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.calendarGroup
summary: Update the navigation property events in users
operationId: user.calendarGroup.calendar_UpdateEvent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.calendarGroup
summary: Delete navigation property events for users
operationId: user.calendarGroup.calendar_DeleteEvent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- 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
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/attachments':
get:
tags:
- users.calendarGroup
summary: Get attachments from users
description: 'The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.'
operationId: user.calendarGroup.calendar.event_ListAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $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.attachmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.calendarGroup
summary: Create new navigation property to attachments for users
operationId: user.calendarGroup.calendar.event_CreateAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/attachments/{attachment-id}':
get:
tags:
- users.calendarGroup
summary: Get attachments from users
description: 'The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.'
operationId: user.calendarGroup.calendar.event_GetAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: attachment
- 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.attachment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.calendarGroup
summary: Delete navigation property attachments for users
operationId: user.calendarGroup.calendar.event_DeleteAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: attachment
- 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
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/attachments/$count':
get:
tags:
- users.calendarGroup
summary: Get the number of the resource
operationId: user.calendarGroup.calendar.event.attachment_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/attachments/microsoft.graph.createUploadSession':
post:
tags:
- users.calendarGroup
summary: Invoke action createUploadSession
description: 'Create an upload session that allows an app to iteratively upload ranges of a file, so as to attach the file to the specified Outlook item. The item can be a message or event. Use this approach to attach a file if the file size is between 3 MB and 150 MB. To attach a file that''s smaller than 3 MB, do a POST operation on the attachments navigation property of the Outlook item; see how to do this for a message or for an event. As part of the response, this action returns an upload URL that you can use in subsequent sequential PUT queries. Request headers for each PUT operation let you specify the exact range of bytes to be uploaded. This allows transfer to be resumed, in case the network connection is dropped during upload. The following are the steps to attach a file to an Outlook item using an upload session: See attach large files to Outlook messages or events for an example.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/attachment-createuploadsession?view=graph-rest-1.0
operationId: user.calendarGroup.calendar.event.attachment_createUploadSession
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
AttachmentItem:
$ref: '#/components/schemas/microsoft.graph.attachmentItem'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.uploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/calendar':
get:
tags:
- users.calendarGroup
summary: Get calendar from users
description: The calendar that contains the event. Navigation property. Read-only.
operationId: user.calendarGroup.calendar.event_GetCalendar
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- 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.calendar'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/extensions':
get:
tags:
- users.calendarGroup
summary: Get extensions from users
description: The collection of open extensions defined for the event. Nullable.
operationId: user.calendarGroup.calendar.event_ListExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $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.extensionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.calendarGroup
summary: Create new navigation property to extensions for users
operationId: user.calendarGroup.calendar.event_CreateExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/extensions/{extension-id}':
get:
tags:
- users.calendarGroup
summary: Get extensions from users
description: The collection of open extensions defined for the event. Nullable.
operationId: user.calendarGroup.calendar.event_GetExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
- 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.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.calendarGroup
summary: Update the navigation property extensions in users
operationId: user.calendarGroup.calendar.event_UpdateExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.calendarGroup
summary: Delete navigation property extensions for users
operationId: user.calendarGroup.calendar.event_DeleteExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
- 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
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/extensions/$count':
get:
tags:
- users.calendarGroup
summary: Get the number of the resource
operationId: user.calendarGroup.calendar.event.extension_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances':
get:
tags:
- users.calendarGroup
summary: Get instances from users
description: 'The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern, and exceptions modified, but doesn''t include occurrences canceled from the series. Navigation property. Read-only. Nullable.'
operationId: user.calendarGroup.calendar.event_ListInstance
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: startDateTime
in: query
description: 'The start date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T19:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $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.eventCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/microsoft.graph.delta()':
get:
tags:
- users.calendarGroup
summary: Invoke function delta
description: 'Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user''s primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: user.calendarGroup.calendar.event.instance_delta
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: startDateTime
in: query
description: 'The start date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of event
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/microsoft.graph.accept':
post:
tags:
- users.calendarGroup
summary: Invoke action accept
description: Accept the specified event in a user calendar.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-accept?view=graph-rest-1.0
operationId: user.calendarGroup.calendar.event_accept
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/microsoft.graph.cancel':
post:
tags:
- users.calendarGroup
summary: Invoke action cancel
description: "This action allows the organizer of a meeting to send a cancellation message and cancel the event. The action moves the event to the Deleted Items folder. The organizer can also cancel an occurrence of a recurring meeting \r\nby providing the occurrence event ID. An attendee calling this action gets an error (HTTP 400 Bad Request), with the following\r\nerror message: 'Your request can't be completed. You need to be an organizer to cancel a meeting.' This action differs from Delete in that Cancel is available to only the organizer, and lets\r\nthe organizer send a custom message to the attendees about the cancellation."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-cancel?view=graph-rest-1.0
operationId: user.calendarGroup.calendar.event_cancel
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/microsoft.graph.decline':
post:
tags:
- users.calendarGroup
summary: Invoke action decline
description: 'Decline invitation to the specified event in a user calendar. If the event allows proposals for new times, on declining the event, an invitee can choose to suggest an alternative time by including the proposedNewTime parameter. For more information on how to propose a time, and how to receive and accept a new time proposal, see Propose new meeting times.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-decline?view=graph-rest-1.0
operationId: user.calendarGroup.calendar.event_decline
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ProposedNewTime:
$ref: '#/components/schemas/microsoft.graph.timeSlot'
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/microsoft.graph.dismissReminder':
post:
tags:
- users.calendarGroup
summary: Invoke action dismissReminder
description: Dismiss a reminder that has been triggered for an event in a user calendar.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-dismissreminder?view=graph-rest-1.0
operationId: user.calendarGroup.calendar.event_dismissReminder
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/microsoft.graph.forward':
post:
tags:
- users.calendarGroup
summary: Invoke action forward
description: "This action allows the organizer or attendee of a meeting event to forward the\r\nmeeting request to a new recipient. If the meeting event is forwarded from an attendee's Microsoft 365 mailbox to another recipient, this action\r\nalso sends a message to notify the organizer of the forwarding, and adds the recipient to the organizer's\r\ncopy of the meeting event. This convenience is not available when forwarding from an Outlook.com account."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-forward?view=graph-rest-1.0
operationId: user.calendarGroup.calendar.event_forward
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/microsoft.graph.permanentDelete':
post:
tags:
- users.calendarGroup
summary: Invoke action permanentDelete
operationId: user.calendarGroup.calendar.event_permanentDelete
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/microsoft.graph.snoozeReminder':
post:
tags:
- users.calendarGroup
summary: Invoke action snoozeReminder
description: Postpone a reminder for an event in a user calendar until a new time.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-snoozereminder?view=graph-rest-1.0
operationId: user.calendarGroup.calendar.event_snoozeReminder
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
NewReminderTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/microsoft.graph.tentativelyAccept':
post:
tags:
- users.calendarGroup
summary: Invoke action tentativelyAccept
description: 'Tentatively accept the specified event in a user calendar. If the event allows proposals for new times, on responding tentative to the event, an invitee can choose to suggest an alternative time by including the proposedNewTime parameter. For more information on how to propose a time, and how to receive and accept a new time proposal, see Propose new meeting times.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-tentativelyaccept?view=graph-rest-1.0
operationId: user.calendarGroup.calendar.event_tentativelyAccept
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ProposedNewTime:
$ref: '#/components/schemas/microsoft.graph.timeSlot'
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/$count':
get:
tags:
- users.calendarGroup
summary: Get the number of the resource
operationId: user.calendarGroup.calendar.event_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/microsoft.graph.delta()':
get:
tags:
- users.calendarGroup
summary: Invoke function delta
description: 'Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user''s primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: user.calendarGroup.calendar.event_delta
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: startDateTime
in: query
description: 'The start date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of event
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/microsoft.graph.allowedCalendarSharingRoles(User=''{User}'')':
get:
tags:
- users.calendarGroup
summary: Invoke function allowedCalendarSharingRoles
operationId: user.calendarGroup.calendar_allowedCalendarSharingRole
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: User
in: path
description: 'Usage: User=''{User}'''
required: true
style: simple
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarRoleType'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/microsoft.graph.getSchedule':
post:
tags:
- users.calendarGroup
summary: Invoke action getSchedule
description: 'Get the free/busy availability information for a collection of users, distributions lists, or resources (rooms or equipment) for a specified time period.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/calendar-getschedule?view=graph-rest-1.0
operationId: user.calendarGroup.calendar_getSchedule
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Schedules:
type: array
items:
type: string
nullable: true
EndTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
StartTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
AvailabilityViewInterval:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.scheduleInformation'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/microsoft.graph.permanentDelete':
post:
tags:
- users.calendarGroup
summary: Invoke action permanentDelete
operationId: user.calendarGroup.calendar_permanentDelete
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/$count':
get:
tags:
- users.calendarGroup
summary: Get the number of the resource
operationId: user.calendarGroup.calendar_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarGroup
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/calendarGroups/$count':
get:
tags:
- users.calendarGroup
summary: Get the number of the resource
operationId: user.calendarGroup_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/calendars':
get:
tags:
- users.calendar
summary: Get calendars from users
description: The user's calendars. Read-only. Nullable.
operationId: user_ListCalendar
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- $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.calendarCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.calendar
summary: Create new navigation property to calendars for users
operationId: user_CreateCalendar
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/calendars/{calendar-id}':
get:
tags:
- users.calendar
summary: Get calendars from users
description: The user's calendars. Read-only. Nullable.
operationId: user_GetCalendar
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- 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.calendar'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.calendar
summary: Update the navigation property calendars in users
operationId: user_UpdateCalendar
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.calendar
summary: Delete navigation property calendars for users
operationId: user_DeleteCalendar
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- 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
'/users/{user-id}/calendars/{calendar-id}/calendarPermissions':
get:
tags:
- users.calendar
summary: Get calendarPermissions from users
description: The permissions of the users with whom the calendar is shared.
operationId: user.calendar_ListCalendarPermission
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- $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.calendarPermissionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.calendar
summary: Create new navigation property to calendarPermissions for users
operationId: user.calendar_CreateCalendarPermission
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/calendars/{calendar-id}/calendarPermissions/{calendarPermission-id}':
get:
tags:
- users.calendar
summary: Get calendarPermissions from users
description: The permissions of the users with whom the calendar is shared.
operationId: user.calendar_GetCalendarPermission
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: calendarPermission-id
in: path
description: The unique identifier of calendarPermission
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarPermission
- 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.calendarPermission'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.calendar
summary: Update the navigation property calendarPermissions in users
operationId: user.calendar_UpdateCalendarPermission
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: calendarPermission-id
in: path
description: The unique identifier of calendarPermission
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarPermission
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.calendar
summary: Delete navigation property calendarPermissions for users
operationId: user.calendar_DeleteCalendarPermission
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: calendarPermission-id
in: path
description: The unique identifier of calendarPermission
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendarPermission
- 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
'/users/{user-id}/calendars/{calendar-id}/calendarPermissions/$count':
get:
tags:
- users.calendar
summary: Get the number of the resource
operationId: user.calendar.calendarPermission_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/calendars/{calendar-id}/calendarView':
get:
tags:
- users.calendar
summary: Get calendarView from users
description: The calendar view for the calendar. Navigation property. Read-only.
operationId: user.calendar_ListCalendarView
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: startDateTime
in: query
description: 'The start date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T19:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $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.eventCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/users/{user-id}/calendars/{calendar-id}/calendarView/microsoft.graph.delta()':
get:
tags:
- users.calendar
summary: Invoke function delta
description: 'Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user''s primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: user.calendar.calendarView_delta
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: startDateTime
in: query
description: 'The start date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of event
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/calendars/{calendar-id}/events':
get:
tags:
- users.calendar
summary: Get events from users
description: The events in the calendar. Navigation property. Read-only.
operationId: user.calendar_ListEvent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- $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.eventCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.calendar
summary: Create new navigation property to events for users
operationId: user.calendar_CreateEvent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/calendars/{calendar-id}/events/{event-id}':
get:
tags:
- users.calendar
summary: Get events from users
description: The events in the calendar. Navigation property. Read-only.
operationId: user.calendar_GetEvent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- 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.event'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.calendar
summary: Update the navigation property events in users
operationId: user.calendar_UpdateEvent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.calendar
summary: Delete navigation property events for users
operationId: user.calendar_DeleteEvent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- 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
'/users/{user-id}/calendars/{calendar-id}/events/{event-id}/attachments':
get:
tags:
- users.calendar
summary: Get attachments from users
description: 'The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.'
operationId: user.calendar.event_ListAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $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.attachmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.calendar
summary: Create new navigation property to attachments for users
operationId: user.calendar.event_CreateAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/calendars/{calendar-id}/events/{event-id}/attachments/{attachment-id}':
get:
tags:
- users.calendar
summary: Get attachments from users
description: 'The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.'
operationId: user.calendar.event_GetAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: attachment
- 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.attachment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.calendar
summary: Delete navigation property attachments for users
operationId: user.calendar.event_DeleteAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: attachment
- 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
'/users/{user-id}/calendars/{calendar-id}/events/{event-id}/attachments/$count':
get:
tags:
- users.calendar
summary: Get the number of the resource
operationId: user.calendar.event.attachment_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/calendars/{calendar-id}/events/{event-id}/attachments/microsoft.graph.createUploadSession':
post:
tags:
- users.calendar
summary: Invoke action createUploadSession
description: 'Create an upload session that allows an app to iteratively upload ranges of a file, so as to attach the file to the specified Outlook item. The item can be a message or event. Use this approach to attach a file if the file size is between 3 MB and 150 MB. To attach a file that''s smaller than 3 MB, do a POST operation on the attachments navigation property of the Outlook item; see how to do this for a message or for an event. As part of the response, this action returns an upload URL that you can use in subsequent sequential PUT queries. Request headers for each PUT operation let you specify the exact range of bytes to be uploaded. This allows transfer to be resumed, in case the network connection is dropped during upload. The following are the steps to attach a file to an Outlook item using an upload session: See attach large files to Outlook messages or events for an example.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/attachment-createuploadsession?view=graph-rest-1.0
operationId: user.calendar.event.attachment_createUploadSession
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
AttachmentItem:
$ref: '#/components/schemas/microsoft.graph.attachmentItem'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.uploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendars/{calendar-id}/events/{event-id}/calendar':
get:
tags:
- users.calendar
summary: Get calendar from users
description: The calendar that contains the event. Navigation property. Read-only.
operationId: user.calendar.event_GetCalendar
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- 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.calendar'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/calendars/{calendar-id}/events/{event-id}/extensions':
get:
tags:
- users.calendar
summary: Get extensions from users
description: The collection of open extensions defined for the event. Nullable.
operationId: user.calendar.event_ListExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $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.extensionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.calendar
summary: Create new navigation property to extensions for users
operationId: user.calendar.event_CreateExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/calendars/{calendar-id}/events/{event-id}/extensions/{extension-id}':
get:
tags:
- users.calendar
summary: Get extensions from users
description: The collection of open extensions defined for the event. Nullable.
operationId: user.calendar.event_GetExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
- 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.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.calendar
summary: Update the navigation property extensions in users
operationId: user.calendar.event_UpdateExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.calendar
summary: Delete navigation property extensions for users
operationId: user.calendar.event_DeleteExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
- 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
'/users/{user-id}/calendars/{calendar-id}/events/{event-id}/extensions/$count':
get:
tags:
- users.calendar
summary: Get the number of the resource
operationId: user.calendar.event.extension_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances':
get:
tags:
- users.calendar
summary: Get instances from users
description: 'The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern, and exceptions modified, but doesn''t include occurrences canceled from the series. Navigation property. Read-only. Nullable.'
operationId: user.calendar.event_ListInstance
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: startDateTime
in: query
description: 'The start date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T19:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $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.eventCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/microsoft.graph.delta()':
get:
tags:
- users.calendar
summary: Invoke function delta
description: 'Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user''s primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: user.calendar.event.instance_delta
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: startDateTime
in: query
description: 'The start date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of event
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/calendars/{calendar-id}/events/{event-id}/microsoft.graph.accept':
post:
tags:
- users.calendar
summary: Invoke action accept
description: Accept the specified event in a user calendar.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-accept?view=graph-rest-1.0
operationId: user.calendar.event_accept
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendars/{calendar-id}/events/{event-id}/microsoft.graph.cancel':
post:
tags:
- users.calendar
summary: Invoke action cancel
description: "This action allows the organizer of a meeting to send a cancellation message and cancel the event. The action moves the event to the Deleted Items folder. The organizer can also cancel an occurrence of a recurring meeting \r\nby providing the occurrence event ID. An attendee calling this action gets an error (HTTP 400 Bad Request), with the following\r\nerror message: 'Your request can't be completed. You need to be an organizer to cancel a meeting.' This action differs from Delete in that Cancel is available to only the organizer, and lets\r\nthe organizer send a custom message to the attendees about the cancellation."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-cancel?view=graph-rest-1.0
operationId: user.calendar.event_cancel
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendars/{calendar-id}/events/{event-id}/microsoft.graph.decline':
post:
tags:
- users.calendar
summary: Invoke action decline
description: 'Decline invitation to the specified event in a user calendar. If the event allows proposals for new times, on declining the event, an invitee can choose to suggest an alternative time by including the proposedNewTime parameter. For more information on how to propose a time, and how to receive and accept a new time proposal, see Propose new meeting times.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-decline?view=graph-rest-1.0
operationId: user.calendar.event_decline
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ProposedNewTime:
$ref: '#/components/schemas/microsoft.graph.timeSlot'
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendars/{calendar-id}/events/{event-id}/microsoft.graph.dismissReminder':
post:
tags:
- users.calendar
summary: Invoke action dismissReminder
description: Dismiss a reminder that has been triggered for an event in a user calendar.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-dismissreminder?view=graph-rest-1.0
operationId: user.calendar.event_dismissReminder
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendars/{calendar-id}/events/{event-id}/microsoft.graph.forward':
post:
tags:
- users.calendar
summary: Invoke action forward
description: "This action allows the organizer or attendee of a meeting event to forward the\r\nmeeting request to a new recipient. If the meeting event is forwarded from an attendee's Microsoft 365 mailbox to another recipient, this action\r\nalso sends a message to notify the organizer of the forwarding, and adds the recipient to the organizer's\r\ncopy of the meeting event. This convenience is not available when forwarding from an Outlook.com account."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-forward?view=graph-rest-1.0
operationId: user.calendar.event_forward
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendars/{calendar-id}/events/{event-id}/microsoft.graph.permanentDelete':
post:
tags:
- users.calendar
summary: Invoke action permanentDelete
operationId: user.calendar.event_permanentDelete
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendars/{calendar-id}/events/{event-id}/microsoft.graph.snoozeReminder':
post:
tags:
- users.calendar
summary: Invoke action snoozeReminder
description: Postpone a reminder for an event in a user calendar until a new time.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-snoozereminder?view=graph-rest-1.0
operationId: user.calendar.event_snoozeReminder
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
NewReminderTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendars/{calendar-id}/events/{event-id}/microsoft.graph.tentativelyAccept':
post:
tags:
- users.calendar
summary: Invoke action tentativelyAccept
description: 'Tentatively accept the specified event in a user calendar. If the event allows proposals for new times, on responding tentative to the event, an invitee can choose to suggest an alternative time by including the proposedNewTime parameter. For more information on how to propose a time, and how to receive and accept a new time proposal, see Propose new meeting times.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-tentativelyaccept?view=graph-rest-1.0
operationId: user.calendar.event_tentativelyAccept
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ProposedNewTime:
$ref: '#/components/schemas/microsoft.graph.timeSlot'
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendars/{calendar-id}/events/$count':
get:
tags:
- users.calendar
summary: Get the number of the resource
operationId: user.calendar.event_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/calendars/{calendar-id}/events/microsoft.graph.delta()':
get:
tags:
- users.calendar
summary: Invoke function delta
description: 'Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user''s primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: user.calendar.event_delta
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: startDateTime
in: query
description: 'The start date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of event
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/calendars/{calendar-id}/microsoft.graph.allowedCalendarSharingRoles(User=''{User}'')':
get:
tags:
- users.calendar
summary: Invoke function allowedCalendarSharingRoles
operationId: user.calendar_allowedCalendarSharingRole
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
- name: User
in: path
description: 'Usage: User=''{User}'''
required: true
style: simple
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarRoleType'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/calendars/{calendar-id}/microsoft.graph.getSchedule':
post:
tags:
- users.calendar
summary: Invoke action getSchedule
description: 'Get the free/busy availability information for a collection of users, distributions lists, or resources (rooms or equipment) for a specified time period.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/calendar-getschedule?view=graph-rest-1.0
operationId: user.calendar_getSchedule
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Schedules:
type: array
items:
type: string
nullable: true
EndTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
StartTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
AvailabilityViewInterval:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.scheduleInformation'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/calendars/{calendar-id}/microsoft.graph.permanentDelete':
post:
tags:
- users.calendar
summary: Invoke action permanentDelete
description: 'Permanently delete a calendar folder and the events that it contains and remove them from the mailbox. For more information about item retention, see Configure deleted item retention and recoverable items quotas.'
operationId: user.calendar_permanentDelete
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: calendar
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/calendars/$count':
get:
tags:
- users.calendar
summary: Get the number of the resource
operationId: user.calendar_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/calendarView':
get:
tags:
- users.event
summary: Get calendarView from users
description: The calendar view for the calendar. Read-only. Nullable.
operationId: user_ListCalendarView
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: startDateTime
in: query
description: 'The start date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T19:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $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.eventCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/users/{user-id}/calendarView/microsoft.graph.delta()':
get:
tags:
- users.event
summary: Invoke function delta
description: 'Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user''s primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: user.calendarView_delta
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: startDateTime
in: query
description: 'The start date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of event
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/events':
get:
tags:
- users.event
summary: Get events from users
description: The user's events. Default is to show Events under the Default Calendar. Read-only. Nullable.
operationId: user_ListEvent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- $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.eventCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.event
summary: Create new navigation property to events for users
operationId: user_CreateEvent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/events/{event-id}':
get:
tags:
- users.event
summary: Get events from users
description: The user's events. Default is to show Events under the Default Calendar. Read-only. Nullable.
operationId: user_GetEvent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- 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.event'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.event
summary: Update the navigation property events in users
operationId: user_UpdateEvent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.event
summary: Delete navigation property events for users
operationId: user_DeleteEvent
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- 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
'/users/{user-id}/events/{event-id}/attachments':
get:
tags:
- users.event
summary: Get attachments from users
description: 'The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.'
operationId: user.event_ListAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $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.attachmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.event
summary: Create new navigation property to attachments for users
operationId: user.event_CreateAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/events/{event-id}/attachments/{attachment-id}':
get:
tags:
- users.event
summary: Get attachments from users
description: 'The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.'
operationId: user.event_GetAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: attachment
- 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.attachment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.event
summary: Delete navigation property attachments for users
operationId: user.event_DeleteAttachment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: attachment
- 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
'/users/{user-id}/events/{event-id}/attachments/$count':
get:
tags:
- users.event
summary: Get the number of the resource
operationId: user.event.attachment_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/events/{event-id}/attachments/microsoft.graph.createUploadSession':
post:
tags:
- users.event
summary: Invoke action createUploadSession
description: 'Create an upload session that allows an app to iteratively upload ranges of a file, so as to attach the file to the specified Outlook item. The item can be a message or event. Use this approach to attach a file if the file size is between 3 MB and 150 MB. To attach a file that''s smaller than 3 MB, do a POST operation on the attachments navigation property of the Outlook item; see how to do this for a message or for an event. As part of the response, this action returns an upload URL that you can use in subsequent sequential PUT queries. Request headers for each PUT operation let you specify the exact range of bytes to be uploaded. This allows transfer to be resumed, in case the network connection is dropped during upload. The following are the steps to attach a file to an Outlook item using an upload session: See attach large files to Outlook messages or events for an example.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/attachment-createuploadsession?view=graph-rest-1.0
operationId: user.event.attachment_createUploadSession
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
AttachmentItem:
$ref: '#/components/schemas/microsoft.graph.attachmentItem'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.uploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/events/{event-id}/calendar':
get:
tags:
- users.event
summary: Get calendar from users
description: The calendar that contains the event. Navigation property. Read-only.
operationId: user.event_GetCalendar
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- 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.calendar'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/events/{event-id}/extensions':
get:
tags:
- users.event
summary: Get extensions from users
description: The collection of open extensions defined for the event. Nullable.
operationId: user.event_ListExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $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.extensionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.event
summary: Create new navigation property to extensions for users
operationId: user.event_CreateExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/events/{event-id}/extensions/{extension-id}':
get:
tags:
- users.event
summary: Get extensions from users
description: The collection of open extensions defined for the event. Nullable.
operationId: user.event_GetExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
- 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.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.event
summary: Update the navigation property extensions in users
operationId: user.event_UpdateExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.event
summary: Delete navigation property extensions for users
operationId: user.event_DeleteExtension
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extension
- 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
'/users/{user-id}/events/{event-id}/extensions/$count':
get:
tags:
- users.event
summary: Get the number of the resource
operationId: user.event.extension_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/events/{event-id}/instances':
get:
tags:
- users.event
summary: Get instances from users
description: 'The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern, and exceptions modified, but doesn''t include occurrences canceled from the series. Navigation property. Read-only. Nullable.'
operationId: user.event_ListInstance
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: startDateTime
in: query
description: 'The start date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T19:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $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.eventCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/users/{user-id}/events/{event-id}/instances/microsoft.graph.delta()':
get:
tags:
- users.event
summary: Invoke function delta
description: 'Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user''s primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: user.event.instance_delta
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
- name: startDateTime
in: query
description: 'The start date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of event
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/events/{event-id}/microsoft.graph.accept':
post:
tags:
- users.event
summary: Invoke action accept
description: Accept the specified event in a user calendar.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-accept?view=graph-rest-1.0
operationId: user.event_accept
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/events/{event-id}/microsoft.graph.cancel':
post:
tags:
- users.event
summary: Invoke action cancel
description: "This action allows the organizer of a meeting to send a cancellation message and cancel the event. The action moves the event to the Deleted Items folder. The organizer can also cancel an occurrence of a recurring meeting \r\nby providing the occurrence event ID. An attendee calling this action gets an error (HTTP 400 Bad Request), with the following\r\nerror message: 'Your request can't be completed. You need to be an organizer to cancel a meeting.' This action differs from Delete in that Cancel is available to only the organizer, and lets\r\nthe organizer send a custom message to the attendees about the cancellation."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-cancel?view=graph-rest-1.0
operationId: user.event_cancel
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/events/{event-id}/microsoft.graph.decline':
post:
tags:
- users.event
summary: Invoke action decline
description: 'Decline invitation to the specified event in a user calendar. If the event allows proposals for new times, on declining the event, an invitee can choose to suggest an alternative time by including the proposedNewTime parameter. For more information on how to propose a time, and how to receive and accept a new time proposal, see Propose new meeting times.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-decline?view=graph-rest-1.0
operationId: user.event_decline
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ProposedNewTime:
$ref: '#/components/schemas/microsoft.graph.timeSlot'
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/events/{event-id}/microsoft.graph.dismissReminder':
post:
tags:
- users.event
summary: Invoke action dismissReminder
description: Dismiss a reminder that has been triggered for an event in a user calendar.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-dismissreminder?view=graph-rest-1.0
operationId: user.event_dismissReminder
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/events/{event-id}/microsoft.graph.forward':
post:
tags:
- users.event
summary: Invoke action forward
description: "This action allows the organizer or attendee of a meeting event to forward the\r\nmeeting request to a new recipient. If the meeting event is forwarded from an attendee's Microsoft 365 mailbox to another recipient, this action\r\nalso sends a message to notify the organizer of the forwarding, and adds the recipient to the organizer's\r\ncopy of the meeting event. This convenience is not available when forwarding from an Outlook.com account."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-forward?view=graph-rest-1.0
operationId: user.event_forward
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/events/{event-id}/microsoft.graph.permanentDelete':
post:
tags:
- users.event
summary: Invoke action permanentDelete
operationId: user.event_permanentDelete
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/events/{event-id}/microsoft.graph.snoozeReminder':
post:
tags:
- users.event
summary: Invoke action snoozeReminder
description: Postpone a reminder for an event in a user calendar until a new time.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-snoozereminder?view=graph-rest-1.0
operationId: user.event_snoozeReminder
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
NewReminderTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/events/{event-id}/microsoft.graph.tentativelyAccept':
post:
tags:
- users.event
summary: Invoke action tentativelyAccept
description: 'Tentatively accept the specified event in a user calendar. If the event allows proposals for new times, on responding tentative to the event, an invitee can choose to suggest an alternative time by including the proposedNewTime parameter. For more information on how to propose a time, and how to receive and accept a new time proposal, see Propose new meeting times.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-tentativelyaccept?view=graph-rest-1.0
operationId: user.event_tentativelyAccept
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: event
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ProposedNewTime:
$ref: '#/components/schemas/microsoft.graph.timeSlot'
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/events/$count':
get:
tags:
- users.event
summary: Get the number of the resource
operationId: user.event_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/events/microsoft.graph.delta()':
get:
tags:
- users.event
summary: Invoke function delta
description: 'Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user''s primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: user.event_delta
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: startDateTime
in: query
description: 'The start date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- name: endDateTime
in: query
description: 'The end date and time of the time range in the function, represented in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00'
required: true
style: form
explode: false
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of event
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
components:
schemas:
microsoft.graph.calendar:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: calendar
type: object
properties:
allowedOnlineMeetingProviders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType'
description: 'Represent the online meeting service providers that can be used to create online meetings in this calendar. The possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.'
canEdit:
type: boolean
description: 'true if the user can write to the calendar, false otherwise. This property is true for the user who created the calendar. This property is also true for a user who shared a calendar and granted write access.'
nullable: true
canShare:
type: boolean
description: 'true if the user has permission to share the calendar, false otherwise. Only the user who created the calendar can share it.'
nullable: true
canViewPrivateItems:
type: boolean
description: 'If true, the user can read calendar items that have been marked private, false otherwise.'
nullable: true
changeKey:
type: string
description: 'Identifies the version of the calendar object. Every time the calendar is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.'
nullable: true
color:
$ref: '#/components/schemas/microsoft.graph.calendarColor'
defaultOnlineMeetingProvider:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType'
hexColor:
type: string
description: 'The calendar color, expressed in a hex color code of three hexadecimal values, each ranging from 00 to FF and representing the red, green, or blue components of the color in the RGB color space. If the user has never explicitly set a color for the calendar, this property is empty. Read-only.'
nullable: true
isDefaultCalendar:
type: boolean
description: 'true if this is the default calendar where new events are created by default, false otherwise.'
nullable: true
isRemovable:
type: boolean
description: Indicates whether this user calendar can be deleted from the user mailbox.
nullable: true
isTallyingResponses:
type: boolean
description: Indicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses.
nullable: true
name:
type: string
description: The calendar name.
nullable: true
owner:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
calendarPermissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
description: The permissions of the users with whom the calendar is shared.
x-ms-navigationProperty: true
calendarView:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The calendar view for the calendar. Navigation property. Read-only.
x-ms-navigationProperty: true
events:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The events in the calendar. Navigation property. Read-only.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the calendar. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the calendar. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.calendarPermission:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: calendarPermission
type: object
properties:
allowedRoles:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarRoleType'
description: 'List of allowed sharing or delegating permission levels for the calendar. The possible values are: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom.'
emailAddress:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
isInsideOrganization:
type: boolean
description: True if the user in context (recipient or delegate) is inside the same organization as the calendar owner.
nullable: true
isRemovable:
type: boolean
description: 'True if the user can be removed from the list of recipients or delegates for the specified calendar, false otherwise. The ''My organization'' user determines the permissions other people within your organization have to the given calendar. You can''t remove ''My organization'' as a share recipient to a calendar.'
nullable: true
role:
$ref: '#/components/schemas/microsoft.graph.calendarRoleType'
additionalProperties:
type: object
microsoft.graph.event:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: event
type: object
properties:
allowNewTimeProposals:
type: boolean
description: 'true if the meeting organizer allows invitees to propose a new time when responding; otherwise, false. Optional. The default is true.'
nullable: true
attendees:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attendee'
description: The collection of attendees for the event.
body:
$ref: '#/components/schemas/microsoft.graph.itemBody'
bodyPreview:
type: string
description: The preview of the message associated with the event. It's in text format.
nullable: true
cancelledOccurrences:
type: array
items:
type: string
description: 'Contains occurrenceId property values of canceled instances in a recurring series, if the event is the series master. Instances in a recurring series that are canceled are called canceled occurences.Requires $select to retrieve. Only returned in a Get operation that specifies the ID (seriesMasterId property value) of a series master event.'
end:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
hasAttachments:
type: boolean
description: Set to true if the event has attachments.
nullable: true
hideAttendees:
type: boolean
description: 'When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. The default is false.'
nullable: true
iCalUId:
type: string
description: A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only.
nullable: true
importance:
$ref: '#/components/schemas/microsoft.graph.importance'
isAllDay:
type: boolean
description: 'Set to true if the event lasts all day. If true, regardless of whether it''s a single-day or multi-day event, start, and endtime must be set to midnight and be in the same time zone.'
nullable: true
isCancelled:
type: boolean
description: Set to true if the event has been canceled.
nullable: true
isDraft:
type: boolean
description: 'Set to true if the user has updated the meeting in Outlook but hasn''t sent the updates to attendees. Set to false if all changes are sent, or if the event is an appointment without any attendees.'
nullable: true
isOnlineMeeting:
type: boolean
description: 'True if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise. Default is false (onlineMeeting is null). Optional. After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting. Subsequently, Outlook ignores any further changes to isOnlineMeeting, and the meeting remains available online.'
nullable: true
isOrganizer:
type: boolean
description: Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event). It also applies if a delegate organized the event on behalf of the owner.
nullable: true
isReminderOn:
type: boolean
description: Set to true if an alert is set to remind the user of the event.
nullable: true
location:
$ref: '#/components/schemas/microsoft.graph.location'
locations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.location'
description: 'The locations where the event is held or attended from. The location and locations properties always correspond with each other. If you update the location property, any prior locations in the locations collection are removed and replaced by the new location value.'
onlineMeeting:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingInfo'
onlineMeetingProvider:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType'
onlineMeetingUrl:
type: string
description: 'A URL for an online meeting. The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype. Read-only.To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event. The onlineMeetingUrl property will be deprecated in the future.'
nullable: true
organizer:
$ref: '#/components/schemas/microsoft.graph.recipient'
originalEndTimeZone:
type: string
description: The end time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
nullable: true
originalStart:
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: 'Represents the start time of an event when it''s initially created as an occurrence or exception in a recurring series. This property is not returned for events that are single instances. Its date and time information is expressed in 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
nullable: true
originalStartTimeZone:
type: string
description: The start time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
nullable: true
recurrence:
$ref: '#/components/schemas/microsoft.graph.patternedRecurrence'
reminderMinutesBeforeStart:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of minutes before the event start time that the reminder alert occurs.
format: int32
nullable: true
responseRequested:
type: boolean
description: 'Default is true, which represents the organizer would like an invitee to send a response to the event.'
nullable: true
responseStatus:
$ref: '#/components/schemas/microsoft.graph.responseStatus'
sensitivity:
$ref: '#/components/schemas/microsoft.graph.sensitivity'
seriesMasterId:
type: string
description: 'The ID for the recurring series master item, if this event is part of a recurring series.'
nullable: true
showAs:
$ref: '#/components/schemas/microsoft.graph.freeBusyStatus'
start:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
subject:
type: string
description: The text of the event's subject line.
nullable: true
transactionId:
type: string
description: 'A custom identifier specified by a client app for the server to avoid redundant POST operations in case of client retries to create the same event. It''s useful when low network connectivity causes the client to time out before receiving a response from the server for the client''s prior create-event request. After you set transactionId when creating an event, you can''t change transactionId in a subsequent update. This property is only returned in a response payload if an app has set it. Optional.'
nullable: true
type:
$ref: '#/components/schemas/microsoft.graph.eventType'
webLink:
type: string
description: 'The URL to open the event in Outlook on the web.Outlook on the web opens the event in the browser if you are signed in to your mailbox. Otherwise, Outlook on the web prompts you to sign in.This URL can''t be accessed from within an iFrame.'
nullable: true
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachment'
description: 'The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.'
x-ms-navigationProperty: true
calendar:
$ref: '#/components/schemas/microsoft.graph.calendar'
exceptionOccurrences:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: 'Contains the id property values of the event instances that are exceptions in a recurring series.Exceptions can differ from other occurrences in a recurring series, such as the subject, start or end times, or attendees. Exceptions don''t include canceled occurrences.Requires $select and $expand to retrieve. Only returned in a GET operation that specifies the ID (seriesMasterId property value) of a series master event.'
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the event. Nullable.
x-ms-navigationProperty: true
instances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: 'The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern, and exceptions modified, but doesn''t include occurrences canceled from the series. Navigation property. Read-only. Nullable.'
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the event. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the event. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.attachment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: attachment
type: object
properties:
contentType:
type: string
description: The MIME type.
nullable: true
isInline:
type: boolean
description: 'true if the attachment is an inline attachment; otherwise, false.'
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
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
nullable: true
name:
type: string
description: The attachment's file name.
nullable: true
size:
maximum: 2147483647
minimum: -2147483648
type: number
description: The length of the attachment in bytes.
format: int32
additionalProperties:
type: object
microsoft.graph.attachmentItem:
title: attachmentItem
type: object
properties:
attachmentType:
$ref: '#/components/schemas/microsoft.graph.attachmentType'
contentId:
type: string
description: The CID or Content-Id of the attachment for referencing for the in-line attachments using the
tag in HTML messages. Optional.
nullable: true
contentType:
type: string
description: The nature of the data in the attachment. Optional.
nullable: true
isInline:
type: boolean
description: 'true if the attachment is an inline attachment; otherwise, false. Optional.'
nullable: true
name:
type: string
description: The display name of the attachment. This can be a descriptive string and doesn't have to be the actual file name. Required.
nullable: true
size:
type: number
description: The length of the attachment in bytes. Required.
format: int64
nullable: true
additionalProperties:
type: object
microsoft.graph.uploadSession:
title: uploadSession
type: object
properties:
expirationDateTime:
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: The date and time in UTC that the upload session expires. The complete file must be uploaded before this expiration time is reached. Each fragment uploaded during the session extends the expiration time.
format: date-time
nullable: true
nextExpectedRanges:
type: array
items:
type: string
nullable: true
description: 'A collection of byte ranges that the server is missing for the file. These ranges are zero indexed and of the format ''start-end'' (for example ''0-26'' to indicate the first 27 bytes of the file). When uploading files as Outlook attachments, instead of a collection of ranges, this property always indicates a single value ''{start}'', the location in the file where the next upload should begin.'
uploadUrl:
type: string
description: The URL endpoint that accepts PUT requests for byte ranges of the file.
nullable: true
additionalProperties:
type: object
microsoft.graph.extension:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: extension
type: object
additionalProperties:
type: object
microsoft.graph.timeSlot:
title: timeSlot
type: object
properties:
end:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
start:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
additionalProperties:
type: object
microsoft.graph.recipient:
title: recipient
type: object
properties:
emailAddress:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
additionalProperties:
type: object
microsoft.graph.dateTimeTimeZone:
title: dateTimeTimeZone
type: object
properties:
dateTime:
type: string
description: 'A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).'
timeZone:
type: string
description: 'Represents a time zone, for example, ''Pacific Standard Time''. See below for more possible values.'
nullable: true
additionalProperties:
type: object
microsoft.graph.calendarRoleType:
title: calendarRoleType
enum:
- none
- freeBusyRead
- limitedRead
- read
- write
- delegateWithoutPrivateEventAccess
- delegateWithPrivateEventAccess
- custom
type: string
microsoft.graph.scheduleInformation:
title: scheduleInformation
type: object
properties:
availabilityView:
type: string
description: 'Represents a merged view of availability of all the items in scheduleItems. The view consists of time slots. Availability during each time slot is indicated with: 0= free or working elswhere, 1= tentative, 2= busy, 3= out of office.Note: Working elsewhere is set to 0 instead of 4 for backward compatibility. For details, see the Q&A and Exchange 2007 and Exchange 2010 do not use the WorkingElsewhere value.'
nullable: true
error:
$ref: '#/components/schemas/microsoft.graph.freeBusyError'
scheduleId:
type: string
description: 'An SMTP address of the user, distribution list, or resource, identifying an instance of scheduleInformation.'
nullable: true
scheduleItems:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.scheduleItem'
description: Contains the items that describe the availability of the user or resource.
workingHours:
$ref: '#/components/schemas/microsoft.graph.workingHours'
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
description: Indicates whether the place is wheelchair accessible.
nullable: true
label:
type: string
description: User-defined description of the place.
nullable: true
parentId:
type: string
description: The ID of a parent place.
nullable: true
phone:
type: string
description: The phone number of the place.
nullable: true
placeId:
type: string
description: A stable service-level identifier for the place object used by Places workloads.
nullable: true
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.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
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
nullable: true
additionalProperties:
type: object
microsoft.graph.building:
allOf:
- $ref: '#/components/schemas/microsoft.graph.place'
- title: building
type: object
properties:
resourceLinks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.resourceLink'
description: A set of links to external resources that are associated with the building. Inherited from place.
wifiState:
$ref: '#/components/schemas/microsoft.graph.placeFeatureEnablement'
map:
$ref: '#/components/schemas/microsoft.graph.buildingMap'
additionalProperties:
type: object
microsoft.graph.buildingMap:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseMapFeature'
- title: buildingMap
type: object
properties:
placeId:
type: string
description: Identifier for the building to which this buildingMap belongs.
nullable: true
footprints:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.footprintMap'
description: Represents the approximate physical extent of a referenced building. It corresponds to footprint.geojson in IMDF format.
x-ms-navigationProperty: true
levels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.levelMap'
description: Represents a physical floor structure within a building. It corresponds to level.geojson in IMDF format.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.footprintMap:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseMapFeature'
- title: footprintMap
type: object
additionalProperties:
type: object
microsoft.graph.levelMap:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseMapFeature'
- title: levelMap
type: object
properties:
placeId:
type: string
description: Identifier of the floor to which this levelMap belongs.
nullable: true
fixtures:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.fixtureMap'
description: Collection of fixtures (such as furniture or equipment) on this level. Supports upsert.
x-ms-navigationProperty: true
sections:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sectionMap'
description: Collection of sections (such as zones or partitions) on this level. Supports upsert.
x-ms-navigationProperty: true
units:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unitMap'
description: Collection of units (such as rooms or offices) on this level. Supports upsert.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.fixtureMap:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseMapFeature'
- title: fixtureMap
type: object
properties:
placeId:
type: string
description: Identifier for the floor to which this fixtureMap belongs.
nullable: true
additionalProperties:
type: object
microsoft.graph.sectionMap:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseMapFeature'
- title: sectionMap
type: object
properties:
placeId:
type: string
description: Identifier of the section to which this sectionMap belongs.
nullable: true
additionalProperties:
type: object
microsoft.graph.unitMap:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseMapFeature'
- title: unitMap
type: object
properties:
placeId:
type: string
description: Identifier of the place (such as a room) to which this unitMap belongs.
nullable: true
additionalProperties:
type: object
microsoft.graph.desk:
allOf:
- $ref: '#/components/schemas/microsoft.graph.place'
- title: desk
type: object
properties:
displayDeviceName:
type: string
description: 'The name of the display device (for example, monitor or projector) that is available at the desk.'
nullable: true
heightAdjustableState:
$ref: '#/components/schemas/microsoft.graph.placeFeatureEnablement'
mailboxDetails:
$ref: '#/components/schemas/microsoft.graph.mailboxDetails'
mode:
$ref: '#/components/schemas/microsoft.graph.placeMode'
servicePlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.placeServicePlanInfo'
description: The service plans associated with the desk.
additionalProperties:
type: object
microsoft.graph.floor:
allOf:
- $ref: '#/components/schemas/microsoft.graph.place'
- title: floor
type: object
properties:
sortOrder:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Specifies the sort order of the floor. For example, a floor might be named ''Lobby'' with a sort order of 0 to show this floor first in ordered lists.'
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.room:
allOf:
- $ref: '#/components/schemas/microsoft.graph.place'
- title: room
type: object
properties:
audioDeviceName:
type: string
description: Specifies the name of the audio device in the room.
nullable: true
bookingType:
$ref: '#/components/schemas/microsoft.graph.bookingType'
building:
type: string
description: Specifies the building name or building number that the room is in.
nullable: true
capacity:
maximum: 2147483647
minimum: -2147483648
type: number
description: Specifies the capacity of the room.
format: int32
nullable: true
displayDeviceName:
type: string
description: Specifies the name of the display device in the room.
nullable: true
emailAddress:
type: string
description: Email address of the room.
nullable: true
floorLabel:
type: string
description: 'Specifies a descriptive label for the floor, for example, P.'
nullable: true
floorNumber:
maximum: 2147483647
minimum: -2147483648
type: number
description: Specifies the floor number that the room is on.
format: int32
nullable: true
nickname:
type: string
description: 'Specifies a nickname for the room, for example, ''conf room''.'
teamsEnabledState:
$ref: '#/components/schemas/microsoft.graph.placeFeatureEnablement'
videoDeviceName:
type: string
description: Specifies the name of the video device in the room.
nullable: true
additionalProperties:
type: object
microsoft.graph.roomList:
allOf:
- $ref: '#/components/schemas/microsoft.graph.place'
- title: roomList
type: object
properties:
emailAddress:
type: string
description: The email address of the room list.
nullable: true
rooms:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.room'
x-ms-navigationProperty: true
workspaces:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workspace'
x-ms-navigationProperty: true
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
description: The maximum number of individual desks within a workspace.
format: int32
nullable: true
displayDeviceName:
type: string
description: 'The name of the display device (for example, monitor or projector) that is available in the workspace.'
nullable: true
emailAddress:
type: string
description: The email address that is associated with the workspace. This email address is used for booking.
nullable: true
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.section:
allOf:
- $ref: '#/components/schemas/microsoft.graph.place'
- title: section
type: object
additionalProperties:
type: object
microsoft.graph.calendarGroup:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: calendarGroup
type: object
properties:
changeKey:
type: string
description: 'Identifies the version of the calendar group. Every time the calendar group is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.'
nullable: true
classId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The class identifier. Read-only.
format: uuid
nullable: true
name:
type: string
description: The group name.
nullable: true
calendars:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendar'
description: The calendars in the calendar group. Navigation property. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
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.onlineMeetingProviderType:
title: onlineMeetingProviderType
enum:
- unknown
- skypeForBusiness
- skypeForConsumer
- teamsForBusiness
type: string
microsoft.graph.calendarColor:
title: calendarColor
enum:
- auto
- lightBlue
- lightGreen
- lightOrange
- lightGray
- lightYellow
- lightTeal
- lightPink
- lightBrown
- lightRed
- maxColor
type: string
microsoft.graph.emailAddress:
title: emailAddress
type: object
properties:
address:
type: string
description: The email address of the person or entity.
nullable: true
name:
type: string
description: The display name of the person or entity.
nullable: true
additionalProperties:
type: object
microsoft.graph.multiValueLegacyExtendedProperty:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: multiValueLegacyExtendedProperty
type: object
properties:
value:
type: array
items:
type: string
nullable: true
description: A collection of property values.
additionalProperties:
type: object
microsoft.graph.singleValueLegacyExtendedProperty:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: singleValueLegacyExtendedProperty
type: object
properties:
value:
type: string
description: A property value.
nullable: true
additionalProperties:
type: object
microsoft.graph.outlookItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: outlookItem
type: object
properties:
categories:
type: array
items:
type: string
nullable: true
description: The categories associated with the item
changeKey:
type: string
description: 'Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.'
nullable: true
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: '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
nullable: true
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
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
nullable: true
additionalProperties:
type: object
microsoft.graph.attendee:
allOf:
- $ref: '#/components/schemas/microsoft.graph.attendeeBase'
- title: attendee
type: object
properties:
proposedNewTime:
$ref: '#/components/schemas/microsoft.graph.timeSlot'
status:
$ref: '#/components/schemas/microsoft.graph.responseStatus'
additionalProperties:
type: object
microsoft.graph.itemBody:
title: itemBody
type: object
properties:
content:
type: string
description: The content of the item.
nullable: true
contentType:
$ref: '#/components/schemas/microsoft.graph.bodyType'
additionalProperties:
type: object
microsoft.graph.importance:
title: importance
enum:
- low
- normal
- high
type: string
microsoft.graph.location:
title: location
type: object
properties:
address:
$ref: '#/components/schemas/microsoft.graph.physicalAddress'
coordinates:
$ref: '#/components/schemas/microsoft.graph.outlookGeoCoordinates'
displayName:
type: string
description: The name associated with the location.
nullable: true
locationEmailAddress:
type: string
description: Optional email address of the location.
nullable: true
locationType:
$ref: '#/components/schemas/microsoft.graph.locationType'
locationUri:
type: string
description: Optional URI representing the location.
nullable: true
uniqueId:
type: string
description: For internal use only.
nullable: true
uniqueIdType:
$ref: '#/components/schemas/microsoft.graph.locationUniqueIdType'
additionalProperties:
type: object
microsoft.graph.onlineMeetingInfo:
title: onlineMeetingInfo
type: object
properties:
conferenceId:
type: string
description: The ID of the conference.
nullable: true
joinUrl:
type: string
description: The external link that launches the online meeting. This is a URL that clients launch into a browser and will redirect the user to join the meeting.
nullable: true
phones:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.phone'
description: All of the phone numbers associated with this conference.
quickDial:
type: string
description: The preformatted quick dial for this call.
nullable: true
tollFreeNumbers:
type: array
items:
type: string
nullable: true
description: The toll free numbers that can be used to join the conference.
tollNumber:
type: string
description: The toll number that can be used to join the conference.
nullable: true
additionalProperties:
type: object
microsoft.graph.patternedRecurrence:
title: patternedRecurrence
type: object
properties:
pattern:
$ref: '#/components/schemas/microsoft.graph.recurrencePattern'
range:
$ref: '#/components/schemas/microsoft.graph.recurrenceRange'
additionalProperties:
type: object
microsoft.graph.responseStatus:
title: responseStatus
type: object
properties:
response:
$ref: '#/components/schemas/microsoft.graph.responseType'
time:
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: 'The date and time when the response was returned. It uses 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
nullable: true
additionalProperties:
type: object
microsoft.graph.sensitivity:
title: sensitivity
enum:
- normal
- personal
- private
- confidential
type: string
microsoft.graph.freeBusyStatus:
title: freeBusyStatus
enum:
- unknown
- free
- tentative
- busy
- oof
- workingElsewhere
type: string
microsoft.graph.eventType:
title: eventType
enum:
- singleInstance
- occurrence
- exception
- seriesMaster
type: string
microsoft.graph.attachmentType:
title: attachmentType
enum:
- file
- item
- reference
type: string
microsoft.graph.freeBusyError:
title: freeBusyError
type: object
properties:
message:
type: string
description: Describes the error.
nullable: true
responseCode:
type: string
description: 'The response code from querying for the availability of the user, distribution list, or resource.'
nullable: true
additionalProperties:
type: object
microsoft.graph.scheduleItem:
title: scheduleItem
type: object
properties:
end:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
isPrivate:
type: boolean
description: 'The sensitivity of the corresponding event. True if the event is marked private, false otherwise. Optional.'
nullable: true
location:
type: string
description: The location where the corresponding event is held or attended from. Optional.
nullable: true
start:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
status:
$ref: '#/components/schemas/microsoft.graph.freeBusyStatus'
subject:
type: string
description: The corresponding event's subject line. Optional.
nullable: true
additionalProperties:
type: object
microsoft.graph.workingHours:
title: workingHours
type: object
properties:
daysOfWeek:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.dayOfWeek'
description: The days of the week on which the user works.
endTime:
pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$'
type: string
description: The time of the day that the user stops working.
format: time
nullable: true
startTime:
pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$'
type: string
description: The time of the day that the user starts working.
format: time
nullable: true
timeZone:
$ref: '#/components/schemas/microsoft.graph.timeZoneBase'
additionalProperties:
type: object
microsoft.graph.physicalAddress:
title: physicalAddress
type: object
properties:
city:
type: string
description: The city.
nullable: true
countryOrRegion:
type: string
description: 'The country or region. It''s a free-format string value, for example, ''United States''.'
nullable: true
postalCode:
type: string
description: The postal code.
nullable: true
state:
type: string
description: The state.
nullable: true
street:
type: string
description: The street.
nullable: true
additionalProperties:
type: object
microsoft.graph.outlookGeoCoordinates:
title: outlookGeoCoordinates
type: object
properties:
accuracy:
type: number
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
nullable: true
altitude:
type: number
description: The altitude of the location.
format: double
nullable: true
altitudeAccuracy:
type: number
description: The accuracy of the altitude.
format: double
nullable: true
latitude:
type: number
description: The latitude of the location.
format: double
nullable: true
longitude:
type: number
description: The longitude of the location.
format: double
nullable: true
additionalProperties:
type: object
microsoft.graph.checkInMethod:
title: checkInMethod
enum:
- unspecified
- manual
- inferred
- verified
- unknownFutureValue
type: string
microsoft.graph.resourceLink:
title: resourceLink
type: object
properties:
linkType:
$ref: '#/components/schemas/microsoft.graph.resourceLinkType'
name:
type: string
description: The link text that is visible in the Places app. The maximum length is 200 characters.
nullable: true
value:
type: string
description: The URL of the resource link. The maximum length is 200 characters.
nullable: true
additionalProperties:
type: object
microsoft.graph.placeFeatureEnablement:
title: placeFeatureEnablement
enum:
- unknown
- enabled
- disabled
- unknownFutureValue
type: string
microsoft.graph.baseMapFeature:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: baseMapFeature
type: object
properties:
properties:
type: string
description: Concatenated key-value pair of all properties of a GeoJSON file for this baseMapFeature.
nullable: true
additionalProperties:
type: object
microsoft.graph.mailboxDetails:
title: mailboxDetails
type: object
properties:
emailAddress:
type: string
description: The primary SMTP address associated with the mailbox.
nullable: true
externalDirectoryObjectId:
type: string
description: The unique identifier of the mailbox in the external directory (such as Microsoft Entra).
nullable: true
additionalProperties:
type: object
microsoft.graph.placeMode:
title: placeMode
type: object
additionalProperties:
type: object
microsoft.graph.placeServicePlanInfo:
title: placeServicePlanInfo
type: object
properties:
servicePlanId:
type: string
description: The service plan identifier.
nullable: true
additionalProperties:
type: object
microsoft.graph.bookingType:
title: bookingType
enum:
- unknown
- standard
- reserved
type: string
microsoft.graph.ODataErrors.ODataError:
required:
- error
type: object
properties:
error:
$ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
additionalProperties:
type: object
microsoft.graph.calendarPermissionCollectionResponse:
title: Collection of calendarPermission
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
ODataCountResponse:
type: integer
format: int32
microsoft.graph.eventCollectionResponse:
title: Collection of event
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.attachmentCollectionResponse:
title: Collection of attachment
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachment'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.extensionCollectionResponse:
title: Collection of extension
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
'@odata.nextLink':
type: string
nullable: true
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
nullable: true
additionalProperties:
type: object
microsoft.graph.footprintMapCollectionResponse:
title: Collection of footprintMap
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.footprintMap'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.levelMapCollectionResponse:
title: Collection of levelMap
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.levelMap'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.fixtureMapCollectionResponse:
title: Collection of fixtureMap
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.fixtureMap'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.sectionMapCollectionResponse:
title: Collection of sectionMap
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sectionMap'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unitMapCollectionResponse:
title: Collection of unitMap
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unitMap'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.roomCollectionResponse:
title: Collection of room
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.room'
'@odata.nextLink':
type: string
nullable: true
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
nullable: true
additionalProperties:
type: object
microsoft.graph.buildingCollectionResponse:
title: Collection of building
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.building'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.deskCollectionResponse:
title: Collection of desk
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.desk'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.floorCollectionResponse:
title: Collection of floor
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.floor'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.roomListCollectionResponse:
title: Collection of roomList
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.roomList'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.sectionCollectionResponse:
title: Collection of section
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.section'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.calendarGroupCollectionResponse:
title: Collection of calendarGroup
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarGroup'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.calendarCollectionResponse:
title: Collection of calendar
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendar'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.attendeeBase:
allOf:
- $ref: '#/components/schemas/microsoft.graph.recipient'
- title: attendeeBase
type: object
properties:
type:
$ref: '#/components/schemas/microsoft.graph.attendeeType'
additionalProperties:
type: object
microsoft.graph.bodyType:
title: bodyType
enum:
- text
- html
type: string
microsoft.graph.locationType:
title: locationType
enum:
- default
- conferenceRoom
- homeAddress
- businessAddress
- geoCoordinates
- streetAddress
- hotel
- restaurant
- localBusiness
- postalAddress
type: string
microsoft.graph.locationUniqueIdType:
title: locationUniqueIdType
enum:
- unknown
- locationStore
- directory
- private
- bing
type: string
microsoft.graph.phone:
title: phone
type: object
properties:
language:
type: string
nullable: true
number:
type: string
description: The phone number.
nullable: true
region:
type: string
nullable: true
type:
$ref: '#/components/schemas/microsoft.graph.phoneType'
additionalProperties:
type: object
microsoft.graph.recurrencePattern:
title: recurrencePattern
type: object
properties:
dayOfMonth:
maximum: 2147483647
minimum: -2147483648
type: number
description: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly.
format: int32
daysOfWeek:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.dayOfWeek'
description: 'A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.'
firstDayOfWeek:
$ref: '#/components/schemas/microsoft.graph.dayOfWeek'
index:
$ref: '#/components/schemas/microsoft.graph.weekIndex'
interval:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.'
format: int32
month:
maximum: 2147483647
minimum: -2147483648
type: number
description: The month in which the event occurs. This is a number from 1 to 12.
format: int32
type:
$ref: '#/components/schemas/microsoft.graph.recurrencePatternType'
additionalProperties:
type: object
microsoft.graph.recurrenceRange:
title: recurrenceRange
type: object
properties:
endDate:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
description: 'The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate.'
format: date
nullable: true
numberOfOccurrences:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of times to repeat the event. Required and must be positive if type is numbered.
format: int32
recurrenceTimeZone:
type: string
description: 'Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.'
nullable: true
startDate:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
description: 'The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required.'
format: date
nullable: true
type:
$ref: '#/components/schemas/microsoft.graph.recurrenceRangeType'
additionalProperties:
type: object
microsoft.graph.responseType:
title: responseType
enum:
- none
- organizer
- tentativelyAccepted
- accepted
- declined
- notResponded
type: string
microsoft.graph.dayOfWeek:
title: dayOfWeek
enum:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
type: string
microsoft.graph.timeZoneBase:
title: timeZoneBase
type: object
properties:
name:
type: string
description: 'The name of a time zone. It can be a standard time zone name such as ''Hawaii-Aleutian Standard Time'', or ''Customized Time Zone'' for a custom time zone.'
nullable: true
additionalProperties:
type: object
ReferenceNumeric:
enum:
- '-INF'
- INF
- NaN
type: string
nullable: true
microsoft.graph.resourceLinkType:
title: resourceLinkType
enum:
- url
- unknownFutureValue
type: string
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
nullable: true
details:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails'
innerError:
$ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError'
additionalProperties:
type: object
microsoft.graph.attendeeType:
title: attendeeType
enum:
- required
- optional
- resource
type: string
microsoft.graph.phoneType:
title: phoneType
enum:
- home
- business
- mobile
- other
- assistant
- homeFax
- businessFax
- otherFax
- pager
- radio
type: string
microsoft.graph.weekIndex:
title: weekIndex
enum:
- first
- second
- third
- fourth
- last
type: string
microsoft.graph.recurrencePatternType:
title: recurrencePatternType
enum:
- daily
- weekly
- absoluteMonthly
- relativeMonthly
- absoluteYearly
- relativeYearly
type: string
microsoft.graph.recurrenceRangeType:
title: recurrenceRangeType
enum:
- endDate
- noEnd
- numbered
type: string
microsoft.graph.ODataErrors.ErrorDetails:
required:
- code
- message
type: object
properties:
code:
type: string
message:
type: string
target:
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.ODataErrors.InnerError:
type: object
additionalProperties:
type: object
description: The structure of this object is service-specific
responses:
error:
description: error
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError'
microsoft.graph.calendarPermissionCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermissionCollectionResponse'
ODataCountResponse:
description: The count of the resource
content:
text/plain:
schema:
$ref: '#/components/schemas/ODataCountResponse'
microsoft.graph.eventCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.eventCollectionResponse'
microsoft.graph.attachmentCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachmentCollectionResponse'
microsoft.graph.extensionCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extensionCollectionResponse'
microsoft.graph.checkInClaimCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.checkInClaimCollectionResponse'
microsoft.graph.footprintMapCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.footprintMapCollectionResponse'
microsoft.graph.levelMapCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.levelMapCollectionResponse'
microsoft.graph.fixtureMapCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.fixtureMapCollectionResponse'
microsoft.graph.sectionMapCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionMapCollectionResponse'
microsoft.graph.unitMapCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unitMapCollectionResponse'
microsoft.graph.roomCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.roomCollectionResponse'
microsoft.graph.workspaceCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.workspaceCollectionResponse'
microsoft.graph.buildingCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.buildingCollectionResponse'
microsoft.graph.deskCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.deskCollectionResponse'
microsoft.graph.floorCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.floorCollectionResponse'
microsoft.graph.roomListCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.roomListCollectionResponse'
microsoft.graph.sectionCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionCollectionResponse'
microsoft.graph.calendarGroupCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarGroupCollectionResponse'
microsoft.graph.calendarCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarCollectionResponse'
parameters:
top:
name: $top
in: query
description: Show only the first n items
style: form
explode: false
schema:
minimum: 0
type: integer
example: 50
skip:
name: $skip
in: query
description: Skip the first n items
style: form
explode: false
schema:
minimum: 0
type: integer
search:
name: $search
in: query
description: Search items by search phrases
style: form
explode: false
schema:
type: string
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: { }
security:
- azureaadv2: [ ]