Update workbookIcon
Namespace: microsoft.graph
Update the properties of an icon object in a workbook.
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Files.ReadWrite | Not available. |
Delegated (personal Microsoft account) | Files.ReadWrite | Not available. |
Application | Not supported. | Not supported. |
HTTP request
PATCH /me/drive/items/{id}/workbook/tables/{id|name}/sort/fields/icon
PATCH /me/drive/root:/{item-path}:/workbook/tables/{id|name}/sort/fields/icon
PATCH /me/drive/items/{id}/workbook/worksheets/{id|name}/tables/{id|name}/sort/fields/icon
PATCH /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/tables/{id|name}/sort/fields/icon
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type | application/json. Required. |
Request body
In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed.
Property | Type | Description |
---|---|---|
index | int | Represents the index of the icon in the given set. |
set | string | Represents 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 . |
Response
If successful, this method returns a 200 OK
response code and updated workbookIcon object in the response body.
Example
Request
The following example shows a request.
PATCH https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/tables/{id|name}/sort/fields/icon
Content-type: application/json
{
"set": "set-value",
"index": 99
}
Response
The following example shows the response. Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"set": "set-value",
"index": 99
}