Microsoft Excel¶

Node: microsoftExcel · Full type: n8n-nodes-base.microsoftExcel · Version: 2.2

Credentials¶

microsoftExcelOAuth2Api (alias: @microsoft)

CREDENTIAL @microsoft = microsoftExcelOAuth2Api "My Microsoft Excel"

Operations¶

Resource: `table`¶

`append`¶

Parameter	Type	Default	Details
`workbook`	resourceLocator	{...}	required; modes: `list`, `id`
`worksheet`	resourceLocator	{...}	required; modes: `list`, `id`
`table`	resourceLocator	{...}	required; modes: `list`, `id`
`dataMode`	options	"define"	`autoMap`, `define`, `raw`
`data`	json	""	required
`fieldsUi`	fixedCollection	{}	groups: `values`
`options`	collection	{}	keys: `index`, `rawData`, `dataProperty`

`convertToRange`¶

Parameter	Type	Default	Details
`workbook`	resourceLocator	{...}	required; modes: `list`, `id`
`worksheet`	resourceLocator	{...}	required; modes: `list`, `id`
`table`	resourceLocator	{...}	required; modes: `list`, `id`

`addTable`¶

Parameter	Type	Default	Details
`workbook`	resourceLocator	{...}	required; modes: `list`, `id`
`worksheet`	resourceLocator	{...}	required; modes: `list`, `id`
`selectRange`	options	"auto"	`auto`, `manual`
`range`	string	""
`hasHeaders`	boolean	true

`deleteTable`¶

Parameter	Type	Default	Details
`workbook`	resourceLocator	{...}	required; modes: `list`, `id`
`worksheet`	resourceLocator	{...}	required; modes: `list`, `id`
`table`	resourceLocator	{...}	required; modes: `list`, `id`

`getColumns`¶

Parameter	Type	Default	Details
`workbook`	resourceLocator	{...}	required; modes: `list`, `id`
`worksheet`	resourceLocator	{...}	required; modes: `list`, `id`
`table`	resourceLocator	{...}	required; modes: `list`, `id`
`returnAll`	boolean	false
`limit`	number	100
`rawData`	boolean	false
`dataProperty`	string	"data"
`filters`	collection	{}	keys: `fields`

`getRows`¶

Parameter	Type	Default	Details
`workbook`	resourceLocator	{...}	required; modes: `list`, `id`
`worksheet`	resourceLocator	{...}	required; modes: `list`, `id`
`table`	resourceLocator	{...}	required; modes: `list`, `id`
`returnAll`	boolean	false
`limit`	number	100
`rawData`	boolean	false
`dataProperty`	string	"data"
`filters`	collection	{}	keys: `fields`, `column`

`lookup`¶

Parameter	Type	Default	Details
`workbook`	resourceLocator	{...}	required; modes: `list`, `id`
`worksheet`	resourceLocator	{...}	required; modes: `list`, `id`
`table`	resourceLocator	{...}	required; modes: `list`, `id`
`lookupColumn`	string	""	required
`lookupValue`	string	""	required
`options`	collection	{}	keys: `returnAllMatches`

Resource: `workbook`¶

`addWorksheet`¶

Parameter	Type	Default	Details
`workbook`	resourceLocator	{...}	required; modes: `list`, `id`
`additionalFields`	collection	{}	keys: `name`

`deleteWorkbook`¶

Parameter	Type	Default	Details
`workbook`	resourceLocator	{...}	required; modes: `list`, `id`

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	100
`filters`	collection	{}	keys: `fields`

Resource: `worksheet`¶

`append`¶

Parameter	Type	Default	Details
`workbook`	resourceLocator	{...}	required; modes: `list`, `id`
`worksheet`	resourceLocator	{...}	required; modes: `list`, `id`
`dataMode`	options	"define"	`autoMap`, `define`, `raw`
`data`	json	""	required
`fieldsUi`	fixedCollection	{}	groups: `values`
`options`	collection	{}	keys: `rawData`, `dataProperty`

