Connectors Reference

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.

 

Status: Production

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

GetDataSetsMetadata ()

Get datasets metadata

TestConnection ()

 

CreateTable ([internal]string source, [internal]string drive, string file, TableToCreate table)

Create table

CreateIdColumn ([internal]string source, [internal]string drive, string file, string table, [Optional]string idColumn, [internal][Optional]boolean populateColumn)

Add a key column to a table

HttpRequestGet (string requestUri)

Runs a generic HTTP request with GET method

HttpRequestPost (string requestUri)

Runs a generic HTTP request with POST method

GetTableV2 (string dataset, string table)

Get metadata of a table

ODataStyleGetItems ([internal]string source, [internal]string drive, string file, string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [advanced][Optional]string $select, [internal][Optional]string idColumn, [advanced][Optional]string dateTimeFormat)

List rows present in a table

ODataStylePostItem ([internal]string source, [internal]string drive, string file, string table, string idColumn, Item item, [internal][Optional]string mode, [advanced][Optional]string dateTimeFormat)

Update or insert a row

GetItems ([internal]string source, [internal]string drive, string file, string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [advanced][Optional]string $select, [internal][Optional]string idColumn, [advanced][Optional]string dateTimeFormat)

List rows present in a table

PostItem ([internal]string source, [internal]string drive, string file, string table, string idColumn, Item item, [internal][Optional]string mode, [advanced][Optional]string dateTimeFormat)

Update or insert a row

ODataStyleGetItemsTabular (string dataset, string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [advanced][Optional]string $select, boolean isGeneratedColumn, string pkColumn)

List rows present in a table (tabular)

ODataStylePostItemTabular (string dataset, string table, boolean isGeneratedColumn, string pkColumn, Item item)

Add a row into a table (tabular)

GetItemsTabular (string dataset, string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [advanced][Optional]string $select, boolean isGeneratedColumn, string pkColumn)

List rows present in a table (tabular)

PostItemTabular (string dataset, string table, boolean isGeneratedColumn, string pkColumn, Item item)

Add a row into a table (tabular)

GetItem ([internal]string source, [internal]string drive, string file, string table, string idColumn, string id, [advanced][Optional]string dateTimeFormat)

Get a row

DeleteItem ([internal]string source, [internal]string drive, string file, string table, string idColumn, string id)

Delete a row

PatchItem ([internal]string source, [internal]string drive, string file, string table, string idColumn, string id, Item item, [internal][Optional]string mode, [advanced][Optional]string dateTimeFormat)

Update a row

ODataStyleGetItem ([internal]string source, [internal]string drive, string file, string table, string idColumn, string id, [advanced][Optional]string dateTimeFormat)

Get a row

ODataStyleDeleteItem ([internal]string source, [internal]string drive, string file, string table, string idColumn, string id)

Delete a row

ODataStylePatchItem ([internal]string source, [internal]string drive, string file, string table, string idColumn, string id, Item item, [internal][Optional]string mode, [advanced][Optional]string dateTimeFormat)

Update a row

GetItemTabular (string dataset, string table, boolean isGeneratedColumn, string pkColumn, string id)

Get a row (tabular)

DeleteItemTabular (string dataset, string table, boolean isGeneratedColumn, string pkColumn, string id)

Delete a row (tabular)

PatchItemTabular (string dataset, string table, boolean isGeneratedColumn, string pkColumn, string id, Item item)

Update a row (tabular)

ODataStyleGetItemTabular (string dataset, string table, boolean isGeneratedColumn, string pkColumn, string id)

Get a row (tabular)

ODataStyleDeleteItemTabular (string dataset, string table, boolean isGeneratedColumn, string pkColumn, string id)

Delete a row (tabular)

ODataStylePatchItemTabular (string dataset, string table, boolean isGeneratedColumn, string pkColumn, string id, Item item)

Update a row (tabular)

GetTablesTabular (string dataset)

Lists tables exposed by the connection

ODataStyleGetTablesTabular (string dataset)

Lists tables exposed by the connection

GetSources ([advanced][Optional]string $top, [internal][Optional]string $select)

Get sources

GetDrives ([internal]string source, [internal][Optional]string $select)

Get drives

ListRootFolder ([internal]string source, [internal]string drive)

List the root folder

ListFolder ([internal]string source, [internal]string drive, string id)

List blobs under a given folder

GetAllWorksheets ([internal]string source, [internal]string drive, string file)

Get worksheets

