Granting this permission allows the calling application to access (and/or update) the following information in your tenant.
Graph reference: channel
Property |
Type |
Description |
createdDateTime |
dateTimeOffset |
Read only. Timestamp at which the channel was created. |
description |
String |
Optional textual description for the channel. |
displayName |
String |
Channel name as it will appear to the user in Microsoft Teams. The maximum length is 50 characters. |
email |
String |
The email address for sending messages to the channel. Read-only. |
id |
String |
The channel's unique identifier. Read-only. |
isArchived |
Boolean |
Indicates whether the channel is archived. Read-only. |
isFavoriteByDefault |
Boolean |
Indicates whether the channel should be marked as recommended for all members of the team to show in their channel list. Note: All recommended channels automatically show in the channels list for education and frontline worker users. The property can only be set programmatically via the Create team method. The default value is false . |
membershipType |
channelMembershipType |
The type of the channel. Can be set during creation and can't be changed. The possible values are: standard , private , unknownFutureValue , shared . The default value is standard . Note that you must use the Prefer: include-unknown-enum-members request header to get the following value in this evolvable enum: shared . |
tenantId |
string |
The ID of the Microsoft Entra tenant. |
webUrl |
String |
A hyperlink that will go to the channel in Microsoft Teams. This is the URL that you get when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. Read-only. |
summary |
channelSummary |
Contains summary information about the channel, including number of owners, members, guests, and an indicator for members from other tenants. The **s |
Graph reference: deleted
Property |
Type |
Description |
state |
String |
Represents the state of the deleted item. |
Graph reference: 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 return personal . OneDrive for Business returns business . SharePoint document libraries 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 isn't returned by default and must be selected using the $select query parameter. |
system |
[systemFacet][] |
If present, indicates that it's a system-managed drive. Read-only. |
webUrl |
string (url) |
URL that displays the resource in the browser. Read-only. |
Graph reference: 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 that 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 isn't changed if only the metadata is changed. Note This property isn't 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 that 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 isn't 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 was 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. |
Graph reference: driveItemVersion
Property |
Type |
Description |
content |
Stream |
The content stream for this version of the item. |
id |
String |
The ID of the version. Read-only. |
lastModifiedBy |
identitySet |
Identity of the user who last modified the version. Read-only. |
lastModifiedDateTime |
DateTimeOffset |
Date and time when the version was last modified. Read-only. |
publication |
publicationFacet |
Indicates the publication status of this particular version. Read-only. |
size |
Int64 |
Indicates the size of the content stream for this version of the item. |
Graph reference: 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. |
Graph reference: 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. |
Graph reference: itemAnalytics
Property |
Type |
Description |
allTime |
[itemActivityStat][] |
Analytics over the item's lifespan. |
lastSevenDays |
[itemActivityStat][] |
Analytics for the last seven days. |
Graph reference: itemReference
Property |
Type |
Description |
driveId |
String |
Unique identifier of the drive instance that contains the driveItem. Only returned if the item is located in a [drive][]. Read-only. |
driveType |
String |
Identifies the type of drive. Only returned if the item is located in a [drive][]. See [drive][] resource for values. |
id |
String |
Unique identifier of the driveItem in the drive or a listItem in a list. Read-only. |
name |
String |
The name of the item being referenced. Read-only. |
path |
String |
Percent-encoded 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 or the parent list of the listItem 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. |
Graph reference: List
Property |
Type |
Description |
createdBy |
identitySet |
Identity of the creator of this item. Read-only. Inherited from baseItem. |
createdDateTime |
DateTimeOffset |
The date and time when the item was created. Read-only. Inherited from baseItem. |
description |
String |
The descriptive text for the item. Inherited from baseItem. |
displayName |
String |
The displayable title of the list. |
eTag |
String |
ETag for the item. Inherited from baseItem. |
id |
String |
The unique identifier of the item. Read-only. Inherited from baseItem. |
lastModifiedBy |
identitySet |
Identity of the last modifier of this item. Read-only. Inherited from baseItem. |
lastModifiedDateTime |
DateTimeOffset |
The date and time when the item was last modified. Read-only. Inherited from baseItem. |
list |
listInfo |
Contains more details about the list. |
name |
String |
The name of the item. Read-only. Inherited from baseItem. |
parentReference |
itemReference |
Parent information if the item has a parent. Read-write. Inherited from baseItem. |
sharepointIds |
sharepointIds |
Returns identifiers useful for SharePoint REST compatibility. Read-only. |
system |
systemFacet |
If present, indicates that the list is system-managed. Read-only. |
webUrl |
String |
URL that displays the item in the browser. Read-only. Inherited from baseItem. |
Graph reference: listItem
Property |
Type |
Description |
contentType |
[contentTypeInfo][] |
The content type of this list item |
Graph reference: 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's 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's 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's a link type permission. 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. |
Graph reference: recycleBin
Property |
Type |
Description |
id |
String |
The unique identifier for the recycleBin object. Returned only on $select . Inherited from baseItem. |
settings |
recycleBinSettings |
Settings of the recycleBin. |
Graph reference: recycleBinItem
Property |
Type |
Description |
deletedDateTime |
DateTimeOffset |
Date and time when the item was deleted. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . |
deletedFromLocation |
String |
Relative URL of the list or folder that originally contained the item. |
id |
String |
Unique identifier of the delete transaction. Inherited from baseItem. |
name |
String |
Name of the item. Inherited from baseItem. |
size |
Int64 |
Size of the item in bytes. |
Graph reference: sharedDriveItem
Property |
Type |
Description |
id |
String |
The unique identifier for the share being accessed. |
name |
String |
The display name of the shared item. |
owner |
identitySet |
Information about the owner of the shared item being referenced. |
Graph reference: 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. |
Graph reference: 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. |
isPersonalSite |
bool |
Identifies whether the site is personal or not. 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, provides 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. |
Graph reference: sitePage
Property |
Type |
Description |
contentType |
contentTypeInfo |
The content type of this item. Inherited from baseSitePage. |
createdBy |
identitySet |
Identity of the creator of this item. Read-only. Inherited from baseSitePage. |
createdDateTime |
DateTimeOffset |
The date and time the item was created. Read-only. Inherited from baseSitePage. |
description |
String |
The descriptive text for the item. Inherited from baseSitePage. |
eTag |
String |
ETag for the item. Inherited from baseSitePage. |
id |
String |
The unique identifier of the item. Inherited from baseSitePage. |
lastModifiedBy |
identitySet |
TIdentity of the last modifier of this item. Read-only. Inherited from baseSitePage. |
lastModifiedDateTime |
DateTimeOffset |
The date and time the item was last modified. Read-only. Inherited from baseSitePage. |
name |
String |
The name of the item. Inherited from baseSitePage. |
pageLayout |
pageLayoutType |
The name of the page layout of the page. The possible values are: microsoftReserved , article , home , unknownFutureValue . Inherited from baseSitePage. |
parentReference |
itemReference |
Parent information, if the item has a parent. Inherited from baseSitePage. |
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. Inherited from baseSitePage. |
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. Inherited from baseSitePage. |
titleArea |
titleArea |
Title area on the SharePoint page. |
webUrl |
String |
URL that displays the resource in the browser. Read-only. Inherited from baseSitePage. |
Graph reference: subscription
Property |
Type |
Description |
applicationId |
String |
Optional. Identifier of the application used to create the subscription. Read-only. |
changeType |
String |
Required. Indicates the type of change in the subscribed resource that raises a change notification. The supported values are: created , updated , deleted . Multiple values can be combined using a comma-separated list.
Note: Drive root item and list change notifications support only the updated changeType. User and group change notifications support updated and deleted changeType. Use updated to receive notifications when user or group is created, updated, or soft deleted. Use deleted to receive notifications when user or group is permanently deleted. |
clientState |
String |
Optional. Specifies the value of the clientState property sent by the service in each change notification. The maximum length is 128 characters. The client can check that the change notification came from the service by comparing the value of the clientState property sent with the subscription with the value of the clientState property received with each change notification. |
creatorId |
String |
Optional. Identifier of the user or service principal that created the subscription. If the app used delegated permissions to create the subscription, this field contains the ID of the signed-in user the app called on behalf of. If the app used application permissions, this field contains the ID of the service principal corresponding to the app. Read-only. |
encryptionCertificate |
String |
Optional. A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Optional but required when includeResourceData is true . |
encryptionCertificateId |
String |
Optional. A custom app-provided identifier to help identify the certificate needed to decrypt resource data. |
expirationDateTime |
DateTimeOffset |
Required. Specifies the date and time when the webhook subscription expires. The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to. For the maximum supported subscription length of time, see Subscription lifetime. |
id |
String |
Optional. Unique identifier for the subscription. Read-only. |
includeResourceData |
Boolean |
Optional. When set to true , change notifications include resource data (such as content of a chat message). |
latestSupportedTlsVersion |
String |
Optional. Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint, specified by notificationUrl, supports. The possible values are: v1_0 , v1_1 , v1_2 , v1_3 .
For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set timeline allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2. For these subscribers, not setting this property per the timeline would result in subscription operations failing.
For subscribers whose notification endpoint already supports TLS 1.2, setting this property is optional. In such cases, Microsoft Graph defaults the property to v1_2 . |
lifecycleNotificationUrl |
String |
Required for Teams resources if the expirationDateTime value is more than 1 hour from now; optional otherwise. The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved , reauthorizationRequired , and missed notifications. This URL must make use of the HTTPS protocol. For more information, see Reduce missing subscriptions and change notifications. |
notificationQueryOptions |
String |
Optional. OData query options for specifying value for the targeting resource. Clients receive notifications when resource reaches the state matching the query options provided here. With this new property in the subscription creation payload along with all existing properties, Webhooks deliver notifications whenever a resource reaches the desired state mentioned in the notificationQueryOptions property. For example, when the print job is completed or when a print job resource isFetchable property value becomes true etc.
Supported only for Universal Print Service. For more information, see Subscribe to change notifications from cloud printing APIs using Microsoft Graph. |
notificationUrl |
String |
Required. The URL of the endpoint that receives the change notifications. This URL must make use of the HTTPS protocol. Any query string parameter included in the notificationUrl property is included in the HTTP POST request when Microsoft Graph sends the change notifications. |
notificationUrlAppId |
String |
Optional. The app ID that the subscription service can use to generate the validation token. The value allows the client to validate the authenticity of the notification received. |
resource |
String |
Required. Specifies the resource that is monitored for changes. Don't include the base URL (https://graph.microsoft.com/v1.0/ ). See the possible resource path values for each supported resource. |
Graph reference: 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. |
Graph reference: 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. |
Graph reference: uploadSession
Property |
Type |
Description |
expirationDateTime |
DateTimeOffset |
The date and time in UTC that the upload session will expire. The complete file must be uploaded before this expiration time is reached. |
nextExpectedRanges |
String collection |
A collection of byte ranges that the server is missing for the file. These ranges are zero indexed and of the format "start-end" (for example "0-26" to indicate the first 27 bytes of the file). When uploading files as Outlook attachments, instead of a collection of ranges, this property always indicates a single value "{start}", the location in the file where the next upload should begin. |
uploadUrl |
String |
The URL endpoint that accepts PUT requests for byte ranges of the file. |
Graph reference: workbookApplication
Property |
Type |
Description |
calculationMode |
string |
Returns the calculation mode used in the workbook. Possible values are: Automatic , AutomaticExceptTables , Manual . |
Graph reference: workbookChart
Property |
Type |
Description |
height |
double |
Represents the height, in points, of the chart object. |
id |
string |
Gets a chart based on its position in the collection. Read-only. |
left |
double |
The distance, in points, from the left side of the chart to the worksheet origin. |
name |
string |
Represents the name of a chart object. |
top |
double |
Represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart). |
width |
double |
Represents the width, in points, of the chart object. |
Graph reference: workbookChartAxis
Property |
Type |
Description |
id |
string |
Unique identifier. Read-only. |
majorUnit |
Json |
Represents the interval between two major tick marks. Can be set to a numeric value or an empty string. The returned value is always a number. |
maximum |
Json |
Represents the maximum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. |
minimum |
Json |
Represents the minimum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. |
minorUnit |
Json |
Represents the interval between two minor tick marks. "Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. |
Graph reference: workbookChartAxisTitle
Property |
Type |
Description |
text |
string |
Represents the axis title. |
visible |
Boolean |
A Boolean that specifies the visibility of an axis title. |
Graph reference: workbookChartDataLabels
Property |
Type |
Description |
position |
string |
DataLabelPosition value that represents the position of the data label. The possible values are: None , Center , InsideEnd , InsideBase , OutsideEnd , Left , Right , Top , Bottom , BestFit , Callout . |
separator |
string |
String that represents the separator used for the data labels on a chart. |
showBubbleSize |
Boolean |
Boolean value that represents whether the data label bubble size is visible. |
showCategoryName |
Boolean |
Boolean value that represents whether the data label category name is visible. |
showLegendKey |
Boolean |
Boolean value that represents whether the data label legend key is visible. |
showPercentage |
Boolean |
Boolean value that represents whether the data label percentage is visible. |
showSeriesName |
Boolean |
Boolean value that represents whether the data label series name is visible. |
showValue |
Boolean |
Boolean value that represents whether the data label value is visible. |
Graph reference: workbookChartFont
Property |
Type |
Description |
bold |
Boolean |
Indicates whether the fond is bold. |
color |
string |
The HTML color code representation of the text color. For example #FF0000 represents Red. |
italic |
Boolean |
Indicates whether the fond is italic. |
name |
string |
The font name. For example "Calibri". |
size |
double |
The size of the font. For example, 11. |
underline |
string |
The type of underlining applied to the font. The possible values are: None , Single . |
Graph reference: workbookChartGridlines
Property |
Type |
Description |
visible |
Boolean |
Indicates whether the axis gridlines are visible. |
Graph reference: workbookChartLegend
Property |
Type |
Description |
overlay |
Boolean |
Indicates whether the chart legend should overlap with the main body of the chart. |
position |
string |
Represents the position of the legend on the chart. The possible values are: Top , Bottom , Left , Right , Corner , Custom . |
visible |
Boolean |
Indicates whether the chart legend is visible. |
Graph reference: workbookChartPoint
Property |
Type |
Description |
ID |
string |
unique identifier |
value |
Json |
The value of a chart point. Read-only. |
Graph reference: workbookChartSeries
Property |
Type |
Description |
name |
string |
The name of a series in a chart. |
Graph reference: workbookChartTitle
Property |
Type |
Description |
overlay |
Boolean |
Indicates whether the chart title will overlay the chart or not. |
text |
string |
The title text of the chart. |
visible |
Boolean |
Indicates whether the chart title is visible. |
Graph reference: workbookDocumentTask
Property |
Type |
Description |
assignees |
workbookEmailIdentity collection |
A collection of user identities the task is assigned to. |
completedBy |
workbookEmailIdentity |
The identity of the user who completed the task. Nullable. |
completedDateTime |
DateTimeOffset |
Date and time when the task was completed. Nullable. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . |
createdBy |
workbookEmailIdentity |
A user identity that creates the task. Nullable. |
createdDateTime |
DateTimeOffset |
Date and time when the task was created. Nullable. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . |
id |
String |
The unique identifier for the task. Inherited from entity. |
percentComplete |
Int32 |
An integer value from 0 to 100 that represents the percentage of the completion of the task. 100 means that the task is completed. Nullable. |
priority |
Int32 |
An integer value from 0 to 10 that represents the priority of the task. A lower value indicates a higher priority. Nullable. |
startAndDueDateTime |
workbookDocumentTaskSchedule |
Start and due date of the task. Nullable. |
title |
String |
The title of the task. |
Graph reference: workbookDocumentTaskChange
Property |
Type |
Description |
assignee |
workbookEmailIdentity |
The user identity the task is assigned to. Only present when the type property is assign . Nullable. |
changedBy |
workbookEmailIdentity |
The identity of the user who performs the change. |
commentId |
String |
The identifier of the associated comment. |
createdDateTime |
DateTimeOffset |
Date and time when the task was changed. Nullable. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . |
dueDateTime |
DateTimeOffset |
The due date and time for the task. Only present when the type property is setSchedule . Nullable. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . |
id |
String |
The unique identifier of the change history. Inherited from entity. |
percentComplete |
Int32 |
An integer value from 0 to 100 that represents the percentage of the completion of the task and associated comment. 100 means that the task and associated comment are completed. If you change the completion from 100 to a lower value, the associated task and comment are reactivated. Only present when the type property is setPercentComplete . Nullable. |
priority |
Int32 |
An integer value from 0 to 10 that represents the priority of the task. A lower value indicates a higher priority. 5 indicates the default priority if not set. Only present when the type property is setPriority . Nullable. |
startDateTime |
DateTimeOffset |
The start date and time for the task. Only present when the type property is setSchedule . Nullable. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . |
title |
String |
The title of the task. Only present when the type property is setTitle . Nullable. |
type |
String |
The type of the change history. Possible values are: create , assign , unassign , unassignAll , setPriority , setTitle , setPercentComplete , setSchedule , remove , restore , undo . |
undoChangeId |
String |
The ID of the **w |
Graph reference: workbookIcon
Property |
Type |
Description |
index |
int |
The index of the icon in the given set. |
set |
string |
The set that the icon is part of. The possible values are: Invalid , ThreeArrows , ThreeArrowsGray , ThreeFlags , ThreeTrafficLights1 , ThreeTrafficLights2 , ThreeSigns , ThreeSymbols , ThreeSymbols2 , FourArrows , FourArrowsGray , FourRedToBlack , FourRating , FourTrafficLights , FiveArrows , FiveArrowsGray , FiveRating , FiveQuarters , ThreeStars , ThreeTriangles , FiveBoxes . |
Graph reference: workbookNamedItem
Property |
Type |
Description |
comment |
String |
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 |
The type of reference is associated with the name. Possible values are: String , Integer , Double , Boolean , Range . Read-only. |
value |
String |
The formula that the name is defined to refer to. For example, =Sheet14!$B$2:$H$12 and =4.75 . Read-only. |
visible |
Boolean |
Indicates whether the object is visible. |
Graph reference: workbookOperation
Property |
Type |
Description |
error |
workbookOperationError |
The error returned by the operation. |
id |
String |
The identifier for the operation. Read-only. |
resourceLocation |
String |
The resource URI for the result. |
status |
String |
The current status of the operation. Possible values are: NotStarted , Running , Completed , Failed . |
statusCode |
integer |
Status code of the operation. |
Graph reference: workbookPivotTable
Property |
Type |
Description |
ID |
String |
The identifier for the pivot table. Read-only. |
name |
String |
The name of the pivot table. |
Graph reference: workbookRange
Property |
Type |
Description |
address |
string |
Represents the range reference in A1-style. Address value contains the Sheet reference (for example, Sheet1!A1:B4). Read-only. |
addressLocal |
string |
Represents range reference for the specified range in the language of the user. Read-only. |
cellCount |
int |
Number of cells in the range. Read-only. |
columnCount |
int |
Represents the total number of columns in the range. Read-only. |
columnHidden |
Boolean |
Indicates whether all columns of the current range are hidden. |
columnIndex |
int |
Represents the column number of the first cell in the range. Zero-indexed. Read-only. |
formulas |
Json |
Represents the formula in A1-style notation. |
formulasLocal |
Json |
Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. |
formulasR1C1 |
Json |
Represents the formula in R1C1-style notation. |
hidden |
Boolean |
Represents if all cells of the current range are hidden. Read-only. |
numberFormat |
Json |
Represents Excel's number format code for the given cell. |
rowCount |
int |
Returns the total number of rows in the range. Read-only. |
rowHidden |
Boolean |
Indicates whether all rows of the current range are hidden. |
rowIndex |
int |
Returns the row number of the first cell in the range. Zero-indexed. Read-only. |
text |
Json |
Text values of the specified range. The Text value doesn't depend on the cell width. The # sign substitution that happens in Excel UI doesn't affect the text value returned by the API. Read-only. |
valueTypes |
Json |
Represents the type of data of each cell. The possible values are: Unknown , Empty , String , Integer , Double , Boolean , Error . Read-only. |
values |
Json |
Represents the raw values of the specified range. The data returned can be of type string, number, or a Boolean. Cell that contains an error returns the error string. |
Graph reference: workbookRangeBorder
Property |
Type |
Description |
color |
string |
The HTML color code that represents the color of the border line. Can either be of the form #RRGGBB, for example "FFA500", or a named HTML color, for example "orange". |
id |
string |
The border identifier. The possible values are: EdgeTop , EdgeBottom , EdgeLeft , EdgeRight , InsideVertical , InsideHorizontal , DiagonalDown , DiagonalUp . Read-only. |
sideIndex |
string |
Indicates the specific side of the border. The possible values are: EdgeTop , EdgeBottom , EdgeLeft , EdgeRight , InsideVertical , InsideHorizontal , DiagonalDown , DiagonalUp . Read-only. |
style |
string |
Indicates the line style for the border. The possible values are: None , Continuous , Dash , DashDot , DashDotDot , Dot , Double , SlantDashDot . |
weight |
string |
The weight of the border around a range. The possible values are: Hairline , Thin , Medium , Thick . |
Graph reference: workbookRangeFill
Property |
Type |
Description |
color |
string |
HTML color code representing the color of the border line. Can either be of the form #RRGGBB, for example "FFA500", or be a named HTML color, for example "orange". |
Graph reference: workbookRangeFont
Property |
Type |
Description |
bold |
Boolean |
Inidicates whether the font is bold. |
color |
string |
The HTML color code representation of the text color. For example, #FF0000 represents the color red. |
italic |
Boolean |
Inidicates whether the font is italic. |
name |
string |
The font name. For example, "Calibri". |
size |
double |
The font size. |
underline |
string |
The type of underlining applied to the font. The possible values are: None , Single , Double , SingleAccountant , DoubleAccountant . |
Graph reference: workbookRangeView
Property |
Type |
Description |
cellAddresses |
Json |
The cell addresses. |
columnCount |
Int32 |
The number of visible columns. Read-only. |
formulas |
Json |
The formula in A1-style notation. |
formulasLocal |
Json |
The formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. |
formulasR1C1 |
Json |
Represents the formula in R1C1-style notation. |
index |
Int32 |
The index of the range. |
numberFormat |
Json |
Excel's number format code for the given cell. Read-only. |
rowCount |
Int32 |
The number of visible rows. Read-only. |
text |
Json |
The text values of the specified range. The Text value won't depend on the cell width. The # sign substitution that happens in Excel UI won't affect the text value returned by the API. Read-only. |
valueTypes |
Json |
The type of data of each cell. Read-only. The possible values are: Unknown, Empty, String, Integer, Double, Boolean, Error. |
values |
Json |
The raw values of the specified range view. The data returned could be of type string, number, or a Boolean. Cell that contains an error returns the error string. |
Graph reference: workbookSessionInfo
Property |
Type |
Description |
id |
string |
ID of the workbook session. |
persistChanges |
Boolean |
true for persistent session. false for non-persistent session (view mode) |
Graph reference: workbookTable
Property |
Type |
Description |
id |
string |
The unique identifier for the table in the workbook. The value of the identifier remains the same even when the table is renamed. This property should be interpreted as an opaque string value and shouldn't be parsed to any other type. Read-only. |
name |
string |
The name of the table. |
showHeaders |
Boolean |
Indicates whether the header row is visible or not. This value can be set to show or remove the header row. |
showTotals |
Boolean |
Indicates whether the total row is visible or not. This value can be set to show or remove the total row. |
style |
string |
A constant value that represents the Table style. Possible values are: TableStyleLight1 through TableStyleLight21 , TableStyleMedium1 through TableStyleMedium28 , TableStyleStyleDark1 through TableStyleStyleDark11 . A custom user-defined style present in the workbook can also be specified. |
highlightFirstColumn |
Boolean |
Indicates whether the first column contains special formatting. |
highlightLastColumn |
Boolean |
Indicates whether the last column contains special formatting. |
showBandedColumns |
Boolean |
Indicates whether the columns show banded formatting in which odd columns are highlighted differently from even ones to make reading the table easier. |
showBandedRows |
Boolean |
Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even ones to make reading the table easier. |
showFilterButton |
Boolean |
Indicates whether the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row. |
legacyId |
String |
A legacy identifier used in older Excel clients. The value of the identifier remains the same even when the table is renamed. This property should be interpreted as an opaque string value and shouldn't be parsed to any other type. Read-only. |
Graph reference: workbookTableColumn
Property |
Type |
Description |
id |
string |
The unique identifier for the column within the table. This property should be interpreted as an opaque string value and shouldn't be parsed to any other type. Read-only. |
index |
int |
The index of the column within the columns collection of the table. Zero-indexed. Read-only. |
name |
string |
The name of the table column. |
values |
Json |
TRepresents the raw values of the specified range. The data returned could be of type string, number, or a Boolean. Cell that contain an error will return the error string. |
Graph reference: workbookTableRow
Property |
Type |
Description |
index |
Int32 |
The index of the row within the rows collection of the table. Zero-based. Read-only. |
values |
Json |
The raw values of the specified range. The data returned could be of type string, number, or a Boolean. Any cell that contain an error will return the error string. |
Graph reference: workbookTableSort
Property |
Type |
Description |
fields |
workbookSortField collection |
The list of the current conditions last used to sort the table. Read-only. |
matchCase |
Boolean |
Indicates whether the casing impacted the last sort of the table. Read-only. |
method |
string |
The Chinese character ordering method last used to sort the table. The possible values are: PinYin , StrokeCount . Read-only. |
Graph reference: workbookWorksheet
Property |
Type |
Description |
id |
string |
The unique identifier for the worksheet in the workbook. The value of the identifier remains the same even when the worksheet is renamed or moved. Read-only. |
name |
string |
The display name of the worksheet. |
position |
int |
The zero-based position of the worksheet within the workbook. |
visibility |
string |
The visibility of the worksheet. The possible values are: Visible , Hidden , VeryHidden . |
Graph reference: workbookWorksheetProtection
Property |
Type |
Description |
options |
workbookWorksheetProtectionOptions |
Worksheet protection options. Read-only. |
protected |
Boolean |
Indicates whether the worksheet is protected. Read-only. |
Graph reference: workbookWorksheetProtectionOptions
Property |
Type |
Description |
allowAutoFilter |
Boolean |
Indicates whether the worksheet protection option to allow the use of the autofilter feature is enabled. |
allowDeleteColumns |
Boolean |
Indicates whether the worksheet protection option to allow deleting columns is enabled. |
allowDeleteRows |
Boolean |
Indicates whether the worksheet protection option to allow deleting rows is enabled. |
allowFormatCells |
Boolean |
Indicates whether the worksheet protection option to allow formatting cells is enabled. |
allowFormatColumns |
Boolean |
Indicates whether the worksheet protection option to allow formatting columns is enabled. |
allowFormatRows |
Boolean |
Indicates whether the worksheet protection option to allow formatting rows is enabled. |
allowInsertColumns |
Boolean |
Indicates whether the worksheet protection option to allow inserting columns is enabled. |
allowInsertHyperlinks |
Boolean |
Indicates whether the worksheet protection option to allow inserting hyperlinks is enabled. |
allowInsertRows |
Boolean |
Indicates whether the worksheet protection option to allow inserting rows is enabled. |
allowPivotTables |
Boolean |
Indicates whether the worksheet protection option to allow the use of the pivot table feature is enabled. |
allowSort |
Boolean |
Indicates whether the worksheet protection option to allow the use of the sort feature is enabled. |