Skip to content

worksheetcollection-add.md

Latest commit

 

History

History
126 lines (98 loc) · 4.28 KB

worksheetcollection-add.md

File metadata and controls

126 lines (98 loc) · 4.28 KB
title worksheetCollection: add
description Add a new worksheet to the workbook.
author lumine2008
ms.localizationpriority medium
ms.subservice excel
doc_type apiPageType
ms.date 05/10/2024

worksheetCollection: add

Namespace: microsoft.graph

Add a new worksheet to the workbook. The worksheet is added at the end of existing worksheets. If you want to activate the newly added worksheet, call .activate() on it.

[!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

POST /me/drive/items/{id}/workbook/worksheets/add
POST /me/drive/root:/{item-path}:/workbook/worksheets/add

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Workbook-Session-Id Workbook session ID that determines whether changes are persisted. Optional.

Request body

In the request body, provide a JSON object with the following parameters.

Parameter Type Description
name string Optional. The name of the worksheet to be added. If specified, name should be unique. If not specified, Excel determines the name of the new worksheet.

Response

If successful, this method returns 201 Created response code and workbookWorksheet object in the response body.

Examples

Request

The following example shows a request.

HTTP

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

{
  "name": "Sheet1"
}

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 201 Created
Content-type: application/json

{
  "id": "{FC034FA8-F8CC-4D24-9C0A-02A81B7792A0}",
  "position": 1,
  "name": "Sheet1",
  "visibility": "Visible"
}