CreateWorksheet ([internal]string source, [internal]string drive, string file, CreateWorksheetParameterBody body)

Create worksheet

GetTables ([internal]string source, [internal]string drive, string file, [internal][Optional]string $select)

Get tables

GetTable ([internal]string source, [internal]string drive, string file, string table)

Get metadata of a table

GetColumns ([internal]string source, [internal]string drive, string file, string table)

Get table columns

AddRow ([internal]string source, [internal]string drive, string file, string table, Item item)

Add a row into a table

AddRowV2 ([internal]string source, [internal]string drive, string file, string table, Item item, [advanced][Optional]string dateTimeFormat)

Add a row into a table

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

AddRowResponse

 

BlobDataSetsMetadata

 

BlobMetadata

 

CreateWorksheetParameterBody

 

DataSetsMetadata

 

GetAllWorksheetsResponse

 

GetColumnsResponse

 

GetDrivesResponse

 

GetSourcesResponse

 

GetTablesResponse

 

Item

 

ItemsList

 

Object

 

Table

 

TableCapabilitiesMetadata

 

TableFilterRestrictionsMetadata

 

TableMetadata

 

TableSelectRestrictionsMetadata

 

TablesList

 

TableSortRestrictionsMetadata

 

TableToCreate

 

TabularDataSetsMetadata

 

WorksheetMetadata

 

 

Actions:

GetDataSetsMetadata

Summary: Get datasets metadata

Description: Get datasets metadata.

 

Syntax:

ExcelOnline(OneDrive).GetDataSetsMetadata ()

 

Returns:

          Type:DataSetsMetadata

          Description: Dataset metadata

 

TestConnection

Summary:

Description:

 

Syntax:

ExcelOnline(OneDrive).TestConnection ()

 

Returns:

 

CreateTable

Summary: Create table

Description: Create a new table in the Excel workbook.

 

Syntax:

ExcelOnline(OneDrive).CreateTable ([internal]string source, [internal]string drive, string file, TableToCreate table)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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).

True

drive

string

(Document Library)

Select a document library from the drop-down.

True

file

string

(File)

Select an Excel file through File Browse.

True

table

TableToCreate

 

Table to create.

True

 

Returns:

          Type:TableMetadata

          Description: Table metadata

 

CreateIdColumn

Summary: Add a key column to a table

Description: Add a key column to an Excel table.

 

Syntax:

ExcelOnline(OneDrive).CreateIdColumn ([internal]string source, [internal]string drive, string file, string table, [Optional]string idColumn, [internal][Optional]boolean populateColumn)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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).

True

drive

string

(Document Library)

Select a document library from the drop-down.

True

file

string

(File)

Select an Excel file through File Browse.

True

table

string

(Table)

Select a table from the drop-down.

True

GetTables

idColumn

string

(Key Column)

Provide the key column name.

False

populateColumn

boolean

(Populate Column)

Should the key column be populated or not.

False

 

Returns:

 

HttpRequestGet

Summary: Runs a generic HTTP request with GET method

Description: Runs a generic HTTP request with GET method.

 

Syntax:

ExcelOnline(OneDrive).HttpRequestGet (string requestUri)

 

Parameters:

Name

Type

Summary

Required

Related Action

requestUri

string

(Request URI)

Request URI.

True

 

Returns:

          Type:Object

 

HttpRequestPost

Summary: Runs a generic HTTP request with POST method

Description: Runs a generic HTTP request with POST method.

 

Syntax:

ExcelOnline(OneDrive).HttpRequestPost (string requestUri)

 

Parameters:

Name

Type

Summary

Required

Related Action

requestUri

string

(Request URI)

Request URI.

True

 

Returns:

          Type:Object

 

GetTableV2

Summary: Get metadata of a table

Description: Get metadata of a table.

 

Syntax:

ExcelOnline(OneDrive).GetTableV2 (string dataset, string table)

 

Parameters:

Name

Type

Summary

Required

Related Action

dataset

string

(Dataset)

Dataset.

True

table

string

(Table)

table name.

True

 

Returns:

          Type:TableMetadata

          Description: Table metadata

 

ODataStyleGetItems

Summary: List rows present in a table

Description: List rows present in a table.

 

Syntax:

ExcelOnline(OneDrive).ODataStyleGetItems ([internal]string source, [internal]string drive, string file, string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [advanced][Optional]string $select, [internal][Optional]string idColumn, [advanced][Optional]string dateTimeFormat)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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)

True

drive

string

(Document Library)

Select a document library from the drop-down.

