Show / Hide Table of Contents

Sites.Read.All

Allows the application to read documents and list items in all site collections on behalf of the signed-in user

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
V1 A,D DELETE /me/drive/following/{item-id}
V1 A,D DELETE /users/{user-id}/drive/following/{item-id}
V1 A,D GET /drive/items/{item-id}/content?format={format}
V1 A,D GET /drive/root:/{path and filename}:/content?format={format}
V1 A,D GET /drive/root/createdByUser/trendingAround
V1 A,D GET /drive/root/lastModifiedByUser/trendingAround
V1 A,D GET /drives/{drive-id}/activities
V1 A,D GET /drives/{drive-id}/items/{item-id}
V1 A,D GET /drives/{drive-id}/items/{item-id}/activities
V1 A,D GET /drives/{drive-id}/items/{item-id}/analytics
V1 A,D GET /drives/{drive-id}/items/{item-id}/analytics/allTime
V1 A,D GET /drives/{drive-id}/items/{item-id}/analytics/lastSevenDays
V1 A,D GET /drives/{drive-id}/items/{item-id}/children
V1 A,D GET /drives/{drive-id}/items/{item-id}/content
V1 A,D GET /drives/{drive-id}/items/{item-id}/getActivitiesByInterval(startDateTime='2017-01-01',endDateTime='2017-01-10',interval='day')
V1 A,D GET /drives/{drive-id}/items/{item-id}/permissions
V1 A,D GET /drives/{drive-id}/items/{item-id}/permissions/{perm-id}
V1 A,D GET /drives/{drive-id}/items/{item-id}/thumbnails
V1 A,D GET /drives/{drive-id}/items/{item-id}/versions
V1 A,D GET /drives/{drive-id}/items/{item-id}/versions/{version-id}
V1 A,D GET /drives/{drive-id}/items/{item-id}/versions/{version-id}/content
V1 A,D GET /drives/{drive-id}/root:/{item-path}
V1 A,D GET /drives/{drive-id}/root/delta
V1 A,D GET /drives/{drive-id}/root/search(q='{search-text}')
V1 A,D GET /groups/{group-id}/drive/items/{item-id}
V1 A,D GET /groups/{group-id}/drive/items/{item-id}/children
V1 A,D GET /groups/{group-id}/drive/items/{item-id}/content
V1 A,D GET /groups/{group-id}/drive/items/{item-id}/permissions
V1 A,D GET /groups/{group-id}/drive/items/{item-id}/permissions/{perm-id}
V1 A,D GET /groups/{group-id}/drive/items/{item-id}/thumbnails
V1 A,D GET /groups/{group-id}/drive/items/{item-id}/versions
V1 A,D GET /groups/{group-id}/drive/items/{item-id}/versions/{version-id}
V1 A,D GET /groups/{group-id}/drive/items/{item-id}/versions/{version-id}/content
V1 A,D GET /groups/{group-id}/drive/root:/{item-path}
V1 A,D GET /groups/{group-id}/drive/root/search(q='{search-text}')
V1 A,D GET /groups/{groupId}/drive/root/delta
V1 A,D GET /groups/{groupId}/drives
V1 A,D GET /me/drive
V1 A,D GET /me/drive/following
V1 A,D GET /me/drive/items/{id}/workbook/worksheets/{id|name}/names
V1 A,D GET /me/drive/items/{item-id}
V1 A,D GET /me/drive/items/{item-id}/children
V1 A,D GET /me/drive/items/{item-id}/content
V1 A,D GET /me/drive/items/{item-id}/permissions
V1 A,D GET /me/drive/items/{item-id}/permissions/{perm-id}
V1 A,D GET /me/drive/items/{item-id}/thumbnails
V1 A,D GET /me/drive/items/{item-id}/versions
V1 A,D GET /me/drive/items/{item-id}/versions/{version-id}
V1 A,D GET /me/drive/items/{item-id}/versions/{version-id}/content
V1 A,D GET /me/drive/recent
V1 A,D GET /me/drive/root:/{item-path}
V1 A,D GET /me/drive/root:/{item-path}:/content
V1 A,D GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/names
V1 A,D GET /me/drive/root:/{path}:/permissions
V1 A,D GET /me/drive/root/delta
V1 A,D GET /me/drive/root/search(q='{search-text}')
V1 A,D GET /me/drive/sharedWithMe
V1 A,D GET /me/drive/special/{name}
V1 D GET /me/followedSites
V1 A,D GET /me/insights/shared
V1 A,D GET /me/insights/trending
V1 A,D GET /me/insights/used
V1 A,D GET /me/trendingAround
V1 A,D GET /shares/{shareIdOrEncodedSharingUrl}/driveItem/content
V1 A,D GET /sites
V1 A,D GET /sites?$filter=siteCollection/root ne null
V1 A,D GET /sites?search={query}
V1 A,D GET /sites/{hostname}:/{relative-path}
V1 A,D GET /sites/{site-id}/analytics
V1 A,D GET /sites/{site-id}/analytics/allTime
V1 A,D GET /sites/{site-id}/analytics/lastSevenDays
V1 A,D GET /sites/{site-id}/columns
V1 A,D GET /sites/{site-id}/columns/{column-id}
V1 A,D GET /sites/{site-id}/contentTypes
V1 A,D GET /sites/{site-id}/contentTypes/{contentType-id}
V1 A,D GET /sites/{site-id}/contentTypes/{contentType-id}/columns
V1 A,D GET /sites/{site-id}/contentTypes/{contentType-id}/columns/{column-id}
V1 A,D GET /sites/{site-id}/drive/items/{item-id}
V1 A,D GET /sites/{site-id}/drive/items/{item-id}/children
V1 A,D GET /sites/{site-id}/drive/items/{item-id}/permissions/{perm-id}
V1 A,D GET /sites/{site-id}/drive/items/{item-id}/thumbnails
V1 A,D GET /sites/{site-id}/drive/items/{item-id}/versions
V1 A,D GET /sites/{site-id}/drive/items/{item-id}/versions/{version-id}
V1 A,D GET /sites/{site-id}/drive/items/{item-id}/versions/{version-id}/content
V1 A,D GET /sites/{site-id}/drive/root:/{item-path}
V1 A,D GET /sites/{site-id}/drive/root/search(q='{search-text}')
V1 A,D GET /sites/{site-id}/getActivitiesByInterval(startDateTime='2016-01-01',endDateTime='2017-05-20',interval='month')
V1 A,D GET /sites/{site-id}/getActivitiesByInterval(startDateTime='2016',endDateTime='2017',interval='month')
V1 A,D GET /sites/{site-id}/items/{item-id}/versions
V1 A,D GET /sites/{site-id}/items/{item-id}/versions/{version-id}
V1 A,D GET /sites/{site-id}/lists
V1 A,D GET /sites/{site-id}/lists/{list-id}/activities
V1 A,D GET /sites/{site-id}/lists/{list-id}/columns
V1 A,D GET /sites/{site-id}/lists/{list-id}/columns/{column-id}
V1 A,D GET /sites/{site-id}/lists/{list-id}/contentTypes
V1 A,D GET /sites/{site-id}/lists/{list-id}/contentTypes/{contentType-id}
V1 A,D GET /sites/{site-id}/lists/{list-id}/contentTypes/{contentType-id}/columns
V1 A,D GET /sites/{site-id}/lists/{list-id}/contentTypes/{contentType-id}/columns/{column-id}
V1 A,D GET /sites/{site-id}/lists/{list-id}/items
V1 A,D GET /sites/{site-id}/lists/{list-id}/items?expand=fields
V1 A,D GET /sites/{site-id}/lists/{list-id}/items?expand=fields(select=Column1,Column2)
V1 A,D GET /sites/{site-id}/lists/{list-id}/items/{item-id}
V1 A,D GET /sites/{site-id}/lists/{list-id}/items/{item-id}?expand=fields
V1 A,D GET /sites/{site-id}/lists/{list-id}/items/{item-id}?expand=fields(select=Column1,Column2)
V1 A,D GET /sites/{site-id}/lists/{list-id}/items/{item-id}/activities
V1 A,D GET /sites/{site-id}/lists/{list-id}/items/{item-id}/analytics
V1 A,D GET /sites/{site-id}/lists/{list-id}/items/{item-id}/analytics/allTime
V1 A,D GET /sites/{site-id}/lists/{list-id}/items/{item-id}/analytics/lastSevenDays
V1 A,D GET /sites/{site-id}/lists/{list-id}/items/{item-id}/driveItem
V1 A,D GET /sites/{site-id}/lists/{list-id}/items/{item-id}/getActivitiesByInterval(startDateTime='2017-05-01',endDateTime='2017-05-20',interval='week')
V1 A,D GET /sites/{site-id}/lists/{list-id}/items/{item-id}/versions
V1 A,D GET /sites/{site-id}/lists/{list-id}/items/{item-id}/versions/{version-id}
V1 A,D GET /sites/{site-id}/pages
V1 A,D GET /sites/{site-id}/pages/{page-id}
V1 A,D GET /sites/{site-id}/sites
V1 A,D GET /sites/{siteId}/drive/items/{item-id}/content
V1 A,D GET /sites/{siteId}/drive/items/{itemId}
V1 A,D GET /sites/{siteId}/drive/items/{itemId}/permissions
V1 A,D GET /sites/{siteId}/drive/root:/{item-path}
V1 A,D GET /sites/{siteId}/drive/root/delta
V1 A,D GET /sites/{siteId}/getApplicableContentTypesForList
V1 A,D GET /sites/{siteId}/lists/{listId}/items/{itemId}/documentSetVersions
V1 A,D GET /sites/{siteId}/lists/{listId}/items/{itemId}/documentSetVersions/{documentSetVersionId}
V1 A,D GET /sites/{siteId}/lists/{listId}/items/delta
V1 A,D GET /sites/{siteId}/lists/{listId}/operations
V1 A,D GET /sites/{siteId}/lists/{listId}/operations/{richLongRunningOperation-ID}
V1 A,D GET /sites/{siteId}/operations
V1 A,D GET /sites/{siteId}/operations/{richLongRunningOperation-ID}
V1 A,D GET /sites/{siteId}/pages/{sitePageId}/getWebPartsByPosition(horizontalSectionId={horizontalSectionId},columnId={columnId},webPartIndex={webPartIndex},isInVerticalSection={isInVerticalSection})
V1 A,D GET /sites/{sitesId}/pages/{sitePageId}/canvasLayout/horizontalSections
V1 A,D GET /sites/{sitesId}/pages/{sitePageId}/canvasLayout/horizontalSections/{horizontalSectionId}
V1 A,D GET /sites/{sitesId}/pages/{sitePageId}/canvasLayout/horizontalSections/{horizontalSectionId}/columns
V1 A,D GET /sites/{sitesId}/pages/{sitePageId}/canvasLayout/horizontalSections/{horizontalSectionId}/columns/{horizontalSectionColumnId}
V1 A,D GET /sites/{sitesId}/pages/{sitePageId}/canvasLayout/horizontalSections/{horizontalSectionId}/columns/{horizontalSectionColumnId}/webparts
V1 A,D GET /sites/{sitesId}/pages/{sitePageId}/canvasLayout/horizontalSections/{horizontalSectionId}/columns/{horizontalSectionColumnId}/webparts/{webPartIndex}
V1 A,D GET /sites/{sitesId}/pages/{sitePageId}/canvasLayout/horizontalSections/{horizontalSectionId}/columns/{horizontalSectionColumnId}/webparts/{webPartIndex}/getPositionOfWebPart
V1 A,D GET /sites/{sitesId}/pages/{sitePageId}/canvasLayout/verticalSection
V1 A,D GET /sites/{sitesId}/pages/{sitePageId}/canvasLayout/verticalSection/webparts
V1 A,D GET /sites/{sitesId}/pages/{sitePageId}/canvasLayout/verticalSection/webparts/{webPartIndex}
V1 A,D GET /sites/{sitesId}/pages/{sitePageId}/canvasLayout/verticalSection/webparts/{webPartIndex}/getPositionOfWebPart
V1 A,D GET /sites/{sitesId}/pages/{sitePageId}/webparts
V1 A,D GET /sites/{sitesId}/pages/{sitePageId}/webParts/{webPartId}
V1 A,D GET /sites/{sitesId}/pages/{sitePageId}/webParts/{webPartId}/getPositionOfWebPart
V1 A,D GET /sites/{sitesId}/settings
V1 A,D GET /sites/contoso.sharepoint.com
V1 A,D GET /sites/root
V1 A,D GET /teams/{teamId}/channels/{channelId}/filesFolder
V1 A,D GET /users/{id | userPrincipalName}/insights/shared
V1 A,D GET /users/{id | userPrincipalName}/insights/trending
V1 A,D GET /users/{id | userPrincipalName}/trendingAround
V1 A,D GET /users/{user-id}/drive/items/{item-id}
V1 A,D GET /users/{user-id}/drive/items/{item-id}/children
V1 A,D GET /users/{user-id}/drive/items/{item-id}/permissions/{perm-id}
V1 A,D GET /users/{user-id}/drive/items/{item-id}/thumbnails
V1 A,D GET /users/{user-id}/drive/items/{item-id}/versions
V1 A,D GET /users/{user-id}/drive/items/{item-id}/versions/{version-id}
V1 A,D GET /users/{user-id}/drive/items/{item-id}/versions/{version-id}/content
V1 A,D GET /users/{user-id}/drive/root:/{item-path}
V1 A,D GET /users/{user-id}/drive/root/search(q='{search-text}')
V1 A,D GET /users/{userId}/drive/items/{item-id}/content
V1 A,D GET /users/{userId}/drive/items/{itemId}
V1 A,D GET /users/{userId}/drive/items/{itemId}/permissions
V1 A,D GET /users/{userId}/drive/root:/{item-path}
V1 A,D GET /users/{userId}/drive/root/delta
V1 A,D GET https://graph.microsoft.com/beta/sites/{site-id}/lists/{list-id}
V1 A,D GET https://graph.microsoft.com/beta/sites/{site-id}/lists/{list-id}?expand=columns,items(expand=fields)
V1 A,D GET https://graph.microsoft.com/beta/sites/{site-id}/lists/{list-title}
V1 A,D GET https://graph.microsoft.com/v1.0/groups/02bd9fd6-8f93-4758-87c3-1fb73740a315/drives
V1 A,D GET https://graph.microsoft.com/v1.0/sites/{site-id}/lists
V1 A,D GET https://graph.microsoft.com/v1.0/sites/{site-id}/lists/{list-id}
V1 A,D GET https://graph.microsoft.com/v1.0/sites/{site-id}/lists/{list-id}?expand=columns,items(expand=fields)
V1 A,D GET https://graph.microsoft.com/v1.0/sites/{site-id}/lists/{list-id}/items
V1 A,D GET https://graph.microsoft.com/v1.0/sites/{site-id}/lists/{list-id}/items?expand=fields
V1 A,D GET https://graph.microsoft.com/v1.0/sites/{site-id}/lists/{list-id}/items?expand=fields(select=Column1,Column2)
V1 A,D GET https://graph.microsoft.com/v1.0/sites/{site-id}/lists/{list-id}/items/{item-id}
V1 A,D GET https://graph.microsoft.com/v1.0/sites/{site-id}/lists/{list-title}
V1 A,D POST /drives/{drive-id}/items/{item-id}/extractSensitivityLabels
V1 A,D POST /drives/{drive-id}/items/{item-id}/follow
V1 A,D POST /drives/{drive-id}/root:/{item-path}/extractSensitivityLabels
V1 A,D POST /drives/{driveId}/items/{itemId}/preview
V1 A,D POST /groups/{group-id}/drive/items/{item-id}/extractSensitivityLabels
V1 A,D POST /groups/{group-id}/drive/items/{item-id}/follow
V1 A,D POST /groups/{group-id}/drive/root:/{item-path}/extractSensitivityLabels
V1 A,D POST /groups/{groupId}/drive/items/{itemId}/preview
V1 A,D POST /me/drive/items/{id}/workbook/names/add
V1 A,D POST /me/drive/items/{id}/workbook/worksheets/{id|name}/names/add
V1 A,D POST /me/drive/items/{item-id}/extractSensitivityLabels
V1 A,D POST /me/drive/items/{item-id}/follow
V1 A,D POST /me/drive/items/{item-id}/unfollow
V1 A,D POST /me/drive/items/{itemId}/preview
V1 A,D POST /me/drive/root:/{item-path}:/workbook/names/add
V1 A,D POST /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/names/add
V1 A,D POST /me/drive/root:/{item-path}/extractSensitivityLabels
V1 A,D POST /search/query
V1 A,D POST /shares/{shareId}/driveItem/preview
V1 A,D POST /sites/{site-id}/drive/items/{item-id}/extractSensitivityLabels
V1 A,D POST /sites/{site-id}/drive/items/{item-id}/follow
V1 A,D POST /sites/{site-id}/drive/root:/{item-path}/extractSensitivityLabels
V1 A,D POST /sites/{siteId}/drive/items/{itemId}/preview
V1 A,D POST /users/{user-id}/drive/items/{item-id}/extractSensitivityLabels
V1 A,D POST /users/{user-id}/drive/items/{item-id}/follow
V1 A,D POST /users/{user-id}/drive/items/{item-id}/unfollow
V1 A,D POST /users/{user-id}/drive/root:/{item-path}/extractSensitivityLabels
V1 A,D POST /users/{userId}/drive/items/{itemId}/preview

