Excel Online (Business)

Excel Online (Business) connector lets you work with Excel files in document libraries supported by Microsoft Graph (OneDrive for Business, SharePoint Sites, and Office 365 Groups).

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure China 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 (Business) connector is 25 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 for an update or delete up to 6 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.
  • The connector supports files only in Microsoft Excel Open XML Spreadsheet format (*.xlsx).
  • The File property expected by the connector's actions should be filled using one of the following options:
    • Pick a file from the file picker.
    • Use an output from the OneDrive for Business connector's triggers/actions (file's Id or File identifier property depending on which one is present for the particular OneDrive for Business's action or trigger).
    • Use an output from the SharePoint connector's triggers/actions (file's Id or Identifier property depending on which one is present for the particular Sharepoint's action or trigger).

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Add a key column to a table

Add a key column to an Excel table.

Add a row into a table

Add a new row into the Excel table.

Add a row into a table [DEPRECATED]

Add a new row into the Excel table.

Create table

Create a new table in the Excel workbook.

Create worksheet

Create a new worksheet in the Excel workbook.

Delete a row

Delete a row using a key column.

Get a row

Get a row using a key column.

Get tables

Get a list of tables in the Excel workbook.

Get worksheets

Get a list of worksheets in the Excel workbook.

List rows present in a table

List rows present in a table.

Update a row

Update a row using a key column.

Add a key column to a table

Add a key column to an Excel table.

Parameters

Name Key Required Type Description
Location
source True string

Select from the drop-down or specify one of the following:

        - "me"

        - "SharePoint Site URL"

        - "users/someone's UPN"

        - "groups/group Id"

        - "sites/SharePoint Site URL:/teams/team name:" (the colons are required).
Document Library
drive True string

Select a document library from the drop-down.

File
file True string

Select an Excel file through File Browse.

Table
table True string

Select a table from the drop-down.

Key Column
idColumn string

Provide the key column name.

Add a row into a table

Add a new row into the Excel table.

Parameters

Name Key Required Type Description
Location
source True string

Select from the drop-down or specify one of the following:

          - "me"

          - "SharePoint Site URL"

          - "users/someone's UPN"

          - "groups/group Id"

          - "sites/SharePoint Site URL:/teams/team name:" (colons are required).
Document Library
drive True string

Select a document library from the drop-down.

File
file True string

Select an Excel file through File Browse.

Table
table True string

Select a table from the drop-down.

Row
item True dynamic

Row to add into the specified Excel table.

Returns

The outputs of this operation are dynamic.

Add a row into a table [DEPRECATED]

Add a new row into the Excel table.

Parameters

Name Key Required Type Description
Location
source True string

Select from the drop-down or specify one of the following:

          - "me"

          - "SharePoint Site URL"

          - "users/someone's UPN"

          - "groups/group Id"

          - "sites/SharePoint Site URL:/teams/team name:" (colons are required).
Document Library
drive True string

Select a document library from the drop-down.

File
file True string

Select an Excel file through File Browse.

Table
table True string

Select a table from the drop-down.

Row
item True dynamic

Row to insert into the specified Excel table.

Returns

Create table

Create a new table in the Excel workbook.

Parameters

Name Key Required Type Description
Location
source True string

Select from the drop-down or specify one of the following:

        - "me"

        - "SharePoint Site URL"

        - "users/someone's UPN"

        - "groups/group Id"

        - "sites/SharePoint Site URL:/teams/team name:" (the colons are required).
Document Library
drive True string

Select a document library from the drop-down.

File
file True string

Select an Excel file through File Browse.

Table name
TableName string

Enter the Excel table name.

Table range
Range True string

Enter the table address using A1 notation.

Columns names
ColumnsNames string

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

Returns

Table metadata

Create worksheet

Create a new worksheet in the Excel workbook.

Parameters

Name Key Required Type Description
Location
source True string

Select from the drop-down or specify one of the following:

          - "me"

          - "SharePoint Site URL"

          - "users/someone's UPN"

          - "groups/group Id"

          - "sites/SharePoint Site URL:/teams/team name:" (colons are required).
Document Library
drive True string

Select a document library from the drop-down.

File
file True string

Select an Excel file through File Browse.

Name
name string

Worksheet name.

Returns

Delete a row

Delete a row using a key column.

Parameters

Name Key Required Type Description
Location
source True string

Select from the drop-down or specify one of the following:

        - "me"

        - "SharePoint Site URL"

        - "users/someone's UPN"

        - "groups/group Id"

        - "sites/SharePoint Site URL:/teams/team name:" (the colons are required)
Document Library
drive True string

Select a document library from the drop-down.

File
file True string

Select an Excel file through File Browse.

Table
table True string

Select a table from the drop-down.

Key Column
idColumn True string

Select a column from the drop-down.

Key Value
id True string

Enter the key value.

Get a row

Get a row using a key column.

Parameters

Name Key Required Type Description
Location
source True string

Select from the drop-down or specify one of the following:

        - "me"

        - "SharePoint Site URL"

        - "users/someone's UPN"

        - "groups/group Id"

        - "sites/SharePoint Site URL:/teams/team name:" (the colons are required)
Document Library
drive True string

Select a document library from the drop-down.

File
file True string

Select an Excel file through File Browse.

Table
table True string

Select a table from the drop-down.