True

file

string

(File)

Select an Excel file through File Browse.

True

table

string

(Table)

Select a table from the drop-down.

True

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned.

False

$orderby

string

(Order By)

An ODATA orderBy query for specifying the order of entries.

False

$top

integer(int32)

(Top Count)

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

False

$skip

integer(int32)

(Skip Count)

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

False

$select

string

(Select Query)

Comma-separated list of columns to retrieve (first 500 by default).

False

idColumn

string

(Key Column)

Select a column from the drop-down.

False

dateTimeFormat

string

(DateTime Format)

DateTime Format.

False

 

Returns:

          Type:ItemsList

          Description: List of Items

 

ODataStylePostItem

Summary: Update or insert a row

Description: Update or insert a row using a key column.

 

Syntax:

ExcelOnline(OneDrive).ODataStylePostItem ([internal]string source, [internal]string drive, string file, string table, string idColumn, Item item, [internal][Optional]string mode, [advanced][Optional]string dateTimeFormat)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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)

True

drive

string

(Document Library)

Select a document library from the drop-down.

True

file

string

(File)

Select an Excel file through File Browse.

True

table

string

(Table)

Select a table from the drop-down.

True

idColumn

string

(Key Column)

Select a column from the drop-down.

True

item

Item

 

Table item entity

True

mode

string

(Mode)Values: [Add, AddV2, AddWithGeneratedId, AddWithCustomId, Upsert]

Mode of the operation.

False

dateTimeFormat

string

(DateTime Format)

DateTime Format.

False

 

Returns:

          Type:Item

          Description: Table item entity

 

GetItems

Summary: List rows present in a table

Description: List rows present in a table.

 

Syntax:

ExcelOnline(OneDrive).GetItems ([internal]string source, [internal]string drive, string file, string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [advanced][Optional]string $select, [internal][Optional]string idColumn, [advanced][Optional]string dateTimeFormat)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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)

True

drive

string

(Document Library)

Select a document library from the drop-down.

True

file

string

(File)

Select an Excel file through File Browse.

True

table

string

(Table)

Select a table from the drop-down.

True

GetTables

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned.

False

$orderby

string

(Order By)

An ODATA orderBy query for specifying the order of entries.

False

$top

integer(int32)

(Top Count)

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

False

$skip

integer(int32)

(Skip Count)

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

False

$select

string

(Select Query)

Comma-separated list of columns to retrieve (first 500 by default).

False

idColumn

string

(Key Column)

Select a column from the drop-down.

False

dateTimeFormat

string

(DateTime Format)Values: [Serial Number, ISO 8601]

DateTime Format.

False

 

Returns:

          Type:ItemsList

          Description: List of Items

 

PostItem

Summary: Update or insert a row

Description: Update or insert a row using a key column.

 

Syntax:

ExcelOnline(OneDrive).PostItem ([internal]string source, [internal]string drive, string file, string table, string idColumn, Item item, [internal][Optional]string mode, [advanced][Optional]string dateTimeFormat)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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)

True

drive

string

(Document Library)

Select a document library from the drop-down.

True

file

string

(File)

Select an Excel file through File Browse.

True

table

string

(Table)

Select a table from the drop-down.

True

GetTables

idColumn

string

(Key Column)

Select a column from the drop-down.

True

GetColumns

item

Item

 

Table item entity

True

mode

string

(Mode)Values: [Add, AddV2, AddWithGeneratedId, AddWithCustomId, Upsert]

Mode of the operation.

False

dateTimeFormat

string

(DateTime Format)Values: [Serial Number, ISO 8601]

DateTime Format.

False

 

Returns:

          Type:Item

          Description: Table item entity

 

ODataStyleGetItemsTabular

Summary: List rows present in a table (tabular)

Description: List rows present in a table (tabular).

 

Syntax:

ExcelOnline(OneDrive).ODataStyleGetItemsTabular (string dataset, string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [advanced][Optional]string $select, boolean isGeneratedColumn, string pkColumn)

 

Parameters:

Name

Type

Summary

Required

Related Action

dataset

string

(Dataset)

Dataset.

True

table

string

(Table)

Table.

True

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

False

$orderby

string

(Order By)

An ODATA orderBy query for specifying the order of entries.

False

$top

integer(int32)

(Top Count)

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

False

$skip

integer(int32)

(Skip Count)

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

False

$select

string

(Select Query)

Specific fields to retrieve from entries (default = all).

False

isGeneratedColumn

boolean

(Is generated column)

