Microsoft Excel · Schema
microsoft.graph.workbookRange
AutomationData AnalysisMicrosoftMicrosoft 365OfficeSpreadsheets
Properties
| Name | Type | Description |
|---|---|---|
| id | string | The unique identifier for an entity. Read-only. |
| @odata.type | string | |
| address | stringnull | Represents the range reference in A1-style. Address value contains the Sheet reference (for example, Sheet1!A1:B4). Read-only. |
| addressLocal | stringnull | Represents range reference for the specified range in the language of the user. Read-only. |
| cellCount | number | Number of cells in the range. Read-only. |
| columnCount | number | Represents the total number of columns in the range. Read-only. |
| columnHidden | booleannull | Indicates whether all columns of the current range are hidden. |
| columnIndex | number | Represents the column number of the first cell in the range. Zero-indexed. Read-only. |
| formulas | object | Represents the formula in A1-style notation. |
| formulasLocal | object | Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English '=SUM(A1, 1.5)' formula would become '=SUMME(A1; 1,5)' in German. |
| formulasR1C1 | object | Represents the formula in R1C1-style notation. |
| hidden | booleannull | Represents if all cells of the current range are hidden. Read-only. |
| numberFormat | object | Represents Excel's number format code for the given cell. |
| rowCount | number | Returns the total number of rows in the range. Read-only. |
| rowHidden | booleannull | Indicates whether all rows of the current range are hidden. |
| rowIndex | number | Returns the row number of the first cell in the range. Zero-indexed. Read-only. |
| text | object | Text values of the specified range. The Text value doesn't depend on the cell width. The # sign substitution that happens in Excel UI doesn't affect the text value returned by the API. Read-only. |
| values | object | Represents the raw values of the specified range. The data returned can be of type string, number, or a Boolean. Cell that contains an error returns the error string. |
| valueTypes | object | Represents the type of data of each cell. The possible values are: Unknown, Empty, String, Integer, Double, Boolean, Error. Read-only. |
| format | object | Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. Read-only. |
| sort | object | The worksheet containing the current range. Read-only. |
| worksheet | object | The worksheet containing the current range. Read-only. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/microsoft-excel/json-schema/microsoft-excel-microsoft-graph-workbook-range-schema.json",
"title": "microsoft.graph.workbookRange",
"x-generated": "2026-11-05",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/microsoft-excel-openapi.yml#/components/schemas/microsoft.graph.workbookRange",
"allOf": [
{
"$ref": "#/$defs/microsoft.graph.entity"
},
{
"title": "workbookRange",
"required": [
"@odata.type"
],
"type": "object",
"properties": {
"address": {
"type": [
"string",
"null"
],
"description": "Represents the range reference in A1-style. Address value contains the Sheet reference (for example, Sheet1!A1:B4). Read-only."
},
"addressLocal": {
"type": [
"string",
"null"
],
"description": "Represents range reference for the specified range in the language of the user. Read-only."
},
"cellCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "number",
"description": "Number of cells in the range. Read-only.",
"format": "int32"
},
"columnCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "number",
"description": "Represents the total number of columns in the range. Read-only.",
"format": "int32"
},
"columnHidden": {
"type": [
"boolean",
"null"
],
"description": "Indicates whether all columns of the current range are hidden."
},
"columnIndex": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "number",
"description": "Represents the column number of the first cell in the range. Zero-indexed. Read-only.",
"format": "int32"
},
"formulas": {
"description": "Represents the formula in A1-style notation."
},
"formulasLocal": {
"description": "Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English '=SUM(A1, 1.5)' formula would become '=SUMME(A1; 1,5)' in German."
},
"formulasR1C1": {
"description": "Represents the formula in R1C1-style notation."
},
"hidden": {
"type": [
"boolean",
"null"
],
"description": "Represents if all cells of the current range are hidden. Read-only."
},
"numberFormat": {
"description": "Represents Excel's number format code for the given cell."
},
"rowCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "number",
"description": "Returns the total number of rows in the range. Read-only.",
"format": "int32"
},
"rowHidden": {
"type": [
"boolean",
"null"
],
"description": "Indicates whether all rows of the current range are hidden."
},
"rowIndex": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "number",
"description": "Returns the row number of the first cell in the range. Zero-indexed. Read-only.",
"format": "int32"
},
"text": {
"description": "Text values of the specified range. The Text value doesn't depend on the cell width. The # sign substitution that happens in Excel UI doesn't affect the text value returned by the API. Read-only."
},
"values": {
"description": "Represents the raw values of the specified range. The data returned can be of type string, number, or a Boolean. Cell that contains an error returns the error string."
},
"valueTypes": {
"description": "Represents the type of data of each cell. The possible values are: Unknown, Empty, String, Integer, Double, Boolean, Error. Read-only."
},
"format": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookRangeFormat"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. Read-only.",
"x-ms-navigationProperty": true
},
"sort": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookRangeSort"
},
{
"type": [
"object",
"null"
]
}
],
"description": "The worksheet containing the current range. Read-only.",
"x-ms-navigationProperty": true
},
"worksheet": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookWorksheet"
},
{
"type": [
"object",
"null"
]
}
],
"description": "The worksheet containing the current range. Read-only.",
"x-ms-navigationProperty": true
},
"@odata.type": {
"type": "string"
}
}
}
],
"x-ms-discriminator-value": "#microsoft.graph.workbookRange",
"$defs": {
"ReferenceNumeric": {
"enum": [
"-INF",
"INF",
"NaN"
],
"type": [
"string",
"null"
]
},
"microsoft.graph.entity": {
"title": "entity",
"required": [
"@odata.type"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for an entity. Read-only."
},
"@odata.type": {
"type": "string"
}
}
},
"microsoft.graph.workbookChart": {
"allOf": [
{
"$ref": "#/$defs/microsoft.graph.entity"
},
{
"title": "workbookChart",
"required": [
"@odata.type"
],
"type": "object",
"properties": {
"height": {
"oneOf": [
{
"type": [
"number",
"null"
],
"format": "double"
},
{
"type": [
"string",
"null"
]
},
{
"$ref": "#/$defs/ReferenceNumeric"
}
],
"description": "Represents the height, in points, of the chart object."
},
"left": {
"oneOf": [
{
"type": [
"number",
"null"
],
"format": "double"
},
{
"type": [
"string",
"null"
]
},
{
"$ref": "#/$defs/ReferenceNumeric"
}
],
"description": "The distance, in points, from the left side of the chart to the worksheet origin."
},
"name": {
"type": [
"string",
"null"
],
"description": "Represents the name of a chart object."
},
"top": {
"oneOf": [
{
"type": [
"number",
"null"
],
"format": "double"
},
{
"type": [
"string",
"null"
]
},
{
"$ref": "#/$defs/ReferenceNumeric"
}
],
"description": "Represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart)."
},
"width": {
"oneOf": [
{
"type": [
"number",
"null"
],
"format": "double"
},
{
"type": [
"string",
"null"
]
},
{
"$ref": "#/$defs/ReferenceNumeric"
}
],
"description": "Represents the width, in points, of the chart object."
},
"axes": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartAxes"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Represents chart axes. Read-only.",
"x-ms-navigationProperty": true
},
"dataLabels": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartDataLabels"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Represents the data labels on the chart. Read-only.",
"x-ms-navigationProperty": true
},
"format": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartAreaFormat"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Encapsulates the format properties for the chart area. Read-only.",
"x-ms-navigationProperty": true
},
"legend": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartLegend"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Represents the legend for the chart. Read-only.",
"x-ms-navigationProperty": true
},
"series": {
"type": "array",
"items": {
"$ref": "#/$defs/microsoft.graph.workbookChartSeries"
},
"description": "Represents either a single series or collection of series in the chart. Read-only.",
"x-ms-navigationProperty": true
},
"title": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartTitle"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Represents the title of the specified chart, including the text, visibility, position and formatting of the title. Read-only.",
"x-ms-navigationProperty": true
},
"worksheet": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookWorksheet"
},
{
"type": [
"object",
"null"
]
}
],
"description": "The worksheet containing the current chart. Read-only.",
"x-ms-navigationProperty": true
},
"@odata.type": {
"type": "string"
}
}
}
],
"x-ms-discriminator-value": "#microsoft.graph.workbookChart"
},
"microsoft.graph.workbookChartAreaFormat": {
"allOf": [
{
"$ref": "#/$defs/microsoft.graph.entity"
},
{
"title": "workbookChartAreaFormat",
"required": [
"@odata.type"
],
"type": "object",
"properties": {
"fill": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartFill"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Represents the fill format of an object, which includes background formatting information. Read-only.",
"x-ms-navigationProperty": true
},
"font": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartFont"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Represents the font attributes (font name, font size, color, etc.) for the current object. Read-only.",
"x-ms-navigationProperty": true
},
"@odata.type": {
"type": "string"
}
}
}
],
"x-ms-discriminator-value": "#microsoft.graph.workbookChartAreaFormat"
},
"microsoft.graph.workbookChartAxes": {
"allOf": [
{
"$ref": "#/$defs/microsoft.graph.entity"
},
{
"title": "workbookChartAxes",
"required": [
"@odata.type"
],
"type": "object",
"properties": {
"categoryAxis": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartAxis"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Represents the category axis in a chart. Read-only.",
"x-ms-navigationProperty": true
},
"seriesAxis": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartAxis"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Represents the series axis of a 3-dimensional chart. Read-only.",
"x-ms-navigationProperty": true
},
"valueAxis": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartAxis"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Represents the value axis in an axis. Read-only.",
"x-ms-navigationProperty": true
},
"@odata.type": {
"type": "string"
}
}
}
],
"x-ms-discriminator-value": "#microsoft.graph.workbookChartAxes"
},
"microsoft.graph.workbookChartAxis": {
"allOf": [
{
"$ref": "#/$defs/microsoft.graph.entity"
},
{
"title": "workbookChartAxis",
"required": [
"@odata.type"
],
"type": "object",
"properties": {
"majorUnit": {
"description": "Represents the interval between two major tick marks. Can be set to a numeric value or an empty string. The returned value is always a number."
},
"maximum": {
"description": "Represents the maximum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number."
},
"minimum": {
"description": "Represents the minimum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number."
},
"minorUnit": {
"description": "Represents the interval between two minor tick marks. 'Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number."
},
"format": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartAxisFormat"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Represents the formatting of a chart object, which includes line and font formatting. Read-only.",
"x-ms-navigationProperty": true
},
"majorGridlines": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartGridlines"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Returns a gridlines object that represents the major gridlines for the specified axis. Read-only.",
"x-ms-navigationProperty": true
},
"minorGridlines": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartGridlines"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Returns a Gridlines object that represents the minor gridlines for the specified axis. Read-only.",
"x-ms-navigationProperty": true
},
"title": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartAxisTitle"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Represents the axis title. Read-only.",
"x-ms-navigationProperty": true
},
"@odata.type": {
"type": "string"
}
}
}
],
"x-ms-discriminator-value": "#microsoft.graph.workbookChartAxis"
},
"microsoft.graph.workbookChartAxisFormat": {
"allOf": [
{
"$ref": "#/$defs/microsoft.graph.entity"
},
{
"title": "workbookChartAxisFormat",
"required": [
"@odata.type"
],
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartFont"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Represents the font attributes (font name, font size, color, etc.) for a chart axis element. Read-only.",
"x-ms-navigationProperty": true
},
"line": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartLineFormat"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Represents chart line formatting. Read-only.",
"x-ms-navigationProperty": true
},
"@odata.type": {
"type": "string"
}
}
}
],
"x-ms-discriminator-value": "#microsoft.graph.workbookChartAxisFormat"
},
"microsoft.graph.workbookChartAxisTitle": {
"allOf": [
{
"$ref": "#/$defs/microsoft.graph.entity"
},
{
"title": "workbookChartAxisTitle",
"required": [
"@odata.type"
],
"type": "object",
"properties": {
"text": {
"type": [
"string",
"null"
],
"description": "Represents the axis title."
},
"visible": {
"type": "boolean",
"description": "A Boolean that specifies the visibility of an axis title."
},
"format": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartAxisTitleFormat"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Represents the formatting of chart axis title. Read-only.",
"x-ms-navigationProperty": true
},
"@odata.type": {
"type": "string"
}
}
}
],
"x-ms-discriminator-value": "#microsoft.graph.workbookChartAxisTitle"
},
"microsoft.graph.workbookChartAxisTitleFormat": {
"allOf": [
{
"$ref": "#/$defs/microsoft.graph.entity"
},
{
"title": "workbookChartAxisTitleFormat",
"required": [
"@odata.type"
],
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartFont"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Represents the font attributes, such as font name, font size, color, etc. of chart axis title object. Read-only.",
"x-ms-navigationProperty": true
},
"@odata.type": {
"type": "string"
}
}
}
],
"x-ms-discriminator-value": "#microsoft.graph.workbookChartAxisTitleFormat"
},
"microsoft.graph.workbookChartDataLabelFormat": {
"allOf": [
{
"$ref": "#/$defs/microsoft.graph.entity"
},
{
"title": "workbookChartDataLabelFormat",
"required": [
"@odata.type"
],
"type": "object",
"properties": {
"fill": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartFill"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Represents the fill format of the current chart data label. Read-only.",
"x-ms-navigationProperty": true
},
"font": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartFont"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Represents the font attributes (font name, font size, color, etc.) for a chart data label. Read-only.",
"x-ms-navigationProperty": true
},
"@odata.type": {
"type": "string"
}
}
}
],
"x-ms-discriminator-value": "#microsoft.graph.workbookChartDataLabelFormat"
},
"microsoft.graph.workbookChartDataLabels": {
"allOf": [
{
"$ref": "#/$defs/microsoft.graph.entity"
},
{
"title": "workbookChartDataLabels",
"required": [
"@odata.type"
],
"type": "object",
"properties": {
"position": {
"type": [
"string",
"null"
],
"description": "DataLabelPosition value that represents the position of the data label. The possible values are: None, Center, InsideEnd, InsideBase, OutsideEnd, Left, Right, Top, Bottom, BestFit, Callout."
},
"separator": {
"type": [
"string",
"null"
],
"description": "String that represents the separator used for the data labels on a chart."
},
"showBubbleSize": {
"type": [
"boolean",
"null"
],
"description": "Boolean value that represents whether the data label bubble size is visible."
},
"showCategoryName": {
"type": [
"boolean",
"null"
],
"description": "Boolean value that represents whether the data label category name is visible."
},
"showLegendKey": {
"type": [
"boolean",
"null"
],
"description": "Boolean value that represents whether the data label legend key is visible."
},
"showPercentage": {
"type": [
"boolean",
"null"
],
"description": "Boolean value that represents whether the data label percentage is visible."
},
"showSeriesName": {
"type": [
"boolean",
"null"
],
"description": "Boolean value that represents whether the data label series name is visible."
},
"showValue": {
"type": [
"boolean",
"null"
],
"description": "Boolean value that represents whether the data label value is visible."
},
"format": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartDataLabelFormat"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Represents the format of chart data labels, which includes fill and font formatting. Read-only.",
"x-ms-navigationProperty": true
},
"@odata.type": {
"type": "string"
}
}
}
],
"x-ms-discriminator-value": "#microsoft.graph.workbookChartDataLabels"
},
"microsoft.graph.workbookChartFill": {
"allOf": [
{
"$ref": "#/$defs/microsoft.graph.entity"
},
{
"title": "workbookChartFill",
"required": [
"@odata.type"
],
"type": "object",
"properties": {
"@odata.type": {
"type": "string"
}
}
}
],
"x-ms-discriminator-value": "#microsoft.graph.workbookChartFill"
},
"microsoft.graph.workbookChartFont": {
"allOf": [
{
"$ref": "#/$defs/microsoft.graph.entity"
},
{
"title": "workbookChartFont",
"required": [
"@odata.type"
],
"type": "object",
"properties": {
"bold": {
"type": [
"boolean",
"null"
],
"description": "Indicates whether the fond is bold."
},
"color": {
"type": [
"string",
"null"
],
"description": "The HTML color code representation of the text color. For example #FF0000 represents Red."
},
"italic": {
"type": [
"boolean",
"null"
],
"description": "Indicates whether the fond is italic."
},
"name": {
"type": [
"string",
"null"
],
"description": "The font name. For example 'Calibri'."
},
"size": {
"oneOf": [
{
"type": [
"number",
"null"
],
"format": "double"
},
{
"type": [
"string",
"null"
]
},
{
"$ref": "#/$defs/ReferenceNumeric"
}
],
"description": "The size of the font. For example, 11."
},
"underline": {
"type": [
"string",
"null"
],
"description": "The type of underlining applied to the font. The possible values are: None, Single."
},
"@odata.type": {
"type": "string"
}
}
}
],
"x-ms-discriminator-value": "#microsoft.graph.workbookChartFont"
},
"microsoft.graph.workbookChartGridlines": {
"allOf": [
{
"$ref": "#/$defs/microsoft.graph.entity"
},
{
"title": "workbookChartGridlines",
"required": [
"@odata.type"
],
"type": "object",
"properties": {
"visible": {
"type": "boolean",
"description": "Indicates whether the axis gridlines are visible."
},
"format": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartGridlinesFormat"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Represents the formatting of chart gridlines. Read-only.",
"x-ms-navigationProperty": true
},
"@odata.type": {
"type": "string"
}
}
}
],
"x-ms-discriminator-value": "#microsoft.graph.workbookChartGridlines"
},
"microsoft.graph.workbookChartGridlinesFormat": {
"allOf": [
{
"$ref": "#/$defs/microsoft.graph.entity"
},
{
"title": "workbookChartGridlinesFormat",
"required": [
"@odata.type"
],
"type": "object",
"properties": {
"line": {
"anyOf": [
{
"$ref": "#/$defs/microsoft.graph.workbookChartLineFormat"
},
{
"type": [
"object",
"null"
]
}
],
"description": "Represents chart line formatting. Read-only.",
"x-ms-navigationProperty": true
},
"@odata.type": {
"type": "string"
}
}
}
],
"x-ms-discriminator-value": "#microsoft.graph.workbookChartGridlinesFormat"
},
"microsoft.graph.workbookChartLegend": {
"allOf": [
{
"$ref": "#/$defs/microsoft.graph.entity"
},
{
"title": "workbookChartLegend",
"required": [
"@odata.type"
],
"type": "object",
"properties": {
"overlay": {
"type": [
"boolean",
# --- truncated at 32 KB (76 KB total) ---
# Full source: https://artifacts.apis.io/microsoft-excel/json-schema/microsoft-excel-microsoft-graph-workbook-range-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/microsoft-excel-microsoft-graph-workbook-range"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.