`upsert`¶

Parameter	Type	Default	Details
`workbook`	resourceLocator	{...}	required; modes: `list`, `id`
`worksheet`	resourceLocator	{...}	required; modes: `list`, `id`
`useRange`	boolean	false
`range`	string	""
`dataMode`	options	"define"	`autoMap`, `define`
`columnToMatchOn`	options	""
`valueToMatchOn`	string	""
`fieldsUi`	fixedCollection	{}	groups: `values`
`options`	collection	{}	keys: `appendAfterSelectedRange`, `rawData`, `dataProperty`, `updateAll`

`clear`¶

Parameter	Type	Default	Details
`workbook`	resourceLocator	{...}	required; modes: `list`, `id`
`worksheet`	resourceLocator	{...}	required; modes: `list`, `id`
`applyTo`	options	"All"	`All`, `Formats`, `Contents`
`useRange`	boolean	false
`range`	string	""

`deleteWorksheet`¶

Parameter	Type	Default	Details
`workbook`	resourceLocator	{...}	required; modes: `list`, `id`
`worksheet`	resourceLocator	{...}	required; modes: `list`, `id`

`getAll`¶

Parameter	Type	Default	Details
`workbook`	resourceLocator	{...}	required; modes: `list`, `id`
`returnAll`	boolean	false
`limit`	number	100
`filters`	collection	{}	keys: `fields`

`readRows`¶

Parameter	Type	Default	Details
`workbook`	resourceLocator	{...}	required; modes: `list`, `id`
`worksheet`	resourceLocator	{...}	required; modes: `list`, `id`
`useRange`	boolean	false
`range`	string	""
`keyRow`	number	0
`dataStartRow`	number	1
`options`	collection	{}	keys: `rawData`, `dataProperty`, `fields`

`update`¶

Parameter	Type	Default	Details
`workbook`	resourceLocator	{...}	required; modes: `list`, `id`
`worksheet`	resourceLocator	{...}	required; modes: `list`, `id`
`useRange`	boolean	false
`range`	string	""
`range`	string	""
`dataMode`	options	"define"	`autoMap`, `define`, `raw`
`data`	json	""	required
`columnToMatchOn`	options	""
`valueToMatchOn`	string	""
`fieldsUi`	fixedCollection	{}	groups: `values`
`options`	collection	{}	keys: `rawData`, `dataProperty`, `fields`, `updateAll`

Parameter Details¶

fieldsUi children:

values group:

Parameter	Type	Default	Details
`column`	options	""
`fieldValue`	string	""

options children:

Parameter	Type	Default	Details
`index`	number	0
`rawData`	boolean	0
`dataProperty`	string	"data"	required

filters children:

Parameter	Type	Default	Details
`fields`	string	""

additionalFields children:

Parameter	Type	Default	Details
`name`	string	""

Example¶

NODE "microsoftExcel" @microsoft AS "Microsoft Excel" {
  resource: "table",
  operation: "getAll",
  data: "{}",
  lookupColumn: {{ $json.lookupColumn }},
  lookupValue: {{ $json.lookupValue }}
}

Microsoft Excel¶

Credentials¶

Operations¶

Resource: table¶

append¶

convertToRange¶

addTable¶

deleteTable¶

getColumns¶

getRows¶

lookup¶

Resource: workbook¶

addWorksheet¶

deleteWorkbook¶

getAll¶

Resource: worksheet¶

append¶

upsert¶

clear¶

deleteWorksheet¶

getAll¶

readRows¶

update¶

Parameter Details¶

Example¶

Resource: `table`¶

`append`¶

`convertToRange`¶

`addTable`¶

`deleteTable`¶

`getColumns`¶

`getRows`¶

`lookup`¶

Resource: `workbook`¶

`addWorksheet`¶

`deleteWorkbook`¶

`getAll`¶

Resource: `worksheet`¶

`append`¶

`upsert`¶

`clear`¶

`deleteWorksheet`¶

`getAll`¶

`readRows`¶

`update`¶