Is column generated.

True

pkColumn

string

(Primary key column name)

Primary key column name.

True

 

Returns:

          Type:ItemsList

          Description: List of Items

 

ODataStylePostItemTabular

Summary: Add a row into a table (tabular)

Description: Add a row into a table (tabular).

 

Syntax:

ExcelOnline(OneDrive).ODataStylePostItemTabular (string dataset, string table, boolean isGeneratedColumn, string pkColumn, Item item)

 

Parameters:

Name

Type

Summary

Required

Related Action

dataset

string

(Dataset)

Dataset.

True

table

string

(Table)

Table.

True

isGeneratedColumn

boolean

(Is generated column)

Is column generated.

True

pkColumn

string

(Primary key column name)

Primary key column name.

True

item

Item

 

Table item entity

True

 

Returns:

          Type:Item

          Description: Table item entity

 

GetItemsTabular

Summary: List rows present in a table (tabular)

Description: List rows present in a table (tabular).

 

Syntax:

ExcelOnline(OneDrive).GetItemsTabular (string dataset, string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [advanced][Optional]string $select, boolean isGeneratedColumn, string pkColumn)

 

Parameters:

Name

Type

Summary

Required

Related Action

dataset

string

(Dataset)

Dataset.

True

table

string

(Table)

Table.

True

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

False

$orderby

string

(Order By)

An ODATA orderBy query for specifying the order of entries.

False

$top

integer(int32)

(Top Count)

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

False

$skip

integer(int32)

(Skip Count)

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

False

$select

string

(Select Query)

Specific fields to retrieve from entries (default = all).

False

isGeneratedColumn

boolean

(Is generated column)

Is column generated.

True

pkColumn

string

(Primary key column name)

Primary key column name.

True

 

Returns:

          Type:ItemsList

          Description: List of Items

 

PostItemTabular

Summary: Add a row into a table (tabular)

Description: Add a row into a table (tabular).

 

Syntax:

ExcelOnline(OneDrive).PostItemTabular (string dataset, string table, boolean isGeneratedColumn, string pkColumn, Item item)

 

Parameters:

Name

Type

Summary

Required

Related Action

dataset

string

(Dataset)

Dataset.

True

table

string

(Table)

Table.

True

isGeneratedColumn

boolean

(Is generated column)

Is column generated.

True

pkColumn

string

(Primary key column name)

Primary key column name.

True

item

Item

 

Table item entity

True

 

Returns:

          Type:Item

          Description: Table item entity

 

GetItem

Summary: Get a row

Description: Get a row using a key column.

 

Syntax:

ExcelOnline(OneDrive).GetItem ([internal]string source, [internal]string drive, string file, string table, string idColumn, string id, [advanced][Optional]string dateTimeFormat)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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)

True

drive

string

(Document Library)

Select a document library from the drop-down.

True

file

string

(File)

Select an Excel file through File Browse.

True

table

string

(Table)

Select a table from the drop-down.

True

GetTables

idColumn

string

(Key Column)

Select a column from the drop-down.

True

GetColumns

id

string

(Key Value)

Enter the key value.

True

dateTimeFormat

string

(DateTime Format)Values: [Serial Number, ISO 8601]

DateTime Format.

False

 

Returns:

          Type:Item

          Description: Table item entity

 

DeleteItem

Summary: Delete a row

Description: Delete a row using a key column.

 

Syntax:

ExcelOnline(OneDrive).DeleteItem ([internal]string source, [internal]string drive, string file, string table, string idColumn, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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)

True

drive

string

(Document Library)

Select a document library from the drop-down.

True

file

string

(File)

Select an Excel file through File Browse.

True

table

string

(Table)

Select a table from the drop-down.

True

GetTables

idColumn

string

(Key Column)

Select a column from the drop-down.

True

GetColumns

id

string

(Key Value)

Enter the key value.

True

 

Returns:

 

PatchItem

Summary: Update a row

Description: Update a row using a key column.

 

Syntax:

ExcelOnline(OneDrive).PatchItem ([internal]string source, [internal]string drive, string file, string table, string idColumn, string id, Item item, [internal][Optional]string mode, [advanced][Optional]string dateTimeFormat)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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)

True

drive

string

(Document Library)

Select a document library from the drop-down.

True

file

string

(File)

Select an Excel file through File Browse.

True

table

string

(Table)

Select a table from the drop-down.

True

GetTables

idColumn

string

(Key Column)

Select a column from the drop-down.

True

GetColumns

