Excel Online (OneDrive)

Excel Online (OneDrive) connection provider lets you work with Excel files stored in OneDrive. This connection provider only supports personal (MSA) accounts.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions
Flow	Standard	All Flow regions
PowerApps	Standard	All PowerApps regions

Known Issues and Limitations

The maximum size of an Excel file that is supported by the Excel Online (OneDrive) connector is 5 MB.
The data may not be up to date (there may be some delay) when filtering or sorting is used in the List rows present in a table action.
The List rows present in a table action supports basic filtering and sorting:
- Supports the following filter functions: eq, ne, contains, startswith, endswith.
- Only 1 filter function can be applied on a column.
- Only 1 column can be used for sorting.
An Excel file may be locked in OneDrive for an update or delete up to 12 minutes since the last use of the connector.
A single Excel file should be used by a single connection to prevent writing data from multiple connections and possible data inconsistency.

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Add a key column to a table

Operation ID:: CreateIdColumn

Add a key column to an Excel table.

Required Parameters

File: string

Select an Excel file through File Browse.

Key:: file

Table: string

Select a table from the drop-down.

Key:: table

Optional Parameters

Key Column: string

Provide the key column name.

Key:: idColumn

Add a row into a table

Operation ID:: AddRowV2

Add a new row into the Excel table.

Required Parameters

File: string

Select an Excel file through File Browse.

Key:: file

Table: string

Select a table from the drop-down.

Key:: table

Row: dynamic

Row to add into the specified Excel table.

Key:: item

Returns

The outputs of this operation are dynamic.

Add a row into a table [DEPRECATED]

Operation ID:: AddRow

Add a new row into the Excel table.

Required Parameters

File: string

Select an Excel file through File Browse.

Key:: file

Table: string

Select a table from the drop-down.

Key:: table

Row: dynamic

Row to insert into the specified Excel table.

Key:: item

Returns

Add a row into a table [DEPRECATED]

Create table

Operation ID:: CreateTable

Create a new table in the Excel workbook.

Required Parameters

File: string

Select an Excel file through File Browse.

Key:: file

Table range: string

Enter the table address using A1 notation.

Key:: Range

Optional Parameters

Table name: string

Enter the Excel table name.

Key:: TableName

Columns names: string

Enter the columns names separated by ';' or ','.

Key:: ColumnsNames

Returns

Body: TableMetadata

Table metadata

Create worksheet

Operation ID:: CreateWorksheet

Create a new worksheet in the Excel workbook.

Required Parameters

File: string

Select an Excel file through File Browse.

Key:: file

Optional Parameters

Name: string

Worksheet name.

Key:: name

Returns

Body: WorksheetMetadata

Delete a row

Operation ID:: DeleteItem

Delete a row using a key column.

Required Parameters

File: string

Select an Excel file through File Browse.

Key:: file

Table: string

Select a table from the drop-down.

Key:: table

Key Column: string

Select a column from the drop-down.

Key:: idColumn

Key Value: string

Enter the key value.

Key:: id

Get a row

Operation ID:: GetItem

Get a row using a key column.

Required Parameters

File: string

Select an Excel file through File Browse.

Key:: file

Table: string

Select a table from the drop-down.

Key:: table

Key Column: string

Select a column from the drop-down.

Key:: idColumn

Key Value: string

Enter the key value.

Key:: id

Returns

The outputs of this operation are dynamic.

Get tables

Operation ID:: GetTables

Get a list of tables in the Excel workbook.

Required Parameters

File: string

Select an Excel file through File Browse.

Key:: file

Returns

value: array of object

Get a list of tables in the Excel workbook.

Path:: value

Id: string

Table Id.

Path:: value.id

Name: string

Table name.

Path:: value.name

Show banded columns: boolean

Show banded columns.

Path:: value.showBandedColumns

Highlight first column: boolean

Highlight first column.

Path:: value.highlightFirstColumn

Highlight last column: boolean

Highlight last column.

Path:: value.highlightLastColumn

Show banded rows: boolean

Show banded rows.

Path:: value.showBandedRows

Show filter button: boolean

Show filter button.

Path:: value.showFilterButton

Show headers: boolean

Show headers.

Path:: value.showHeaders

