Skip to content

worksheet-update.md

Latest commit

 

History

History
127 lines (102 loc) · 4.51 KB

worksheet-update.md

File metadata and controls

127 lines (102 loc) · 4.51 KB
title Update worksheet
description Update the properties of worksheet object.
author lumine2008
ms.localizationpriority medium
ms.subservice excel
doc_type apiPageType
ms.date 05/10/2024

Update worksheet

Namespace: microsoft.graph

Update the properties of worksheet object.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

HTTP request

PATCH /me/drive/items/{id}/workbook/worksheets/{id|name}
PATCH /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.
Workbook-Session-Id Workbook session Id that determines if changes are persisted or not. Optional.

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 maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.

Property Type Description
name string The display name of the worksheet. Optional.
position int The zero-based position of the worksheet within the workbook. Optional.
visibility string The Visibility of the worksheet. Optional. The possible values are: Visible, Hidden, VeryHidden.

Response

If successful, this method returns a 200 OK response code and updated workbookWorksheet object in the response body.

Example

Request

The following example shows a request.

HTTP

PATCH https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/worksheets/{id|name}
Content-type: application/json

{
  "position": 0,
  "name": "Sheet2",
  "visibility": "Hidden"
}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

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

{
  "id": "{FC034FA8-F8CC-4D24-9C0A-02A81B7792A0}",
  "position": 0,
  "name": "Sheet2",
  "visibility": "Hidden"
}