id

string

(Key Value)

Enter the key value.

True

item

Item

 

Table item entity

True

mode

string

(Update Mode)Values: [Update, UpdateWithGeneratedId, UpdateWithCustomId]

Mode of the operation.

False

dateTimeFormat

string

(DateTime Format)Values: [Serial Number, ISO 8601]

DateTime Format.

False

 

Returns:

          Type:Item

          Description: Table item entity

 

ODataStyleGetItem

Summary: Get a row

Description: Get a row using a key column.

 

Syntax:

ExcelOnline(OneDrive).ODataStyleGetItem ([internal]string source, [internal]string drive, string file, string table, string idColumn, string id, [advanced][Optional]string dateTimeFormat)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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)

True

drive

string

(Document Library)

Select a document library from the drop-down.

True

file

string

(File)

Select an Excel file through File Browse.

True

table

string

(Table)

Select a table from the drop-down.

True

idColumn

string

(Key Column)

Select a column from the drop-down.

True

id

string

(Key Value)

Enter the key value.

True

dateTimeFormat

string

(DateTime Format)

DateTime Format.

False

 

Returns:

          Type:Item

          Description: Table item entity

 

ODataStyleDeleteItem

Summary: Delete a row

Description: Delete a row using a key column.

 

Syntax:

ExcelOnline(OneDrive).ODataStyleDeleteItem ([internal]string source, [internal]string drive, string file, string table, string idColumn, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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)

True

drive

string

(Document Library)

Select a document library from the drop-down.

True

file

string

(File)

Select an Excel file through File Browse.

True

table

string

(Table)

Select a table from the drop-down.

True

idColumn

string

(Key Column)

Select a column from the drop-down.

True

id

string

(Key Value)

Enter the key value.

True

 

Returns:

 

ODataStylePatchItem

Summary: Update a row

Description: Update a row using a key column.

 

Syntax:

ExcelOnline(OneDrive).ODataStylePatchItem ([internal]string source, [internal]string drive, string file, string table, string idColumn, string id, Item item, [internal][Optional]string mode, [advanced][Optional]string dateTimeFormat)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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)

True

drive

string

(Document Library)

Select a document library from the drop-down.

True

file

string

(File)

Select an Excel file through File Browse.

True

table

string

(Table)

Select a table from the drop-down.

True

idColumn

string

(Key Column)

Select a column from the drop-down.

True

id

string

(Key Value)

Enter the key value.

True

item

Item

 

Table item entity

True

mode

string

(Update Mode)Values: [Update, UpdateWithGeneratedId, UpdateWithCustomId]

Mode of the operation.

False

dateTimeFormat

string

(DateTime Format)

DateTime Format.

False

 

Returns:

          Type:Item

          Description: Table item entity

 

GetItemTabular

Summary: Get a row (tabular)

Description: Get a row (tabular).

 

Syntax:

ExcelOnline(OneDrive).GetItemTabular (string dataset, string table, boolean isGeneratedColumn, string pkColumn, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

dataset

string

(Dataset)

Dataset.

True

table

string

(Table)

Table.

True

isGeneratedColumn

boolean

(Is generated column)

Is column generated.

True

pkColumn

string

(Primary key column name)

Primary key column name.

True

id

string

(Key Value)

Key value.

True

 

Returns:

          Type:Item

          Description: Table item entity

 

DeleteItemTabular

Summary: Delete a row (tabular)

Description: Delete a row (tabular).

 

Syntax:

ExcelOnline(OneDrive).DeleteItemTabular (string dataset, string table, boolean isGeneratedColumn, string pkColumn, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

dataset

string

(Dataset)

Dataset.

True

table

string

(Table)

Table.

True

isGeneratedColumn

boolean

(Is generated column)

Is column generated.

True

pkColumn

string

(Primary key column name)

Primary key column name.

True

id

string

(Key Value)

Key value.

True

 

Returns:

 

PatchItemTabular

Summary: Update a row (tabular)

Description: Update a row (tabular).

 

Syntax:

ExcelOnline(OneDrive).PatchItemTabular (string dataset, string table, boolean isGeneratedColumn, string pkColumn, string id, Item item)

 

Parameters:

Name

Type

Summary

Required

Related Action

dataset

string

(Dataset)

Dataset.

True

table

string

(Table)

Table.

True

isGeneratedColumn

boolean

(Is generated column)

Is column generated.

True

pkColumn

string

(Primary key column name)

Primary key column name.

True

id

string

(Key Value)

Key value.

True

item

Item

 

Table item entity

True

 

Returns:

          Type:Item

          Description: Table item entity

 

ODataStyleGetItemTabular

Summary: Get a row (tabular)

Description: Get a row (tabular).

 

Syntax:

ExcelOnline(OneDrive).ODataStyleGetItemTabular (string dataset, string table, boolean isGeneratedColumn, string pkColumn, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

dataset

string

(Dataset)

Dataset.

True

table

string

(Table)

Table.

True

isGeneratedColumn

boolean

(Is generated column)

Is column generated.

True

pkColumn

string

(Primary key column name)

Primary key column name.

True

id

string

(Key Value)

Key value.

True

 

Returns:

          Type:Item

          Description: Table item entity

 

ODataStyleDeleteItemTabular

Summary: Delete a row (tabular)

Description: Delete a row (tabular).

 

Syntax:

ExcelOnline(OneDrive).ODataStyleDeleteItemTabular (string dataset, string table, boolean isGeneratedColumn, string pkColumn, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

dataset

string

(Dataset)

Dataset.

True

table

string

(Table)

Table.

True

isGeneratedColumn

boolean

(Is generated column)

Is column generated.

True

pkColumn

string

(Primary key column name)

Primary key column name.

True

id

string

(Key Value)

Key value.

True

 

Returns:

 

ODataStylePatchItemTabular

Summary: Update a row (tabular)

Description: Update a row (tabular).

 

Syntax:

ExcelOnline(OneDrive).ODataStylePatchItemTabular (string dataset, string table, boolean isGeneratedColumn, string pkColumn, string id, Item item)

 

Parameters:

Name

Type

Summary

Required

Related Action

dataset

string

(Dataset)

Dataset.

True

table

string

(Table)

Table.

True

isGeneratedColumn

boolean

(Is generated column)

Is column generated.

True

pkColumn

string

(Primary key column name)

Primary key column name.

True

id

string

(Key Value)

Key value.

True

item

Item

 

Table item entity

True

 

Returns:

          Type:Item

          Description: Table item entity

 

GetTablesTabular

Summary: Lists tables exposed by the connection

Description: Lists tables exposed by the connection

 

Syntax:

ExcelOnline(OneDrive).GetTablesTabular (string dataset)

 

Parameters:

Name

Type

Summary

Required

Related Action

dataset

string

(Dataset)

Dataset.

True

 

Returns:

          Type:TablesList

          Description: Represents a list of tables.

 

ODataStyleGetTablesTabular

Summary: Lists tables exposed by the connection

Description: Lists tables exposed by the connection

 

Syntax:

ExcelOnline(OneDrive).ODataStyleGetTablesTabular (string dataset)

 

Parameters:

Name

Type

Summary

Required

Related Action

dataset

string

(Dataset)

Dataset.

True

 

Returns:

          Type:TablesList

          Description: Represents a list of tables.

 

GetSources

Summary: Get sources

Description: Get a list of sources.

 

Syntax:

ExcelOnline(OneDrive).GetSources ([advanced][Optional]string $top, [internal][Optional]string $select)

 

Parameters:

Name

Type

Summary

Required

Related Action

$top

string

(Top)

Top.

False

$select

string

(Select)

Select.

False

 

Returns:

          Type:GetSourcesResponse

 

GetDrives

Summary: Get drives

Description: Get a list of drives.

 

Syntax:

ExcelOnline(OneDrive).GetDrives ([internal]string source, [internal][Optional]string $select)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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).

True

$select

string

(Select)

Select.

False

 

Returns:

          Type:GetDrivesResponse

 

ListRootFolder

Summary: List the root folder

Description: List the root folder.

 

Syntax:

ExcelOnline(OneDrive).ListRootFolder ([internal]string source, [internal]string drive)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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).

True

drive

string

(Document Library)

Select a document library from the drop-down.

True

 

Returns:

          Type:array of (BlobMetadata)

 

ListFolder

Summary: List blobs under a given folder

Description: List blobs under a given folder.

 

Syntax:

ExcelOnline(OneDrive).ListFolder ([internal]string source, [internal]string drive, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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).

True

drive

string

(Document Library)

Select a document library from the drop-down.

True

id

string

(Folder)

Folder Id.

True

 

Returns:

          Type:array of (BlobMetadata)

 

GetAllWorksheets

Summary: Get worksheets

Description: Get a list of worksheets in the Excel workbook.

 

Syntax:

ExcelOnline(OneDrive).GetAllWorksheets ([internal]string source, [internal]string drive, string file)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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).

True

drive

string

(Document Library)

Select a document library from the drop-down.

True

file

string

(File)

Select an Excel file through File Browse.

True

 

Returns:

          Type:GetAllWorksheetsResponse

 

CreateWorksheet

Summary: Create worksheet

Description: Create a new worksheet in the Excel workbook.

 

Syntax:

ExcelOnline(OneDrive).CreateWorksheet ([internal]string source, [internal]string drive, string file, CreateWorksheetParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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).

True

drive

string

(Document Library)

Select a document library from the drop-down.

True

file

string

(File)

Select an Excel file through File Browse.

True

body

CreateWorksheetParameterBody

 

 

True

 

Returns:

          Type:WorksheetMetadata

 

GetTables

Summary: Get tables

Description: Get a list of tables in the Excel workbook.

 

Syntax:

ExcelOnline(OneDrive).GetTables ([internal]string source, [internal]string drive, string file, [internal][Optional]string $select)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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).

