Excel Online (Business)

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.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add a key column to a table

Add a key column to an Excel table.

Required Parameters

Location
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
string
Select a document library from the drop-down.
File
string
Select an Excel file through File Browse.
Table
string
Select a table from the drop-down.

Optional Parameters

Key Column
string
Provide the key column name.

Add a row into a table

Add a new row into the Excel table.

Required Parameters

Location
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
string
Select a document library from the drop-down.
File
string
Select an Excel file through File Browse.
Table
string
Select a table from the drop-down.
Row
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.

Required Parameters

Location
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
string
Select a document library from the drop-down.
File
string
Select an Excel file through File Browse.
Table
string
Select a table from the drop-down.
Row
dynamic
Row to insert into the specified Excel table.

Returns

Add a row into a table [DEPRECATED]

Create table

Create a new table in the Excel workbook.

Required Parameters

Location
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
string
Select a document library from the drop-down.
File
string
Select an Excel file through File Browse.
Table range
string
Enter the table address using A1 notation.

Optional Parameters

Table name
string
Enter the Excel table name.
Columns names
string
Enter the columns names separated by ';' or ','.

Returns

Body
TableMetadata

Table metadata

Create worksheet

Create a new worksheet in the Excel workbook.

Required Parameters

Location
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
string
Select a document library from the drop-down.
File
string
Select an Excel file through File Browse.

Optional Parameters

Name
string
Worksheet name.

Returns

Delete a row

Delete a row using a key column.

Required Parameters

Location
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
string
Select a document library from the drop-down.
File
string
Select an Excel file through File Browse.
Table
string
Select a table from the drop-down.
Key Column
string
Select a column from the drop-down.
Key Value
string
Enter the key value.

Get a row

Get a row using a key column.

Required Parameters

Location
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
string
Select a document library from the drop-down.
File
string
Select an Excel file through File Browse.
Table
string
Select a table from the drop-down.
Key Column
string
Select a column from the drop-down.
Key Value
string
Enter the key value.

Returns

The outputs of this operation are dynamic.

Get tables

Get a list of tables in the Excel workbook.

Required Parameters

Location
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
string
Select a document library from the drop-down.
File
string
Select an Excel file through File Browse.

Returns

value
array of object
Get a list of tables in the Excel workbook.
Id
string
Table Id.
Name
string
Table name.
Show banded columns
boolean
Show banded columns.
Highlight first column
boolean
Highlight first column.
Highlight last column
boolean
Highlight last column.
Show banded rows
boolean
Show banded rows.
Show filter button
boolean
Show filter button.
Show headers
boolean
Show headers.
Show totals
boolean
Show totals.
Style
string
Table style.

Get worksheets

Get a list of worksheets in the Excel workbook.

Required Parameters

Location
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
string
Select a document library from the drop-down.
File
string
Select an Excel file through File Browse.

Returns

value
array of WorksheetMetadata
Get a list of worksheets in the Excel workbook.

List rows present in a table

List rows present in a table.

Required Parameters

Location
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
string
Select a document library from the drop-down.
File
string
Select an Excel file through File Browse.
Table
string
Select a table from the drop-down.

Optional Parameters

Filter Query
string
An ODATA filter query to restrict the entries returned.
Order By
string
An ODATA orderBy query for specifying the order of entries.
Top Count
integer
Total number of entries to retrieve (default = all).
Skip Count
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.

Required Parameters

Location
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
string
Select a document library from the drop-down.
File
string
Select an Excel file through File Browse.
Table
string
Select a table from the drop-down.
Key Column
string
Select a column from the drop-down.
Key Value
string
Enter the key value.
Provide the item properties.
dynamic
Provide the item properties.

Returns

The outputs of this operation are dynamic.

Definitions

TableMetadata

Table metadata

name
string
Table name
referencedEntities
Object
Table metadata
schema
Object
Table metadata
title
string
Table title
webUrl
string
Url link
x-ms-capabilities
TableCapabilitiesMetadata
Metadata for a table (capabilities)
x-ms-permission
string
Table permission

TableCapabilitiesMetadata

Metadata for a table (capabilities)

filterFunctionSupport
array of string
List of supported filter capabilities
filterRestrictions
TableFilterRestrictionsMetadata
Metadata for a table (filter restrictions)
isOnlyServerPagable
boolean
Server paging restrictions
selectRestrictions
TableSelectRestrictionsMetadata
Metadata for a table (select restrictions)
serverPagingOptions
array of string
List of supported server-driven paging capabilities
sortRestrictions
TableSortRestrictionsMetadata
Metadata for a table (sort restrictions)

Object

name
string
Table name
referencedEntities
Object
schema
Object
title
string
Table title
webUrl
string
Url link
x-ms-capabilities
TableCapabilitiesMetadata
Metadata for a table (capabilities)
x-ms-permission
string
Table permission

TableSortRestrictionsMetadata

Metadata for a table (sort restrictions)

ascendingOnlyProperties
array of string
List of properties which support ascending order only
sortable
boolean
Indicates whether this table has sortable columns
unsortableProperties
array of string
List of unsortable properties

TableFilterRestrictionsMetadata

Metadata for a table (filter restrictions)

filterable
boolean
Indicates whether this table has filterable columns
nonFilterableProperties
array of string
List of non filterable properties
requiredProperties
array of string
List of required properties

TableSelectRestrictionsMetadata

Metadata for a table (select restrictions)

selectable
boolean
Indicates whether this table has selectable columns

WorksheetMetadata

Id
string
Worksheet Id.
Name
string
Worksheet name.
Position
integer
Worksheet position.
Visibility
string
Worksheet visibility.