Key Column
idColumn True string

Select a column from the drop-down.

Key Value
id True string

Enter the key value.

Returns

The outputs of this operation are dynamic.

Get tables

Get a list of tables in the Excel workbook.

Parameters

Name Key Required Type Description
Location
source True string

Select from the drop-down or specify one of the following:

          - "me"

          - "SharePoint Site URL"

          - "users/someone's UPN"

          - "groups/group Id"

          - "sites/SharePoint Site URL:/teams/team name:" (colons are required).
Document Library
drive True string

Select a document library from the drop-down.

File
file True string

Select an Excel file through File Browse.

Returns

Name Path Type Description
value
value array of object
Id
value.id string

Table Id.

Name
value.name string

Table name.

Show banded columns
value.showBandedColumns boolean

Show banded columns.

Highlight first column
value.highlightFirstColumn boolean

Highlight first column.

Highlight last column
value.highlightLastColumn boolean

Highlight last column.

Show banded rows
value.showBandedRows boolean

Show banded rows.

Show filter button
value.showFilterButton boolean

Show filter button.

Show headers
value.showHeaders boolean

Show headers.

Show totals
value.showTotals boolean

Show totals.

Style
value.style string

Table style.

Get worksheets

Get a list of worksheets in the Excel workbook.

Parameters

Name Key Required Type Description
Location
source True string

Select from the drop-down or specify one of the following:

          - "me"

          - "SharePoint Site URL"

          - "users/someone's UPN"

          - "groups/group Id"

          - "sites/SharePoint Site URL:/teams/team name:" (colons are required).
Document Library
drive True string

Select a document library from the drop-down.

File
file True string

Select an Excel file through File Browse.

Returns

Name Path Type Description
value
value array of WorksheetMetadata

List rows present in a table

List rows present in a table.

Parameters

Name Key Required Type Description
Location
source True string

Select from the drop-down or specify one of the following:

        - "me"

        - "SharePoint Site URL"

        - "users/someone's UPN"

        - "groups/group Id"

        - "sites/SharePoint Site URL:/teams/team name:" (the colons are required)
Document Library
drive True string

Select a document library from the drop-down.

File
file True string

Select an Excel file through File Browse.

Table
table True string

Select a table from the drop-down.

Filter Query
$filter string

An ODATA filter query to restrict the entries returned.

Order By
$orderby string

An ODATA orderBy query for specifying the order of entries.

Top Count
$top integer

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

Skip Count
$skip integer

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

Returns

The outputs of this operation are dynamic.

Update a row

Update a row using a key column.

Parameters

Name Key Required Type Description
Location
source True string

Select from the drop-down or specify one of the following:

        - "me"

        - "SharePoint Site URL"

        - "users/someone's UPN"

        - "groups/group Id"

        - "sites/SharePoint Site URL:/teams/team name:" (the colons are required)
Document Library
drive True string

Select a document library from the drop-down.

File
file True string

Select an Excel file through File Browse.

Table
table True string

Select a table from the drop-down.

Key Column
idColumn True string

Select a column from the drop-down.

Key Value
id True string

Enter the key value.

Provide the item properties.
item True dynamic

Provide the item properties.

Returns

The outputs of this operation are dynamic.

Definitions

TableMetadata

Table metadata

Name Path Type Description
name
name string

Table name

title
title string

Table title

x-ms-permission
x-ms-permission string

Table permission

x-ms-capabilities
x-ms-capabilities TableCapabilitiesMetadata

Metadata for a table (capabilities)

schema
schema Object
referencedEntities
referencedEntities Object
webUrl
webUrl string

Url link

TableCapabilitiesMetadata

Metadata for a table (capabilities)

Name Path Type Description
sortRestrictions
sortRestrictions TableSortRestrictionsMetadata

Metadata for a table (sort restrictions)

filterRestrictions
filterRestrictions TableFilterRestrictionsMetadata

Metadata for a table (filter restrictions)

selectRestrictions
selectRestrictions TableSelectRestrictionsMetadata

Metadata for a table (select restrictions)

isOnlyServerPagable
isOnlyServerPagable boolean

Server paging restrictions

filterFunctionSupport
filterFunctionSupport array of string

List of supported filter capabilities

serverPagingOptions
serverPagingOptions array of string

List of supported server-driven paging capabilities

Object

TableSortRestrictionsMetadata

Metadata for a table (sort restrictions)

Name Path Type Description
sortable
sortable boolean

Indicates whether this table has sortable columns

unsortableProperties
unsortableProperties array of string

List of unsortable properties

ascendingOnlyProperties
ascendingOnlyProperties array of string

List of properties which support ascending order only

TableFilterRestrictionsMetadata

Metadata for a table (filter restrictions)

Name Path Type Description
filterable
filterable boolean

Indicates whether this table has filterable columns

nonFilterableProperties
nonFilterableProperties array of string

List of non filterable properties

requiredProperties
requiredProperties array of string

List of required properties

TableSelectRestrictionsMetadata

Metadata for a table (select restrictions)

Name Path Type Description
selectable
selectable boolean

Indicates whether this table has selectable columns

WorksheetMetadata

Name Path Type Description
Id
id string

Worksheet Id.

Name
name string

Worksheet name.

Position
position integer

Worksheet position.

Visibility
visibility string

Worksheet visibility.