Show totals: boolean

Show totals.

Path:: value.showTotals

Style: string

Table style.

Path:: value.style

Get worksheets

Operation ID:: GetAllWorksheets

Get a list of worksheets in the Excel workbook.

Required Parameters

File: string

Select an Excel file through File Browse.

Key:: file

Returns

value: array of WorksheetMetadata

Get a list of worksheets in the Excel workbook.

Path:: value

List rows present in a table

Operation ID:: GetItems

List rows present in a table.

Required Parameters

File: string

Select an Excel file through File Browse.

Key:: file

Table: string

Select a table from the drop-down.

Key:: table

Optional Parameters

Filter Query: string

An ODATA filter query to restrict the entries returned.

Key:: $filter

Order By: string

An ODATA orderBy query for specifying the order of entries.

Key:: $orderby

Top Count: integer

Total number of entries to retrieve (default = all).

Key:: $top

Skip Count: integer

The number of entries to skip (default = 0).

Key:: $skip

Returns

The outputs of this operation are dynamic.

Update a row

Operation ID:: PatchItem

Update a row using a key column.

Required Parameters

File: string

Select an Excel file through File Browse.

Key:: file

Table: string

Select a table from the drop-down.

Key:: table

Key Column: string

Select a column from the drop-down.

Key:: idColumn

Key Value: string

Enter the key value.

Key:: id

Provide the item properties.: dynamic

Provide the item properties.

Key:: item

Returns

The outputs of this operation are dynamic.

Definitions

TableMetadata

Table metadata

name: string

Table name

Path:: name

referencedEntities: Object

Table metadata

Path:: referencedEntities

schema: Object

Table metadata

Path:: schema

title: string

Table title

Path:: title

webUrl: string

Url link

Path:: webUrl

x-ms-capabilities: TableCapabilitiesMetadata

Metadata for a table (capabilities)

Path:: x-ms-capabilities

x-ms-permission: string

Table permission

Path:: x-ms-permission

TableCapabilitiesMetadata

Metadata for a table (capabilities)

filterFunctionSupport: array of string

List of supported filter capabilities

Path:: filterFunctionSupport

filterRestrictions: TableFilterRestrictionsMetadata

Metadata for a table (filter restrictions)

Path:: filterRestrictions

isOnlyServerPagable: boolean

Server paging restrictions

Path:: isOnlyServerPagable

selectRestrictions: TableSelectRestrictionsMetadata

Metadata for a table (select restrictions)

Path:: selectRestrictions

serverPagingOptions: array of string

List of supported server-driven paging capabilities

Path:: serverPagingOptions

sortRestrictions: TableSortRestrictionsMetadata

Metadata for a table (sort restrictions)

Path:: sortRestrictions

Object

name: string

Table name

Path:: name

referencedEntities: Object

Path:: referencedEntities

schema: Object

Path:: schema

title: string

Table title

Path:: title

webUrl: string

Url link

Path:: webUrl

x-ms-capabilities: TableCapabilitiesMetadata

Metadata for a table (capabilities)

Path:: x-ms-capabilities

x-ms-permission: string

Table permission

Path:: x-ms-permission

TableSortRestrictionsMetadata

Metadata for a table (sort restrictions)

ascendingOnlyProperties: array of string

List of properties which support ascending order only

Path:: ascendingOnlyProperties

sortable: boolean

Indicates whether this table has sortable columns

Path:: sortable

unsortableProperties: array of string

List of unsortable properties

Path:: unsortableProperties

TableFilterRestrictionsMetadata

Metadata for a table (filter restrictions)

filterable: boolean

Indicates whether this table has filterable columns

Path:: filterable

nonFilterableProperties: array of string

List of non filterable properties

Path:: nonFilterableProperties

requiredProperties: array of string

List of required properties

Path:: requiredProperties

TableSelectRestrictionsMetadata

Metadata for a table (select restrictions)

selectable: boolean

Indicates whether this table has selectable columns

Path:: selectable

WorksheetMetadata

Id: string

Worksheet Id.

Path:: id

Name: string

Worksheet name.

Path:: name

Position: integer

Worksheet position.

Path:: position

Visibility: string

Worksheet visibility.

Path:: visibility