OpenAPI.NET.OData/docs/oas3_0_0/graph1.0.yaml

16364 lines
494 KiB
YAML

openapi: 3.0.1
info:
title: OData Service for namespace microsoft.graph
description: This OData service is located at https://graph.microsoft.com/v1.0
version: 1.0.1
servers:
- url: https://graph.microsoft.com/v1.0
paths:
/directoryObjects:
get:
tags:
- directoryObjects.directoryObject
summary: Get entities from directoryObjects
operationId: directoryObjects.directoryObject.ListDirectoryObject
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/search'
- name: $orderby
in: query
description: Order items by property values
schema:
uniqueItems: true
type: array
items:
enum:
- id
- id desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of directoryObject
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- directoryObjects.directoryObject
summary: Add new entity to directoryObjects
operationId: directoryObjects.directoryObject.CreateDirectoryObject
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/directoryObjects({id})':
get:
tags:
- directoryObjects.directoryObject
summary: Get entity from directoryObjects by key
operationId: directoryObjects.directoryObject.GetDirectoryObject
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- directoryObjects.directoryObject
summary: Update entity in directoryObjects
operationId: directoryObjects.directoryObject.UpdateDirectoryObject
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- directoryObjects.directoryObject
summary: Delete entity from directoryObjects
operationId: directoryObjects.directoryObject.DeleteDirectoryObject
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/directoryObjects/microsoft.graph.getByIds:
post:
tags:
- directoryObjects.Actions
summary: Invoke action getByIds
operationId: directoryObjects.directoryObject.getByIds
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ids:
type: array
items:
type: string
types:
type: array
items:
type: string
nullable: true
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/directoryObjects/microsoft.graph.user/microsoft.graph.delta():
get:
tags:
- directoryObjects.Functions
summary: Invoke function delta
operationId: directoryObjects.user.delta.8fda216f08e1eb50d1a3787b
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.user'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- /directoryObjects/microsoft.graph.group/microsoft.graph.delta()
/directoryObjects/microsoft.graph.group/microsoft.graph.delta():
get:
tags:
- directoryObjects.Functions
summary: Invoke function delta
operationId: directoryObjects.group.delta.8fda216f08e1eb50d1a3787b
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.group'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- /directoryObjects/microsoft.graph.user/microsoft.graph.delta()
'/directoryObjects({id})/microsoft.graph.checkMemberGroups':
post:
tags:
- directoryObjects.Actions
summary: Invoke action checkMemberGroups
operationId: directoryObjects.directoryObject.checkMemberGroups
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
groupIds:
type: array
items:
type: string
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/directoryObjects({id})/microsoft.graph.getMemberGroups':
post:
tags:
- directoryObjects.Actions
summary: Invoke action getMemberGroups
operationId: directoryObjects.directoryObject.getMemberGroups
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
securityEnabledOnly:
type: boolean
default: false
nullable: true
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/directoryObjects({id})/microsoft.graph.getMemberObjects':
post:
tags:
- directoryObjects.Actions
summary: Invoke action getMemberObjects
operationId: directoryObjects.directoryObject.getMemberObjects
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
securityEnabledOnly:
type: boolean
default: false
nullable: true
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/directoryObjects({id})/microsoft.graph.user/microsoft.graph.assignLicense':
post:
tags:
- directoryObjects.Actions
summary: Invoke action assignLicense
operationId: directoryObjects.user.assignLicense
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
addLicenses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedLicense'
removeLicenses:
type: array
items:
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
format: uuid
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/directoryObjects({id})/microsoft.graph.user/microsoft.graph.changePassword':
post:
tags:
- directoryObjects.Actions
summary: Invoke action changePassword
operationId: directoryObjects.user.changePassword
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
currentPassword:
type: string
nullable: true
newPassword:
type: string
nullable: true
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/directoryObjects({id})/microsoft.graph.user/microsoft.graph.sendMail':
post:
tags:
- directoryObjects.Actions
summary: Invoke action sendMail
operationId: directoryObjects.user.sendMail
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
$ref: '#/components/schemas/microsoft.graph.message'
SaveToSentItems:
type: boolean
default: false
nullable: true
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/directoryObjects({id})/microsoft.graph.user/microsoft.graph.findMeetingTimes':
post:
tags:
- directoryObjects.Actions
summary: Invoke action findMeetingTimes
operationId: directoryObjects.user.findMeetingTimes
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Attendees:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.attendeeBase'
nullable: true
LocationConstraint:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.locationConstraint'
nullable: true
TimeConstraint:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeConstraint'
nullable: true
MeetingDuration:
pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
type: string
format: duration
nullable: true
MaxCandidates:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
IsOrganizerOptional:
type: boolean
default: false
nullable: true
ReturnSuggestionReasons:
type: boolean
default: false
nullable: true
MinimumAttendeePercentage:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
nullable: true
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/directoryObjects({id})/microsoft.graph.user/microsoft.graph.reminderView(StartDateTime={StartDateTime},EndDateTime={EndDateTime})':
get:
tags:
- directoryObjects.Functions
summary: Invoke function reminderView
operationId: directoryObjects.user.reminderView.5affd064fe7df3ca87c7f95a
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: StartDateTime
in: path
required: true
schema:
type: string
- name: EndDateTime
in: path
required: true
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.reminder'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/directoryObjects({id})/microsoft.graph.group/microsoft.graph.subscribeByMail':
post:
tags:
- directoryObjects.Actions
summary: Invoke action subscribeByMail
operationId: directoryObjects.group.subscribeByMail
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/directoryObjects({id})/microsoft.graph.group/microsoft.graph.unsubscribeByMail':
post:
tags:
- directoryObjects.Actions
summary: Invoke action unsubscribeByMail
operationId: directoryObjects.group.unsubscribeByMail
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/directoryObjects({id})/microsoft.graph.group/microsoft.graph.addFavorite':
post:
tags:
- directoryObjects.Actions
summary: Invoke action addFavorite
operationId: directoryObjects.group.addFavorite
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/directoryObjects({id})/microsoft.graph.group/microsoft.graph.removeFavorite':
post:
tags:
- directoryObjects.Actions
summary: Invoke action removeFavorite
operationId: directoryObjects.group.removeFavorite
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/directoryObjects({id})/microsoft.graph.group/microsoft.graph.resetUnseenCount':
post:
tags:
- directoryObjects.Actions
summary: Invoke action resetUnseenCount
operationId: directoryObjects.group.resetUnseenCount
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/devices:
get:
tags:
- devices.device
summary: Get entities from devices
operationId: devices.device.ListDevice
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/search'
- name: $orderby
in: query
description: Order items by property values
schema:
uniqueItems: true
type: array
items:
enum:
- id
- id desc
- accountEnabled
- accountEnabled desc
- alternativeSecurityIds
- alternativeSecurityIds desc
- approximateLastSignInDateTime
- approximateLastSignInDateTime desc
- deviceId
- deviceId desc
- deviceMetadata
- deviceMetadata desc
- deviceVersion
- deviceVersion desc
- displayName
- displayName desc
- isCompliant
- isCompliant desc
- isManaged
- isManaged desc
- onPremisesLastSyncDateTime
- onPremisesLastSyncDateTime desc
- onPremisesSyncEnabled
- onPremisesSyncEnabled desc
- operatingSystem
- operatingSystem desc
- operatingSystemVersion
- operatingSystemVersion desc
- physicalIds
- physicalIds desc
- trustType
- trustType desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- accountEnabled
- alternativeSecurityIds
- approximateLastSignInDateTime
- deviceId
- deviceMetadata
- deviceVersion
- displayName
- isCompliant
- isManaged
- onPremisesLastSyncDateTime
- onPremisesSyncEnabled
- operatingSystem
- operatingSystemVersion
- physicalIds
- trustType
- registeredOwners
- registeredUsers
- extensions
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of device
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.device'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- devices.device
summary: Add new entity to devices
operationId: devices.device.CreateDevice
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.device'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.device'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/devices({id})':
get:
tags:
- devices.device
summary: Get entity from devices by key
operationId: devices.device.GetDevice
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: device
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- accountEnabled
- alternativeSecurityIds
- approximateLastSignInDateTime
- deviceId
- deviceMetadata
- deviceVersion
- displayName
- isCompliant
- isManaged
- onPremisesLastSyncDateTime
- onPremisesSyncEnabled
- operatingSystem
- operatingSystemVersion
- physicalIds
- trustType
- registeredOwners
- registeredUsers
- extensions
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.device'
links:
registeredOwners:
operationId: devices.device.GetDevice
parameters:
id: $request.path.id
registeredUsers:
operationId: devices.device.GetDevice
parameters:
id: $request.path.id
extensions:
operationId: devices.device.GetDevice
parameters:
id: $request.path.id
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- devices.device
summary: Update entity in devices
operationId: devices.device.UpdateDevice
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: device
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.device'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- devices.device
summary: Delete entity from devices
operationId: devices.device.DeleteDevice
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: device
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/domains:
get:
tags:
- domains.domain
summary: Get entities from domains
operationId: domains.domain.ListDomain
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
schema:
uniqueItems: true
type: array
items:
enum:
- id
- id desc
- authenticationType
- authenticationType desc
- availabilityStatus
- availabilityStatus desc
- isAdminManaged
- isAdminManaged desc
- isDefault
- isDefault desc
- isInitial
- isInitial desc
- isRoot
- isRoot desc
- isVerified
- isVerified desc
- supportedServices
- supportedServices desc
- state
- state desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- authenticationType
- availabilityStatus
- isAdminManaged
- isDefault
- isInitial
- isRoot
- isVerified
- supportedServices
- state
- serviceConfigurationRecords
- verificationDnsRecords
- domainNameReferences
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
- serviceConfigurationRecords
- verificationDnsRecords
- domainNameReferences
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of domain
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.domain'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- domains.domain
summary: Add new entity to domains
operationId: domains.domain.CreateDomain
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.domain'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.domain'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/domains({id})':
get:
tags:
- domains.domain
summary: Get entity from domains by key
operationId: domains.domain.GetDomain
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: domain
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- authenticationType
- availabilityStatus
- isAdminManaged
- isDefault
- isInitial
- isRoot
- isVerified
- supportedServices
- state
- serviceConfigurationRecords
- verificationDnsRecords
- domainNameReferences
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
- serviceConfigurationRecords
- verificationDnsRecords
- domainNameReferences
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.domain'
links:
serviceConfigurationRecords:
operationId: domains.domain.GetDomain
parameters:
id: $request.path.id
verificationDnsRecords:
operationId: domains.domain.GetDomain
parameters:
id: $request.path.id
domainNameReferences:
operationId: domains.domain.GetDomain
parameters:
id: $request.path.id
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- domains.domain
summary: Update entity in domains
operationId: domains.domain.UpdateDomain
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: domain
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.domain'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- domains.domain
summary: Delete entity from domains
operationId: domains.domain.DeleteDomain
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: domain
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/domains({id})/microsoft.graph.verify':
post:
tags:
- domains.Actions
summary: Invoke action verify
operationId: domains.domain.verify
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: domain
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/domainDnsRecords:
get:
tags:
- domainDnsRecords.domainDnsRecord
summary: Get entities from domainDnsRecords
operationId: domainDnsRecords.domainDnsRecord.ListDomainDnsRecord
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
schema:
uniqueItems: true
type: array
items:
enum:
- id
- id desc
- isOptional
- isOptional desc
- label
- label desc
- recordType
- recordType desc
- supportedService
- supportedService desc
- ttl
- ttl desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- isOptional
- label
- recordType
- supportedService
- ttl
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of domainDnsRecord
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- domainDnsRecords.domainDnsRecord
summary: Add new entity to domainDnsRecords
operationId: domainDnsRecords.domainDnsRecord.CreateDomainDnsRecord
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/domainDnsRecords({id})':
get:
tags:
- domainDnsRecords.domainDnsRecord
summary: Get entity from domainDnsRecords by key
operationId: domainDnsRecords.domainDnsRecord.GetDomainDnsRecord
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: domainDnsRecord
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- isOptional
- label
- recordType
- supportedService
- ttl
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- domainDnsRecords.domainDnsRecord
summary: Update entity in domainDnsRecords
operationId: domainDnsRecords.domainDnsRecord.UpdateDomainDnsRecord
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: domainDnsRecord
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- domainDnsRecords.domainDnsRecord
summary: Delete entity from domainDnsRecords
operationId: domainDnsRecords.domainDnsRecord.DeleteDomainDnsRecord
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: domainDnsRecord
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/groups:
get:
tags:
- groups.group
summary: Get entities from groups
operationId: groups.group.ListGroup
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/search'
- name: $orderby
in: query
description: Order items by property values
schema:
uniqueItems: true
type: array
items:
enum:
- id
- id desc
- classification
- classification desc
- createdDateTime
- createdDateTime desc
- description
- description desc
- displayName
- displayName desc
- groupTypes
- groupTypes desc
- mail
- mail desc
- mailEnabled
- mailEnabled desc
- mailNickname
- mailNickname desc
- onPremisesLastSyncDateTime
- onPremisesLastSyncDateTime desc
- onPremisesSecurityIdentifier
- onPremisesSecurityIdentifier desc
- onPremisesSyncEnabled
- onPremisesSyncEnabled desc
- proxyAddresses
- proxyAddresses desc
- renewedDateTime
- renewedDateTime desc
- securityEnabled
- securityEnabled desc
- visibility
- visibility desc
- allowExternalSenders
- allowExternalSenders desc
- autoSubscribeNewMembers
- autoSubscribeNewMembers desc
- isSubscribedByMail
- isSubscribedByMail desc
- unseenCount
- unseenCount desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- classification
- createdDateTime
- description
- displayName
- groupTypes
- mail
- mailEnabled
- mailNickname
- onPremisesLastSyncDateTime
- onPremisesSecurityIdentifier
- onPremisesSyncEnabled
- proxyAddresses
- renewedDateTime
- securityEnabled
- visibility
- allowExternalSenders
- autoSubscribeNewMembers
- isSubscribedByMail
- unseenCount
- members
- memberOf
- createdOnBehalfOf
- owners
- settings
- extensions
- threads
- calendar
- calendarView
- events
- conversations
- photo
- photos
- acceptedSenders
- rejectedSenders
- drive
- drives
- sites
- planner
- onenote
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of group
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.group'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- groups.group
summary: Add new entity to groups
operationId: groups.group.CreateGroup
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.group'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.group'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/groups({id})':
get:
tags:
- groups.group
summary: Get entity from groups by key
operationId: groups.group.GetGroup
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: group
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- classification
- createdDateTime
- description
- displayName
- groupTypes
- mail
- mailEnabled
- mailNickname
- onPremisesLastSyncDateTime
- onPremisesSecurityIdentifier
- onPremisesSyncEnabled
- proxyAddresses
- renewedDateTime
- securityEnabled
- visibility
- allowExternalSenders
- autoSubscribeNewMembers
- isSubscribedByMail
- unseenCount
- members
- memberOf
- createdOnBehalfOf
- owners
- settings
- extensions
- threads
- calendar
- calendarView
- events
- conversations
- photo
- photos
- acceptedSenders
- rejectedSenders
- drive
- drives
- sites
- planner
- onenote
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.group'
links:
members:
operationId: groups.group.GetGroup
parameters:
id: $request.path.id
memberOf:
operationId: groups.group.GetGroup
parameters:
id: $request.path.id
createdOnBehalfOf:
operationId: groups.group.GetGroup
parameters:
id: $request.path.id
owners:
operationId: groups.group.GetGroup
parameters:
id: $request.path.id
settings:
operationId: groups.group.GetGroup
parameters:
id: $request.path.id
extensions:
operationId: groups.group.GetGroup
parameters:
id: $request.path.id
threads:
operationId: groups.group.GetGroup
parameters:
id: $request.path.id
calendar:
operationId: groups.group.GetGroup
parameters:
id: $request.path.id
calendarView:
operationId: groups.group.GetGroup
parameters:
id: $request.path.id
events:
operationId: groups.group.GetGroup
parameters:
id: $request.path.id
conversations:
operationId: groups.group.GetGroup
parameters:
id: $request.path.id
photo:
operationId: groups.group.GetGroup
parameters:
id: $request.path.id
photos:
operationId: groups.group.GetGroup
parameters:
id: $request.path.id
acceptedSenders:
operationId: groups.group.GetGroup
parameters:
id: $request.path.id
rejectedSenders:
operationId: groups.group.GetGroup
parameters:
id: $request.path.id
drive:
operationId: groups.group.GetGroup
parameters:
id: $request.path.id
drives:
operationId: groups.group.GetGroup
parameters:
id: $request.path.id
sites:
operationId: groups.group.GetGroup
parameters:
id: $request.path.id
planner:
operationId: groups.group.GetGroup
parameters:
id: $request.path.id
onenote:
operationId: groups.group.GetGroup
parameters:
id: $request.path.id
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- groups.group
summary: Update entity in groups
operationId: groups.group.UpdateGroup
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: group
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.group'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- groups.group
summary: Delete entity from groups
operationId: groups.group.DeleteGroup
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: group
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/groups/microsoft.graph.delta():
get:
tags:
- groups.Functions
summary: Invoke function delta
operationId: groups.group.delta.8fda216f08e1eb50d1a3787b
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.group'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/groups({id})/microsoft.graph.subscribeByMail':
post:
tags:
- groups.Actions
summary: Invoke action subscribeByMail
operationId: groups.group.subscribeByMail
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: group
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups({id})/microsoft.graph.unsubscribeByMail':
post:
tags:
- groups.Actions
summary: Invoke action unsubscribeByMail
operationId: groups.group.unsubscribeByMail
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: group
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups({id})/microsoft.graph.addFavorite':
post:
tags:
- groups.Actions
summary: Invoke action addFavorite
operationId: groups.group.addFavorite
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: group
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups({id})/microsoft.graph.removeFavorite':
post:
tags:
- groups.Actions
summary: Invoke action removeFavorite
operationId: groups.group.removeFavorite
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: group
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/groups({id})/microsoft.graph.resetUnseenCount':
post:
tags:
- groups.Actions
summary: Invoke action resetUnseenCount
operationId: groups.group.resetUnseenCount
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: group
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/directoryRoles:
get:
tags:
- directoryRoles.directoryRole
summary: Get entities from directoryRoles
operationId: directoryRoles.directoryRole.ListDirectoryRole
parameters:
- $ref: '#/components/parameters/search'
- name: $orderby
in: query
description: Order items by property values
schema:
uniqueItems: true
type: array
items:
enum:
- id
- id desc
- description
- description desc
- displayName
- displayName desc
- roleTemplateId
- roleTemplateId desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- description
- displayName
- roleTemplateId
- members
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of directoryRole
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- directoryRoles.directoryRole
summary: Add new entity to directoryRoles
operationId: directoryRoles.directoryRole.CreateDirectoryRole
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryRole'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/directoryRoles({id})':
get:
tags:
- directoryRoles.directoryRole
summary: Get entity from directoryRoles by key
operationId: directoryRoles.directoryRole.GetDirectoryRole
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryRole
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- description
- displayName
- roleTemplateId
- members
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryRole'
links:
members:
operationId: directoryRoles.directoryRole.GetDirectoryRole
parameters:
id: $request.path.id
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- directoryRoles.directoryRole
summary: Update entity in directoryRoles
operationId: directoryRoles.directoryRole.UpdateDirectoryRole
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryRole
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryRole'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- directoryRoles.directoryRole
summary: Delete entity from directoryRoles
operationId: directoryRoles.directoryRole.DeleteDirectoryRole
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryRole
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/directoryRoleTemplates:
get:
tags:
- directoryRoleTemplates.directoryRoleTemplate
summary: Get entities from directoryRoleTemplates
operationId: directoryRoleTemplates.directoryRoleTemplate.ListDirectoryRoleTemplate
parameters:
- $ref: '#/components/parameters/search'
- name: $orderby
in: query
description: Order items by property values
schema:
uniqueItems: true
type: array
items:
enum:
- id
- id desc
- description
- description desc
- displayName
- displayName desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- description
- displayName
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of directoryRoleTemplate
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryRoleTemplate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- directoryRoleTemplates.directoryRoleTemplate
summary: Add new entity to directoryRoleTemplates
operationId: directoryRoleTemplates.directoryRoleTemplate.CreateDirectoryRoleTemplate
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryRoleTemplate'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryRoleTemplate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/directoryRoleTemplates({id})':
get:
tags:
- directoryRoleTemplates.directoryRoleTemplate
summary: Get entity from directoryRoleTemplates by key
operationId: directoryRoleTemplates.directoryRoleTemplate.GetDirectoryRoleTemplate
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryRoleTemplate
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- description
- displayName
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryRoleTemplate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- directoryRoleTemplates.directoryRoleTemplate
summary: Update entity in directoryRoleTemplates
operationId: directoryRoleTemplates.directoryRoleTemplate.UpdateDirectoryRoleTemplate
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryRoleTemplate
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryRoleTemplate'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- directoryRoleTemplates.directoryRoleTemplate
summary: Delete entity from directoryRoleTemplates
operationId: directoryRoleTemplates.directoryRoleTemplate.DeleteDirectoryRoleTemplate
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: directoryRoleTemplate
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/organization:
get:
tags:
- organization.organization
summary: Get entities from organization
operationId: organization.organization.ListOrganization
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/search'
- name: $orderby
in: query
description: Order items by property values
schema:
uniqueItems: true
type: array
items:
enum:
- id
- id desc
- assignedPlans
- assignedPlans desc
- businessPhones
- businessPhones desc
- city
- city desc
- country
- country desc
- countryLetterCode
- countryLetterCode desc
- displayName
- displayName desc
- marketingNotificationEmails
- marketingNotificationEmails desc
- onPremisesLastSyncDateTime
- onPremisesLastSyncDateTime desc
- onPremisesSyncEnabled
- onPremisesSyncEnabled desc
- postalCode
- postalCode desc
- preferredLanguage
- preferredLanguage desc
- provisionedPlans
- provisionedPlans desc
- securityComplianceNotificationMails
- securityComplianceNotificationMails desc
- securityComplianceNotificationPhones
- securityComplianceNotificationPhones desc
- state
- state desc
- street
- street desc
- technicalNotificationMails
- technicalNotificationMails desc
- verifiedDomains
- verifiedDomains desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- assignedPlans
- businessPhones
- city
- country
- countryLetterCode
- displayName
- marketingNotificationEmails
- onPremisesLastSyncDateTime
- onPremisesSyncEnabled
- postalCode
- preferredLanguage
- provisionedPlans
- securityComplianceNotificationMails
- securityComplianceNotificationPhones
- state
- street
- technicalNotificationMails
- verifiedDomains
- extensions
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of organization
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.organization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- organization.organization
summary: Add new entity to organization
operationId: organization.organization.CreateOrganization
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.organization'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.organization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/organization({id})':
get:
tags:
- organization.organization
summary: Get entity from organization by key
operationId: organization.organization.GetOrganization
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: organization
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- assignedPlans
- businessPhones
- city
- country
- countryLetterCode
- displayName
- marketingNotificationEmails
- onPremisesLastSyncDateTime
- onPremisesSyncEnabled
- postalCode
- preferredLanguage
- provisionedPlans
- securityComplianceNotificationMails
- securityComplianceNotificationPhones
- state
- street
- technicalNotificationMails
- verifiedDomains
- extensions
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.organization'
links:
extensions:
operationId: organization.organization.GetOrganization
parameters:
id: $request.path.id
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- organization.organization
summary: Update entity in organization
operationId: organization.organization.UpdateOrganization
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: organization
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.organization'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- organization.organization
summary: Delete entity from organization
operationId: organization.organization.DeleteOrganization
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: organization
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/groupSettings:
get:
tags:
- groupSettings.groupSetting
summary: Get entities from groupSettings
operationId: groupSettings.groupSetting.ListGroupSetting
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
schema:
uniqueItems: true
type: array
items:
enum:
- id
- id desc
- displayName
- displayName desc
- templateId
- templateId desc
- values
- values desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- displayName
- templateId
- values
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of groupSetting
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.groupSetting'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- groupSettings.groupSetting
summary: Add new entity to groupSettings
operationId: groupSettings.groupSetting.CreateGroupSetting
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.groupSetting'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.groupSetting'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/groupSettings({id})':
get:
tags:
- groupSettings.groupSetting
summary: Get entity from groupSettings by key
operationId: groupSettings.groupSetting.GetGroupSetting
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: groupSetting
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- displayName
- templateId
- values
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.groupSetting'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- groupSettings.groupSetting
summary: Update entity in groupSettings
operationId: groupSettings.groupSetting.UpdateGroupSetting
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: groupSetting
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.groupSetting'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- groupSettings.groupSetting
summary: Delete entity from groupSettings
operationId: groupSettings.groupSetting.DeleteGroupSetting
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: groupSetting
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/groupSettingTemplates:
get:
tags:
- groupSettingTemplates.groupSettingTemplate
summary: Get entities from groupSettingTemplates
operationId: groupSettingTemplates.groupSettingTemplate.ListGroupSettingTemplate
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/search'
- name: $orderby
in: query
description: Order items by property values
schema:
uniqueItems: true
type: array
items:
enum:
- id
- id desc
- displayName
- displayName desc
- description
- description desc
- values
- values desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- displayName
- description
- values
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of groupSettingTemplate
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.groupSettingTemplate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- groupSettingTemplates.groupSettingTemplate
summary: Add new entity to groupSettingTemplates
operationId: groupSettingTemplates.groupSettingTemplate.CreateGroupSettingTemplate
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.groupSettingTemplate'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.groupSettingTemplate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/groupSettingTemplates({id})':
get:
tags:
- groupSettingTemplates.groupSettingTemplate
summary: Get entity from groupSettingTemplates by key
operationId: groupSettingTemplates.groupSettingTemplate.GetGroupSettingTemplate
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: groupSettingTemplate
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- displayName
- description
- values
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.groupSettingTemplate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- groupSettingTemplates.groupSettingTemplate
summary: Update entity in groupSettingTemplates
operationId: groupSettingTemplates.groupSettingTemplate.UpdateGroupSettingTemplate
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: groupSettingTemplate
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.groupSettingTemplate'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- groupSettingTemplates.groupSettingTemplate
summary: Delete entity from groupSettingTemplates
operationId: groupSettingTemplates.groupSettingTemplate.DeleteGroupSettingTemplate
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: groupSettingTemplate
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/subscribedSkus:
get:
tags:
- subscribedSkus.subscribedSku
summary: Get entities from subscribedSkus
operationId: subscribedSkus.subscribedSku.ListSubscribedSku
parameters:
- $ref: '#/components/parameters/search'
- name: $orderby
in: query
description: Order items by property values
schema:
uniqueItems: true
type: array
items:
enum:
- id
- id desc
- capabilityStatus
- capabilityStatus desc
- consumedUnits
- consumedUnits desc
- prepaidUnits
- prepaidUnits desc
- servicePlans
- servicePlans desc
- skuId
- skuId desc
- skuPartNumber
- skuPartNumber desc
- appliesTo
- appliesTo desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- capabilityStatus
- consumedUnits
- prepaidUnits
- servicePlans
- skuId
- skuPartNumber
- appliesTo
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of subscribedSku
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subscribedSku'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- subscribedSkus.subscribedSku
summary: Add new entity to subscribedSkus
operationId: subscribedSkus.subscribedSku.CreateSubscribedSku
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.subscribedSku'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.subscribedSku'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/subscribedSkus({id})':
get:
tags:
- subscribedSkus.subscribedSku
summary: Get entity from subscribedSkus by key
operationId: subscribedSkus.subscribedSku.GetSubscribedSku
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: subscribedSku
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- capabilityStatus
- consumedUnits
- prepaidUnits
- servicePlans
- skuId
- skuPartNumber
- appliesTo
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.subscribedSku'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- subscribedSkus.subscribedSku
summary: Update entity in subscribedSkus
operationId: subscribedSkus.subscribedSku.UpdateSubscribedSku
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: subscribedSku
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.subscribedSku'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- subscribedSkus.subscribedSku
summary: Delete entity from subscribedSkus
operationId: subscribedSkus.subscribedSku.DeleteSubscribedSku
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: subscribedSku
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/users:
get:
tags:
- users.user
summary: Get entities from users
operationId: users.user.ListUser
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/search'
- name: $orderby
in: query
description: Order items by property values
schema:
uniqueItems: true
type: array
items:
enum:
- id
- id desc
- accountEnabled
- accountEnabled desc
- assignedLicenses
- assignedLicenses desc
- assignedPlans
- assignedPlans desc
- businessPhones
- businessPhones desc
- city
- city desc
- companyName
- companyName desc
- country
- country desc
- department
- department desc
- displayName
- displayName desc
- givenName
- givenName desc
- imAddresses
- imAddresses desc
- jobTitle
- jobTitle desc
- mail
- mail desc
- mailNickname
- mailNickname desc
- mobilePhone
- mobilePhone desc
- onPremisesImmutableId
- onPremisesImmutableId desc
- onPremisesLastSyncDateTime
- onPremisesLastSyncDateTime desc
- onPremisesSecurityIdentifier
- onPremisesSecurityIdentifier desc
- onPremisesSyncEnabled
- onPremisesSyncEnabled desc
- passwordPolicies
- passwordPolicies desc
- passwordProfile
- passwordProfile desc
- officeLocation
- officeLocation desc
- postalCode
- postalCode desc
- preferredLanguage
- preferredLanguage desc
- provisionedPlans
- provisionedPlans desc
- proxyAddresses
- proxyAddresses desc
- state
- state desc
- streetAddress
- streetAddress desc
- surname
- surname desc
- usageLocation
- usageLocation desc
- userPrincipalName
- userPrincipalName desc
- userType
- userType desc
- mailboxSettings
- mailboxSettings desc
- aboutMe
- aboutMe desc
- birthday
- birthday desc
- hireDate
- hireDate desc
- interests
- interests desc
- mySite
- mySite desc
- pastProjects
- pastProjects desc
- preferredName
- preferredName desc
- responsibilities
- responsibilities desc
- schools
- schools desc
- skills
- skills desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- accountEnabled
- assignedLicenses
- assignedPlans
- businessPhones
- city
- companyName
- country
- department
- displayName
- givenName
- imAddresses
- jobTitle
- mail
- mailNickname
- mobilePhone
- onPremisesImmutableId
- onPremisesLastSyncDateTime
- onPremisesSecurityIdentifier
- onPremisesSyncEnabled
- passwordPolicies
- passwordProfile
- officeLocation
- postalCode
- preferredLanguage
- provisionedPlans
- proxyAddresses
- state
- streetAddress
- surname
- usageLocation
- userPrincipalName
- userType
- mailboxSettings
- aboutMe
- birthday
- hireDate
- interests
- mySite
- pastProjects
- preferredName
- responsibilities
- schools
- skills
- ownedDevices
- registeredDevices
- manager
- directReports
- memberOf
- createdObjects
- ownedObjects
- licenseDetails
- extensions
- messages
- mailFolders
- calendar
- calendars
- calendarGroups
- calendarView
- events
- people
- contacts
- contactFolders
- inferenceClassification
- photo
- photos
- drive
- drives
- planner
- onenote
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of user
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- users.user
summary: Add new entity to users
operationId: users.user.CreateUser
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users({id})':
get:
tags:
- users.user
summary: Get entity from users by key
operationId: users.user.GetUser
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- accountEnabled
- assignedLicenses
- assignedPlans
- businessPhones
- city
- companyName
- country
- department
- displayName
- givenName
- imAddresses
- jobTitle
- mail
- mailNickname
- mobilePhone
- onPremisesImmutableId
- onPremisesLastSyncDateTime
- onPremisesSecurityIdentifier
- onPremisesSyncEnabled
- passwordPolicies
- passwordProfile
- officeLocation
- postalCode
- preferredLanguage
- provisionedPlans
- proxyAddresses
- state
- streetAddress
- surname
- usageLocation
- userPrincipalName
- userType
- mailboxSettings
- aboutMe
- birthday
- hireDate
- interests
- mySite
- pastProjects
- preferredName
- responsibilities
- schools
- skills
- ownedDevices
- registeredDevices
- manager
- directReports
- memberOf
- createdObjects
- ownedObjects
- licenseDetails
- extensions
- messages
- mailFolders
- calendar
- calendars
- calendarGroups
- calendarView
- events
- people
- contacts
- contactFolders
- inferenceClassification
- photo
- photos
- drive
- drives
- planner
- onenote
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
links:
ownedDevices:
operationId: users.user.GetUser
parameters:
id: $request.path.id
registeredDevices:
operationId: users.user.GetUser
parameters:
id: $request.path.id
manager:
operationId: users.user.GetUser
parameters:
id: $request.path.id
directReports:
operationId: users.user.GetUser
parameters:
id: $request.path.id
memberOf:
operationId: users.user.GetUser
parameters:
id: $request.path.id
createdObjects:
operationId: users.user.GetUser
parameters:
id: $request.path.id
ownedObjects:
operationId: users.user.GetUser
parameters:
id: $request.path.id
licenseDetails:
operationId: users.user.GetUser
parameters:
id: $request.path.id
extensions:
operationId: users.user.GetUser
parameters:
id: $request.path.id
messages:
operationId: users.user.GetUser
parameters:
id: $request.path.id
mailFolders:
operationId: users.user.GetUser
parameters:
id: $request.path.id
calendar:
operationId: users.user.GetUser
parameters:
id: $request.path.id
calendars:
operationId: users.user.GetUser
parameters:
id: $request.path.id
calendarGroups:
operationId: users.user.GetUser
parameters:
id: $request.path.id
calendarView:
operationId: users.user.GetUser
parameters:
id: $request.path.id
events:
operationId: users.user.GetUser
parameters:
id: $request.path.id
people:
operationId: users.user.GetUser
parameters:
id: $request.path.id
contacts:
operationId: users.user.GetUser
parameters:
id: $request.path.id
contactFolders:
operationId: users.user.GetUser
parameters:
id: $request.path.id
inferenceClassification:
operationId: users.user.GetUser
parameters:
id: $request.path.id
photo:
operationId: users.user.GetUser
parameters:
id: $request.path.id
photos:
operationId: users.user.GetUser
parameters:
id: $request.path.id
drive:
operationId: users.user.GetUser
parameters:
id: $request.path.id
drives:
operationId: users.user.GetUser
parameters:
id: $request.path.id
planner:
operationId: users.user.GetUser
parameters:
id: $request.path.id
onenote:
operationId: users.user.GetUser
parameters:
id: $request.path.id
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.user
summary: Update entity in users
operationId: users.user.UpdateUser
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: user
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.user
summary: Delete entity from users
operationId: users.user.DeleteUser
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/users/microsoft.graph.delta():
get:
tags:
- users.Functions
summary: Invoke function delta
operationId: users.user.delta.8fda216f08e1eb50d1a3787b
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.user'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/users({id})/microsoft.graph.assignLicense':
post:
tags:
- users.Actions
summary: Invoke action assignLicense
operationId: users.user.assignLicense
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: user
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
addLicenses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedLicense'
removeLicenses:
type: array
items:
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
format: uuid
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users({id})/microsoft.graph.changePassword':
post:
tags:
- users.Actions
summary: Invoke action changePassword
operationId: users.user.changePassword
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: user
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
currentPassword:
type: string
nullable: true
newPassword:
type: string
nullable: true
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users({id})/microsoft.graph.sendMail':
post:
tags:
- users.Actions
summary: Invoke action sendMail
operationId: users.user.sendMail
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: user
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
$ref: '#/components/schemas/microsoft.graph.message'
SaveToSentItems:
type: boolean
default: false
nullable: true
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users({id})/microsoft.graph.findMeetingTimes':
post:
tags:
- users.Actions
summary: Invoke action findMeetingTimes
operationId: users.user.findMeetingTimes
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: user
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Attendees:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.attendeeBase'
nullable: true
LocationConstraint:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.locationConstraint'
nullable: true
TimeConstraint:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeConstraint'
nullable: true
MeetingDuration:
pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
type: string
format: duration
nullable: true
MaxCandidates:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
IsOrganizerOptional:
type: boolean
default: false
nullable: true
ReturnSuggestionReasons:
type: boolean
default: false
nullable: true
MinimumAttendeePercentage:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
nullable: true
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users({id})/microsoft.graph.reminderView(StartDateTime={StartDateTime},EndDateTime={EndDateTime})':
get:
tags:
- users.Functions
summary: Invoke function reminderView
operationId: users.user.reminderView.5affd064fe7df3ca87c7f95a
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: StartDateTime
in: path
required: true
schema:
type: string
- name: EndDateTime
in: path
required: true
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.reminder'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
/contracts:
get:
tags:
- contracts.contract
summary: Get entities from contracts
operationId: contracts.contract.ListContract
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/search'
- name: $orderby
in: query
description: Order items by property values
schema:
uniqueItems: true
type: array
items:
enum:
- id
- id desc
- contractType
- contractType desc
- customerId
- customerId desc
- defaultDomainName
- defaultDomainName desc
- displayName
- displayName desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- contractType
- customerId
- defaultDomainName
- displayName
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of contract
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contract'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- contracts.contract
summary: Add new entity to contracts
operationId: contracts.contract.CreateContract
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contract'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contract'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/contracts({id})':
get:
tags:
- contracts.contract
summary: Get entity from contracts by key
operationId: contracts.contract.GetContract
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: contract
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- contractType
- customerId
- defaultDomainName
- displayName
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contract'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- contracts.contract
summary: Update entity in contracts
operationId: contracts.contract.UpdateContract
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: contract
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contract'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- contracts.contract
summary: Delete entity from contracts
operationId: contracts.contract.DeleteContract
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: contract
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/schemaExtensions:
get:
tags:
- schemaExtensions.schemaExtension
summary: Get entities from schemaExtensions
operationId: schemaExtensions.schemaExtension.ListSchemaExtension
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
schema:
uniqueItems: true
type: array
items:
enum:
- id
- id desc
- description
- description desc
- targetTypes
- targetTypes desc
- properties
- properties desc
- status
- status desc
- owner
- owner desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- description
- targetTypes
- properties
- status
- owner
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of schemaExtension
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.schemaExtension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- schemaExtensions.schemaExtension
summary: Add new entity to schemaExtensions
operationId: schemaExtensions.schemaExtension.CreateSchemaExtension
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.schemaExtension'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.schemaExtension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/schemaExtensions({id})':
get:
tags:
- schemaExtensions.schemaExtension
summary: Get entity from schemaExtensions by key
operationId: schemaExtensions.schemaExtension.GetSchemaExtension
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: schemaExtension
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- description
- targetTypes
- properties
- status
- owner
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.schemaExtension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- schemaExtensions.schemaExtension
summary: Update entity in schemaExtensions
operationId: schemaExtensions.schemaExtension.UpdateSchemaExtension
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: schemaExtension
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.schemaExtension'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- schemaExtensions.schemaExtension
summary: Delete entity from schemaExtensions
operationId: schemaExtensions.schemaExtension.DeleteSchemaExtension
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: schemaExtension
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/drives:
get:
tags:
- drives.drive
summary: Get entities from drives
operationId: drives.drive.ListDrive
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
schema:
uniqueItems: true
type: array
items:
enum:
- id
- id desc
- createdBy
- createdBy desc
- createdDateTime
- createdDateTime desc
- description
- description desc
- eTag
- eTag desc
- lastModifiedBy
- lastModifiedBy desc
- lastModifiedDateTime
- lastModifiedDateTime desc
- name
- name desc
- parentReference
- parentReference desc
- webUrl
- webUrl desc
- driveType
- driveType desc
- owner
- owner desc
- quota
- quota desc
- sharePointIds
- sharePointIds desc
- system
- system desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- createdBy
- createdDateTime
- description
- eTag
- lastModifiedBy
- lastModifiedDateTime
- name
- parentReference
- webUrl
- driveType
- owner
- quota
- sharePointIds
- system
- createdByUser
- lastModifiedByUser
- items
- list
- root
- special
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
- createdByUser
- lastModifiedByUser
- items
- list
- root
- special
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of drive
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.drive'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- drives.drive
summary: Add new entity to drives
operationId: drives.drive.CreateDrive
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.drive'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.drive'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/drives({id})':
get:
tags:
- drives.drive
summary: Get entity from drives by key
operationId: drives.drive.GetDrive
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: drive
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- createdBy
- createdDateTime
- description
- eTag
- lastModifiedBy
- lastModifiedDateTime
- name
- parentReference
- webUrl
- driveType
- owner
- quota
- sharePointIds
- system
- createdByUser
- lastModifiedByUser
- items
- list
- root
- special
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
- createdByUser
- lastModifiedByUser
- items
- list
- root
- special
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.drive'
links:
items:
operationId: drives.drive.GetDrive
parameters:
id: $request.path.id
list:
operationId: drives.drive.GetDrive
parameters:
id: $request.path.id
root:
operationId: drives.drive.GetDrive
parameters:
id: $request.path.id
special:
operationId: drives.drive.GetDrive
parameters:
id: $request.path.id
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- drives.drive
summary: Update entity in drives
operationId: drives.drive.UpdateDrive
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.drive'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- drives.drive
summary: Delete entity from drives
operationId: drives.drive.DeleteDrive
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: drive
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/drives({id})/microsoft.graph.recent()':
get:
tags:
- drives.Functions
summary: Invoke function recent
operationId: drives.drive.recent.d3f031c1d9c48074285bfbc7
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: drive
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.driveItem'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/drives({id})/microsoft.graph.search(q={q})':
get:
tags:
- drives.Functions
summary: Invoke function search
operationId: drives.drive.search.15e9ccdaa36cf21169027b47
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: drive
- name: q
in: path
required: true
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.driveItem'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/drives({id})/microsoft.graph.sharedWithMe()':
get:
tags:
- drives.Functions
summary: Invoke function sharedWithMe
operationId: drives.drive.sharedWithMe.2f10bc98d2c4ee31f6daa2c7
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: drive
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.driveItem'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
/shares:
get:
tags:
- shares.sharedDriveItem
summary: Get entities from shares
operationId: shares.sharedDriveItem.ListSharedDriveItem
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
schema:
uniqueItems: true
type: array
items:
enum:
- id
- id desc
- createdBy
- createdBy desc
- createdDateTime
- createdDateTime desc
- description
- description desc
- eTag
- eTag desc
- lastModifiedBy
- lastModifiedBy desc
- lastModifiedDateTime
- lastModifiedDateTime desc
- name
- name desc
- parentReference
- parentReference desc
- webUrl
- webUrl desc
- owner
- owner desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- createdBy
- createdDateTime
- description
- eTag
- lastModifiedBy
- lastModifiedDateTime
- name
- parentReference
- webUrl
- owner
- createdByUser
- lastModifiedByUser
- driveItem
- items
- list
- listItem
- root
- site
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
- createdByUser
- lastModifiedByUser
- driveItem
- items
- list
- listItem
- root
- site
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of sharedDriveItem
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sharedDriveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- shares.sharedDriveItem
summary: Add new entity to shares
operationId: shares.sharedDriveItem.CreateSharedDriveItem
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sharedDriveItem'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sharedDriveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/shares({id})':
get:
tags:
- shares.sharedDriveItem
summary: Get entity from shares by key
operationId: shares.sharedDriveItem.GetSharedDriveItem
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: sharedDriveItem
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- createdBy
- createdDateTime
- description
- eTag
- lastModifiedBy
- lastModifiedDateTime
- name
- parentReference
- webUrl
- owner
- createdByUser
- lastModifiedByUser
- driveItem
- items
- list
- listItem
- root
- site
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
- createdByUser
- lastModifiedByUser
- driveItem
- items
- list
- listItem
- root
- site
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sharedDriveItem'
links:
driveItem:
operationId: shares.sharedDriveItem.GetSharedDriveItem
parameters:
id: $request.path.id
items:
operationId: shares.sharedDriveItem.GetSharedDriveItem
parameters:
id: $request.path.id
list:
operationId: shares.sharedDriveItem.GetSharedDriveItem
parameters:
id: $request.path.id
listItem:
operationId: shares.sharedDriveItem.GetSharedDriveItem
parameters:
id: $request.path.id
root:
operationId: shares.sharedDriveItem.GetSharedDriveItem
parameters:
id: $request.path.id
site:
operationId: shares.sharedDriveItem.GetSharedDriveItem
parameters:
id: $request.path.id
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- shares.sharedDriveItem
summary: Update entity in shares
operationId: shares.sharedDriveItem.UpdateSharedDriveItem
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: sharedDriveItem
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sharedDriveItem'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- shares.sharedDriveItem
summary: Delete entity from shares
operationId: shares.sharedDriveItem.DeleteSharedDriveItem
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: sharedDriveItem
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/sites:
get:
tags:
- sites.site
summary: Get entities from sites
operationId: sites.site.ListSite
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
schema:
uniqueItems: true
type: array
items:
enum:
- id
- id desc
- createdBy
- createdBy desc
- createdDateTime
- createdDateTime desc
- description
- description desc
- eTag
- eTag desc
- lastModifiedBy
- lastModifiedBy desc
- lastModifiedDateTime
- lastModifiedDateTime desc
- name
- name desc
- parentReference
- parentReference desc
- webUrl
- webUrl desc
- displayName
- displayName desc
- root
- root desc
- sharepointIds
- sharepointIds desc
- siteCollection
- siteCollection desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- createdBy
- createdDateTime
- description
- eTag
- lastModifiedBy
- lastModifiedDateTime
- name
- parentReference
- webUrl
- displayName
- root
- sharepointIds
- siteCollection
- createdByUser
- lastModifiedByUser
- columns
- contentTypes
- drive
- drives
- items
- lists
- sites
- onenote
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
- createdByUser
- lastModifiedByUser
- columns
- contentTypes
- drive
- drives
- items
- lists
- sites
- onenote
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of site
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- sites.site
summary: Add new entity to sites
operationId: sites.site.CreateSite
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.site'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.site'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/sites({id})':
get:
tags:
- sites.site
summary: Get entity from sites by key
operationId: sites.site.GetSite
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: site
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- createdBy
- createdDateTime
- description
- eTag
- lastModifiedBy
- lastModifiedDateTime
- name
- parentReference
- webUrl
- displayName
- root
- sharepointIds
- siteCollection
- createdByUser
- lastModifiedByUser
- columns
- contentTypes
- drive
- drives
- items
- lists
- sites
- onenote
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
- createdByUser
- lastModifiedByUser
- columns
- contentTypes
- drive
- drives
- items
- lists
- sites
- onenote
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.site'
links:
columns:
operationId: sites.site.GetSite
parameters:
id: $request.path.id
contentTypes:
operationId: sites.site.GetSite
parameters:
id: $request.path.id
drive:
operationId: sites.site.GetSite
parameters:
id: $request.path.id
drives:
operationId: sites.site.GetSite
parameters:
id: $request.path.id
items:
operationId: sites.site.GetSite
parameters:
id: $request.path.id
lists:
operationId: sites.site.GetSite
parameters:
id: $request.path.id
sites:
operationId: sites.site.GetSite
parameters:
id: $request.path.id
onenote:
operationId: sites.site.GetSite
parameters:
id: $request.path.id
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- sites.site
summary: Update entity in sites
operationId: sites.site.UpdateSite
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: site
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.site'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- sites.site
summary: Delete entity from sites
operationId: sites.site.DeleteSite
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: site
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/sites({id})/microsoft.graph.getByPath(path={path})':
get:
tags:
- sites.Functions
summary: Invoke function getByPath
operationId: sites.site.getByPath.235709cb86c8f299432b2142
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: site
- name: path
in: path
required: true
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.site'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
/workbooks:
get:
tags:
- workbooks.driveItem
summary: Get entities from workbooks
operationId: workbooks.driveItem.ListDriveItem
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
schema:
uniqueItems: true
type: array
items:
enum:
- id
- id desc
- createdBy
- createdBy desc
- createdDateTime
- createdDateTime desc
- description
- description desc
- eTag
- eTag desc
- lastModifiedBy
- lastModifiedBy desc
- lastModifiedDateTime
- lastModifiedDateTime desc
- name
- name desc
- parentReference
- parentReference desc
- webUrl
- webUrl desc
- audio
- audio desc
- content
- content desc
- cTag
- cTag desc
- deleted
- deleted desc
- file
- file desc
- fileSystemInfo
- fileSystemInfo desc
- folder
- folder desc
- image
- image desc
- location
- location desc
- package
- package desc
- photo
- photo desc
- remoteItem
- remoteItem desc
- root
- root desc
- searchResult
- searchResult desc
- shared
- shared desc
- sharepointIds
- sharepointIds desc
- size
- size desc
- specialFolder
- specialFolder desc
- video
- video desc
- webDavUrl
- webDavUrl desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- createdBy
- createdDateTime
- description
- eTag
- lastModifiedBy
- lastModifiedDateTime
- name
- parentReference
- webUrl
- audio
- content
- cTag
- deleted
- file
- fileSystemInfo
- folder
- image
- location
- package
- photo
- remoteItem
- root
- searchResult
- shared
- sharepointIds
- size
- specialFolder
- video
- webDavUrl
- createdByUser
- lastModifiedByUser
- children
- listItem
- permissions
- thumbnails
- workbook
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
- createdByUser
- lastModifiedByUser
- children
- listItem
- permissions
- thumbnails
- workbook
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of driveItem
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- workbooks.driveItem
summary: Add new entity to workbooks
operationId: workbooks.driveItem.CreateDriveItem
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/workbooks({id})':
get:
tags:
- workbooks.driveItem
summary: Get entity from workbooks by key
operationId: workbooks.driveItem.GetDriveItem
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: driveItem
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- createdBy
- createdDateTime
- description
- eTag
- lastModifiedBy
- lastModifiedDateTime
- name
- parentReference
- webUrl
- audio
- content
- cTag
- deleted
- file
- fileSystemInfo
- folder
- image
- location
- package
- photo
- remoteItem
- root
- searchResult
- shared
- sharepointIds
- size
- specialFolder
- video
- webDavUrl
- createdByUser
- lastModifiedByUser
- children
- listItem
- permissions
- thumbnails
- workbook
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
- createdByUser
- lastModifiedByUser
- children
- listItem
- permissions
- thumbnails
- workbook
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
links:
children:
operationId: workbooks.driveItem.GetDriveItem
parameters:
id: $request.path.id
listItem:
operationId: workbooks.driveItem.GetDriveItem
parameters:
id: $request.path.id
permissions:
operationId: workbooks.driveItem.GetDriveItem
parameters:
id: $request.path.id
thumbnails:
operationId: workbooks.driveItem.GetDriveItem
parameters:
id: $request.path.id
workbook:
operationId: workbooks.driveItem.GetDriveItem
parameters:
id: $request.path.id
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- workbooks.driveItem
summary: Update entity in workbooks
operationId: workbooks.driveItem.UpdateDriveItem
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- workbooks.driveItem
summary: Delete entity from workbooks
operationId: workbooks.driveItem.DeleteDriveItem
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: driveItem
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/workbooks({id})/microsoft.graph.delta(token={token})':
get:
tags:
- workbooks.Functions
summary: Invoke function delta
operationId: workbooks.driveItem.delta.722655a427602f57c8636c75
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: driveItem
- name: token
in: path
required: true
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.driveItem'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/workbooks({id})/microsoft.graph.delta()'
'/workbooks({id})/microsoft.graph.delta()':
get:
tags:
- workbooks.Functions
summary: Invoke function delta
operationId: workbooks.driveItem.delta.8fda216f08e1eb50d1a3787b
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: driveItem
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.driveItem'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/workbooks({id})/microsoft.graph.delta(token={token})'
'/workbooks({id})/microsoft.graph.search(q={q})':
get:
tags:
- workbooks.Functions
summary: Invoke function search
operationId: workbooks.driveItem.search.15e9ccdaa36cf21169027b47
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: driveItem
- name: q
in: path
required: true
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.driveItem'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/workbooks({id})/microsoft.graph.copy':
post:
tags:
- workbooks.Actions
summary: Invoke action copy
operationId: workbooks.driveItem.copy
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
name:
type: string
nullable: true
parentReference:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemReference'
nullable: true
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/workbooks({id})/microsoft.graph.createLink':
post:
tags:
- workbooks.Actions
summary: Invoke action createLink
operationId: workbooks.driveItem.createLink
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
type:
type: string
scope:
type: string
nullable: true
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/workbooks({id})/microsoft.graph.createUploadSession':
post:
tags:
- workbooks.Actions
summary: Invoke action createUploadSession
operationId: workbooks.driveItem.createUploadSession
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
item:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.driveItemUploadableProperties'
nullable: true
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/workbooks({id})/microsoft.graph.invite':
post:
tags:
- workbooks.Actions
summary: Invoke action invite
operationId: workbooks.driveItem.invite
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
requireSignIn:
type: boolean
default: false
nullable: true
roles:
type: array
items:
type: string
nullable: true
sendInvitation:
type: boolean
default: false
nullable: true
message:
type: string
nullable: true
recipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveRecipient'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/subscriptions:
get:
tags:
- subscriptions.subscription
summary: Get entities from subscriptions
operationId: subscriptions.subscription.ListSubscription
parameters:
- $ref: '#/components/parameters/search'
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- resource
- changeType
- clientState
- notificationUrl
- expirationDateTime
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of subscription
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subscription'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- subscriptions.subscription
summary: Add new entity to subscriptions
operationId: subscriptions.subscription.CreateSubscription
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.subscription'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.subscription'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/subscriptions({id})':
get:
tags:
- subscriptions.subscription
summary: Get entity from subscriptions by key
operationId: subscriptions.subscription.GetSubscription
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: subscription
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- resource
- changeType
- clientState
- notificationUrl
- expirationDateTime
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.subscription'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- subscriptions.subscription
summary: Update entity in subscriptions
operationId: subscriptions.subscription.UpdateSubscription
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: subscription
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.subscription'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- subscriptions.subscription
summary: Delete entity from subscriptions
operationId: subscriptions.subscription.DeleteSubscription
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: subscription
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/invitations:
get:
tags:
- invitations.invitation
summary: Get entities from invitations
operationId: invitations.invitation.ListInvitation
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
schema:
uniqueItems: true
type: array
items:
enum:
- id
- id desc
- invitedUserDisplayName
- invitedUserDisplayName desc
- invitedUserType
- invitedUserType desc
- invitedUserEmailAddress
- invitedUserEmailAddress desc
- invitedUserMessageInfo
- invitedUserMessageInfo desc
- sendInvitationMessage
- sendInvitationMessage desc
- inviteRedirectUrl
- inviteRedirectUrl desc
- inviteRedeemUrl
- inviteRedeemUrl desc
- status
- status desc
type: string
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- invitedUserDisplayName
- invitedUserType
- invitedUserEmailAddress
- invitedUserMessageInfo
- sendInvitationMessage
- inviteRedirectUrl
- inviteRedeemUrl
- status
- invitedUser
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
- invitedUser
type: string
responses:
'200':
description: Retrieved entities
content:
application/json:
schema:
title: Collection of invitation
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.invitation'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
post:
tags:
- invitations.invitation
summary: Add new entity to invitations
operationId: invitations.invitation.CreateInvitation
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.invitation'
required: true
responses:
'201':
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.invitation'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/invitations({id})':
get:
tags:
- invitations.invitation
summary: Get entity from invitations by key
operationId: invitations.invitation.GetInvitation
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: invitation
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- invitedUserDisplayName
- invitedUserType
- invitedUserEmailAddress
- invitedUserMessageInfo
- sendInvitationMessage
- inviteRedirectUrl
- inviteRedeemUrl
- status
- invitedUser
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
- invitedUser
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.invitation'
links:
invitedUser:
operationId: invitations.invitation.GetInvitation
parameters:
id: $request.path.id
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- invitations.invitation
summary: Update entity in invitations
operationId: invitations.invitation.UpdateInvitation
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: invitation
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.invitation'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- invitations.invitation
summary: Delete entity from invitations
operationId: invitations.invitation.DeleteInvitation
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
x-ms-docs-key-type: invitation
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/me:
get:
tags:
- me.user
summary: Get me
operationId: me.user.GetUser
parameters:
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- accountEnabled
- assignedLicenses
- assignedPlans
- businessPhones
- city
- companyName
- country
- department
- displayName
- givenName
- imAddresses
- jobTitle
- mail
- mailNickname
- mobilePhone
- onPremisesImmutableId
- onPremisesLastSyncDateTime
- onPremisesSecurityIdentifier
- onPremisesSyncEnabled
- passwordPolicies
- passwordProfile
- officeLocation
- postalCode
- preferredLanguage
- provisionedPlans
- proxyAddresses
- state
- streetAddress
- surname
- usageLocation
- userPrincipalName
- userType
- mailboxSettings
- aboutMe
- birthday
- hireDate
- interests
- mySite
- pastProjects
- preferredName
- responsibilities
- schools
- skills
- ownedDevices
- registeredDevices
- manager
- directReports
- memberOf
- createdObjects
- ownedObjects
- licenseDetails
- extensions
- messages
- mailFolders
- calendar
- calendars
- calendarGroups
- calendarView
- events
- people
- contacts
- contactFolders
- inferenceClassification
- photo
- photos
- drive
- drives
- planner
- onenote
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- me.user
summary: Update me
operationId: me.user.UpdateUser
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/me/microsoft.graph.assignLicense:
post:
tags:
- me.Actions
summary: Invoke action assignLicense
operationId: me.user.assignLicense
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
addLicenses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedLicense'
removeLicenses:
type: array
items:
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
format: uuid
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/me/microsoft.graph.changePassword:
post:
tags:
- me.Actions
summary: Invoke action changePassword
operationId: me.user.changePassword
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
currentPassword:
type: string
nullable: true
newPassword:
type: string
nullable: true
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/me/microsoft.graph.sendMail:
post:
tags:
- me.Actions
summary: Invoke action sendMail
operationId: me.user.sendMail
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
$ref: '#/components/schemas/microsoft.graph.message'
SaveToSentItems:
type: boolean
default: false
nullable: true
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/me/microsoft.graph.findMeetingTimes:
post:
tags:
- me.Actions
summary: Invoke action findMeetingTimes
operationId: me.user.findMeetingTimes
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Attendees:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.attendeeBase'
nullable: true
LocationConstraint:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.locationConstraint'
nullable: true
TimeConstraint:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeConstraint'
nullable: true
MeetingDuration:
pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
type: string
format: duration
nullable: true
MaxCandidates:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
IsOrganizerOptional:
type: boolean
default: false
nullable: true
ReturnSuggestionReasons:
type: boolean
default: false
nullable: true
MinimumAttendeePercentage:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
nullable: true
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/me/microsoft.graph.reminderView(StartDateTime={StartDateTime},EndDateTime={EndDateTime})':
get:
tags:
- me.Functions
summary: Invoke function reminderView
operationId: me.user.reminderView.5affd064fe7df3ca87c7f95a
parameters:
- name: StartDateTime
in: path
required: true
schema:
type: string
- name: EndDateTime
in: path
required: true
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.reminder'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
/drive:
get:
tags:
- drive.drive
summary: Get drive
operationId: drive.drive.GetDrive
parameters:
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- createdBy
- createdDateTime
- description
- eTag
- lastModifiedBy
- lastModifiedDateTime
- name
- parentReference
- webUrl
- driveType
- owner
- quota
- sharePointIds
- system
- createdByUser
- lastModifiedByUser
- items
- list
- root
- special
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
- createdByUser
- lastModifiedByUser
- items
- list
- root
- special
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.drive'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- drive.drive
summary: Update drive
operationId: drive.drive.UpdateDrive
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.drive'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/drive/microsoft.graph.recent():
get:
tags:
- drive.Functions
summary: Invoke function recent
operationId: drive.drive.recent.d3f031c1d9c48074285bfbc7
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.driveItem'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/drive/microsoft.graph.search(q={q})':
get:
tags:
- drive.Functions
summary: Invoke function search
operationId: drive.drive.search.15e9ccdaa36cf21169027b47
parameters:
- name: q
in: path
required: true
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.driveItem'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
/drive/microsoft.graph.sharedWithMe():
get:
tags:
- drive.Functions
summary: Invoke function sharedWithMe
operationId: drive.drive.sharedWithMe.2f10bc98d2c4ee31f6daa2c7
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.driveItem'
nullable: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
/planner:
get:
tags:
- planner.planner
summary: Get planner
operationId: planner.planner.GetPlanner
parameters:
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
- tasks
- plans
- buckets
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
- tasks
- plans
- buckets
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.planner'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- planner.planner
summary: Update planner
operationId: planner.planner.UpdatePlanner
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.planner'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/reports:
get:
tags:
- reports.reportRoot
summary: Get reports
operationId: reports.reportRoot.GetReportRoot
parameters:
- name: $select
in: query
description: Select properties to be returned
schema:
uniqueItems: true
type: array
items:
enum:
- id
type: string
- name: $expand
in: query
description: Expand related entities
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
type: string
responses:
'200':
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.reportRoot'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- reports.reportRoot
summary: Update reports
operationId: reports.reportRoot.UpdateReportRoot
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.reportRoot'
required: true
responses:
'204':
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/reports/microsoft.graph.getOffice365ActivationsUserDetail():
get:
tags:
- reports.Functions
summary: Invoke function getOffice365ActivationsUserDetail
operationId: reports.reportRoot.getOffice365ActivationsUserDetail.13c71eed2c1809c4ef046862
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
/reports/microsoft.graph.getOffice365ActivationCounts():
get:
tags:
- reports.Functions
summary: Invoke function getOffice365ActivationCounts
operationId: reports.reportRoot.getOffice365ActivationCounts.70c119abc0af47b59bcd7567
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
/reports/microsoft.graph.getOffice365ActivationsUserCounts():
get:
tags:
- reports.Functions
summary: Invoke function getOffice365ActivationsUserCounts
operationId: reports.reportRoot.getOffice365ActivationsUserCounts.027ddeb4739542e024ac5c69
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getOffice365ActiveUserDetail(date={date})':
get:
tags:
- reports.Functions
summary: Invoke function getOffice365ActiveUserDetail
operationId: reports.reportRoot.getOffice365ActiveUserDetail.b4ad29d72e04cb5f928d3302
parameters:
- name: date
in: path
required: true
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
format: date
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getOffice365ActiveUserDetail(period={period})'
'/reports/microsoft.graph.getOffice365ActiveUserDetail(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getOffice365ActiveUserDetail
operationId: reports.reportRoot.getOffice365ActiveUserDetail.3c45b672c9211380cbb93aaf
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getOffice365ActiveUserDetail(date={date})'
'/reports/microsoft.graph.getOffice365ServicesUserCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getOffice365ServicesUserCounts
operationId: reports.reportRoot.getOffice365ServicesUserCounts.b83f115e25e31b7769f7053c
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getOffice365ActiveUserCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getOffice365ActiveUserCounts
operationId: reports.reportRoot.getOffice365ActiveUserCounts.33a5266df147ae12534c7ac0
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getOffice365GroupsActivityDetail(date={date})':
get:
tags:
- reports.Functions
summary: Invoke function getOffice365GroupsActivityDetail
operationId: reports.reportRoot.getOffice365GroupsActivityDetail.584102add469342246dea4a6
parameters:
- name: date
in: path
required: true
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
format: date
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getOffice365GroupsActivityDetail(period={period})'
'/reports/microsoft.graph.getOffice365GroupsActivityDetail(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getOffice365GroupsActivityDetail
operationId: reports.reportRoot.getOffice365GroupsActivityDetail.314f5e2cd90e9f0e27e87d05
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getOffice365GroupsActivityDetail(date={date})'
'/reports/microsoft.graph.getOffice365GroupsActivityCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getOffice365GroupsActivityCounts
operationId: reports.reportRoot.getOffice365GroupsActivityCounts.949c7d25b084ce1883183854
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getOffice365GroupsActivityGroupCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getOffice365GroupsActivityGroupCounts
operationId: reports.reportRoot.getOffice365GroupsActivityGroupCounts.711b8131adbf47b5b33fbf20
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getOffice365GroupsActivityStorage(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getOffice365GroupsActivityStorage
operationId: reports.reportRoot.getOffice365GroupsActivityStorage.40c5f2e237d06d8caa408950
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getOffice365GroupsActivityFileCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getOffice365GroupsActivityFileCounts
operationId: reports.reportRoot.getOffice365GroupsActivityFileCounts.c7ec8e7db234bd53f643c23e
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getEmailActivityUserDetail(date={date})':
get:
tags:
- reports.Functions
summary: Invoke function getEmailActivityUserDetail
operationId: reports.reportRoot.getEmailActivityUserDetail.fd73d2a28e6cb07ad3f037c2
parameters:
- name: date
in: path
required: true
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
format: date
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getEmailActivityUserDetail(period={period})'
'/reports/microsoft.graph.getEmailActivityUserDetail(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getEmailActivityUserDetail
operationId: reports.reportRoot.getEmailActivityUserDetail.49d7dec39a67e89e69979278
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getEmailActivityUserDetail(date={date})'
'/reports/microsoft.graph.getEmailActivityCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getEmailActivityCounts
operationId: reports.reportRoot.getEmailActivityCounts.5ff9c3ff1edf7e31002a9ba5
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getEmailActivityUserCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getEmailActivityUserCounts
operationId: reports.reportRoot.getEmailActivityUserCounts.0d71442762927e611f745678
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getEmailAppUsageUserDetail(date={date})':
get:
tags:
- reports.Functions
summary: Invoke function getEmailAppUsageUserDetail
operationId: reports.reportRoot.getEmailAppUsageUserDetail.971eabe8d8d80ac30d7a13f8
parameters:
- name: date
in: path
required: true
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
format: date
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getEmailAppUsageUserDetail(period={period})'
'/reports/microsoft.graph.getEmailAppUsageUserDetail(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getEmailAppUsageUserDetail
operationId: reports.reportRoot.getEmailAppUsageUserDetail.c8ff19ea83f55656ec0519ad
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getEmailAppUsageUserDetail(date={date})'
'/reports/microsoft.graph.getEmailAppUsageAppsUserCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getEmailAppUsageAppsUserCounts
operationId: reports.reportRoot.getEmailAppUsageAppsUserCounts.12b3d5bb1f7ab643ed649ec8
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getEmailAppUsageUserCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getEmailAppUsageUserCounts
operationId: reports.reportRoot.getEmailAppUsageUserCounts.5ccd568244908718f4056c76
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getEmailAppUsageVersionsUserCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getEmailAppUsageVersionsUserCounts
operationId: reports.reportRoot.getEmailAppUsageVersionsUserCounts.477fca84e1a25a2216ad99b4
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getMailboxUsageDetail(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getMailboxUsageDetail
operationId: reports.reportRoot.getMailboxUsageDetail.f1007e9438b51215a1685933
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getMailboxUsageMailboxCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getMailboxUsageMailboxCounts
operationId: reports.reportRoot.getMailboxUsageMailboxCounts.59e9ffd250a038d8e4a7b378
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getMailboxUsageQuotaStatusMailboxCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getMailboxUsageQuotaStatusMailboxCounts
operationId: reports.reportRoot.getMailboxUsageQuotaStatusMailboxCounts.78e058c80c05eb220ac6727b
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getMailboxUsageStorage(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getMailboxUsageStorage
operationId: reports.reportRoot.getMailboxUsageStorage.e7208185d7f600c70353fae3
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getOneDriveActivityUserDetail(date={date})':
get:
tags:
- reports.Functions
summary: Invoke function getOneDriveActivityUserDetail
operationId: reports.reportRoot.getOneDriveActivityUserDetail.0238a15d6c6ea1fdb9760409
parameters:
- name: date
in: path
required: true
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
format: date
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getOneDriveActivityUserDetail(period={period})'
'/reports/microsoft.graph.getOneDriveActivityUserDetail(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getOneDriveActivityUserDetail
operationId: reports.reportRoot.getOneDriveActivityUserDetail.2cbbd80c09870da45712e816
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getOneDriveActivityUserDetail(date={date})'
'/reports/microsoft.graph.getOneDriveActivityUserCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getOneDriveActivityUserCounts
operationId: reports.reportRoot.getOneDriveActivityUserCounts.79a3a31381ccd6da60da969e
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getOneDriveActivityFileCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getOneDriveActivityFileCounts
operationId: reports.reportRoot.getOneDriveActivityFileCounts.53a4be96636f99c5f73d6931
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getOneDriveUsageAccountDetail(date={date})':
get:
tags:
- reports.Functions
summary: Invoke function getOneDriveUsageAccountDetail
operationId: reports.reportRoot.getOneDriveUsageAccountDetail.021e1e7fd462af6aa0009b62
parameters:
- name: date
in: path
required: true
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
format: date
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getOneDriveUsageAccountDetail(period={period})'
'/reports/microsoft.graph.getOneDriveUsageAccountDetail(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getOneDriveUsageAccountDetail
operationId: reports.reportRoot.getOneDriveUsageAccountDetail.68875840255f867581b26939
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getOneDriveUsageAccountDetail(date={date})'
'/reports/microsoft.graph.getOneDriveUsageAccountCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getOneDriveUsageAccountCounts
operationId: reports.reportRoot.getOneDriveUsageAccountCounts.a3ab3d55a57df63702676685
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getOneDriveUsageFileCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getOneDriveUsageFileCounts
operationId: reports.reportRoot.getOneDriveUsageFileCounts.5d09834b79b5acb6177db2a7
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getOneDriveUsageStorage(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getOneDriveUsageStorage
operationId: reports.reportRoot.getOneDriveUsageStorage.6c49a3945e7d02266faa0d2c
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getSharePointActivityUserDetail(date={date})':
get:
tags:
- reports.Functions
summary: Invoke function getSharePointActivityUserDetail
operationId: reports.reportRoot.getSharePointActivityUserDetail.482d6fd117a75a1f6fba584e
parameters:
- name: date
in: path
required: true
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
format: date
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getSharePointActivityUserDetail(period={period})'
'/reports/microsoft.graph.getSharePointActivityUserDetail(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSharePointActivityUserDetail
operationId: reports.reportRoot.getSharePointActivityUserDetail.e8387fedf2444768ad8b3b97
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getSharePointActivityUserDetail(date={date})'
'/reports/microsoft.graph.getSharePointActivityFileCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSharePointActivityFileCounts
operationId: reports.reportRoot.getSharePointActivityFileCounts.bbf804882b0fbe65048aac08
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getSharePointActivityUserCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSharePointActivityUserCounts
operationId: reports.reportRoot.getSharePointActivityUserCounts.2adc15c788d3eb009f33f5f7
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getSharePointActivityPages(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSharePointActivityPages
operationId: reports.reportRoot.getSharePointActivityPages.f887ef78417faeeec6dc8e6a
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getSharePointSiteUsageDetail(date={date})':
get:
tags:
- reports.Functions
summary: Invoke function getSharePointSiteUsageDetail
operationId: reports.reportRoot.getSharePointSiteUsageDetail.06e5704078f61c65140119cb
parameters:
- name: date
in: path
required: true
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
format: date
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getSharePointSiteUsageDetail(period={period})'
'/reports/microsoft.graph.getSharePointSiteUsageDetail(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSharePointSiteUsageDetail
operationId: reports.reportRoot.getSharePointSiteUsageDetail.208fe1ab10faafeb543ab705
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getSharePointSiteUsageDetail(date={date})'
'/reports/microsoft.graph.getSharePointSiteUsageFileCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSharePointSiteUsageFileCounts
operationId: reports.reportRoot.getSharePointSiteUsageFileCounts.155ba9ba076d3f316ad30a0a
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getSharePointSiteUsageSiteCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSharePointSiteUsageSiteCounts
operationId: reports.reportRoot.getSharePointSiteUsageSiteCounts.c07df42031bee73730772e57
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getSharePointSiteUsageStorage(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSharePointSiteUsageStorage
operationId: reports.reportRoot.getSharePointSiteUsageStorage.9f73ac820d2bf382be19fe49
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getSharePointSiteUsagePages(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSharePointSiteUsagePages
operationId: reports.reportRoot.getSharePointSiteUsagePages.988cbbc218485558a0b934b3
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getSkypeForBusinessActivityUserDetail(date={date})':
get:
tags:
- reports.Functions
summary: Invoke function getSkypeForBusinessActivityUserDetail
operationId: reports.reportRoot.getSkypeForBusinessActivityUserDetail.23b7c50a041d2e8efb340e29
parameters:
- name: date
in: path
required: true
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
format: date
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getSkypeForBusinessActivityUserDetail(period={period})'
'/reports/microsoft.graph.getSkypeForBusinessActivityUserDetail(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSkypeForBusinessActivityUserDetail
operationId: reports.reportRoot.getSkypeForBusinessActivityUserDetail.b224074b80c404bd6f360ae6
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getSkypeForBusinessActivityUserDetail(date={date})'
'/reports/microsoft.graph.getSkypeForBusinessActivityCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSkypeForBusinessActivityCounts
operationId: reports.reportRoot.getSkypeForBusinessActivityCounts.73b877a5582512351a4b5aff
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getSkypeForBusinessActivityUserCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSkypeForBusinessActivityUserCounts
operationId: reports.reportRoot.getSkypeForBusinessActivityUserCounts.9341cc2b78ef779562e1b522
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getSkypeForBusinessPeerToPeerActivityCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSkypeForBusinessPeerToPeerActivityCounts
operationId: reports.reportRoot.getSkypeForBusinessPeerToPeerActivityCounts.b145849bf239fc4acae0116b
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getSkypeForBusinessPeerToPeerActivityUserCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSkypeForBusinessPeerToPeerActivityUserCounts
operationId: reports.reportRoot.getSkypeForBusinessPeerToPeerActivityUserCounts.dff498d2c383219ee7cd2baf
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getSkypeForBusinessPeerToPeerActivityMinuteCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSkypeForBusinessPeerToPeerActivityMinuteCounts
operationId: reports.reportRoot.getSkypeForBusinessPeerToPeerActivityMinuteCounts.9cab2135d898e5b695855b02
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getSkypeForBusinessOrganizerActivityCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSkypeForBusinessOrganizerActivityCounts
operationId: reports.reportRoot.getSkypeForBusinessOrganizerActivityCounts.e47ebc16d0b08668af9b52ad
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getSkypeForBusinessOrganizerActivityUserCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSkypeForBusinessOrganizerActivityUserCounts
operationId: reports.reportRoot.getSkypeForBusinessOrganizerActivityUserCounts.f276d6b31ea5f120a74fee07
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getSkypeForBusinessOrganizerActivityMinuteCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSkypeForBusinessOrganizerActivityMinuteCounts
operationId: reports.reportRoot.getSkypeForBusinessOrganizerActivityMinuteCounts.c25e2d8f12de360c913065a5
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getSkypeForBusinessParticipantActivityCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSkypeForBusinessParticipantActivityCounts
operationId: reports.reportRoot.getSkypeForBusinessParticipantActivityCounts.86f01d23d87a3b2dea6a385e
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getSkypeForBusinessParticipantActivityUserCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSkypeForBusinessParticipantActivityUserCounts
operationId: reports.reportRoot.getSkypeForBusinessParticipantActivityUserCounts.f2f5180b73976b2359805488
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getSkypeForBusinessParticipantActivityMinuteCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSkypeForBusinessParticipantActivityMinuteCounts
operationId: reports.reportRoot.getSkypeForBusinessParticipantActivityMinuteCounts.700bfde176771e61514879f8
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getSkypeForBusinessDeviceUsageUserDetail(date={date})':
get:
tags:
- reports.Functions
summary: Invoke function getSkypeForBusinessDeviceUsageUserDetail
operationId: reports.reportRoot.getSkypeForBusinessDeviceUsageUserDetail.96b5eb20baed695ce1d24c8c
parameters:
- name: date
in: path
required: true
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
format: date
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getSkypeForBusinessDeviceUsageUserDetail(period={period})'
'/reports/microsoft.graph.getSkypeForBusinessDeviceUsageUserDetail(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSkypeForBusinessDeviceUsageUserDetail
operationId: reports.reportRoot.getSkypeForBusinessDeviceUsageUserDetail.c0a05adc8b18000011f482cb
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getSkypeForBusinessDeviceUsageUserDetail(date={date})'
'/reports/microsoft.graph.getSkypeForBusinessDeviceUsageDistributionUserCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSkypeForBusinessDeviceUsageDistributionUserCounts
operationId: reports.reportRoot.getSkypeForBusinessDeviceUsageDistributionUserCounts.a578976a66bed8f5e995e319
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getSkypeForBusinessDeviceUsageUserCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getSkypeForBusinessDeviceUsageUserCounts
operationId: reports.reportRoot.getSkypeForBusinessDeviceUsageUserCounts.57d56a2163ef120cdc2490b8
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getYammerActivityUserDetail(date={date})':
get:
tags:
- reports.Functions
summary: Invoke function getYammerActivityUserDetail
operationId: reports.reportRoot.getYammerActivityUserDetail.09fc912d428fb73b604c6bf7
parameters:
- name: date
in: path
required: true
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
format: date
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getYammerActivityUserDetail(period={period})'
'/reports/microsoft.graph.getYammerActivityUserDetail(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getYammerActivityUserDetail
operationId: reports.reportRoot.getYammerActivityUserDetail.c80d2e9473101ab2eb597bc5
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getYammerActivityUserDetail(date={date})'
'/reports/microsoft.graph.getYammerActivityCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getYammerActivityCounts
operationId: reports.reportRoot.getYammerActivityCounts.d6da704787ac396a023345cd
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getYammerActivityUserCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getYammerActivityUserCounts
operationId: reports.reportRoot.getYammerActivityUserCounts.51c76ce0bef4c6547701ac1f
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getYammerDeviceUsageUserDetail(date={date})':
get:
tags:
- reports.Functions
summary: Invoke function getYammerDeviceUsageUserDetail
operationId: reports.reportRoot.getYammerDeviceUsageUserDetail.d2c5f42c37f4faab60034e3d
parameters:
- name: date
in: path
required: true
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
format: date
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getYammerDeviceUsageUserDetail(period={period})'
'/reports/microsoft.graph.getYammerDeviceUsageUserDetail(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getYammerDeviceUsageUserDetail
operationId: reports.reportRoot.getYammerDeviceUsageUserDetail.72d057f2a4741325f5a9bdbc
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getYammerDeviceUsageUserDetail(date={date})'
'/reports/microsoft.graph.getYammerDeviceUsageDistributionUserCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getYammerDeviceUsageDistributionUserCounts
operationId: reports.reportRoot.getYammerDeviceUsageDistributionUserCounts.1fe0d5a9b7ddca849c32753d
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getYammerDeviceUsageUserCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getYammerDeviceUsageUserCounts
operationId: reports.reportRoot.getYammerDeviceUsageUserCounts.06cad47a723e231d41efc932
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getYammerGroupsActivityDetail(date={date})':
get:
tags:
- reports.Functions
summary: Invoke function getYammerGroupsActivityDetail
operationId: reports.reportRoot.getYammerGroupsActivityDetail.0ba8882e1710d81f4c46f697
parameters:
- name: date
in: path
required: true
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
format: date
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getYammerGroupsActivityDetail(period={period})'
'/reports/microsoft.graph.getYammerGroupsActivityDetail(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getYammerGroupsActivityDetail
operationId: reports.reportRoot.getYammerGroupsActivityDetail.9981731ae22e2449a3aaafb7
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- '/reports/microsoft.graph.getYammerGroupsActivityDetail(date={date})'
'/reports/microsoft.graph.getYammerGroupsActivityGroupCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getYammerGroupsActivityGroupCounts
operationId: reports.reportRoot.getYammerGroupsActivityGroupCounts.e10c91249509b79e861661dc
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/reports/microsoft.graph.getYammerGroupsActivityCounts(period={period})':
get:
tags:
- reports.Functions
summary: Invoke function getYammerGroupsActivityCounts
operationId: reports.reportRoot.getYammerGroupsActivityCounts.02c28af8a9f2b5cd66e41712
parameters:
- name: period
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.report'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
components:
schemas:
microsoft.graph.entity:
title: entity
type: object
properties:
id:
type: string
example:
id: String (identifier)
microsoft.graph.directoryObject:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: directoryObject
type: object
example:
id: String (identifier)
microsoft.graph.device:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: device
type: object
properties:
accountEnabled:
type: boolean
nullable: true
alternativeSecurityIds:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.alternativeSecurityId'
approximateLastSignInDateTime:
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
format: date-time
nullable: true
deviceId:
type: string
nullable: true
deviceMetadata:
type: string
nullable: true
deviceVersion:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
displayName:
type: string
nullable: true
isCompliant:
type: boolean
nullable: true
isManaged:
type: boolean
nullable: true
onPremisesLastSyncDateTime:
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
format: date-time
nullable: true
onPremisesSyncEnabled:
type: boolean
nullable: true
operatingSystem:
type: string
nullable: true
operatingSystemVersion:
type: string
nullable: true
physicalIds:
type: array
items:
type: string
trustType:
type: string
nullable: true
registeredOwners:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
registeredUsers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
example:
id: String (identifier)
accountEnabled: true
alternativeSecurityIds:
- '@odata.type': microsoft.graph.alternativeSecurityId
approximateLastSignInDateTime: DateTimeOffset (timestamp)
deviceId: String
deviceMetadata: String
deviceVersion: Int32
displayName: String
isCompliant: true
isManaged: true
onPremisesLastSyncDateTime: DateTimeOffset (timestamp)
onPremisesSyncEnabled: true
operatingSystem: String
operatingSystemVersion: String
physicalIds:
- String
trustType: String
registeredOwners:
- '@odata.type': microsoft.graph.directoryObject
registeredUsers:
- '@odata.type': microsoft.graph.directoryObject
extensions:
- '@odata.type': microsoft.graph.extension
microsoft.graph.alternativeSecurityId:
title: alternativeSecurityId
type: object
properties:
type:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
identityProvider:
type: string
nullable: true
key:
type: string
format: base64url
nullable: true
example:
type: Int32
identityProvider: String
key: Binary
microsoft.graph.extension:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: extension
type: object
example:
id: String (identifier)
microsoft.graph.directoryRole:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: directoryRole
type: object
properties:
description:
type: string
nullable: true
displayName:
type: string
nullable: true
roleTemplateId:
type: string
nullable: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
example:
id: String (identifier)
description: String
displayName: String
roleTemplateId: String
members:
- '@odata.type': microsoft.graph.directoryObject
microsoft.graph.directoryRoleTemplate:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: directoryRoleTemplate
type: object
properties:
description:
type: string
nullable: true
displayName:
type: string
nullable: true
example:
id: String (identifier)
description: String
displayName: String
microsoft.graph.domain:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: domain
type: object
properties:
authenticationType:
type: string
availabilityStatus:
type: string
nullable: true
isAdminManaged:
type: boolean
isDefault:
type: boolean
isInitial:
type: boolean
isRoot:
type: boolean
isVerified:
type: boolean
supportedServices:
type: array
items:
type: string
state:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.domainState'
nullable: true
serviceConfigurationRecords:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
verificationDnsRecords:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
domainNameReferences:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
example:
id: String (identifier)
authenticationType: String
availabilityStatus: String
isAdminManaged: true
isDefault: true
isInitial: true
isRoot: true
isVerified: true
supportedServices:
- String
state:
'@odata.type': microsoft.graph.domainState
serviceConfigurationRecords:
- '@odata.type': microsoft.graph.domainDnsRecord
verificationDnsRecords:
- '@odata.type': microsoft.graph.domainDnsRecord
domainNameReferences:
- '@odata.type': microsoft.graph.directoryObject
microsoft.graph.domainState:
title: domainState
type: object
properties:
status:
type: string
nullable: true
operation:
type: string
nullable: true
lastActionDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
nullable: true
example:
status: String
operation: String
lastActionDateTime: DateTimeOffset (timestamp)
microsoft.graph.domainDnsRecord:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: domainDnsRecord
type: object
properties:
isOptional:
type: boolean
label:
type: string
recordType:
type: string
nullable: true
supportedService:
type: string
ttl:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
example:
id: String (identifier)
isOptional: true
label: String
recordType: String
supportedService: String
ttl: Int32
microsoft.graph.domainDnsCnameRecord:
allOf:
- $ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
- title: domainDnsCnameRecord
type: object
properties:
canonicalName:
type: string
nullable: true
example:
id: String (identifier)
isOptional: true
label: String
recordType: String
supportedService: String
ttl: Int32
canonicalName: String
microsoft.graph.domainDnsMxRecord:
allOf:
- $ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
- title: domainDnsMxRecord
type: object
properties:
mailExchange:
type: string
preference:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
example:
id: String (identifier)
isOptional: true
label: String
recordType: String
supportedService: String
ttl: Int32
mailExchange: String
preference: Int32
microsoft.graph.domainDnsSrvRecord:
allOf:
- $ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
- title: domainDnsSrvRecord
type: object
properties:
nameTarget:
type: string
nullable: true
port:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
priority:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
protocol:
type: string
nullable: true
service:
type: string
nullable: true
weight:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
example:
id: String (identifier)
isOptional: true
label: String
recordType: String
supportedService: String
ttl: Int32
nameTarget: String
port: Int32
priority: Int32
protocol: String
service: String
weight: Int32
microsoft.graph.domainDnsTxtRecord:
allOf:
- $ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
- title: domainDnsTxtRecord
type: object
properties:
text:
type: string
example:
id: String (identifier)
isOptional: true
label: String
recordType: String
supportedService: String
ttl: Int32
text: String
microsoft.graph.domainDnsUnavailableRecord:
allOf:
- $ref: '#/components/schemas/microsoft.graph.domainDnsRecord'
- title: domainDnsUnavailableRecord
type: object
properties:
description:
type: string
nullable: true
example:
id: String (identifier)
isOptional: true
label: String
recordType: String
supportedService: String
ttl: Int32
description: String
microsoft.graph.licenseDetails:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: licenseDetails
type: object
properties:
servicePlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.servicePlanInfo'
skuId:
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
format: uuid
nullable: true
skuPartNumber:
type: string
nullable: true
example:
id: String (identifier)
servicePlans:
- '@odata.type': microsoft.graph.servicePlanInfo
skuId: Guid
skuPartNumber: String
microsoft.graph.servicePlanInfo:
title: servicePlanInfo
type: object
properties:
servicePlanId:
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
format: uuid
nullable: true
servicePlanName:
type: string
nullable: true
provisioningStatus:
type: string
nullable: true
appliesTo:
type: string
nullable: true
example:
servicePlanId: Guid
servicePlanName: String
provisioningStatus: String
appliesTo: String
microsoft.graph.group:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: group
type: object
properties:
classification:
type: string
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
format: date-time
nullable: true
description:
type: string
nullable: true
displayName:
type: string
nullable: true
groupTypes:
type: array
items:
type: string
mail:
type: string
nullable: true
mailEnabled:
type: boolean
nullable: true
mailNickname:
type: string
nullable: true
onPremisesLastSyncDateTime:
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
format: date-time
nullable: true
onPremisesSecurityIdentifier:
type: string
nullable: true
onPremisesSyncEnabled:
type: boolean
nullable: true
proxyAddresses:
type: array
items:
type: string
renewedDateTime:
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
format: date-time
nullable: true
securityEnabled:
type: boolean
nullable: true
visibility:
type: string
nullable: true
allowExternalSenders:
type: boolean
nullable: true
autoSubscribeNewMembers:
type: boolean
nullable: true
isSubscribedByMail:
type: boolean
nullable: true
unseenCount:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
memberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
createdOnBehalfOf:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
nullable: true
owners:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
settings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.groupSetting'
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
threads:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationThread'
calendar:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.calendar'
nullable: true
calendarView:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
events:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
conversations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversation'
photo:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.profilePhoto'
nullable: true
photos:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
acceptedSenders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
rejectedSenders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
drive:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.drive'
nullable: true
drives:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.drive'
sites:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
planner:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerGroup'
nullable: true
onenote:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenote'
nullable: true
example:
id: String (identifier)
classification: String
createdDateTime: DateTimeOffset (timestamp)
description: String
displayName: String
groupTypes:
- String
mail: String
mailEnabled: true
mailNickname: String
onPremisesLastSyncDateTime: DateTimeOffset (timestamp)
onPremisesSecurityIdentifier: String
onPremisesSyncEnabled: true
proxyAddresses:
- String
renewedDateTime: DateTimeOffset (timestamp)
securityEnabled: true
visibility: String
allowExternalSenders: true
autoSubscribeNewMembers: true
isSubscribedByMail: true
unseenCount: Int32
members:
- '@odata.type': microsoft.graph.directoryObject
memberOf:
- '@odata.type': microsoft.graph.directoryObject
createdOnBehalfOf:
'@odata.type': microsoft.graph.directoryObject
owners:
- '@odata.type': microsoft.graph.directoryObject
settings:
- '@odata.type': microsoft.graph.groupSetting
extensions:
- '@odata.type': microsoft.graph.extension
threads:
- '@odata.type': microsoft.graph.conversationThread
calendar:
'@odata.type': microsoft.graph.calendar
calendarView:
- '@odata.type': microsoft.graph.event
events:
- '@odata.type': microsoft.graph.event
conversations:
- '@odata.type': microsoft.graph.conversation
photo:
'@odata.type': microsoft.graph.profilePhoto
photos:
- '@odata.type': microsoft.graph.profilePhoto
acceptedSenders:
- '@odata.type': microsoft.graph.directoryObject
rejectedSenders:
- '@odata.type': microsoft.graph.directoryObject
drive:
'@odata.type': microsoft.graph.drive
drives:
- '@odata.type': microsoft.graph.drive
sites:
- '@odata.type': microsoft.graph.site
planner:
'@odata.type': microsoft.graph.plannerGroup
onenote:
'@odata.type': microsoft.graph.onenote
microsoft.graph.groupSetting:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: groupSetting
type: object
properties:
displayName:
type: string
nullable: true
templateId:
type: string
nullable: true
values:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.settingValue'
example:
id: String (identifier)
displayName: String
templateId: String
values:
- '@odata.type': microsoft.graph.settingValue
microsoft.graph.conversationThread:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: conversationThread
type: object
properties:
toRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
topic:
type: string
hasAttachments:
type: boolean
lastDeliveredDateTime:
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
format: date-time
uniqueSenders:
type: array
items:
type: string
ccRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
preview:
type: string
isLocked:
type: boolean
posts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.post'
example:
id: String (identifier)
toRecipients:
- '@odata.type': microsoft.graph.recipient
topic: String
hasAttachments: true
lastDeliveredDateTime: DateTimeOffset (timestamp)
uniqueSenders:
- String
ccRecipients:
- '@odata.type': microsoft.graph.recipient
preview: String
isLocked: true
posts:
- '@odata.type': microsoft.graph.post
microsoft.graph.calendar:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: calendar
type: object
properties:
name:
type: string
nullable: true
color:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.calendarColor'
nullable: true
changeKey:
type: string
nullable: true
canShare:
type: boolean
nullable: true
canViewPrivateItems:
type: boolean
nullable: true
canEdit:
type: boolean
nullable: true
owner:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.emailAddress'
nullable: true
events:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
calendarView:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
example:
id: String (identifier)
name: String
color:
'@odata.type': microsoft.graph.calendarColor
changeKey: String
canShare: true
canViewPrivateItems: true
canEdit: true
owner:
'@odata.type': microsoft.graph.emailAddress
events:
- '@odata.type': microsoft.graph.event
calendarView:
- '@odata.type': microsoft.graph.event
singleValueExtendedProperties:
- '@odata.type': microsoft.graph.singleValueLegacyExtendedProperty
multiValueExtendedProperties:
- '@odata.type': microsoft.graph.multiValueLegacyExtendedProperty
microsoft.graph.outlookItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: outlookItem
type: object
properties:
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
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
format: date-time
nullable: true
changeKey:
type: string
nullable: true
categories:
type: array
items:
type: string
nullable: true
example:
id: String (identifier)
createdDateTime: DateTimeOffset (timestamp)
lastModifiedDateTime: DateTimeOffset (timestamp)
changeKey: String
categories:
- String
microsoft.graph.event:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: event
type: object
properties:
originalStartTimeZone:
type: string
nullable: true
originalEndTimeZone:
type: string
nullable: true
responseStatus:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.responseStatus'
nullable: true
iCalUId:
type: string
nullable: true
reminderMinutesBeforeStart:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
isReminderOn:
type: boolean
nullable: true
hasAttachments:
type: boolean
nullable: true
subject:
type: string
nullable: true
body:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
nullable: true
bodyPreview:
type: string
nullable: true
importance:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.importance'
nullable: true
sensitivity:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sensitivity'
nullable: true
start:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
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
format: date-time
nullable: true
end:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
nullable: true
location:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.location'
nullable: true
isAllDay:
type: boolean
nullable: true
isCancelled:
type: boolean
nullable: true
isOrganizer:
type: boolean
nullable: true
recurrence:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.patternedRecurrence'
nullable: true
responseRequested:
type: boolean
nullable: true
seriesMasterId:
type: string
nullable: true
showAs:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.freeBusyStatus'
nullable: true
type:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.eventType'
nullable: true
attendees:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.attendee'
nullable: true
organizer:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.recipient'
nullable: true
webLink:
type: string
nullable: true
onlineMeetingUrl:
type: string
nullable: true
calendar:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.calendar'
nullable: true
instances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachment'
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
example:
id: String (identifier)
createdDateTime: DateTimeOffset (timestamp)
lastModifiedDateTime: DateTimeOffset (timestamp)
changeKey: String
categories:
- String
originalStartTimeZone: String
originalEndTimeZone: String
responseStatus:
'@odata.type': microsoft.graph.responseStatus
iCalUId: String
reminderMinutesBeforeStart: Int32
isReminderOn: true
hasAttachments: true
subject: String
body:
'@odata.type': microsoft.graph.itemBody
bodyPreview: String
importance:
'@odata.type': microsoft.graph.importance
sensitivity:
'@odata.type': microsoft.graph.sensitivity
start:
'@odata.type': microsoft.graph.dateTimeTimeZone
originalStart: DateTimeOffset (timestamp)
end:
'@odata.type': microsoft.graph.dateTimeTimeZone
location:
'@odata.type': microsoft.graph.location
isAllDay: true
isCancelled: true
isOrganizer: true
recurrence:
'@odata.type': microsoft.graph.patternedRecurrence
responseRequested: true
seriesMasterId: String
showAs:
'@odata.type': microsoft.graph.freeBusyStatus
type:
'@odata.type': microsoft.graph.eventType
attendees:
- '@odata.type': microsoft.graph.attendee
organizer:
'@odata.type': microsoft.graph.recipient
webLink: String
onlineMeetingUrl: String
calendar:
'@odata.type': microsoft.graph.calendar
instances:
- '@odata.type': microsoft.graph.event
extensions:
- '@odata.type': microsoft.graph.extension
attachments:
- '@odata.type': microsoft.graph.attachment
singleValueExtendedProperties:
- '@odata.type': microsoft.graph.singleValueLegacyExtendedProperty
multiValueExtendedProperties:
- '@odata.type': microsoft.graph.multiValueLegacyExtendedProperty
microsoft.graph.conversation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: conversation
type: object
properties:
topic:
type: string
hasAttachments:
type: boolean
lastDeliveredDateTime:
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
format: date-time
uniqueSenders:
type: array
items:
type: string
preview:
type: string
threads:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationThread'
example:
id: String (identifier)
topic: String
hasAttachments: true
lastDeliveredDateTime: DateTimeOffset (timestamp)
uniqueSenders:
- String
preview: String
threads:
- '@odata.type': microsoft.graph.conversationThread
microsoft.graph.profilePhoto:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: profilePhoto
type: object
properties:
height:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
width:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
example:
id: String (identifier)
height: Int32
width: Int32
microsoft.graph.baseItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: baseItem
type: object
properties:
createdBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
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
format: date-time
description:
type: string
nullable: true
eTag:
type: string
nullable: true
lastModifiedBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
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
format: date-time
name:
type: string
nullable: true
parentReference:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemReference'
nullable: true
webUrl:
type: string
nullable: true
createdByUser:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.user'
nullable: true
lastModifiedByUser:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.user'
nullable: true
example:
id: String (identifier)
createdBy:
'@odata.type': microsoft.graph.identitySet
createdDateTime: DateTimeOffset (timestamp)
description: String
eTag: String
lastModifiedBy:
'@odata.type': microsoft.graph.identitySet
lastModifiedDateTime: DateTimeOffset (timestamp)
name: String
parentReference:
'@odata.type': microsoft.graph.itemReference
webUrl: String
createdByUser:
'@odata.type': microsoft.graph.user
lastModifiedByUser:
'@odata.type': microsoft.graph.user
microsoft.graph.drive:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: drive
type: object
properties:
driveType:
type: string
nullable: true
owner:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
nullable: true
quota:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.quota'
nullable: true
sharePointIds:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sharepointIds'
nullable: true
system:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.systemFacet'
nullable: true
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
list:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.list'
nullable: true
root:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.driveItem'
nullable: true
special:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
example:
id: String (identifier)
createdBy:
'@odata.type': microsoft.graph.identitySet
createdDateTime: DateTimeOffset (timestamp)
description: String
eTag: String
lastModifiedBy:
'@odata.type': microsoft.graph.identitySet
lastModifiedDateTime: DateTimeOffset (timestamp)
name: String
parentReference:
'@odata.type': microsoft.graph.itemReference
webUrl: String
createdByUser:
'@odata.type': microsoft.graph.user
lastModifiedByUser:
'@odata.type': microsoft.graph.user
driveType: String
owner:
'@odata.type': microsoft.graph.identitySet
quota:
'@odata.type': microsoft.graph.quota
sharePointIds:
'@odata.type': microsoft.graph.sharepointIds
system:
'@odata.type': microsoft.graph.systemFacet
items:
- '@odata.type': microsoft.graph.driveItem
list:
'@odata.type': microsoft.graph.list
root:
'@odata.type': microsoft.graph.driveItem
special:
- '@odata.type': microsoft.graph.driveItem
microsoft.graph.site:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: site
type: object
properties:
displayName:
type: string
nullable: true
root:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.root'
nullable: true
sharepointIds:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sharepointIds'
nullable: true
siteCollection:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.siteCollection'
nullable: true
columns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
contentTypes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentType'
drive:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.drive'
nullable: true
drives:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.drive'
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.baseItem'
lists:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.list'
sites:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
onenote:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenote'
nullable: true
example:
id: String (identifier)
createdBy:
'@odata.type': microsoft.graph.identitySet
createdDateTime: DateTimeOffset (timestamp)
description: String
eTag: String
lastModifiedBy:
'@odata.type': microsoft.graph.identitySet
lastModifiedDateTime: DateTimeOffset (timestamp)
name: String
parentReference:
'@odata.type': microsoft.graph.itemReference
webUrl: String
createdByUser:
'@odata.type': microsoft.graph.user
lastModifiedByUser:
'@odata.type': microsoft.graph.user
displayName: String
root:
'@odata.type': microsoft.graph.root
sharepointIds:
'@odata.type': microsoft.graph.sharepointIds
siteCollection:
'@odata.type': microsoft.graph.siteCollection
columns:
- '@odata.type': microsoft.graph.columnDefinition
contentTypes:
- '@odata.type': microsoft.graph.contentType
drive:
'@odata.type': microsoft.graph.drive
drives:
- '@odata.type': microsoft.graph.drive
items:
- '@odata.type': microsoft.graph.baseItem
lists:
- '@odata.type': microsoft.graph.list
sites:
- '@odata.type': microsoft.graph.site
onenote:
'@odata.type': microsoft.graph.onenote
microsoft.graph.plannerGroup:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerGroup
type: object
properties:
plans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerPlan'
example:
id: String (identifier)
plans:
- '@odata.type': microsoft.graph.plannerPlan
microsoft.graph.onenote:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: onenote
type: object
properties:
notebooks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.notebook'
sections:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
sectionGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
pages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
resources:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteResource'
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteOperation'
example:
id: String (identifier)
notebooks:
- '@odata.type': microsoft.graph.notebook
sections:
- '@odata.type': microsoft.graph.onenoteSection
sectionGroups:
- '@odata.type': microsoft.graph.sectionGroup
pages:
- '@odata.type': microsoft.graph.onenotePage
resources:
- '@odata.type': microsoft.graph.onenoteResource
operations:
- '@odata.type': microsoft.graph.onenoteOperation
microsoft.graph.contract:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: contract
type: object
properties:
contractType:
type: string
nullable: true
customerId:
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
format: uuid
nullable: true
defaultDomainName:
type: string
nullable: true
displayName:
type: string
nullable: true
example:
id: String (identifier)
contractType: String
customerId: Guid
defaultDomainName: String
displayName: String
microsoft.graph.subscribedSku:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: subscribedSku
type: object
properties:
capabilityStatus:
type: string
nullable: true
consumedUnits:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
prepaidUnits:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.licenseUnitsDetail'
nullable: true
servicePlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.servicePlanInfo'
skuId:
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
format: uuid
nullable: true
skuPartNumber:
type: string
nullable: true
appliesTo:
type: string
nullable: true
example:
id: String (identifier)
capabilityStatus: String
consumedUnits: Int32
prepaidUnits:
'@odata.type': microsoft.graph.licenseUnitsDetail
servicePlans:
- '@odata.type': microsoft.graph.servicePlanInfo
skuId: Guid
skuPartNumber: String
appliesTo: String
microsoft.graph.licenseUnitsDetail:
title: licenseUnitsDetail
type: object
properties:
enabled:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
suspended:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
warning:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
example:
enabled: Int32
suspended: Int32
warning: Int32
microsoft.graph.organization:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: organization
type: object
properties:
assignedPlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedPlan'
businessPhones:
type: array
items:
type: string
city:
type: string
nullable: true
country:
type: string
nullable: true
countryLetterCode:
type: string
nullable: true
displayName:
type: string
nullable: true
marketingNotificationEmails:
type: array
items:
type: string
onPremisesLastSyncDateTime:
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
format: date-time
nullable: true
onPremisesSyncEnabled:
type: boolean
nullable: true
postalCode:
type: string
nullable: true
preferredLanguage:
type: string
nullable: true
provisionedPlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.provisionedPlan'
securityComplianceNotificationMails:
type: array
items:
type: string
securityComplianceNotificationPhones:
type: array
items:
type: string
state:
type: string
nullable: true
street:
type: string
nullable: true
technicalNotificationMails:
type: array
items:
type: string
verifiedDomains:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.verifiedDomain'
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
example:
id: String (identifier)
assignedPlans:
- '@odata.type': microsoft.graph.assignedPlan
businessPhones:
- String
city: String
country: String
countryLetterCode: String
displayName: String
marketingNotificationEmails:
- String
onPremisesLastSyncDateTime: DateTimeOffset (timestamp)
onPremisesSyncEnabled: true
postalCode: String
preferredLanguage: String
provisionedPlans:
- '@odata.type': microsoft.graph.provisionedPlan
securityComplianceNotificationMails:
- String
securityComplianceNotificationPhones:
- String
state: String
street: String
technicalNotificationMails:
- String
verifiedDomains:
- '@odata.type': microsoft.graph.verifiedDomain
extensions:
- '@odata.type': microsoft.graph.extension
microsoft.graph.assignedPlan:
title: assignedPlan
type: object
properties:
assignedDateTime:
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
format: date-time
nullable: true
capabilityStatus:
type: string
nullable: true
service:
type: string
nullable: true
servicePlanId:
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
format: uuid
nullable: true
example:
assignedDateTime: DateTimeOffset (timestamp)
capabilityStatus: String
service: String
servicePlanId: Guid
microsoft.graph.provisionedPlan:
title: provisionedPlan
type: object
properties:
capabilityStatus:
type: string
nullable: true
provisioningStatus:
type: string
nullable: true
service:
type: string
nullable: true
example:
capabilityStatus: String
provisioningStatus: String
service: String
microsoft.graph.verifiedDomain:
title: verifiedDomain
type: object
properties:
capabilities:
type: string
nullable: true
isDefault:
type: boolean
nullable: true
isInitial:
type: boolean
nullable: true
name:
type: string
nullable: true
type:
type: string
nullable: true
example:
capabilities: String
isDefault: true
isInitial: true
name: String
type: String
microsoft.graph.user:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: user
type: object
properties:
accountEnabled:
type: boolean
nullable: true
assignedLicenses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedLicense'
assignedPlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedPlan'
businessPhones:
type: array
items:
type: string
city:
type: string
nullable: true
companyName:
type: string
nullable: true
country:
type: string
nullable: true
department:
type: string
nullable: true
displayName:
type: string
nullable: true
givenName:
type: string
nullable: true
imAddresses:
type: array
items:
type: string
nullable: true
jobTitle:
type: string
nullable: true
mail:
type: string
nullable: true
mailNickname:
type: string
nullable: true
mobilePhone:
type: string
nullable: true
onPremisesImmutableId:
type: string
nullable: true
onPremisesLastSyncDateTime:
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
format: date-time
nullable: true
onPremisesSecurityIdentifier:
type: string
nullable: true
onPremisesSyncEnabled:
type: boolean
nullable: true
passwordPolicies:
type: string
nullable: true
passwordProfile:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.passwordProfile'
nullable: true
officeLocation:
type: string
nullable: true
postalCode:
type: string
nullable: true
preferredLanguage:
type: string
nullable: true
provisionedPlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.provisionedPlan'
proxyAddresses:
type: array
items:
type: string
state:
type: string
nullable: true
streetAddress:
type: string
nullable: true
surname:
type: string
nullable: true
usageLocation:
type: string
nullable: true
userPrincipalName:
type: string
nullable: true
userType:
type: string
nullable: true
mailboxSettings:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.mailboxSettings'
nullable: true
aboutMe:
type: string
nullable: true
birthday:
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
format: date-time
hireDate:
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
format: date-time
interests:
type: array
items:
type: string
nullable: true
mySite:
type: string
nullable: true
pastProjects:
type: array
items:
type: string
nullable: true
preferredName:
type: string
nullable: true
responsibilities:
type: array
items:
type: string
nullable: true
schools:
type: array
items:
type: string
nullable: true
skills:
type: array
items:
type: string
nullable: true
ownedDevices:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
registeredDevices:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
manager:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
nullable: true
directReports:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
memberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
createdObjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
ownedObjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
licenseDetails:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.licenseDetails'
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.message'
mailFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
calendar:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.calendar'
nullable: true
calendars:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendar'
calendarGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarGroup'
calendarView:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
events:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
people:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.person'
contacts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contact'
contactFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
inferenceClassification:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.inferenceClassification'
nullable: true
photo:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.profilePhoto'
nullable: true
photos:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
drive:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.drive'
nullable: true
drives:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.drive'
planner:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerUser'
nullable: true
onenote:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenote'
nullable: true
example:
id: String (identifier)
accountEnabled: true
assignedLicenses:
- '@odata.type': microsoft.graph.assignedLicense
assignedPlans:
- '@odata.type': microsoft.graph.assignedPlan
businessPhones:
- String
city: String
companyName: String
country: String
department: String
displayName: String
givenName: String
imAddresses:
- String
jobTitle: String
mail: String
mailNickname: String
mobilePhone: String
onPremisesImmutableId: String
onPremisesLastSyncDateTime: DateTimeOffset (timestamp)
onPremisesSecurityIdentifier: String
onPremisesSyncEnabled: true
passwordPolicies: String
passwordProfile:
'@odata.type': microsoft.graph.passwordProfile
officeLocation: String
postalCode: String
preferredLanguage: String
provisionedPlans:
- '@odata.type': microsoft.graph.provisionedPlan
proxyAddresses:
- String
state: String
streetAddress: String
surname: String
usageLocation: String
userPrincipalName: String
userType: String
mailboxSettings:
'@odata.type': microsoft.graph.mailboxSettings
aboutMe: String
birthday: DateTimeOffset (timestamp)
hireDate: DateTimeOffset (timestamp)
interests:
- String
mySite: String
pastProjects:
- String
preferredName: String
responsibilities:
- String
schools:
- String
skills:
- String
ownedDevices:
- '@odata.type': microsoft.graph.directoryObject
registeredDevices:
- '@odata.type': microsoft.graph.directoryObject
manager:
'@odata.type': microsoft.graph.directoryObject
directReports:
- '@odata.type': microsoft.graph.directoryObject
memberOf:
- '@odata.type': microsoft.graph.directoryObject
createdObjects:
- '@odata.type': microsoft.graph.directoryObject
ownedObjects:
- '@odata.type': microsoft.graph.directoryObject
licenseDetails:
- '@odata.type': microsoft.graph.licenseDetails
extensions:
- '@odata.type': microsoft.graph.extension
messages:
- '@odata.type': microsoft.graph.message
mailFolders:
- '@odata.type': microsoft.graph.mailFolder
calendar:
'@odata.type': microsoft.graph.calendar
calendars:
- '@odata.type': microsoft.graph.calendar
calendarGroups:
- '@odata.type': microsoft.graph.calendarGroup
calendarView:
- '@odata.type': microsoft.graph.event
events:
- '@odata.type': microsoft.graph.event
people:
- '@odata.type': microsoft.graph.person
contacts:
- '@odata.type': microsoft.graph.contact
contactFolders:
- '@odata.type': microsoft.graph.contactFolder
inferenceClassification:
'@odata.type': microsoft.graph.inferenceClassification
photo:
'@odata.type': microsoft.graph.profilePhoto
photos:
- '@odata.type': microsoft.graph.profilePhoto
drive:
'@odata.type': microsoft.graph.drive
drives:
- '@odata.type': microsoft.graph.drive
planner:
'@odata.type': microsoft.graph.plannerUser
onenote:
'@odata.type': microsoft.graph.onenote
microsoft.graph.assignedLicense:
title: assignedLicense
type: object
properties:
disabledPlans:
type: array
items:
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
format: uuid
skuId:
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
format: uuid
nullable: true
example:
disabledPlans:
- Guid
skuId: Guid
microsoft.graph.passwordProfile:
title: passwordProfile
type: object
properties:
password:
type: string
nullable: true
forceChangePasswordNextSignIn:
type: boolean
nullable: true
example:
password: String
forceChangePasswordNextSignIn: true
microsoft.graph.mailboxSettings:
title: mailboxSettings
type: object
properties:
automaticRepliesSetting:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.automaticRepliesSetting'
nullable: true
archiveFolder:
type: string
nullable: true
timeZone:
type: string
nullable: true
language:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.localeInfo'
nullable: true
example:
automaticRepliesSetting:
'@odata.type': microsoft.graph.automaticRepliesSetting
archiveFolder: String
timeZone: String
language:
'@odata.type': microsoft.graph.localeInfo
microsoft.graph.automaticRepliesSetting:
title: automaticRepliesSetting
type: object
properties:
status:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.automaticRepliesStatus'
nullable: true
externalAudience:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.externalAudienceScope'
nullable: true
scheduledStartDateTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
nullable: true
scheduledEndDateTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
nullable: true
internalReplyMessage:
type: string
nullable: true
externalReplyMessage:
type: string
nullable: true
example:
status:
'@odata.type': microsoft.graph.automaticRepliesStatus
externalAudience:
'@odata.type': microsoft.graph.externalAudienceScope
scheduledStartDateTime:
'@odata.type': microsoft.graph.dateTimeTimeZone
scheduledEndDateTime:
'@odata.type': microsoft.graph.dateTimeTimeZone
internalReplyMessage: String
externalReplyMessage: String
microsoft.graph.dateTimeTimeZone:
title: dateTimeTimeZone
type: object
properties:
dateTime:
type: string
timeZone:
type: string
nullable: true
example:
dateTime: String
timeZone: String
microsoft.graph.localeInfo:
title: localeInfo
type: object
properties:
locale:
type: string
nullable: true
displayName:
type: string
nullable: true
example:
locale: String
displayName: String
microsoft.graph.message:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: message
type: object
properties:
receivedDateTime:
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
format: date-time
nullable: true
sentDateTime:
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
format: date-time
nullable: true
hasAttachments:
type: boolean
nullable: true
internetMessageId:
type: string
nullable: true
subject:
type: string
nullable: true
body:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
nullable: true
bodyPreview:
type: string
nullable: true
importance:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.importance'
nullable: true
parentFolderId:
type: string
nullable: true
sender:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.recipient'
nullable: true
from:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.recipient'
nullable: true
toRecipients:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.recipient'
nullable: true
ccRecipients:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.recipient'
nullable: true
bccRecipients:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.recipient'
nullable: true
replyTo:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.recipient'
nullable: true
conversationId:
type: string
nullable: true
uniqueBody:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
nullable: true
isDeliveryReceiptRequested:
type: boolean
nullable: true
isReadReceiptRequested:
type: boolean
nullable: true
isRead:
type: boolean
nullable: true
isDraft:
type: boolean
nullable: true
webLink:
type: string
nullable: true
inferenceClassification:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.inferenceClassificationType'
nullable: true
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachment'
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
example:
id: String (identifier)
createdDateTime: DateTimeOffset (timestamp)
lastModifiedDateTime: DateTimeOffset (timestamp)
changeKey: String
categories:
- String
receivedDateTime: DateTimeOffset (timestamp)
sentDateTime: DateTimeOffset (timestamp)
hasAttachments: true
internetMessageId: String
subject: String
body:
'@odata.type': microsoft.graph.itemBody
bodyPreview: String
importance:
'@odata.type': microsoft.graph.importance
parentFolderId: String
sender:
'@odata.type': microsoft.graph.recipient
from:
'@odata.type': microsoft.graph.recipient
toRecipients:
- '@odata.type': microsoft.graph.recipient
ccRecipients:
- '@odata.type': microsoft.graph.recipient
bccRecipients:
- '@odata.type': microsoft.graph.recipient
replyTo:
- '@odata.type': microsoft.graph.recipient
conversationId: String
uniqueBody:
'@odata.type': microsoft.graph.itemBody
isDeliveryReceiptRequested: true
isReadReceiptRequested: true
isRead: true
isDraft: true
webLink: String
inferenceClassification:
'@odata.type': microsoft.graph.inferenceClassificationType
attachments:
- '@odata.type': microsoft.graph.attachment
extensions:
- '@odata.type': microsoft.graph.extension
singleValueExtendedProperties:
- '@odata.type': microsoft.graph.singleValueLegacyExtendedProperty
multiValueExtendedProperties:
- '@odata.type': microsoft.graph.multiValueLegacyExtendedProperty
microsoft.graph.mailFolder:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: mailFolder
type: object
properties:
displayName:
type: string
nullable: true
parentFolderId:
type: string
nullable: true
childFolderCount:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
unreadItemCount:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
totalItemCount:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.message'
childFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
example:
id: String (identifier)
displayName: String
parentFolderId: String
childFolderCount: Int32
unreadItemCount: Int32
totalItemCount: Int32
messages:
- '@odata.type': microsoft.graph.message
childFolders:
- '@odata.type': microsoft.graph.mailFolder
singleValueExtendedProperties:
- '@odata.type': microsoft.graph.singleValueLegacyExtendedProperty
multiValueExtendedProperties:
- '@odata.type': microsoft.graph.multiValueLegacyExtendedProperty
microsoft.graph.calendarGroup:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: calendarGroup
type: object
properties:
name:
type: string
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
format: uuid
nullable: true
changeKey:
type: string
nullable: true
calendars:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendar'
example:
id: String (identifier)
name: String
classId: Guid
changeKey: String
calendars:
- '@odata.type': microsoft.graph.calendar
microsoft.graph.person:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: person
type: object
properties:
displayName:
type: string
nullable: true
givenName:
type: string
nullable: true
surname:
type: string
nullable: true
birthday:
type: string
nullable: true
personNotes:
type: string
nullable: true
isFavorite:
type: boolean
nullable: true
scoredEmailAddresses:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.scoredEmailAddress'
nullable: true
phones:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.phone'
nullable: true
postalAddresses:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.location'
nullable: true
websites:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.website'
nullable: true
jobTitle:
type: string
nullable: true
companyName:
type: string
nullable: true
yomiCompany:
type: string
nullable: true
department:
type: string
nullable: true
officeLocation:
type: string
nullable: true
profession:
type: string
nullable: true
personType:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.personType'
nullable: true
userPrincipalName:
type: string
nullable: true
imAddress:
type: string
nullable: true
example:
id: String (identifier)
displayName: String
givenName: String
surname: String
birthday: String
personNotes: String
isFavorite: true
scoredEmailAddresses:
- '@odata.type': microsoft.graph.scoredEmailAddress
phones:
- '@odata.type': microsoft.graph.phone
postalAddresses:
- '@odata.type': microsoft.graph.location
websites:
- '@odata.type': microsoft.graph.website
jobTitle: String
companyName: String
yomiCompany: String
department: String
officeLocation: String
profession: String
personType:
'@odata.type': microsoft.graph.personType
userPrincipalName: String
imAddress: String
microsoft.graph.contact:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: contact
type: object
properties:
parentFolderId:
type: string
nullable: true
birthday:
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
format: date-time
nullable: true
fileAs:
type: string
nullable: true
displayName:
type: string
nullable: true
givenName:
type: string
nullable: true
initials:
type: string
nullable: true
middleName:
type: string
nullable: true
nickName:
type: string
nullable: true
surname:
type: string
nullable: true
title:
type: string
nullable: true
yomiGivenName:
type: string
nullable: true
yomiSurname:
type: string
nullable: true
yomiCompanyName:
type: string
nullable: true
generation:
type: string
nullable: true
emailAddresses:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.emailAddress'
nullable: true
imAddresses:
type: array
items:
type: string
nullable: true
jobTitle:
type: string
nullable: true
companyName:
type: string
nullable: true
department:
type: string
nullable: true
officeLocation:
type: string
nullable: true
profession:
type: string
nullable: true
businessHomePage:
type: string
nullable: true
assistantName:
type: string
nullable: true
manager:
type: string
nullable: true
homePhones:
type: array
items:
type: string
nullable: true
mobilePhone:
type: string
nullable: true
businessPhones:
type: array
items:
type: string
nullable: true
homeAddress:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.physicalAddress'
nullable: true
businessAddress:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.physicalAddress'
nullable: true
otherAddress:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.physicalAddress'
nullable: true
spouseName:
type: string
nullable: true
personalNotes:
type: string
nullable: true
children:
type: array
items:
type: string
nullable: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
photo:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.profilePhoto'
nullable: true
example:
id: String (identifier)
createdDateTime: DateTimeOffset (timestamp)
lastModifiedDateTime: DateTimeOffset (timestamp)
changeKey: String
categories:
- String
parentFolderId: String
birthday: DateTimeOffset (timestamp)
fileAs: String
displayName: String
givenName: String
initials: String
middleName: String
nickName: String
surname: String
title: String
yomiGivenName: String
yomiSurname: String
yomiCompanyName: String
generation: String
emailAddresses:
- '@odata.type': microsoft.graph.emailAddress
imAddresses:
- String
jobTitle: String
companyName: String
department: String
officeLocation: String
profession: String
businessHomePage: String
assistantName: String
manager: String
homePhones:
- String
mobilePhone: String
businessPhones:
- String
homeAddress:
'@odata.type': microsoft.graph.physicalAddress
businessAddress:
'@odata.type': microsoft.graph.physicalAddress
otherAddress:
'@odata.type': microsoft.graph.physicalAddress
spouseName: String
personalNotes: String
children:
- String
extensions:
- '@odata.type': microsoft.graph.extension
singleValueExtendedProperties:
- '@odata.type': microsoft.graph.singleValueLegacyExtendedProperty
multiValueExtendedProperties:
- '@odata.type': microsoft.graph.multiValueLegacyExtendedProperty
photo:
'@odata.type': microsoft.graph.profilePhoto
microsoft.graph.contactFolder:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: contactFolder
type: object
properties:
parentFolderId:
type: string
nullable: true
displayName:
type: string
nullable: true
contacts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contact'
childFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
example:
id: String (identifier)
parentFolderId: String
displayName: String
contacts:
- '@odata.type': microsoft.graph.contact
childFolders:
- '@odata.type': microsoft.graph.contactFolder
singleValueExtendedProperties:
- '@odata.type': microsoft.graph.singleValueLegacyExtendedProperty
multiValueExtendedProperties:
- '@odata.type': microsoft.graph.multiValueLegacyExtendedProperty
microsoft.graph.inferenceClassification:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: inferenceClassification
type: object
properties:
overrides:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationOverride'
example:
id: String (identifier)
overrides:
- '@odata.type': microsoft.graph.inferenceClassificationOverride
microsoft.graph.plannerUser:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerUser
type: object
properties:
tasks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
plans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerPlan'
example:
id: String (identifier)
tasks:
- '@odata.type': microsoft.graph.plannerTask
plans:
- '@odata.type': microsoft.graph.plannerPlan
microsoft.graph.settingValue:
title: settingValue
type: object
properties:
name:
type: string
nullable: true
value:
type: string
nullable: true
example:
name: String
value: String
microsoft.graph.groupSettingTemplate:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: groupSettingTemplate
type: object
properties:
displayName:
type: string
nullable: true
description:
type: string
nullable: true
values:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.settingTemplateValue'
example:
id: String (identifier)
displayName: String
description: String
values:
- '@odata.type': microsoft.graph.settingTemplateValue
microsoft.graph.settingTemplateValue:
title: settingTemplateValue
type: object
properties:
name:
type: string
nullable: true
type:
type: string
nullable: true
defaultValue:
type: string
nullable: true
description:
type: string
nullable: true
example:
name: String
type: String
defaultValue: String
description: String
microsoft.graph.ComplexExtensionValue:
title: ComplexExtensionValue
type: object
microsoft.graph.schemaExtension:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: schemaExtension
type: object
properties:
description:
type: string
nullable: true
targetTypes:
type: array
items:
type: string
properties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extensionSchemaProperty'
status:
type: string
owner:
type: string
example:
id: String (identifier)
description: String
targetTypes:
- String
properties:
- '@odata.type': microsoft.graph.extensionSchemaProperty
status: String
owner: String
microsoft.graph.extensionSchemaProperty:
title: extensionSchemaProperty
type: object
properties:
name:
type: string
nullable: true
type:
type: string
nullable: true
example:
name: String
type: String
microsoft.graph.attachment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: attachment
type: object
properties:
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
format: date-time
nullable: true
name:
type: string
nullable: true
contentType:
type: string
nullable: true
size:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
isInline:
type: boolean
example:
id: String (identifier)
lastModifiedDateTime: DateTimeOffset (timestamp)
name: String
contentType: String
size: Int32
isInline: true
microsoft.graph.recipient:
title: recipient
type: object
properties:
emailAddress:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.emailAddress'
nullable: true
example:
emailAddress:
'@odata.type': microsoft.graph.emailAddress
microsoft.graph.emailAddress:
title: emailAddress
type: object
properties:
name:
type: string
nullable: true
address:
type: string
nullable: true
example:
name: String
address: String
microsoft.graph.attendeeBase:
allOf:
- $ref: '#/components/schemas/microsoft.graph.recipient'
- title: attendeeBase
type: object
properties:
type:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.attendeeType'
nullable: true
example:
emailAddress:
'@odata.type': microsoft.graph.emailAddress
type:
'@odata.type': microsoft.graph.attendeeType
microsoft.graph.meetingTimeSuggestionsResult:
title: meetingTimeSuggestionsResult
type: object
properties:
meetingTimeSuggestions:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.meetingTimeSuggestion'
nullable: true
emptySuggestionsReason:
type: string
nullable: true
example:
meetingTimeSuggestions:
- '@odata.type': microsoft.graph.meetingTimeSuggestion
emptySuggestionsReason: String
microsoft.graph.meetingTimeSuggestion:
title: meetingTimeSuggestion
type: object
properties:
meetingTimeSlot:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeSlot'
nullable: true
confidence:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
nullable: true
organizerAvailability:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.freeBusyStatus'
nullable: true
attendeeAvailability:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.attendeeAvailability'
nullable: true
locations:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.location'
nullable: true
suggestionReason:
type: string
nullable: true
example:
meetingTimeSlot:
'@odata.type': microsoft.graph.timeSlot
confidence: Double
organizerAvailability:
'@odata.type': microsoft.graph.freeBusyStatus
attendeeAvailability:
- '@odata.type': microsoft.graph.attendeeAvailability
locations:
- '@odata.type': microsoft.graph.location
suggestionReason: String
microsoft.graph.timeSlot:
title: timeSlot
type: object
properties:
start:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
nullable: true
end:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
nullable: true
example:
start:
'@odata.type': microsoft.graph.dateTimeTimeZone
end:
'@odata.type': microsoft.graph.dateTimeTimeZone
microsoft.graph.attendeeAvailability:
title: attendeeAvailability
type: object
properties:
attendee:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.attendeeBase'
nullable: true
availability:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.freeBusyStatus'
nullable: true
example:
attendee:
'@odata.type': microsoft.graph.attendeeBase
availability:
'@odata.type': microsoft.graph.freeBusyStatus
microsoft.graph.location:
title: location
type: object
properties:
displayName:
type: string
nullable: true
locationEmailAddress:
type: string
nullable: true
address:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.physicalAddress'
nullable: true
example:
displayName: String
locationEmailAddress: String
address:
'@odata.type': microsoft.graph.physicalAddress
microsoft.graph.physicalAddress:
title: physicalAddress
type: object
properties:
street:
type: string
nullable: true
city:
type: string
nullable: true
state:
type: string
nullable: true
countryOrRegion:
type: string
nullable: true
postalCode:
type: string
nullable: true
example:
street: String
city: String
state: String
countryOrRegion: String
postalCode: String
microsoft.graph.locationConstraint:
title: locationConstraint
type: object
properties:
isRequired:
type: boolean
nullable: true
suggestLocation:
type: boolean
nullable: true
locations:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.locationConstraintItem'
nullable: true
example:
isRequired: true
suggestLocation: true
locations:
- '@odata.type': microsoft.graph.locationConstraintItem
microsoft.graph.locationConstraintItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.location'
- title: locationConstraintItem
type: object
properties:
resolveAvailability:
type: boolean
nullable: true
example:
displayName: String
locationEmailAddress: String
address:
'@odata.type': microsoft.graph.physicalAddress
resolveAvailability: true
microsoft.graph.timeConstraint:
title: timeConstraint
type: object
properties:
activityDomain:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.activityDomain'
nullable: true
timeslots:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeSlot'
nullable: true
example:
activityDomain:
'@odata.type': microsoft.graph.activityDomain
timeslots:
- '@odata.type': microsoft.graph.timeSlot
microsoft.graph.reminder:
title: reminder
type: object
properties:
eventId:
type: string
nullable: true
eventStartTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
nullable: true
eventEndTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
nullable: true
changeKey:
type: string
nullable: true
eventSubject:
type: string
nullable: true
eventLocation:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.location'
nullable: true
eventWebLink:
type: string
nullable: true
reminderFireTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
nullable: true
example:
eventId: String
eventStartTime:
'@odata.type': microsoft.graph.dateTimeTimeZone
eventEndTime:
'@odata.type': microsoft.graph.dateTimeTimeZone
changeKey: String
eventSubject: String
eventLocation:
'@odata.type': microsoft.graph.location
eventWebLink: String
reminderFireTime:
'@odata.type': microsoft.graph.dateTimeTimeZone
microsoft.graph.singleValueLegacyExtendedProperty:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: singleValueLegacyExtendedProperty
type: object
properties:
value:
type: string
nullable: true
example:
id: String (identifier)
value: String
microsoft.graph.multiValueLegacyExtendedProperty:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: multiValueLegacyExtendedProperty
type: object
properties:
value:
type: array
items:
type: string
nullable: true
example:
id: String (identifier)
value:
- String
microsoft.graph.itemBody:
title: itemBody
type: object
properties:
contentType:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.bodyType'
nullable: true
content:
type: string
nullable: true
example:
contentType:
'@odata.type': microsoft.graph.bodyType
content: String
microsoft.graph.fileAttachment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.attachment'
- title: fileAttachment
type: object
properties:
contentId:
type: string
nullable: true
contentLocation:
type: string
nullable: true
contentBytes:
type: string
format: base64url
nullable: true
example:
id: String (identifier)
lastModifiedDateTime: DateTimeOffset (timestamp)
name: String
contentType: String
size: Int32
isInline: true
contentId: String
contentLocation: String
contentBytes: Binary
microsoft.graph.itemAttachment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.attachment'
- title: itemAttachment
type: object
properties:
item:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
nullable: true
example:
id: String (identifier)
lastModifiedDateTime: DateTimeOffset (timestamp)
name: String
contentType: String
size: Int32
isInline: true
item:
'@odata.type': microsoft.graph.outlookItem
microsoft.graph.responseStatus:
title: responseStatus
type: object
properties:
response:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.responseType'
nullable: true
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
format: date-time
nullable: true
example:
response:
'@odata.type': microsoft.graph.responseType
time: DateTimeOffset (timestamp)
microsoft.graph.patternedRecurrence:
title: patternedRecurrence
type: object
properties:
pattern:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.recurrencePattern'
nullable: true
range:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.recurrenceRange'
nullable: true
example:
pattern:
'@odata.type': microsoft.graph.recurrencePattern
range:
'@odata.type': microsoft.graph.recurrenceRange
microsoft.graph.recurrencePattern:
title: recurrencePattern
type: object
properties:
type:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.recurrencePatternType'
nullable: true
interval:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
month:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
dayOfMonth:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
daysOfWeek:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dayOfWeek'
nullable: true
firstDayOfWeek:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dayOfWeek'
nullable: true
index:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.weekIndex'
nullable: true
example:
type:
'@odata.type': microsoft.graph.recurrencePatternType
interval: Int32
month: Int32
dayOfMonth: Int32
daysOfWeek:
- '@odata.type': microsoft.graph.dayOfWeek
firstDayOfWeek:
'@odata.type': microsoft.graph.dayOfWeek
index:
'@odata.type': microsoft.graph.weekIndex
microsoft.graph.recurrenceRange:
title: recurrenceRange
type: object
properties:
type:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.recurrenceRangeType'
nullable: true
startDate:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
format: date
nullable: true
endDate:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
format: date
nullable: true
recurrenceTimeZone:
type: string
nullable: true
numberOfOccurrences:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
example:
type:
'@odata.type': microsoft.graph.recurrenceRangeType
startDate: Date (timestamp)
endDate: Date (timestamp)
recurrenceTimeZone: String
numberOfOccurrences: Int32
microsoft.graph.attendee:
allOf:
- $ref: '#/components/schemas/microsoft.graph.attendeeBase'
- title: attendee
type: object
properties:
status:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.responseStatus'
nullable: true
example:
emailAddress:
'@odata.type': microsoft.graph.emailAddress
type:
'@odata.type': microsoft.graph.attendeeType
status:
'@odata.type': microsoft.graph.responseStatus
microsoft.graph.eventMessage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- title: eventMessage
type: object
properties:
meetingMessageType:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.meetingMessageType'
nullable: true
event:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.event'
nullable: true
example:
id: String (identifier)
createdDateTime: DateTimeOffset (timestamp)
lastModifiedDateTime: DateTimeOffset (timestamp)
changeKey: String
categories:
- String
receivedDateTime: DateTimeOffset (timestamp)
sentDateTime: DateTimeOffset (timestamp)
hasAttachments: true
internetMessageId: String
subject: String
body:
'@odata.type': microsoft.graph.itemBody
bodyPreview: String
importance:
'@odata.type': microsoft.graph.importance
parentFolderId: String
sender:
'@odata.type': microsoft.graph.recipient
from:
'@odata.type': microsoft.graph.recipient
toRecipients:
- '@odata.type': microsoft.graph.recipient
ccRecipients:
- '@odata.type': microsoft.graph.recipient
bccRecipients:
- '@odata.type': microsoft.graph.recipient
replyTo:
- '@odata.type': microsoft.graph.recipient
conversationId: String
uniqueBody:
'@odata.type': microsoft.graph.itemBody
isDeliveryReceiptRequested: true
isReadReceiptRequested: true
isRead: true
isDraft: true
webLink: String
inferenceClassification:
'@odata.type': microsoft.graph.inferenceClassificationType
attachments:
- '@odata.type': microsoft.graph.attachment
extensions:
- '@odata.type': microsoft.graph.extension
singleValueExtendedProperties:
- '@odata.type': microsoft.graph.singleValueLegacyExtendedProperty
multiValueExtendedProperties:
- '@odata.type': microsoft.graph.multiValueLegacyExtendedProperty
meetingMessageType:
'@odata.type': microsoft.graph.meetingMessageType
event:
'@odata.type': microsoft.graph.event
microsoft.graph.referenceAttachment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.attachment'
- title: referenceAttachment
type: object
example:
id: String (identifier)
lastModifiedDateTime: DateTimeOffset (timestamp)
name: String
contentType: String
size: Int32
isInline: true
microsoft.graph.openTypeExtension:
allOf:
- $ref: '#/components/schemas/microsoft.graph.extension'
- title: openTypeExtension
type: object
properties:
extensionName:
type: string
example:
id: String (identifier)
extensionName: String
microsoft.graph.post:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: post
type: object
properties:
body:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
nullable: true
receivedDateTime:
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
format: date-time
hasAttachments:
type: boolean
from:
$ref: '#/components/schemas/microsoft.graph.recipient'
sender:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.recipient'
nullable: true
conversationThreadId:
type: string
nullable: true
newParticipants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
conversationId:
type: string
nullable: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
inReplyTo:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.post'
nullable: true
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachment'
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
example:
id: String (identifier)
createdDateTime: DateTimeOffset (timestamp)
lastModifiedDateTime: DateTimeOffset (timestamp)
changeKey: String
categories:
- String
body:
'@odata.type': microsoft.graph.itemBody
receivedDateTime: DateTimeOffset (timestamp)
hasAttachments: true
from:
'@odata.type': microsoft.graph.recipient
sender:
'@odata.type': microsoft.graph.recipient
conversationThreadId: String
newParticipants:
- '@odata.type': microsoft.graph.recipient
conversationId: String
extensions:
- '@odata.type': microsoft.graph.extension
inReplyTo:
'@odata.type': microsoft.graph.post
attachments:
- '@odata.type': microsoft.graph.attachment
singleValueExtendedProperties:
- '@odata.type': microsoft.graph.singleValueLegacyExtendedProperty
multiValueExtendedProperties:
- '@odata.type': microsoft.graph.multiValueLegacyExtendedProperty
microsoft.graph.inferenceClassificationOverride:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: inferenceClassificationOverride
type: object
properties:
classifyAs:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.inferenceClassificationType'
nullable: true
senderEmailAddress:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.emailAddress'
nullable: true
example:
id: String (identifier)
classifyAs:
'@odata.type': microsoft.graph.inferenceClassificationType
senderEmailAddress:
'@odata.type': microsoft.graph.emailAddress
microsoft.graph.scoredEmailAddress:
title: scoredEmailAddress
type: object
properties:
address:
type: string
nullable: true
relevanceScore:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
nullable: true
example:
address: String
relevanceScore: Double
microsoft.graph.phone:
title: phone
type: object
properties:
type:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.phoneType'
nullable: true
number:
type: string
nullable: true
region:
type: string
nullable: true
language:
type: string
nullable: true
example:
type:
'@odata.type': microsoft.graph.phoneType
number: String
region: String
language: String
microsoft.graph.website:
title: website
type: object
properties:
type:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.websiteType'
nullable: true
address:
type: string
nullable: true
displayName:
type: string
nullable: true
example:
type:
'@odata.type': microsoft.graph.websiteType
address: String
displayName: String
microsoft.graph.personType:
title: personType
type: object
properties:
class:
type: string
nullable: true
subclass:
type: string
nullable: true
example:
class: String
subclass: String
microsoft.graph.identitySet:
title: identitySet
type: object
properties:
application:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identity'
nullable: true
device:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identity'
nullable: true
user:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identity'
nullable: true
example:
application:
'@odata.type': microsoft.graph.identity
device:
'@odata.type': microsoft.graph.identity
user:
'@odata.type': microsoft.graph.identity
microsoft.graph.identity:
title: identity
type: object
properties:
displayName:
type: string
nullable: true
id:
type: string
nullable: true
example:
displayName: String
id: String
microsoft.graph.itemReference:
title: itemReference
type: object
properties:
driveId:
type: string
nullable: true
driveType:
type: string
nullable: true
id:
type: string
nullable: true
name:
type: string
nullable: true
path:
type: string
nullable: true
shareId:
type: string
nullable: true
sharepointIds:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sharepointIds'
nullable: true
example:
driveId: String
driveType: String
id: String
name: String
path: String
shareId: String
sharepointIds:
'@odata.type': microsoft.graph.sharepointIds
microsoft.graph.sharepointIds:
title: sharepointIds
type: object
properties:
listId:
type: string
nullable: true
listItemId:
type: string
nullable: true
listItemUniqueId:
type: string
nullable: true
siteId:
type: string
nullable: true
siteUrl:
type: string
nullable: true
webId:
type: string
nullable: true
example:
listId: String
listItemId: String
listItemUniqueId: String
siteId: String
siteUrl: String
webId: String
microsoft.graph.columnDefinition:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: columnDefinition
type: object
properties:
boolean:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.booleanColumn'
nullable: true
calculated:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.calculatedColumn'
nullable: true
choice:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.choiceColumn'
nullable: true
columnGroup:
type: string
nullable: true
currency:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.currencyColumn'
nullable: true
dateTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeColumn'
nullable: true
defaultValue:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.defaultColumnValue'
nullable: true
description:
type: string
nullable: true
displayName:
type: string
nullable: true
enforceUniqueValues:
type: boolean
nullable: true
hidden:
type: boolean
nullable: true
indexed:
type: boolean
nullable: true
lookup:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.lookupColumn'
nullable: true
name:
type: string
nullable: true
number:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.numberColumn'
nullable: true
personOrGroup:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.personOrGroupColumn'
nullable: true
readOnly:
type: boolean
nullable: true
required:
type: boolean
nullable: true
text:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.textColumn'
nullable: true
example:
id: String (identifier)
boolean:
'@odata.type': microsoft.graph.booleanColumn
calculated:
'@odata.type': microsoft.graph.calculatedColumn
choice:
'@odata.type': microsoft.graph.choiceColumn
columnGroup: String
currency:
'@odata.type': microsoft.graph.currencyColumn
dateTime:
'@odata.type': microsoft.graph.dateTimeColumn
defaultValue:
'@odata.type': microsoft.graph.defaultColumnValue
description: String
displayName: String
enforceUniqueValues: true
hidden: true
indexed: true
lookup:
'@odata.type': microsoft.graph.lookupColumn
name: String
number:
'@odata.type': microsoft.graph.numberColumn
personOrGroup:
'@odata.type': microsoft.graph.personOrGroupColumn
readOnly: true
required: true
text:
'@odata.type': microsoft.graph.textColumn
microsoft.graph.booleanColumn:
title: booleanColumn
type: object
microsoft.graph.calculatedColumn:
title: calculatedColumn
type: object
properties:
format:
type: string
nullable: true
formula:
type: string
nullable: true
outputType:
type: string
nullable: true
example:
format: String
formula: String
outputType: String
microsoft.graph.choiceColumn:
title: choiceColumn
type: object
properties:
allowTextEntry:
type: boolean
nullable: true
choices:
type: array
items:
type: string
nullable: true
displayAs:
type: string
nullable: true
example:
allowTextEntry: true
choices:
- String
displayAs: String
microsoft.graph.currencyColumn:
title: currencyColumn
type: object
properties:
locale:
type: string
nullable: true
example:
locale: String
microsoft.graph.dateTimeColumn:
title: dateTimeColumn
type: object
properties:
displayAs:
type: string
nullable: true
format:
type: string
nullable: true
example:
displayAs: String
format: String
microsoft.graph.defaultColumnValue:
title: defaultColumnValue
type: object
properties:
formula:
type: string
nullable: true
value:
type: string
nullable: true
example:
formula: String
value: String
microsoft.graph.lookupColumn:
title: lookupColumn
type: object
properties:
allowMultipleValues:
type: boolean
nullable: true
allowUnlimitedLength:
type: boolean
nullable: true
columnName:
type: string
nullable: true
listId:
type: string
nullable: true
primaryLookupColumnId:
type: string
nullable: true
example:
allowMultipleValues: true
allowUnlimitedLength: true
columnName: String
listId: String
primaryLookupColumnId: String
microsoft.graph.numberColumn:
title: numberColumn
type: object
properties:
decimalPlaces:
type: string
nullable: true
displayAs:
type: string
nullable: true
maximum:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
nullable: true
minimum:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
nullable: true
example:
decimalPlaces: String
displayAs: String
maximum: Double
minimum: Double
microsoft.graph.personOrGroupColumn:
title: personOrGroupColumn
type: object
properties:
allowMultipleSelection:
type: boolean
nullable: true
displayAs:
type: string
nullable: true
chooseFromType:
type: string
nullable: true
example:
allowMultipleSelection: true
displayAs: String
chooseFromType: String
microsoft.graph.textColumn:
title: textColumn
type: object
properties:
allowMultipleLines:
type: boolean
nullable: true
appendChangesToExistingText:
type: boolean
nullable: true
linesForEditing:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
maxLength:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
textType:
type: string
nullable: true
example:
allowMultipleLines: true
appendChangesToExistingText: true
linesForEditing: Int32
maxLength: Int32
textType: String
microsoft.graph.columnLink:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: columnLink
type: object
properties:
name:
type: string
nullable: true
example:
id: String (identifier)
name: String
microsoft.graph.contentType:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: contentType
type: object
properties:
description:
type: string
nullable: true
group:
type: string
nullable: true
hidden:
type: boolean
nullable: true
inheritedFrom:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemReference'
nullable: true
name:
type: string
nullable: true
order:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.contentTypeOrder'
nullable: true
parentId:
type: string
nullable: true
readOnly:
type: boolean
nullable: true
sealed:
type: boolean
nullable: true
columnLinks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnLink'
example:
id: String (identifier)
description: String
group: String
hidden: true
inheritedFrom:
'@odata.type': microsoft.graph.itemReference
name: String
order:
'@odata.type': microsoft.graph.contentTypeOrder
parentId: String
readOnly: true
sealed: true
columnLinks:
- '@odata.type': microsoft.graph.columnLink
microsoft.graph.contentTypeOrder:
title: contentTypeOrder
type: object
properties:
default:
type: boolean
nullable: true
position:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
example:
default: true
position: Int32
microsoft.graph.quota:
title: quota
type: object
properties:
deleted:
type: integer
format: int64
nullable: true
remaining:
type: integer
format: int64
nullable: true
state:
type: string
nullable: true
total:
type: integer
format: int64
nullable: true
used:
type: integer
format: int64
nullable: true
example:
deleted: Int64
remaining: Int64
state: String
total: Int64
used: Int64
microsoft.graph.systemFacet:
title: systemFacet
type: object
microsoft.graph.driveItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: driveItem
type: object
properties:
audio:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.audio'
nullable: true
content:
type: string
format: base64url
nullable: true
cTag:
type: string
nullable: true
deleted:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.deleted'
nullable: true
file:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.file'
nullable: true
fileSystemInfo:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.fileSystemInfo'
nullable: true
folder:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.folder'
nullable: true
image:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.image'
nullable: true
location:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.geoCoordinates'
nullable: true
package:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.package'
nullable: true
photo:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.photo'
nullable: true
remoteItem:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.remoteItem'
nullable: true
root:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.root'
nullable: true
searchResult:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.searchResult'
nullable: true
shared:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.shared'
nullable: true
sharepointIds:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sharepointIds'
nullable: true
size:
type: integer
format: int64
nullable: true
specialFolder:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.specialFolder'
nullable: true
video:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.video'
nullable: true
webDavUrl:
type: string
nullable: true
children:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
listItem:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.listItem'
nullable: true
permissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permission'
thumbnails:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.thumbnailSet'
workbook:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbook'
nullable: true
example:
id: String (identifier)
createdBy:
'@odata.type': microsoft.graph.identitySet
createdDateTime: DateTimeOffset (timestamp)
description: String
eTag: String
lastModifiedBy:
'@odata.type': microsoft.graph.identitySet
lastModifiedDateTime: DateTimeOffset (timestamp)
name: String
parentReference:
'@odata.type': microsoft.graph.itemReference
webUrl: String
createdByUser:
'@odata.type': microsoft.graph.user
lastModifiedByUser:
'@odata.type': microsoft.graph.user
audio:
'@odata.type': microsoft.graph.audio
content: Stream
cTag: String
deleted:
'@odata.type': microsoft.graph.deleted
file:
'@odata.type': microsoft.graph.file
fileSystemInfo:
'@odata.type': microsoft.graph.fileSystemInfo
folder:
'@odata.type': microsoft.graph.folder
image:
'@odata.type': microsoft.graph.image
location:
'@odata.type': microsoft.graph.geoCoordinates
package:
'@odata.type': microsoft.graph.package
photo:
'@odata.type': microsoft.graph.photo
remoteItem:
'@odata.type': microsoft.graph.remoteItem
root:
'@odata.type': microsoft.graph.root
searchResult:
'@odata.type': microsoft.graph.searchResult
shared:
'@odata.type': microsoft.graph.shared
sharepointIds:
'@odata.type': microsoft.graph.sharepointIds
size: Int64
specialFolder:
'@odata.type': microsoft.graph.specialFolder
video:
'@odata.type': microsoft.graph.video
webDavUrl: String
children:
- '@odata.type': microsoft.graph.driveItem
listItem:
'@odata.type': microsoft.graph.listItem
permissions:
- '@odata.type': microsoft.graph.permission
thumbnails:
- '@odata.type': microsoft.graph.thumbnailSet
workbook:
'@odata.type': microsoft.graph.workbook
microsoft.graph.list:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: list
type: object
properties:
displayName:
type: string
nullable: true
list:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.listInfo'
nullable: true
sharepointIds:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sharepointIds'
nullable: true
system:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.systemFacet'
nullable: true
columns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
contentTypes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentType'
drive:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.drive'
nullable: true
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.listItem'
example:
id: String (identifier)
createdBy:
'@odata.type': microsoft.graph.identitySet
createdDateTime: DateTimeOffset (timestamp)
description: String
eTag: String
lastModifiedBy:
'@odata.type': microsoft.graph.identitySet
lastModifiedDateTime: DateTimeOffset (timestamp)
name: String
parentReference:
'@odata.type': microsoft.graph.itemReference
webUrl: String
createdByUser:
'@odata.type': microsoft.graph.user
lastModifiedByUser:
'@odata.type': microsoft.graph.user
displayName: String
list:
'@odata.type': microsoft.graph.listInfo
sharepointIds:
'@odata.type': microsoft.graph.sharepointIds
system:
'@odata.type': microsoft.graph.systemFacet
columns:
- '@odata.type': microsoft.graph.columnDefinition
contentTypes:
- '@odata.type': microsoft.graph.contentType
drive:
'@odata.type': microsoft.graph.drive
items:
- '@odata.type': microsoft.graph.listItem
microsoft.graph.audio:
title: audio
type: object
properties:
album:
type: string
nullable: true
albumArtist:
type: string
nullable: true
artist:
type: string
nullable: true
bitrate:
type: integer
format: int64
nullable: true
composers:
type: string
nullable: true
copyright:
type: string
nullable: true
disc:
maximum: 32767
minimum: -32768
type: integer
format: int16
nullable: true
discCount:
maximum: 32767
minimum: -32768
type: integer
format: int16
nullable: true
duration:
type: integer
format: int64
nullable: true
genre:
type: string
nullable: true
hasDrm:
type: boolean
nullable: true
isVariableBitrate:
type: boolean
nullable: true
title:
type: string
nullable: true
track:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
trackCount:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
year:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
example:
album: String
albumArtist: String
artist: String
bitrate: Int64
composers: String
copyright: String
disc: Int16
discCount: Int16
duration: Int64
genre: String
hasDrm: true
isVariableBitrate: true
title: String
track: Int32
trackCount: Int32
year: Int32
microsoft.graph.deleted:
title: deleted
type: object
properties:
state:
type: string
nullable: true
example:
state: String
microsoft.graph.file:
title: file
type: object
properties:
hashes:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.hashes'
nullable: true
mimeType:
type: string
nullable: true
processingMetadata:
type: boolean
nullable: true
example:
hashes:
'@odata.type': microsoft.graph.hashes
mimeType: String
processingMetadata: true
microsoft.graph.hashes:
title: hashes
type: object
properties:
crc32Hash:
type: string
nullable: true
quickXorHash:
type: string
nullable: true
sha1Hash:
type: string
nullable: true
example:
crc32Hash: String
quickXorHash: String
sha1Hash: String
microsoft.graph.fileSystemInfo:
title: fileSystemInfo
type: object
properties:
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
format: date-time
nullable: true
lastAccessedDateTime:
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
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
format: date-time
nullable: true
example:
createdDateTime: DateTimeOffset (timestamp)
lastAccessedDateTime: DateTimeOffset (timestamp)
lastModifiedDateTime: DateTimeOffset (timestamp)
microsoft.graph.folder:
title: folder
type: object
properties:
childCount:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
view:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.folderView'
nullable: true
example:
childCount: Int32
view:
'@odata.type': microsoft.graph.folderView
microsoft.graph.folderView:
title: folderView
type: object
properties:
sortBy:
type: string
nullable: true
sortOrder:
type: string
nullable: true
viewType:
type: string
nullable: true
example:
sortBy: String
sortOrder: String
viewType: String
microsoft.graph.image:
title: image
type: object
properties:
height:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
width:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
example:
height: Int32
width: Int32
microsoft.graph.geoCoordinates:
title: geoCoordinates
type: object
properties:
altitude:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
nullable: true
latitude:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
nullable: true
longitude:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
nullable: true
example:
altitude: Double
latitude: Double
longitude: Double
microsoft.graph.package:
title: package
type: object
properties:
type:
type: string
nullable: true
example:
type: String
microsoft.graph.photo:
title: photo
type: object
properties:
cameraMake:
type: string
nullable: true
cameraModel:
type: string
nullable: true
exposureDenominator:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
nullable: true
exposureNumerator:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
nullable: true
fNumber:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
nullable: true
focalLength:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
nullable: true
iso:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
takenDateTime:
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
format: date-time
nullable: true
example:
cameraMake: String
cameraModel: String
exposureDenominator: Double
exposureNumerator: Double
fNumber: Double
focalLength: Double
iso: Int32
takenDateTime: DateTimeOffset (timestamp)
microsoft.graph.remoteItem:
title: remoteItem
type: object
properties:
createdBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
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
format: date-time
nullable: true
file:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.file'
nullable: true
fileSystemInfo:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.fileSystemInfo'
nullable: true
folder:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.folder'
nullable: true
id:
type: string
nullable: true
lastModifiedBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
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
format: date-time
nullable: true
name:
type: string
nullable: true
package:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.package'
nullable: true
parentReference:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemReference'
nullable: true
shared:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.shared'
nullable: true
sharepointIds:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sharepointIds'
nullable: true
size:
type: integer
format: int64
nullable: true
specialFolder:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.specialFolder'
nullable: true
webDavUrl:
type: string
nullable: true
webUrl:
type: string
nullable: true
example:
createdBy:
'@odata.type': microsoft.graph.identitySet
createdDateTime: DateTimeOffset (timestamp)
file:
'@odata.type': microsoft.graph.file
fileSystemInfo:
'@odata.type': microsoft.graph.fileSystemInfo
folder:
'@odata.type': microsoft.graph.folder
id: String
lastModifiedBy:
'@odata.type': microsoft.graph.identitySet
lastModifiedDateTime: DateTimeOffset (timestamp)
name: String
package:
'@odata.type': microsoft.graph.package
parentReference:
'@odata.type': microsoft.graph.itemReference
shared:
'@odata.type': microsoft.graph.shared
sharepointIds:
'@odata.type': microsoft.graph.sharepointIds
size: Int64
specialFolder:
'@odata.type': microsoft.graph.specialFolder
webDavUrl: String
webUrl: String
microsoft.graph.shared:
title: shared
type: object
properties:
owner:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
nullable: true
scope:
type: string
nullable: true
sharedBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
nullable: true
sharedDateTime:
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
format: date-time
nullable: true
example:
owner:
'@odata.type': microsoft.graph.identitySet
scope: String
sharedBy:
'@odata.type': microsoft.graph.identitySet
sharedDateTime: DateTimeOffset (timestamp)
microsoft.graph.specialFolder:
title: specialFolder
type: object
properties:
name:
type: string
nullable: true
example:
name: String
microsoft.graph.root:
title: root
type: object
microsoft.graph.searchResult:
title: searchResult
type: object
properties:
onClickTelemetryUrl:
type: string
nullable: true
example:
onClickTelemetryUrl: String
microsoft.graph.video:
title: video
type: object
properties:
audioBitsPerSample:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
audioChannels:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
audioFormat:
type: string
nullable: true
audioSamplesPerSecond:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
bitrate:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
duration:
type: integer
format: int64
nullable: true
fourCC:
type: string
nullable: true
frameRate:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
nullable: true
height:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
width:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
example:
audioBitsPerSample: Int32
audioChannels: Int32
audioFormat: String
audioSamplesPerSecond: Int32
bitrate: Int32
duration: Int64
fourCC: String
frameRate: Double
height: Int32
width: Int32
microsoft.graph.listItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: listItem
type: object
properties:
contentType:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.contentTypeInfo'
nullable: true
sharepointIds:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sharepointIds'
nullable: true
driveItem:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.driveItem'
nullable: true
fields:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.fieldValueSet'
nullable: true
example:
id: String (identifier)
createdBy:
'@odata.type': microsoft.graph.identitySet
createdDateTime: DateTimeOffset (timestamp)
description: String
eTag: String
lastModifiedBy:
'@odata.type': microsoft.graph.identitySet
lastModifiedDateTime: DateTimeOffset (timestamp)
name: String
parentReference:
'@odata.type': microsoft.graph.itemReference
webUrl: String
createdByUser:
'@odata.type': microsoft.graph.user
lastModifiedByUser:
'@odata.type': microsoft.graph.user
contentType:
'@odata.type': microsoft.graph.contentTypeInfo
sharepointIds:
'@odata.type': microsoft.graph.sharepointIds
driveItem:
'@odata.type': microsoft.graph.driveItem
fields:
'@odata.type': microsoft.graph.fieldValueSet
microsoft.graph.permission:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: permission
type: object
properties:
grantedTo:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
nullable: true
inheritedFrom:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemReference'
nullable: true
invitation:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sharingInvitation'
nullable: true
link:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sharingLink'
nullable: true
roles:
type: array
items:
type: string
nullable: true
shareId:
type: string
nullable: true
example:
id: String (identifier)
grantedTo:
'@odata.type': microsoft.graph.identitySet
inheritedFrom:
'@odata.type': microsoft.graph.itemReference
invitation:
'@odata.type': microsoft.graph.sharingInvitation
link:
'@odata.type': microsoft.graph.sharingLink
roles:
- String
shareId: String
microsoft.graph.thumbnailSet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: thumbnailSet
type: object
properties:
large:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.thumbnail'
nullable: true
medium:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.thumbnail'
nullable: true
small:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.thumbnail'
nullable: true
source:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.thumbnail'
nullable: true
example:
id: String (identifier)
large:
'@odata.type': microsoft.graph.thumbnail
medium:
'@odata.type': microsoft.graph.thumbnail
small:
'@odata.type': microsoft.graph.thumbnail
source:
'@odata.type': microsoft.graph.thumbnail
microsoft.graph.workbook:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbook
type: object
properties:
application:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookApplication'
nullable: true
names:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookNamedItem'
tables:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookTable'
worksheets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookWorksheet'
functions:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookFunctions'
nullable: true
example:
id: String (identifier)
application:
'@odata.type': microsoft.graph.workbookApplication
names:
- '@odata.type': microsoft.graph.workbookNamedItem
tables:
- '@odata.type': microsoft.graph.workbookTable
worksheets:
- '@odata.type': microsoft.graph.workbookWorksheet
functions:
'@odata.type': microsoft.graph.workbookFunctions
microsoft.graph.fieldValueSet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: fieldValueSet
type: object
example:
id: String (identifier)
microsoft.graph.listInfo:
title: listInfo
type: object
properties:
contentTypesEnabled:
type: boolean
nullable: true
hidden:
type: boolean
nullable: true
template:
type: string
nullable: true
example:
contentTypesEnabled: true
hidden: true
template: String
microsoft.graph.contentTypeInfo:
title: contentTypeInfo
type: object
properties:
id:
type: string
nullable: true
example:
id: String
microsoft.graph.sharingInvitation:
title: sharingInvitation
type: object
properties:
email:
type: string
nullable: true
invitedBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
nullable: true
redeemedBy:
type: string
nullable: true
signInRequired:
type: boolean
nullable: true
example:
email: String
invitedBy:
'@odata.type': microsoft.graph.identitySet
redeemedBy: String
signInRequired: true
microsoft.graph.sharingLink:
title: sharingLink
type: object
properties:
application:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identity'
nullable: true
scope:
type: string
nullable: true
type:
type: string
nullable: true
webUrl:
type: string
nullable: true
example:
application:
'@odata.type': microsoft.graph.identity
scope: String
type: String
webUrl: String
microsoft.graph.sharedDriveItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: sharedDriveItem
type: object
properties:
owner:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
nullable: true
driveItem:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.driveItem'
nullable: true
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
list:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.list'
nullable: true
listItem:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.listItem'
nullable: true
root:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.driveItem'
nullable: true
site:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.site'
nullable: true
example:
id: String (identifier)
createdBy:
'@odata.type': microsoft.graph.identitySet
createdDateTime: DateTimeOffset (timestamp)
description: String
eTag: String
lastModifiedBy:
'@odata.type': microsoft.graph.identitySet
lastModifiedDateTime: DateTimeOffset (timestamp)
name: String
parentReference:
'@odata.type': microsoft.graph.itemReference
webUrl: String
createdByUser:
'@odata.type': microsoft.graph.user
lastModifiedByUser:
'@odata.type': microsoft.graph.user
owner:
'@odata.type': microsoft.graph.identitySet
driveItem:
'@odata.type': microsoft.graph.driveItem
items:
- '@odata.type': microsoft.graph.driveItem
list:
'@odata.type': microsoft.graph.list
listItem:
'@odata.type': microsoft.graph.listItem
root:
'@odata.type': microsoft.graph.driveItem
site:
'@odata.type': microsoft.graph.site
microsoft.graph.siteCollection:
title: siteCollection
type: object
properties:
hostname:
type: string
nullable: true
example:
hostname: String
microsoft.graph.thumbnail:
title: thumbnail
type: object
properties:
content:
type: string
format: base64url
nullable: true
height:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
sourceItemId:
type: string
nullable: true
url:
type: string
nullable: true
width:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
example:
content: Stream
height: Int32
sourceItemId: String
url: String
width: Int32
microsoft.graph.driveItemUploadableProperties:
title: driveItemUploadableProperties
type: object
properties:
description:
type: string
nullable: true
fileSystemInfo:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.fileSystemInfo'
nullable: true
name:
type: string
nullable: true
example:
description: String
fileSystemInfo:
'@odata.type': microsoft.graph.fileSystemInfo
name: String
microsoft.graph.driveRecipient:
title: driveRecipient
type: object
properties:
alias:
type: string
nullable: true
email:
type: string
nullable: true
objectId:
type: string
nullable: true
example:
alias: String
email: String
objectId: String
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
format: date-time
nullable: true
nextExpectedRanges:
type: array
items:
type: string
nullable: true
uploadUrl:
type: string
nullable: true
example:
expirationDateTime: DateTimeOffset (timestamp)
nextExpectedRanges:
- String
uploadUrl: String
microsoft.graph.workbookApplication:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookApplication
type: object
properties:
calculationMode:
type: string
example:
id: String (identifier)
calculationMode: String
microsoft.graph.workbookNamedItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookNamedItem
type: object
properties:
comment:
type: string
nullable: true
name:
type: string
nullable: true
scope:
type: string
type:
type: string
nullable: true
value:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
visible:
type: boolean
worksheet:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookWorksheet'
nullable: true
example:
id: String (identifier)
comment: String
name: String
scope: String
type: String
value:
'@odata.type': microsoft.graph.Json
visible: true
worksheet:
'@odata.type': microsoft.graph.workbookWorksheet
microsoft.graph.workbookTable:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookTable
type: object
properties:
highlightFirstColumn:
type: boolean
highlightLastColumn:
type: boolean
name:
type: string
nullable: true
showBandedColumns:
type: boolean
showBandedRows:
type: boolean
showFilterButton:
type: boolean
showHeaders:
type: boolean
showTotals:
type: boolean
style:
type: string
nullable: true
columns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookTableColumn'
rows:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookTableRow'
sort:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookTableSort'
nullable: true
worksheet:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookWorksheet'
nullable: true
example:
id: String (identifier)
highlightFirstColumn: true
highlightLastColumn: true
name: String
showBandedColumns: true
showBandedRows: true
showFilterButton: true
showHeaders: true
showTotals: true
style: String
columns:
- '@odata.type': microsoft.graph.workbookTableColumn
rows:
- '@odata.type': microsoft.graph.workbookTableRow
sort:
'@odata.type': microsoft.graph.workbookTableSort
worksheet:
'@odata.type': microsoft.graph.workbookWorksheet
microsoft.graph.workbookWorksheet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookWorksheet
type: object
properties:
name:
type: string
nullable: true
position:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
visibility:
type: string
charts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookChart'
names:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookNamedItem'
pivotTables:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookPivotTable'
protection:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookWorksheetProtection'
nullable: true
tables:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookTable'
example:
id: String (identifier)
name: String
position: Int32
visibility: String
charts:
- '@odata.type': microsoft.graph.workbookChart
names:
- '@odata.type': microsoft.graph.workbookNamedItem
pivotTables:
- '@odata.type': microsoft.graph.workbookPivotTable
protection:
'@odata.type': microsoft.graph.workbookWorksheetProtection
tables:
- '@odata.type': microsoft.graph.workbookTable
microsoft.graph.workbookFunctions:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookFunctions
type: object
example:
id: String (identifier)
microsoft.graph.workbookSessionInfo:
title: workbookSessionInfo
type: object
properties:
id:
type: string
nullable: true
persistChanges:
type: boolean
nullable: true
example:
id: String
persistChanges: true
microsoft.graph.Json:
title: Json
type: object
microsoft.graph.workbookChart:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChart
type: object
properties:
height:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
left:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
name:
type: string
nullable: true
top:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
width:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
axes:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartAxes'
nullable: true
dataLabels:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartDataLabels'
nullable: true
format:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartAreaFormat'
nullable: true
legend:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartLegend'
nullable: true
series:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookChartSeries'
title:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartTitle'
nullable: true
worksheet:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookWorksheet'
nullable: true
example:
id: String (identifier)
height: Double
left: Double
name: String
top: Double
width: Double
axes:
'@odata.type': microsoft.graph.workbookChartAxes
dataLabels:
'@odata.type': microsoft.graph.workbookChartDataLabels
format:
'@odata.type': microsoft.graph.workbookChartAreaFormat
legend:
'@odata.type': microsoft.graph.workbookChartLegend
series:
- '@odata.type': microsoft.graph.workbookChartSeries
title:
'@odata.type': microsoft.graph.workbookChartTitle
worksheet:
'@odata.type': microsoft.graph.workbookWorksheet
microsoft.graph.workbookChartAxes:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartAxes
type: object
properties:
categoryAxis:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartAxis'
nullable: true
seriesAxis:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartAxis'
nullable: true
valueAxis:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartAxis'
nullable: true
example:
id: String (identifier)
categoryAxis:
'@odata.type': microsoft.graph.workbookChartAxis
seriesAxis:
'@odata.type': microsoft.graph.workbookChartAxis
valueAxis:
'@odata.type': microsoft.graph.workbookChartAxis
microsoft.graph.workbookChartDataLabels:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartDataLabels
type: object
properties:
position:
type: string
nullable: true
separator:
type: string
nullable: true
showBubbleSize:
type: boolean
nullable: true
showCategoryName:
type: boolean
nullable: true
showLegendKey:
type: boolean
nullable: true
showPercentage:
type: boolean
nullable: true
showSeriesName:
type: boolean
nullable: true
showValue:
type: boolean
nullable: true
format:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartDataLabelFormat'
nullable: true
example:
id: String (identifier)
position: String
separator: String
showBubbleSize: true
showCategoryName: true
showLegendKey: true
showPercentage: true
showSeriesName: true
showValue: true
format:
'@odata.type': microsoft.graph.workbookChartDataLabelFormat
microsoft.graph.workbookChartAreaFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartAreaFormat
type: object
properties:
fill:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartFill'
nullable: true
font:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartFont'
nullable: true
example:
id: String (identifier)
fill:
'@odata.type': microsoft.graph.workbookChartFill
font:
'@odata.type': microsoft.graph.workbookChartFont
microsoft.graph.workbookChartLegend:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartLegend
type: object
properties:
overlay:
type: boolean
nullable: true
position:
type: string
nullable: true
visible:
type: boolean
format:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartLegendFormat'
nullable: true
example:
id: String (identifier)
overlay: true
position: String
visible: true
format:
'@odata.type': microsoft.graph.workbookChartLegendFormat
microsoft.graph.workbookChartSeries:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartSeries
type: object
properties:
name:
type: string
nullable: true
format:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartSeriesFormat'
nullable: true
points:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookChartPoint'
example:
id: String (identifier)
name: String
format:
'@odata.type': microsoft.graph.workbookChartSeriesFormat
points:
- '@odata.type': microsoft.graph.workbookChartPoint
microsoft.graph.workbookChartTitle:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartTitle
type: object
properties:
overlay:
type: boolean
nullable: true
text:
type: string
nullable: true
visible:
type: boolean
format:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartTitleFormat'
nullable: true
example:
id: String (identifier)
overlay: true
text: String
visible: true
format:
'@odata.type': microsoft.graph.workbookChartTitleFormat
microsoft.graph.workbookChartFill:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartFill
type: object
example:
id: String (identifier)
microsoft.graph.workbookChartFont:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartFont
type: object
properties:
bold:
type: boolean
nullable: true
color:
type: string
nullable: true
italic:
type: boolean
nullable: true
name:
type: string
nullable: true
size:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
nullable: true
underline:
type: string
nullable: true
example:
id: String (identifier)
bold: true
color: String
italic: true
name: String
size: Double
underline: String
microsoft.graph.workbookChartAxis:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartAxis
type: object
properties:
majorUnit:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
maximum:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
minimum:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
minorUnit:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
format:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartAxisFormat'
nullable: true
majorGridlines:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartGridlines'
nullable: true
minorGridlines:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartGridlines'
nullable: true
title:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartAxisTitle'
nullable: true
example:
id: String (identifier)
majorUnit:
'@odata.type': microsoft.graph.Json
maximum:
'@odata.type': microsoft.graph.Json
minimum:
'@odata.type': microsoft.graph.Json
minorUnit:
'@odata.type': microsoft.graph.Json
format:
'@odata.type': microsoft.graph.workbookChartAxisFormat
majorGridlines:
'@odata.type': microsoft.graph.workbookChartGridlines
minorGridlines:
'@odata.type': microsoft.graph.workbookChartGridlines
title:
'@odata.type': microsoft.graph.workbookChartAxisTitle
microsoft.graph.workbookChartAxisFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartAxisFormat
type: object
properties:
font:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartFont'
nullable: true
line:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartLineFormat'
nullable: true
example:
id: String (identifier)
font:
'@odata.type': microsoft.graph.workbookChartFont
line:
'@odata.type': microsoft.graph.workbookChartLineFormat
microsoft.graph.workbookChartGridlines:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartGridlines
type: object
properties:
visible:
type: boolean
format:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartGridlinesFormat'
nullable: true
example:
id: String (identifier)
visible: true
format:
'@odata.type': microsoft.graph.workbookChartGridlinesFormat
microsoft.graph.workbookChartAxisTitle:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartAxisTitle
type: object
properties:
text:
type: string
nullable: true
visible:
type: boolean
format:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartAxisTitleFormat'
nullable: true
example:
id: String (identifier)
text: String
visible: true
format:
'@odata.type': microsoft.graph.workbookChartAxisTitleFormat
microsoft.graph.workbookChartLineFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartLineFormat
type: object
properties:
color:
type: string
nullable: true
example:
id: String (identifier)
color: String
microsoft.graph.workbookChartAxisTitleFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartAxisTitleFormat
type: object
properties:
font:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartFont'
nullable: true
example:
id: String (identifier)
font:
'@odata.type': microsoft.graph.workbookChartFont
microsoft.graph.workbookChartDataLabelFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartDataLabelFormat
type: object
properties:
fill:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartFill'
nullable: true
font:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartFont'
nullable: true
example:
id: String (identifier)
fill:
'@odata.type': microsoft.graph.workbookChartFill
font:
'@odata.type': microsoft.graph.workbookChartFont
microsoft.graph.workbookChartGridlinesFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartGridlinesFormat
type: object
properties:
line:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartLineFormat'
nullable: true
example:
id: String (identifier)
line:
'@odata.type': microsoft.graph.workbookChartLineFormat
microsoft.graph.workbookChartLegendFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartLegendFormat
type: object
properties:
fill:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartFill'
nullable: true
font:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartFont'
nullable: true
example:
id: String (identifier)
fill:
'@odata.type': microsoft.graph.workbookChartFill
font:
'@odata.type': microsoft.graph.workbookChartFont
microsoft.graph.workbookChartPoint:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartPoint
type: object
properties:
value:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
format:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartPointFormat'
nullable: true
example:
id: String (identifier)
value:
'@odata.type': microsoft.graph.Json
format:
'@odata.type': microsoft.graph.workbookChartPointFormat
microsoft.graph.workbookChartPointFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartPointFormat
type: object
properties:
fill:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartFill'
nullable: true
example:
id: String (identifier)
fill:
'@odata.type': microsoft.graph.workbookChartFill
microsoft.graph.workbookChartSeriesFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartSeriesFormat
type: object
properties:
fill:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartFill'
nullable: true
line:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartLineFormat'
nullable: true
example:
id: String (identifier)
fill:
'@odata.type': microsoft.graph.workbookChartFill
line:
'@odata.type': microsoft.graph.workbookChartLineFormat
microsoft.graph.workbookChartTitleFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartTitleFormat
type: object
properties:
fill:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartFill'
nullable: true
font:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookChartFont'
nullable: true
example:
id: String (identifier)
fill:
'@odata.type': microsoft.graph.workbookChartFill
font:
'@odata.type': microsoft.graph.workbookChartFont
microsoft.graph.workbookFilter:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookFilter
type: object
properties:
criteria:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookFilterCriteria'
nullable: true
example:
id: String (identifier)
criteria:
'@odata.type': microsoft.graph.workbookFilterCriteria
microsoft.graph.workbookFilterCriteria:
title: workbookFilterCriteria
type: object
properties:
color:
type: string
nullable: true
criterion1:
type: string
nullable: true
criterion2:
type: string
nullable: true
dynamicCriteria:
type: string
filterOn:
type: string
icon:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookIcon'
nullable: true
operator:
type: string
values:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
example:
color: String
criterion1: String
criterion2: String
dynamicCriteria: String
filterOn: String
icon:
'@odata.type': microsoft.graph.workbookIcon
operator: String
values:
'@odata.type': microsoft.graph.Json
microsoft.graph.workbookIcon:
title: workbookIcon
type: object
properties:
index:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
set:
type: string
example:
index: Int32
set: String
microsoft.graph.workbookFormatProtection:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookFormatProtection
type: object
properties:
formulaHidden:
type: boolean
nullable: true
locked:
type: boolean
nullable: true
example:
id: String (identifier)
formulaHidden: true
locked: true
microsoft.graph.workbookFunctionResult:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookFunctionResult
type: object
properties:
error:
type: string
nullable: true
value:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
example:
id: String (identifier)
error: String
value:
'@odata.type': microsoft.graph.Json
microsoft.graph.workbookPivotTable:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookPivotTable
type: object
properties:
name:
type: string
nullable: true
worksheet:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookWorksheet'
nullable: true
example:
id: String (identifier)
name: String
worksheet:
'@odata.type': microsoft.graph.workbookWorksheet
microsoft.graph.workbookRange:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookRange
type: object
properties:
address:
type: string
nullable: true
addressLocal:
type: string
nullable: true
cellCount:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
columnCount:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
columnHidden:
type: boolean
nullable: true
columnIndex:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
formulas:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
formulasLocal:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
formulasR1C1:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
hidden:
type: boolean
nullable: true
numberFormat:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
rowCount:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
rowHidden:
type: boolean
nullable: true
rowIndex:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
text:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
valueTypes:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
values:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
format:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookRangeFormat'
nullable: true
sort:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookRangeSort'
nullable: true
worksheet:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookWorksheet'
nullable: true
example:
id: String (identifier)
address: String
addressLocal: String
cellCount: Int32
columnCount: Int32
columnHidden: true
columnIndex: Int32
formulas:
'@odata.type': microsoft.graph.Json
formulasLocal:
'@odata.type': microsoft.graph.Json
formulasR1C1:
'@odata.type': microsoft.graph.Json
hidden: true
numberFormat:
'@odata.type': microsoft.graph.Json
rowCount: Int32
rowHidden: true
rowIndex: Int32
text:
'@odata.type': microsoft.graph.Json
valueTypes:
'@odata.type': microsoft.graph.Json
values:
'@odata.type': microsoft.graph.Json
format:
'@odata.type': microsoft.graph.workbookRangeFormat
sort:
'@odata.type': microsoft.graph.workbookRangeSort
worksheet:
'@odata.type': microsoft.graph.workbookWorksheet
microsoft.graph.workbookRangeFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookRangeFormat
type: object
properties:
columnWidth:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
nullable: true
horizontalAlignment:
type: string
nullable: true
rowHeight:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
nullable: true
verticalAlignment:
type: string
nullable: true
wrapText:
type: boolean
nullable: true
borders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookRangeBorder'
fill:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookRangeFill'
nullable: true
font:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookRangeFont'
nullable: true
protection:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookFormatProtection'
nullable: true
example:
id: String (identifier)
columnWidth: Double
horizontalAlignment: String
rowHeight: Double
verticalAlignment: String
wrapText: true
borders:
- '@odata.type': microsoft.graph.workbookRangeBorder
fill:
'@odata.type': microsoft.graph.workbookRangeFill
font:
'@odata.type': microsoft.graph.workbookRangeFont
protection:
'@odata.type': microsoft.graph.workbookFormatProtection
microsoft.graph.workbookRangeSort:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookRangeSort
type: object
example:
id: String (identifier)
microsoft.graph.workbookRangeBorder:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookRangeBorder
type: object
properties:
color:
type: string
nullable: true
sideIndex:
type: string
nullable: true
style:
type: string
nullable: true
weight:
type: string
nullable: true
example:
id: String (identifier)
color: String
sideIndex: String
style: String
weight: String
microsoft.graph.workbookRangeFill:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookRangeFill
type: object
properties:
color:
type: string
nullable: true
example:
id: String (identifier)
color: String
microsoft.graph.workbookRangeFont:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookRangeFont
type: object
properties:
bold:
type: boolean
nullable: true
color:
type: string
nullable: true
italic:
type: boolean
nullable: true
name:
type: string
nullable: true
size:
anyOf:
- type: number
- type: string
- enum:
- '-INF'
- INF
- NaN
format: double
nullable: true
underline:
type: string
nullable: true
example:
id: String (identifier)
bold: true
color: String
italic: true
name: String
size: Double
underline: String
microsoft.graph.workbookRangeView:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookRangeView
type: object
properties:
cellAddresses:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
columnCount:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
formulas:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
formulasLocal:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
formulasR1C1:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
index:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
numberFormat:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
rowCount:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
text:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
valueTypes:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
values:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
rows:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookRangeView'
example:
id: String (identifier)
cellAddresses:
'@odata.type': microsoft.graph.Json
columnCount: Int32
formulas:
'@odata.type': microsoft.graph.Json
formulasLocal:
'@odata.type': microsoft.graph.Json
formulasR1C1:
'@odata.type': microsoft.graph.Json
index: Int32
numberFormat:
'@odata.type': microsoft.graph.Json
rowCount: Int32
text:
'@odata.type': microsoft.graph.Json
valueTypes:
'@odata.type': microsoft.graph.Json
values:
'@odata.type': microsoft.graph.Json
rows:
- '@odata.type': microsoft.graph.workbookRangeView
microsoft.graph.workbookTableColumn:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookTableColumn
type: object
properties:
index:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
name:
type: string
nullable: true
values:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
filter:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookFilter'
nullable: true
example:
id: String (identifier)
index: Int32
name: String
values:
'@odata.type': microsoft.graph.Json
filter:
'@odata.type': microsoft.graph.workbookFilter
microsoft.graph.workbookTableRow:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookTableRow
type: object
properties:
index:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
values:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.Json'
nullable: true
example:
id: String (identifier)
index: Int32
values:
'@odata.type': microsoft.graph.Json
microsoft.graph.workbookTableSort:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookTableSort
type: object
properties:
fields:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookSortField'
nullable: true
matchCase:
type: boolean
method:
type: string
example:
id: String (identifier)
fields:
- '@odata.type': microsoft.graph.workbookSortField
matchCase: true
method: String
microsoft.graph.workbookSortField:
title: workbookSortField
type: object
properties:
ascending:
type: boolean
color:
type: string
nullable: true
dataOption:
type: string
icon:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookIcon'
nullable: true
key:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
sortOn:
type: string
example:
ascending: true
color: String
dataOption: String
icon:
'@odata.type': microsoft.graph.workbookIcon
key: Int32
sortOn: String
microsoft.graph.workbookWorksheetProtection:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookWorksheetProtection
type: object
properties:
options:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookWorksheetProtectionOptions'
nullable: true
protected:
type: boolean
example:
id: String (identifier)
options:
'@odata.type': microsoft.graph.workbookWorksheetProtectionOptions
protected: true
microsoft.graph.workbookWorksheetProtectionOptions:
title: workbookWorksheetProtectionOptions
type: object
properties:
allowAutoFilter:
type: boolean
allowDeleteColumns:
type: boolean
allowDeleteRows:
type: boolean
allowFormatCells:
type: boolean
allowFormatColumns:
type: boolean
allowFormatRows:
type: boolean
allowInsertColumns:
type: boolean
allowInsertHyperlinks:
type: boolean
allowInsertRows:
type: boolean
allowPivotTables:
type: boolean
allowSort:
type: boolean
example:
allowAutoFilter: true
allowDeleteColumns: true
allowDeleteRows: true
allowFormatCells: true
allowFormatColumns: true
allowFormatRows: true
allowInsertColumns: true
allowInsertHyperlinks: true
allowInsertRows: true
allowPivotTables: true
allowSort: true
microsoft.graph.workbookFilterDatetime:
title: workbookFilterDatetime
type: object
properties:
date:
type: string
nullable: true
specificity:
type: string
example:
date: String
specificity: String
microsoft.graph.workbookRangeReference:
title: workbookRangeReference
type: object
properties:
address:
type: string
nullable: true
example:
address: String
microsoft.graph.subscription:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: subscription
type: object
properties:
resource:
type: string
changeType:
type: string
clientState:
type: string
nullable: true
notificationUrl:
type: string
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
format: date-time
example:
id: String (identifier)
resource: String
changeType: String
clientState: String
notificationUrl: String
expirationDateTime: DateTimeOffset (timestamp)
microsoft.graph.invitation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: invitation
type: object
properties:
invitedUserDisplayName:
type: string
nullable: true
invitedUserType:
type: string
nullable: true
invitedUserEmailAddress:
type: string
invitedUserMessageInfo:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.invitedUserMessageInfo'
nullable: true
sendInvitationMessage:
type: boolean
nullable: true
inviteRedirectUrl:
type: string
inviteRedeemUrl:
type: string
nullable: true
status:
type: string
nullable: true
invitedUser:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.user'
nullable: true
example:
id: String (identifier)
invitedUserDisplayName: String
invitedUserType: String
invitedUserEmailAddress: String
invitedUserMessageInfo:
'@odata.type': microsoft.graph.invitedUserMessageInfo
sendInvitationMessage: true
inviteRedirectUrl: String
inviteRedeemUrl: String
status: String
invitedUser:
'@odata.type': microsoft.graph.user
microsoft.graph.invitedUserMessageInfo:
title: invitedUserMessageInfo
type: object
properties:
ccRecipients:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.recipient'
nullable: true
messageLanguage:
type: string
nullable: true
customizedMessageBody:
type: string
nullable: true
example:
ccRecipients:
- '@odata.type': microsoft.graph.recipient
messageLanguage: String
customizedMessageBody: String
microsoft.graph.plannerTask:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerTask
type: object
properties:
createdBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
nullable: true
planId:
type: string
nullable: true
bucketId:
type: string
nullable: true
title:
type: string
orderHint:
type: string
nullable: true
assigneePriority:
type: string
nullable: true
percentComplete:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
startDateTime:
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
format: date-time
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
format: date-time
nullable: true
dueDateTime:
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
format: date-time
nullable: true
hasDescription:
type: boolean
nullable: true
previewType:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerPreviewType'
nullable: true
completedDateTime:
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
format: date-time
nullable: true
completedBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
nullable: true
referenceCount:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
checklistItemCount:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
activeChecklistItemCount:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
appliedCategories:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerAppliedCategories'
nullable: true
assignments:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerAssignments'
nullable: true
conversationThreadId:
type: string
nullable: true
details:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerTaskDetails'
nullable: true
assignedToTaskBoardFormat:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerAssignedToTaskBoardTaskFormat'
nullable: true
progressTaskBoardFormat:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerProgressTaskBoardTaskFormat'
nullable: true
bucketTaskBoardFormat:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerBucketTaskBoardTaskFormat'
nullable: true
example:
id: String (identifier)
createdBy:
'@odata.type': microsoft.graph.identitySet
planId: String
bucketId: String
title: String
orderHint: String
assigneePriority: String
percentComplete: Int32
startDateTime: DateTimeOffset (timestamp)
createdDateTime: DateTimeOffset (timestamp)
dueDateTime: DateTimeOffset (timestamp)
hasDescription: true
previewType:
'@odata.type': microsoft.graph.plannerPreviewType
completedDateTime: DateTimeOffset (timestamp)
completedBy:
'@odata.type': microsoft.graph.identitySet
referenceCount: Int32
checklistItemCount: Int32
activeChecklistItemCount: Int32
appliedCategories:
'@odata.type': microsoft.graph.plannerAppliedCategories
assignments:
'@odata.type': microsoft.graph.plannerAssignments
conversationThreadId: String
details:
'@odata.type': microsoft.graph.plannerTaskDetails
assignedToTaskBoardFormat:
'@odata.type': microsoft.graph.plannerAssignedToTaskBoardTaskFormat
progressTaskBoardFormat:
'@odata.type': microsoft.graph.plannerProgressTaskBoardTaskFormat
bucketTaskBoardFormat:
'@odata.type': microsoft.graph.plannerBucketTaskBoardTaskFormat
microsoft.graph.plannerPlan:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerPlan
type: object
properties:
createdBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
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
format: date-time
nullable: true
owner:
type: string
nullable: true
title:
type: string
tasks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
buckets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerBucket'
details:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerPlanDetails'
nullable: true
example:
id: String (identifier)
createdBy:
'@odata.type': microsoft.graph.identitySet
createdDateTime: DateTimeOffset (timestamp)
owner: String
title: String
tasks:
- '@odata.type': microsoft.graph.plannerTask
buckets:
- '@odata.type': microsoft.graph.plannerBucket
details:
'@odata.type': microsoft.graph.plannerPlanDetails
microsoft.graph.planner:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: planner
type: object
properties:
tasks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
plans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerPlan'
buckets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerBucket'
example:
id: String (identifier)
tasks:
- '@odata.type': microsoft.graph.plannerTask
plans:
- '@odata.type': microsoft.graph.plannerPlan
buckets:
- '@odata.type': microsoft.graph.plannerBucket
microsoft.graph.plannerBucket:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerBucket
type: object
properties:
name:
type: string
planId:
type: string
nullable: true
orderHint:
type: string
nullable: true
tasks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
example:
id: String (identifier)
name: String
planId: String
orderHint: String
tasks:
- '@odata.type': microsoft.graph.plannerTask
microsoft.graph.plannerAppliedCategories:
title: plannerAppliedCategories
type: object
microsoft.graph.plannerAssignments:
title: plannerAssignments
type: object
microsoft.graph.plannerTaskDetails:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerTaskDetails
type: object
properties:
description:
type: string
nullable: true
previewType:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerPreviewType'
nullable: true
references:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerExternalReferences'
nullable: true
checklist:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerChecklistItems'
nullable: true
example:
id: String (identifier)
description: String
previewType:
'@odata.type': microsoft.graph.plannerPreviewType
references:
'@odata.type': microsoft.graph.plannerExternalReferences
checklist:
'@odata.type': microsoft.graph.plannerChecklistItems
microsoft.graph.plannerAssignedToTaskBoardTaskFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerAssignedToTaskBoardTaskFormat
type: object
properties:
unassignedOrderHint:
type: string
nullable: true
orderHintsByAssignee:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerOrderHintsByAssignee'
nullable: true
example:
id: String (identifier)
unassignedOrderHint: String
orderHintsByAssignee:
'@odata.type': microsoft.graph.plannerOrderHintsByAssignee
microsoft.graph.plannerProgressTaskBoardTaskFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerProgressTaskBoardTaskFormat
type: object
properties:
orderHint:
type: string
nullable: true
example:
id: String (identifier)
orderHint: String
microsoft.graph.plannerBucketTaskBoardTaskFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerBucketTaskBoardTaskFormat
type: object
properties:
orderHint:
type: string
nullable: true
example:
id: String (identifier)
orderHint: String
microsoft.graph.plannerPlanDetails:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerPlanDetails
type: object
properties:
sharedWith:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerUserIds'
nullable: true
categoryDescriptions:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerCategoryDescriptions'
nullable: true
example:
id: String (identifier)
sharedWith:
'@odata.type': microsoft.graph.plannerUserIds
categoryDescriptions:
'@odata.type': microsoft.graph.plannerCategoryDescriptions
microsoft.graph.plannerExternalReference:
title: plannerExternalReference
type: object
properties:
alias:
type: string
nullable: true
type:
type: string
nullable: true
previewPriority:
type: string
nullable: true
lastModifiedBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
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
format: date-time
nullable: true
example:
alias: String
type: String
previewPriority: String
lastModifiedBy:
'@odata.type': microsoft.graph.identitySet
lastModifiedDateTime: DateTimeOffset (timestamp)
microsoft.graph.plannerChecklistItem:
title: plannerChecklistItem
type: object
properties:
isChecked:
type: boolean
nullable: true
title:
type: string
nullable: true
orderHint:
type: string
nullable: true
lastModifiedBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
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
format: date-time
nullable: true
example:
isChecked: true
title: String
orderHint: String
lastModifiedBy:
'@odata.type': microsoft.graph.identitySet
lastModifiedDateTime: DateTimeOffset (timestamp)
microsoft.graph.plannerAssignment:
title: plannerAssignment
type: object
properties:
assignedBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
nullable: true
assignedDateTime:
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
format: date-time
nullable: true
orderHint:
type: string
nullable: true
example:
assignedBy:
'@odata.type': microsoft.graph.identitySet
assignedDateTime: DateTimeOffset (timestamp)
orderHint: String
microsoft.graph.plannerExternalReferences:
title: plannerExternalReferences
type: object
microsoft.graph.plannerChecklistItems:
title: plannerChecklistItems
type: object
microsoft.graph.plannerOrderHintsByAssignee:
title: plannerOrderHintsByAssignee
type: object
microsoft.graph.plannerUserIds:
title: plannerUserIds
type: object
microsoft.graph.plannerCategoryDescriptions:
title: plannerCategoryDescriptions
type: object
properties:
category1:
type: string
nullable: true
category2:
type: string
nullable: true
category3:
type: string
nullable: true
category4:
type: string
nullable: true
category5:
type: string
nullable: true
category6:
type: string
nullable: true
example:
category1: String
category2: String
category3: String
category4: String
category5: String
category6: String
microsoft.graph.onenoteEntityBaseModel:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: onenoteEntityBaseModel
type: object
properties:
self:
type: string
nullable: true
example:
id: String (identifier)
self: String
microsoft.graph.onenoteEntitySchemaObjectModel:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityBaseModel'
- title: onenoteEntitySchemaObjectModel
type: object
properties:
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
format: date-time
nullable: true
example:
id: String (identifier)
self: String
createdDateTime: DateTimeOffset (timestamp)
microsoft.graph.onenoteEntityHierarchyModel:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntitySchemaObjectModel'
- title: onenoteEntityHierarchyModel
type: object
properties:
displayName:
type: string
nullable: true
createdBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
nullable: true
lastModifiedBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
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
format: date-time
nullable: true
example:
id: String (identifier)
self: String
createdDateTime: DateTimeOffset (timestamp)
displayName: String
createdBy:
'@odata.type': microsoft.graph.identitySet
lastModifiedBy:
'@odata.type': microsoft.graph.identitySet
lastModifiedDateTime: DateTimeOffset (timestamp)
microsoft.graph.notebook:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
- title: notebook
type: object
properties:
isDefault:
type: boolean
nullable: true
userRole:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteUserRole'
nullable: true
isShared:
type: boolean
nullable: true
sectionsUrl:
type: string
nullable: true
sectionGroupsUrl:
type: string
nullable: true
links:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.notebookLinks'
nullable: true
sections:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
sectionGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
example:
id: String (identifier)
self: String
createdDateTime: DateTimeOffset (timestamp)
displayName: String
createdBy:
'@odata.type': microsoft.graph.identitySet
lastModifiedBy:
'@odata.type': microsoft.graph.identitySet
lastModifiedDateTime: DateTimeOffset (timestamp)
isDefault: true
userRole:
'@odata.type': microsoft.graph.onenoteUserRole
isShared: true
sectionsUrl: String
sectionGroupsUrl: String
links:
'@odata.type': microsoft.graph.notebookLinks
sections:
- '@odata.type': microsoft.graph.onenoteSection
sectionGroups:
- '@odata.type': microsoft.graph.sectionGroup
microsoft.graph.onenoteSection:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
- title: onenoteSection
type: object
properties:
isDefault:
type: boolean
nullable: true
links:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sectionLinks'
nullable: true
pagesUrl:
type: string
nullable: true
parentNotebook:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.notebook'
nullable: true
parentSectionGroup:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sectionGroup'
nullable: true
pages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
example:
id: String (identifier)
self: String
createdDateTime: DateTimeOffset (timestamp)
displayName: String
createdBy:
'@odata.type': microsoft.graph.identitySet
lastModifiedBy:
'@odata.type': microsoft.graph.identitySet
lastModifiedDateTime: DateTimeOffset (timestamp)
isDefault: true
links:
'@odata.type': microsoft.graph.sectionLinks
pagesUrl: String
parentNotebook:
'@odata.type': microsoft.graph.notebook
parentSectionGroup:
'@odata.type': microsoft.graph.sectionGroup
pages:
- '@odata.type': microsoft.graph.onenotePage
microsoft.graph.sectionGroup:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
- title: sectionGroup
type: object
properties:
sectionsUrl:
type: string
nullable: true
sectionGroupsUrl:
type: string
nullable: true
parentNotebook:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.notebook'
nullable: true
parentSectionGroup:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sectionGroup'
nullable: true
sections:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
sectionGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
example:
id: String (identifier)
self: String
createdDateTime: DateTimeOffset (timestamp)
displayName: String
createdBy:
'@odata.type': microsoft.graph.identitySet
lastModifiedBy:
'@odata.type': microsoft.graph.identitySet
lastModifiedDateTime: DateTimeOffset (timestamp)
sectionsUrl: String
sectionGroupsUrl: String
parentNotebook:
'@odata.type': microsoft.graph.notebook
parentSectionGroup:
'@odata.type': microsoft.graph.sectionGroup
sections:
- '@odata.type': microsoft.graph.onenoteSection
sectionGroups:
- '@odata.type': microsoft.graph.sectionGroup
microsoft.graph.onenotePage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntitySchemaObjectModel'
- title: onenotePage
type: object
properties:
title:
type: string
nullable: true
createdByAppId:
type: string
nullable: true
links:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.pageLinks'
nullable: true
contentUrl:
type: string
nullable: true
content:
type: string
format: base64url
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
format: date-time
nullable: true
level:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
order:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
userTags:
type: array
items:
type: string
nullable: true
parentSection:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteSection'
nullable: true
parentNotebook:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.notebook'
nullable: true
example:
id: String (identifier)
self: String
createdDateTime: DateTimeOffset (timestamp)
title: String
createdByAppId: String
links:
'@odata.type': microsoft.graph.pageLinks
contentUrl: String
content: Stream
lastModifiedDateTime: DateTimeOffset (timestamp)
level: Int32
order: Int32
userTags:
- String
parentSection:
'@odata.type': microsoft.graph.onenoteSection
parentNotebook:
'@odata.type': microsoft.graph.notebook
microsoft.graph.onenoteResource:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityBaseModel'
- title: onenoteResource
type: object
properties:
content:
type: string
format: base64url
nullable: true
contentUrl:
type: string
nullable: true
example:
id: String (identifier)
self: String
content: Stream
contentUrl: String
microsoft.graph.operation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: operation
type: object
properties:
status:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.operationStatus'
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
format: date-time
nullable: true
lastActionDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
nullable: true
example:
id: String (identifier)
status:
'@odata.type': microsoft.graph.operationStatus
createdDateTime: DateTimeOffset (timestamp)
lastActionDateTime: DateTimeOffset (timestamp)
microsoft.graph.onenoteOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.operation'
- title: onenoteOperation
type: object
properties:
resourceLocation:
type: string
nullable: true
resourceId:
type: string
nullable: true
error:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteOperationError'
nullable: true
percentComplete:
type: string
nullable: true
example:
id: String (identifier)
status:
'@odata.type': microsoft.graph.operationStatus
createdDateTime: DateTimeOffset (timestamp)
lastActionDateTime: DateTimeOffset (timestamp)
resourceLocation: String
resourceId: String
error:
'@odata.type': microsoft.graph.onenoteOperationError
percentComplete: String
microsoft.graph.notebookLinks:
title: notebookLinks
type: object
properties:
oneNoteClientUrl:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.externalLink'
nullable: true
oneNoteWebUrl:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.externalLink'
nullable: true
example:
oneNoteClientUrl:
'@odata.type': microsoft.graph.externalLink
oneNoteWebUrl:
'@odata.type': microsoft.graph.externalLink
microsoft.graph.externalLink:
title: externalLink
type: object
properties:
href:
type: string
nullable: true
example:
href: String
microsoft.graph.sectionLinks:
title: sectionLinks
type: object
properties:
oneNoteClientUrl:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.externalLink'
nullable: true
oneNoteWebUrl:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.externalLink'
nullable: true
example:
oneNoteClientUrl:
'@odata.type': microsoft.graph.externalLink
oneNoteWebUrl:
'@odata.type': microsoft.graph.externalLink
microsoft.graph.pageLinks:
title: pageLinks
type: object
properties:
oneNoteClientUrl:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.externalLink'
nullable: true
oneNoteWebUrl:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.externalLink'
nullable: true
example:
oneNoteClientUrl:
'@odata.type': microsoft.graph.externalLink
oneNoteWebUrl:
'@odata.type': microsoft.graph.externalLink
microsoft.graph.onenoteOperationError:
title: onenoteOperationError
type: object
properties:
code:
type: string
nullable: true
message:
type: string
nullable: true
example:
code: String
message: String
microsoft.graph.diagnostic:
title: diagnostic
type: object
properties:
message:
type: string
nullable: true
url:
type: string
nullable: true
example:
message: String
url: String
microsoft.graph.onenotePatchContentCommand:
title: onenotePatchContentCommand
type: object
properties:
action:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenotePatchActionType'
target:
type: string
content:
type: string
nullable: true
position:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenotePatchInsertPosition'
nullable: true
example:
action:
'@odata.type': microsoft.graph.onenotePatchActionType
target: String
content: String
position:
'@odata.type': microsoft.graph.onenotePatchInsertPosition
microsoft.graph.onenotePagePreview:
title: onenotePagePreview
type: object
properties:
previewText:
type: string
nullable: true
links:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenotePagePreviewLinks'
nullable: true
example:
previewText: String
links:
'@odata.type': microsoft.graph.onenotePagePreviewLinks
microsoft.graph.onenotePagePreviewLinks:
title: onenotePagePreviewLinks
type: object
properties:
previewImageUrl:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.externalLink'
nullable: true
example:
previewImageUrl:
'@odata.type': microsoft.graph.externalLink
microsoft.graph.recentNotebook:
title: recentNotebook
type: object
properties:
displayName:
type: string
nullable: true
lastAccessedTime:
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
format: date-time
nullable: true
links:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.recentNotebookLinks'
nullable: true
sourceService:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteSourceService'
nullable: true
example:
displayName: String
lastAccessedTime: DateTimeOffset (timestamp)
links:
'@odata.type': microsoft.graph.recentNotebookLinks
sourceService:
'@odata.type': microsoft.graph.onenoteSourceService
microsoft.graph.recentNotebookLinks:
title: recentNotebookLinks
type: object
properties:
oneNoteClientUrl:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.externalLink'
nullable: true
oneNoteWebUrl:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.externalLink'
nullable: true
example:
oneNoteClientUrl:
'@odata.type': microsoft.graph.externalLink
oneNoteWebUrl:
'@odata.type': microsoft.graph.externalLink
microsoft.graph.reportRoot:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: reportRoot
type: object
example:
id: String (identifier)
microsoft.graph.report:
title: report
type: object
properties:
content:
type: string
format: base64url
nullable: true
example:
content: Stream
microsoft.graph.automaticRepliesStatus:
title: automaticRepliesStatus
enum:
- disabled
- alwaysEnabled
- scheduled
type: string
microsoft.graph.externalAudienceScope:
title: externalAudienceScope
enum:
- none
- contactsOnly
- all
type: string
microsoft.graph.attendeeType:
title: attendeeType
enum:
- required
- optional
- resource
type: string
microsoft.graph.freeBusyStatus:
title: freeBusyStatus
enum:
- free
- tentative
- busy
- oof
- workingElsewhere
- unknown
type: string
microsoft.graph.activityDomain:
title: activityDomain
enum:
- unknown
- work
- personal
- unrestricted
type: string
microsoft.graph.bodyType:
title: bodyType
enum:
- text
- html
type: string
microsoft.graph.importance:
title: importance
enum:
- low
- normal
- high
type: string
microsoft.graph.inferenceClassificationType:
title: inferenceClassificationType
enum:
- focused
- other
type: string
microsoft.graph.calendarColor:
title: calendarColor
enum:
- lightBlue
- lightGreen
- lightOrange
- lightGray
- lightYellow
- lightTeal
- lightPink
- lightBrown
- lightRed
- maxColor
- auto
type: string
microsoft.graph.responseType:
title: responseType
enum:
- none
- organizer
- tentativelyAccepted
- accepted
- declined
- notResponded
type: string
microsoft.graph.sensitivity:
title: sensitivity
enum:
- normal
- personal
- private
- confidential
type: string
microsoft.graph.recurrencePatternType:
title: recurrencePatternType
enum:
- daily
- weekly
- absoluteMonthly
- relativeMonthly
- absoluteYearly
- relativeYearly
type: string
microsoft.graph.dayOfWeek:
title: dayOfWeek
enum:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
type: string
microsoft.graph.weekIndex:
title: weekIndex
enum:
- first
- second
- third
- fourth
- last
type: string
microsoft.graph.recurrenceRangeType:
title: recurrenceRangeType
enum:
- endDate
- noEnd
- numbered
type: string
microsoft.graph.eventType:
title: eventType
enum:
- singleInstance
- occurrence
- exception
- seriesMaster
type: string
microsoft.graph.meetingMessageType:
title: meetingMessageType
enum:
- none
- meetingRequest
- meetingCancelled
- meetingAccepted
- meetingTenativelyAccepted
- meetingDeclined
type: string
microsoft.graph.phoneType:
title: phoneType
enum:
- home
- business
- mobile
- other
- assistant
- homeFax
- businessFax
- otherFax
- pager
- radio
type: string
microsoft.graph.websiteType:
title: websiteType
enum:
- other
- home
- work
- blog
- profile
type: string
microsoft.graph.plannerPreviewType:
title: plannerPreviewType
enum:
- automatic
- noPreview
- checklist
- description
- reference
type: string
microsoft.graph.operationStatus:
title: operationStatus
enum:
- NotStarted
- Running
- Completed
- Failed
type: string
microsoft.graph.onenotePatchInsertPosition:
title: onenotePatchInsertPosition
enum:
- After
- Before
type: string
microsoft.graph.onenotePatchActionType:
title: onenotePatchActionType
enum:
- Replace
- Append
- Delete
- Insert
- Prepend
type: string
microsoft.graph.onenoteSourceService:
title: onenoteSourceService
enum:
- Unknown
- OneDrive
- OneDriveForBusiness
- OnPremOneDriveForBusiness
type: string
microsoft.graph.onenoteUserRole:
title: onenoteUserRole
enum:
- Owner
- Contributor
- Reader
- None
type: string
odata.error:
required:
- error
type: object
properties:
error:
$ref: '#/components/schemas/odata.error.main'
odata.error.main:
required:
- code
- message
type: object
properties:
code:
type: string
message:
type: string
target:
type: string
details:
type: array
items:
$ref: '#/components/schemas/odata.error.detail'
innererror:
type: object
description: The structure of this object is service-specific
odata.error.detail:
required:
- code
- message
type: object
properties:
code:
type: string
message:
type: string
target:
type: string
responses:
error:
description: error
content:
application/json:
schema:
$ref: '#/components/schemas/odata.error'
parameters:
top:
name: $top
in: query
description: Show only the first n items
schema:
minimum: 0
type: integer
example: 50
skip:
name: $skip
in: query
description: Skip the first n items
schema:
minimum: 0
type: integer
count:
name: $count
in: query
description: Include count of items
schema:
type: boolean
filter:
name: $filter
in: query
description: Filter items by property values
schema:
type: string
search:
name: $search
in: query
description: Search items by search phrases
schema:
type: string
tags:
- name: directoryObjects.directoryObject
x-ms-docs-toc-type: page
- name: directoryObjects.Actions
x-ms-docs-toc-type: container
- name: directoryObjects.Functions
x-ms-docs-toc-type: container
- name: devices.device
x-ms-docs-toc-type: page
- name: domains.domain
x-ms-docs-toc-type: page
- name: domains.Actions
x-ms-docs-toc-type: container
- name: domainDnsRecords.domainDnsRecord
x-ms-docs-toc-type: page
- name: groups.group
x-ms-docs-toc-type: page
- name: groups.Functions
x-ms-docs-toc-type: container
- name: groups.Actions
x-ms-docs-toc-type: container
- name: directoryRoles.directoryRole
x-ms-docs-toc-type: page
- name: directoryRoleTemplates.directoryRoleTemplate
x-ms-docs-toc-type: page
- name: organization.organization
x-ms-docs-toc-type: page
- name: groupSettings.groupSetting
x-ms-docs-toc-type: page
- name: groupSettingTemplates.groupSettingTemplate
x-ms-docs-toc-type: page
- name: subscribedSkus.subscribedSku
x-ms-docs-toc-type: page
- name: users.user
x-ms-docs-toc-type: page
- name: users.Functions
x-ms-docs-toc-type: container
- name: users.Actions
x-ms-docs-toc-type: container
- name: contracts.contract
x-ms-docs-toc-type: page
- name: schemaExtensions.schemaExtension
x-ms-docs-toc-type: page
- name: drives.drive
x-ms-docs-toc-type: page
- name: drives.Functions
x-ms-docs-toc-type: container
- name: shares.sharedDriveItem
x-ms-docs-toc-type: page
- name: sites.site
x-ms-docs-toc-type: page
- name: sites.Functions
x-ms-docs-toc-type: container
- name: workbooks.driveItem
x-ms-docs-toc-type: page
- name: workbooks.Functions
x-ms-docs-toc-type: container
- name: workbooks.Actions
x-ms-docs-toc-type: container
- name: subscriptions.subscription
x-ms-docs-toc-type: page
- name: invitations.invitation
x-ms-docs-toc-type: page
- name: me.user
x-ms-docs-toc-type: page
- name: me.Actions
x-ms-docs-toc-type: container
- name: me.Functions
x-ms-docs-toc-type: container
- name: drive.drive
x-ms-docs-toc-type: page
- name: drive.Functions
x-ms-docs-toc-type: container
- name: planner.planner
x-ms-docs-toc-type: page
- name: reports.reportRoot
x-ms-docs-toc-type: page
- name: reports.Functions
x-ms-docs-toc-type: container