Worksheet: UsedRange

Important: APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported.

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.

Prerequisites

The following scopes are required to execute this API:

* Files.ReadWrite

HTTP request

GET /workbook/worksheets/{id|name}/UsedRange

Optional query parameters

In the request URL, provide an optonal query parameter.

Parameter Type Description
valuesOnly boolean Optional. Considers only cells with values as used cells (ignores formatting).

Request headers

Name Description
Authorization Bearer {token}. Required.

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/beta/me/drive/items/{id}/workbook/worksheets/{id|name}/UsedRange(valuesOnly=true)
Content-type: application/json

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": 99,
  "columnCount": 99,
  "columnIndex": 99,
  "valueTypes": "valueTypes-value"
}