Worksheet: UsedRange
- 2 minutes to read
-
Contributors
The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the worksheet is blank, this function will return the top left cell.
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}/usedRange
Function parameters
In the request URL you may provide optional parameters.
| Parameter | Type | Description |
|---|---|---|
| valuesOnly | Boolean | Optional. Considers only cells with values as used cells (ignores formatting). |
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 that shows 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}/usedRange
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"
}
Alternatively, this function can be called with the optional valuesOnly parameter.
Request
Here is an example of the request.
GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/worksheets/{id|name}/usedRange(valuesOnly=true)
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"
}