Worksheet: Cell
- 2 minutes to read
-
Contributors
Gets the range object containing the single cell based on row and column numbers. The cell can be outside the bounds of its parent range, so long as it's stays within the worksheet grid.
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
| Permission type | Permissions (from least to most privileged) |
|---|---|
| Delegated (work or school account) | Files.ReadWrite |
| Delegated (personal Microsoft account) | Not supported. |
| Application | Not supported. |
HTTP request
GET /workbook/worksheets/{id|name}/cell(row={row},column={column})
Function parameters
In the request path, provide the following parameters.
| Parameter | Type | Description |
|---|---|---|
| row | Int32 | Row number of the cell to be retrieved. Zero-indexed. |
| column | Int32 | Column number of the cell to be retrieved. Zero-indexed. |
Request headers
| Name | Description |
|---|---|
| Authorization | Bearer {token}. Required. |
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional. |
Request body
Do not supply a request body for this method.
Response
If successful, this method returns 200 OK response code and Range object in the response body.
Example
Here is an example of how to call this API.
Request
Here is an example of the request.
GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/worksheets/{id|name}/cell(row=<row>,column=<column>)
Response
Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.
HTTP/1.1 200 OK
Content-type: application/json
Content-length: 169
{
"address": "address-value",
"addressLocal": "addressLocal-value",
"cellCount": 1,
"columnCount": 1,
"columnIndex": 3,
"valueTypes": "valueTypes-value"
}