True

drive

string

(Document Library)

Select a document library from the drop-down.

True

file

string

(File)

Select an Excel file through File Browse.

True

$select

string

(Select)

Select.

False

 

Returns:

          Type:GetTablesResponse

 

GetTable

Summary: Get metadata of a table

Description: Get metadata of a table.

 

Syntax:

ExcelOnline(OneDrive).GetTable ([internal]string source, [internal]string drive, string file, string table)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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).

True

drive

string

(Document Library)

Select a document library from the drop-down.

True

file

string

(File)

Select an Excel file through File Browse.

True

table

string

(Table)

Select a table from the drop-down.

True

GetTables

 

Returns:

          Type:TableMetadata

          Description: Table metadata

 

GetColumns

Summary: Get table columns

Description: Get table columns.

 

Syntax:

ExcelOnline(OneDrive).GetColumns ([internal]string source, [internal]string drive, string file, string table)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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).

True

drive

string

(Document Library)

Select a document library from the drop-down.

True

file

string

(File)

Select an Excel file through File Browse.

True

table

string

(Table)

Select a table from the drop-down.

True

GetTables

 

Returns:

          Type:GetColumnsResponse

 

AddRow

Summary: Add a row into a table

Description: Add a new row into the Excel table.

 

Syntax:

ExcelOnline(OneDrive).AddRow ([internal]string source, [internal]string drive, string file, string table, Item item)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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).

True

drive

string

(Document Library)

Select a document library from the drop-down.

True

file

string

(File)

Select an Excel file through File Browse.

True

table

string

(Table)

Select a table from the drop-down.

True

GetTables

item

Item

 

Table item entity

True

 

Returns:

          Type:AddRowResponse

 

AddRowV2

Summary: Add a row into a table

Description: Add a new row into the Excel table.

 

Syntax:

ExcelOnline(OneDrive).AddRowV2 ([internal]string source, [internal]string drive, string file, string table, Item item, [advanced][Optional]string dateTimeFormat)

 

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

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).

True

drive

string

(Document Library)

Select a document library from the drop-down.

True

file

string

(File)

Select an Excel file through File Browse.

True

table

string

(Table)

Select a table from the drop-down.

True

GetTables

item

Item

 

Table item entity

True

dateTimeFormat

string

(DateTime Format)Values: [Serial Number, ISO 8601]

DateTime Format.

False

 

Returns:

          Type:Item

          Description: Table item entity

 


 

AddRowResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

BlobDataSetsMetadata

Summary:

Description: Blob dataset metadata

 

          Properties:

Name

Type

Summary

source

string

 

Blob dataset source

displayName

string

 

Blob dataset display name

urlEncoding

string

 

Blob dataset url encoding


 

BlobMetadata

Summary:

Description:

 

          Properties:

Name

Type

Summary

Id

string

 

The unique id of the file or folder.

Name

string

 

The name of the file or folder.

DisplayName

string

 

The display name of the file or folder.

Path

string

 

The path of the file or folder.

MediaType

string

 

The media type of the file or folder.

IsFolder

boolean

 

A boolean value (true, false) to indicate whether or not the blob is a folder.


 

CreateWorksheetParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

Worksheet name.


 

DataSetsMetadata

Summary:

Description: Dataset metadata

 

          Properties:

Name

Type

Summary

tabular

TabularDataSetsMetadata

 

Tabular dataset metadata

blob

BlobDataSetsMetadata

 

Blob dataset metadata


 

GetAllWorksheetsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (WorksheetMetadata)

 

 


 

GetColumnsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (ValueItem)

 

 

 

ValueItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

Column name.

 


 

GetDrivesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (ValueItem)

 

 

 

ValueItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

Drive Id.

name

string

Name

Drive name.

 


 

GetSourcesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (ValueItem)

 

 

 

ValueItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

Id.

displayName

string

Name

Name.

 


 

GetTablesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (ValueItem)

 

 

 

ValueItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

Table Id.

name

string

Name

Table name.

showBandedColumns

boolean

Show banded columns

Show banded columns.

highlightFirstColumn

boolean

Highlight first column

Highlight first column.

highlightLastColumn

boolean

Highlight last column

Highlight last column.

showBandedRows

boolean

Show banded rows

Show banded rows.

showFilterButton

boolean

Show filter button

Show filter button.

showHeaders

boolean

Show headers

Show headers.

showTotals

boolean

Show totals

Show totals.

style

string

Style

Table style.

 


 

Item

Summary:

Description: Table item entity

 

          Properties:

Name

Type

Summary

dynamicProperties

DynamicProperties

 

 

 

DynamicProperties

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

ItemsList

Summary:

Description: List of Items

 

          Properties:

Name

Type

Summary

value

array of (Item)

 

List of Items


 

Object

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Table

Summary:

Description: Represents a table.

 

          Properties:

Name

Type

Summary

Name

string

 

The name of the table. The name is used at runtime.

DisplayName

string

 

The display name of the table.

DynamicProperties

DynamicProperties

 

Additional table properties provided by the connector to the clients.

 

DynamicProperties

Summary:

Description: Additional table properties provided by the connector to the clients.

 

          Properties:

Name

Type

Summary

 


 

TableCapabilitiesMetadata

Summary:

Description: Metadata for a table (capabilities)

 

          Properties:

Name

Type

Summary

sortRestrictions

TableSortRestrictionsMetadata

 

Metadata for a table (sort restrictions)

filterRestrictions

TableFilterRestrictionsMetadata

 

Metadata for a table (filter restrictions)

selectRestrictions

TableSelectRestrictionsMetadata

 

Metadata for a table (select restrictions)

isOnlyServerPagable

boolean

 

Server paging restrictions

filterFunctionSupport

array of (string)

 

List of supported filter capabilities

serverPagingOptions

array of (string)

 

List of supported server-driven paging capabilities


 

TableFilterRestrictionsMetadata

Summary:

Description: Metadata for a table (filter restrictions)

 

          Properties:

Name

Type

Summary

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


 

TableMetadata

Summary:

Description: Table metadata

 

          Properties:

Name

Type

Summary

name

string

 

Table name

title

string

 

Table title

x-ms-permission

string

 

Table permission

x-ms-capabilities

TableCapabilitiesMetadata

 

Metadata for a table (capabilities)

schema

Object

 

 

referencedEntities

Object

 

 

webUrl

string

 

Url link


 

TableSelectRestrictionsMetadata

Summary:

Description: Metadata for a table (select restrictions)

 

          Properties:

Name

Type

Summary

selectable

boolean

 

Indicates whether this table has selectable columns


 

TablesList

Summary:

Description: Represents a list of tables.

 

          Properties:

Name

Type

Summary

value

array of (Table)

 

List of Tables


 

TableSortRestrictionsMetadata

Summary:

Description: Metadata for a table (sort restrictions)

 

          Properties:

Name

Type

Summary

sortable

boolean

 

Indicates whether this table has sortable columns

unsortableProperties

array of (string)

 

List of unsortable properties

ascendingOnlyProperties

array of (string)

 

List of properties which support ascending order only


 

TableToCreate

Summary:

Description: Table to create.

 

          Properties:

Name

Type

Summary

TableName

string

Table name

Enter the Excel table name.

Range

string

Table range

Enter the table address using A1 notation.

ColumnsNames

string

Columns names

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


 

TabularDataSetsMetadata

Summary:

Description: Tabular dataset metadata

 

          Properties:

Name

Type

Summary

source

string

 

Dataset source

displayName

string

 

Dataset display name

urlEncoding

string

 

Dataset url encoding

tableDisplayName

string

 

Table display name

tablePluralName

string

 

Table plural display name


 

WorksheetMetadata

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

Worksheet Id.

name

string

Name

Worksheet name.

position

integer(int32)

Position

Worksheet position.

visibility

string

Visibility

Worksheet visibility.