Delegate Permission

Id 205e70e5-aba6-4c52-a976-6d2d46c48043
Consent Type User
Display String Read items in all site collections
Description Allows the application to read documents and list items in all site collections on behalf of the signed-in user

Application Permission

Id 332a536c-c7ef-4017-ab91-336970924f0d
Display String Read items in all site collections
Description Allows the app to read documents and list items in all site collections without a signed in user.

Resources

contentType

Property Type Description
associatedHubsUrls Collection(string) List of canonical URLs for hub sites with which this content type is associated to. This will contain all hub sites where this content type is queued to be enforced or is already enforced. Enforcing a content type means that the content type will be applied to the lists in the enforced sites.
description string The descriptive text for the item.
documentSet documentSet][] [Document Set metadata.
documentTemplate [documentSetContent][] Document template metadata. To make sure that documents have consistent content across a site and its subsites, you can associate a Word, Excel, or PowerPoint template with a site content type.
group string The name of the group this content type belongs to. Helps organize related content types.
hidden Boolean Indicates whether the content type is hidden in the list's 'New' menu.
id string The unique identifier of the content type.
inheritedFrom [itemReference][] If this content type is inherited from another scope (like a site), provides a reference to the item where the content type is defined.
isBuiltIn Boolean Specifies if a content type is a built-in content type.
name string The name of the content type.
order [contentTypeOrder][] Specifies the order in which the content type appears in the selection UI.
parentId string The unique identifier of the content type.
propagateChanges Boolean If true, any changes made to the content type will be pushed to inherited content types and lists that implement the content type.
readOnly Boolean If true, the content type can't be modified unless this value is first set to false.
sealed Boolean If true, the content type can't be modified by users or through push-down operations. Only site collection administrators can seal or unseal content types.

deleted

Property Type Description
state String Represents the state of the deleted item.

documentSetVersion

Property Type Description
comment string Comment about the captured version.
createdBy identitySet User who captured the version.
createdDateTime dateTime Date and time when this version was created.
id string The ID of the version. Read-only. Inherited from listItemVersion.
items documentSetVersionItem collection Items within the document set that are captured as part of this version.
lastModifiedBy identitySet Identity of the user which last modified the version. Read-only. Inherited from listItemVersion.
lastModifiedDateTime dateTimeOffset Date and time when the version was last modified. Read-only. Inherited from listItemVersion.
published publicationFacet Indicates the publication status of this particular version. Read-only. Inherited from listItemVersion.
shouldCaptureMinorVersion boolean If true, minor versions of items are also captured; otherwise, only major versions will be captured. Default value is false.

drive

Property Type Description
createdBy [identitySet][] Identity of the user, device, or application which created the item. Read-only.
createdDateTime dateTimeOffset Date and time of item creation. Read-only.
description String Provide a user-visible description of the drive. Read-write.
driveType String Describes the type of drive represented by this resource. OneDrive personal drives will return personal. OneDrive for Business will return business. SharePoint document libraries will return documentLibrary. Read-only.
id String The unique identifier of the drive. Read-only.
lastModifiedBy [identitySet][] Identity of the user, device, and application which last modified the item. Read-only.
lastModifiedDateTime dateTimeOffset Date and time the item was last modified. Read-only.
name string The name of the item. Read-write.
owner identitySet Optional. The user account that owns the drive. Read-only.
quota quota Optional. Information about the drive's storage space quota. Read-only.
sharepointIds [sharepointIds][] Returns identifiers useful for SharePoint REST compatibility. Read-only. This property is not returned by default and must be selected using the $select query parameter.
system [systemFacet][] If present, indicates that this is a system-managed drive. Read-only.
webUrl string (url) URL that displays the resource in the browser. Read-only.

driveItem

Property Type Description
audio [audio][] Audio metadata, if the item is an audio file. Read-only. Read-only. Only on OneDrive Personal.
bundle [bundle][] Bundle metadata, if the item is a bundle. Read-only.
content Stream The content stream, if the item represents a file.
createdBy [identitySet][] Identity of the user, device, and application which created the item. Read-only.
createdDateTime DateTimeOffset Date and time of item creation. Read-only.
cTag String An eTag for the content of the item. This eTag is not changed if only the metadata is changed. Note This property is not returned if the item is a folder. Read-only.
deleted [deleted][] Information about the deleted state of the item. Read-only.
description String Provides a user-visible description of the item. Read-write. Only on OneDrive Personal.
eTag String eTag for the entire item (metadata + content). Read-only.
file [file][] File metadata, if the item is a file. Read-only.
fileSystemInfo [fileSystemInfo][] File system information on client. Read-write.
folder [folder][] Folder metadata, if the item is a folder. Read-only.
id String The unique identifier of the item within the Drive. Read-only.
image [image][] Image metadata, if the item is an image. Read-only.
lastModifiedBy [identitySet][] Identity of the user, device, and application which last modified the item. Read-only.
lastModifiedDateTime DateTimeOffset Date and time the item was last modified. Read-only.
location [geoCoordinates][] Location metadata, if the item has location data. Read-only.
malware [malware][] Malware metadata, if the item was detected to contain malware. Read-only.
name String The name of the item (filename and extension). Read-write.
package [package][] If present, indicates that this item is a package instead of a folder or file. Packages are treated like files in some contexts and folders in others. Read-only.
parentReference [itemReference][] Parent information, if the item has a parent. Read-write.
pendingOperations [pendingOperations][] If present, indicates that one or more operations that might affect the state of the driveItem are pending completion. Read-only.
photo [photo][] Photo metadata, if the item is a photo. Read-only.
publication [publicationFacet][] Provides information about the published or checked-out state of an item, in locations that support such actions. This property is not returned by default. Read-only.
remoteItem [remoteItem][] Remote item data, if the item is shared from a drive other than the one being accessed. Read-only.
root [root][] If this property is non-null, it indicates that the driveItem is the top-most driveItem in the drive.
searchResult [searchResult][] Search metadata, if the item is from a search result. Read-only.
shared [shared][] Indicates that the item has been shared with others and provides information about the shared state of the item. Read-only.
sharepointIds [sharepointIds][] Returns identifiers useful for SharePoint REST compatibility. Read-only.
size Int64 Size of the item in bytes. Read-only.
specialFolder [specialFolder][] If the current item is also available as a special folder, this facet is returned. Read-only.
video [video][] Video metadata, if the item is a video. Read-only.
webDavUrl String WebDAV compatible URL for the item.
webUrl String URL that displays the resource in the browser. Read-only.

extractSensitivityLabelsResult

Property Type Description
labels sensitivityLabelAssignment collection List of sensitivity labels assigned to a file.

horizontalSection

Property Type Description
emphasis sectionEmphasisType Enumeration value that indicates the emphasis of the section background. The possible values are: none, netural, soft, strong, unknownFutureValue.
id String Unique identifier of the resource. Inherited from entity.
layout horizontalSectionLayoutType Layout type of the section. The possible values are: none, oneColumn, twoColumns, threeColumns, oneThirdLeftColumn, oneThirdRightColumn, fullWidth, unknownFutureValue.

horizontalSectionColumn

Property Type Description
id String Unique identifier of the resource. Inherited from entity.
width Int32 Width of the column. A horizontal section is divided into 12 grids. A column should have a value of 1-12 to represent its range spans. For example, there can be two columns both have a width of 6 in a section.

resourceVisualization

Property Type Description
title String The item's title text.
containerDisplayName String A string describing where the item is stored. For example, the name of a SharePoint site or the user name identifying the owner of the OneDrive storing the item.
containerType String Can be used for filtering by the type of container in which the file is stored. Such as Site or OneDriveBusiness.
containerWebUrl String A path leading to the folder in which the item is stored.
mediaType String The item's media type. Can be used for filtering for a specific type of file based on supported IANA Media Mime Types. Note that not all Media Mime Types are supported.
previewImageUrl String A URL leading to the preview image for the item.
previewText String A preview text for the item.
type String The item's media type. Can be used for filtering for a specific file based on a specific type. See below for supported types.

sharedInsight

Property Type Description
id String Unique identifier of the relationship. Read only.
lastShared sharingDetail Details about the shared item. Read only.
resourceReference resourceReference Reference properties of the shared document, such as the url and type of the document. Read-only
resourceVisualization resourceVisualization Properties that you can use to visualize the document in your experience. Read-only

sharingDetail

Property Type Description
sharedBy insightIdentity The user who shared the document.
sharedDateTime DateTimeOffset The date and time the file was last shared. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
sharingSubject String The subject with which the document was shared.
sharingType String Determines the way the document was shared, can be by a "Link", "Attachment", "Group", "Site".
sharingReference resourceReference

trending

Property Type Description
id String Unique identifier of the relationship. Read only.
lastModifiedDateTime DateTimeOffset
resourceReference resourceReference Reference properties of the trending document, such as the url and type of the document.
resourceVisualization resourceVisualization Properties that you can use to visualize the document in your experience.
weight Double Value indicating how much the document is currently trending. The larger the number, the more the document is currently trending around the user (the more relevant it is). Returned documents are sorted by this value.

usedInsight

Property Type Description
id String Unique identifier of the relationship. Read only.
lastUsed usageDetails Information about when the item was last viewed or modified by the user. Read only.
resourceReference resourceReference Reference properties of the used document, such as the url and type of the document. Read-only
resourceVisualization resourceVisualization Properties that you can use to visualize the document in your experience. Read-only

itemActivity

Property Type Description
access [accessAction][] An item was accessed.
activityDateTime DateTimeOffset Details about when the activity took place. Read-only.
actor [identitySet][] Identity of who performed the action. Read-only.
id string The unique identifier of the activity. Read-only.

itemActivityStat

Property Type Description
access [itemActionStat][] Statistics about the access actions in this interval. Read-only.
create [itemActionStat][] Statistics about the create actions in this interval. Read-only.
delete [itemActionStat][] Statistics about the delete actions in this interval. Read-only.
edit [itemActionStat][] Statistics about the edit actions in this interval. Read-only.
endDateTime DateTimeOffset When the interval ends. Read-only.
incompleteData [incompleteData][] Indicates that the statistics in this interval are based on incomplete data. Read-only.
isTrending Boolean Indicates whether the item is "trending." Read-only.
move [itemActionStat][] Statistics about the move actions in this interval. Read-only.
startDateTime DateTimeOffset When the interval starts. Read-only.

itemAnalytics

Property Type Description
allTime [itemActivityStat][] Analytics over the item's lifespan.
lastSevenDays [itemActivityStat][] Analytics for the last seven days.

ItemReference

Property Type Description
driveId String Unique identifier of the drive instance that contains the item. Read-only.
driveType String Identifies the type of drive. See [drive][] resource for values.
id String Unique identifier of the item in the drive. Read-only.
name String The name of the item being referenced. Read-only.
path String Path that can be used to navigate to the item. Read-only.
shareId String A unique identifier for a shared resource that can be accessed via the [Shares][] API.
sharepointIds [sharepointIds][] Returns identifiers useful for SharePoint REST compatibility. Read-only.
siteId String For OneDrive for Business and SharePoint, this property represents the ID of the site that contains the parent document library of the driveItem resource. The value is the same as the id property of that site][] resource. It is an [opaque string that consists of three identifiers of the site.
For OneDrive, this property is not populated.

list

listitem

Property Type Description
contentType [contentTypeInfo][] The content type of this list item

ListItemVersion

NamedItem

Property Type Description
comment string Represents the comment associated with this name.
name string The name of the object. Read-only.
scope string Indicates whether the name is scoped to the workbook or to a specific worksheet. Read-only.
type string Indicates what type of reference is associated with the name. The possible values are: String, Integer, Double, Boolean, Range. Read-only.
value Json Represents the formula that the name is defined to refer to. E.g. =Sheet14!$B$2:$H$12, =4.75, etc. Read-only.
visible boolean Specifies whether the object is visible or not.

Permission

Property Type Description
expirationDateTime DateTimeOffset A format of yyyy-MM-ddTHH:mm:ssZ of DateTimeOffset indicates the expiration time of the permission. DateTime.MinValue indicates there is no expiration set for this permission. Optional.
id String The unique identifier of the permission among all permissions on the item. Read-only.
hasPassword Boolean Indicates whether the password is set for this permission. This property only appears in the response. Optional. Read-only. For OneDrive Personal only..
grantedTo (deprecated) IdentitySet For user type permissions, the details of the users and applications for this permission. Read-only.
grantedToIdentities (deprecated) Collection(IdentitySet) For type permissions, the details of the users to whom permission was granted. Read-only.
grantedToIdentitiesV2 Collection([SharePointIdentitySet][]) For link type permissions, the details of the users to whom permission was granted. Read-only.
grantedToV2 [SharePointIdentitySet][] For user type permissions, the details of the users and applications for this permission. Read-only.
inheritedFrom ItemReference Provides a reference to the ancestor of the current permission, if it is inherited from an ancestor. Read-only.
invitation [SharingInvitation][] Details of any associated sharing invitation for this permission. Read-only.
link [SharingLink][] Provides the link details of the current permission, if it is a link type permissions. Read-only.
roles Collection of String The type of permission, for example, read. See below for the full list of roles. Read-only.
shareId String A unique token that can be used to access this shared item via the shares API. Read-only.

remoteItem

richLongRunningOperation

Property Type Description
createdDateTime DateTimeOffset The date and time when this operation was created.
error publicError Error that caused the operation to fail.
id String Unique identifier for the operation. Inherited from entity.
lastActionDateTime DateTimeOffset The date and time when the last action was performed on this operation.
percentageComplete Int32 A value between 0 and 100 that indicates the progress of the operation.
resourceId String The unique identifier for the result.
resourceLocation String The canonical URL of the resource.
status longRunningOperationStatus The status of the long-running operation. Possible values are: notStarted, running, succeeded, failed, unknownFutureValue.
statusDetail String The detail about the status value.
type String The type of the operation.

search-api-overview

searchRequest

Property Type Description
aggregationFilters String collection Contains one or more filters to obtain search results aggregated and filtered to a specific value of a field. Optional.
Build this filter based on a prior search that aggregates by the same field. From the response of the prior search, identify the searchBucket that filters results to the specific value of the field, use the string in its aggregationFilterToken property, and build an aggregation filter string in the format "{field}:\"{aggregationFilterToken}\"".
If multiple values for the same field need to be provided, use the strings in its aggregationFilterToken property and build an aggregation filter string in the format "{field}:or(\"{aggregationFilterToken1}\",\"{aggregationFilterToken2}\")".
For example, searching and aggregating drive items by file type returns a searchBucket for the file type docx in the response. You can conveniently use the aggregationFilterToken returned for this searchBucket in a subsequent search query and filter matches down to drive items of the docx file type. Example 1 and example 2 show the actual requests and responses.
aggregations aggregationOption collection Specifies aggregations (also known as refiners) to be returned alongside search results. Optional.
contentSources String collection Contains the connection to be targeted.
enableTopResults Boolean This triggers hybrid sort for messages : the first 3 messages are the most relevant. This property is only applicable to entityType=message. Optional.
entityTypes entityType collection One or more types of resources expected in the response. Possible values are: list, site, listItem, message, event, drive, driveItem, externalItem. See known limitations for those combinations of two or more entity types that are supported in the same search request. Required.
fields String collection Contains the fields to be returned for each resource object specified in entityTypes, allowing customization of the fields returned by default; otherwise, including additional fields such as custom managed properties from SharePoint and OneDrive, or custom fields in externalItem from the content that Microsoft Graph connectors bring in. The fields property can use the semantic labels applied to properties. For example, if a property is labeled as title, you can retrieve it using the following syntax: label_title. Optional.
from Int32 Specifies the offset for the search results. Offset 0 returns the very first result. Optional.
query searchQuery Contains the query terms. Required.
queryAlterationOptions searchAlterationOptions Query alteration options formatted in a JSON blob that contains two optional flags related to spelling correction. Optional.
resultTemplateOptions resultTemplateOption collection Provides the search result template options to render search results from connectors.
size Int32 The size of the page to be retrieved.The maximum value is 1000. Optional.
sortProperties sortProperty collection Contains the ordered collection of fields and direction to sort results. There can be at most 5 sort properties in the collection. Optional.

searchResponse

Property Type Description
hitsContainers searchHitsContainer collection A collection of search results.
queryAlterationResponse alterationResponse Provides information related to spelling corrections in the alteration response.
resultTemplates resultTemplate collection A dictionary of resultTemplateIds and associated values, which include the name and JSON schema of the result templates.
searchTerms String collection Contains the search terms sent in the initial search query.

sharingInvitation

sharingLink

Property Type Description
application [identity][] The app the link is associated with.
preventsDownload Boolean If true then the user can only use this link to view the item on the web, and cannot use it to download the contents of the item. Only for OneDrive for Business and SharePoint.
scope String The scope of the link represented by this permission. Value anonymous indicates the link is usable by anyone, organization indicates the link is only usable for users signed into the same tenant.
type String The type of the link created.
webHtml String For embed links, this property contains the HTML code for an <iframe> element that will embed the item in a webpage.
webUrl String A URL that opens the item in the browser on the OneDrive website.

site

Property Type Description
createdDateTime DateTimeOffset The date and time the item was created. Read-only.
description string The descriptive text for the site.
displayName string The full title for the site. Read-only.
eTag string ETag for the item. Read-only.
id string The unique identifier of the item. Read-only.
lastModifiedDateTime DateTimeOffset The date and time the item was last modified. Read-only.
name string The name / title of the item.
root root If present, indicates that this is the root site in the site collection. Read-only.
sharepointIds sharepointIds Returns identifiers useful for SharePoint REST compatibility. Read-only.
siteCollection siteCollection Provides details about the site's site collection. Available only on the root site. Read-only.
webUrl string (url) URL that displays the item in the browser. Read-only.

sitePage

Property Type Description
contentType contentTypeInfo Inherited from baseItem.
createdBy identitySet Inherited from baseItem.
createdDateTime DateTimeOffset Inherited from baseItem.
description String Inherited from baseItem.
eTag String Inherited from baseItem.
id String Inherited from entity.
lastModifiedBy identitySet Inherited from baseItem.
lastModifiedDateTime DateTimeOffset Inherited from baseItem.
name String Inherited from baseItem.
pageLayout pageLayoutType The name of the page layout of the page. The possible values are: microsoftReserved, article, home, unknownFutureValue.
parentReference itemReference Inherited from baseItem.
promotionKind pagePromotionType Indicates the promotion kind of the sitePage. The possible values are: microsoftReserved, page, newsPost, unknownFutureValue.
publishingState publicationFacet The publishing status and the MM.mm version of the page.
reactions reactionsFacet Reactions information for the page.
showComments Boolean Determines whether or not to show comments at the bottom of the page.
showRecommendedPages Boolean Determines whether or not to show recommended pages at the bottom of the page.
thumbnailWebUrl String Url of the sitePage's thumbnail image
title String Title of the sitePage.
titleArea titleArea Title area on the SharePoint page.
webUrl String Inherited from baseItem.

siteSettings

Property Type Description
languageTag String The language tag for the language used on this site.
timeZone String Indicates the time offset for the time zone of the site from Coordinated Universal Time (UTC).

standardWebPart

Property Type Description
data webPartData Data of the webPart.
id String Instance identifier of the webPart. Inherited from entity.
webPartType String A Guid which indicates the type of the webParts

systemfacet

textWebPart

Property Type Description
id String Instance identifier of the web part. Inherited from entity.
innerHtml String The HTML string in text web part.

Thumbnail

Property Type Description
content Stream The content stream for the thumbnail.
height Int32 The height of the thumbnail, in pixels.
sourceItemId String The unique identifier of the item that provided the thumbnail. This is only available when a folder thumbnail is requested.
url String The URL used to fetch the thumbnail content.
width Int32 The width of the thumbnail, in pixels.

ThumbnailSet

Property Type Description
id String The id within the item. Read-only.
large Thumbnail A 1920x1920 scaled thumbnail.
medium Thumbnail A 176x176 scaled thumbnail.
small Thumbnail A 48x48 cropped thumbnail.
source Thumbnail A custom thumbnail image or the original image used to generate other thumbnails.

verticalSection

Property Type Description
emphasis sectionEmphasisType Enumeration value that indicates the emphasis of the section background. The possible values are: none, netural, soft, strong, unknownFutureValue.
id String Unique identifier of the resource. Inherited from entity.

webPart

Property Type Description
id String Unique instance identifier of the web part. Inherited from entity.

webPartPosition

Property Type Description
columnId Double Indicates the identifier of the column where the web part is located.
horizontalSectionId Double Indicates the horizontal section where the web part is located.
isInVerticalSection boolean Indicates whether the web part is located in the vertical section.
webPartIndex Double Index of the current web part. Represents the order of the web part in this column or section.

workbookNamedItem

Property Type Description
name string The name of the object. Read-only.
comment string Represents the comment associated with this name.
scope string Indicates whether the name is scoped to the workbook or to a specific worksheet. Read-only.
type string Indicates what type of reference is associated with the name. Possible values are: String, Integer, Double, Boolean, Range. Read-only.
value string Represents the formula that the name is defined to refer to. E.g. =Sheet14!$B$2:$H$12, =4.75, etc. Read-only.
visible boolean Specifies whether the object is visible or not.
In This Article
Back to top Created by merill | Submit feedback