ExcelonlinebusinessClient

Classes

TableMetadata dataclass

TableMetadata(name: Optional[str] = None, title: Optional[str] = None, x_ms_permission: Optional[str] = None, x_ms_capabilities: Optional[TableCapabilitiesMetadata] = None, schema: Optional[ObjectEntity] = None, referenced_entities: Optional[ObjectEntity] = None, web_url: Optional[str] = None)

Response for Create table

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Table name

title class-attribute instance-attribute

title: Optional[str] = None

Table title

x_ms_permission class-attribute instance-attribute

x_ms_permission: Optional[str] = field(default=None, metadata={'wire_name': 'x-ms-permission'})

Table permission

web_url class-attribute instance-attribute

web_url: Optional[str] = field(default=None, metadata={'wire_name': 'webUrl'})

Url link

ItemsList dataclass

ItemsList(value: Optional[List[Item]] = None, sensitivity_label_info: Optional[List[SensitivityLabelMetadata]] = None)

Response for List rows present in a table

Attributes

value class-attribute instance-attribute

value: Optional[List[Item]] = None

List of Items

CommentsList dataclass

CommentsList(value: Optional[List[Comment]] = None)

Response for List all comments present in a workbook

Attributes

value class-attribute instance-attribute

value: Optional[List[Comment]] = None

List of Comments

Comment dataclass

Comment(id: Optional[str] = None, content: Optional[str] = None, content_type: Optional[str] = None)

Response for Get a comment present in a workbook

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The unique identifier for the comment.

content class-attribute instance-attribute

content: Optional[str] = None

The content of the comment.

content_type class-attribute instance-attribute

content_type: Optional[str] = field(default=None, metadata={'wire_name': 'contentType'})

The content type of the comment.

GetItemResponse dataclass

GetItemResponse(dynamic_properties: Optional[Dict[str, Any]] = None, sensitivity_label_info: Optional[List[SensitivityLabelMetadata]] = None)

Response for Get a row

Item dataclass

Item(dynamic_properties: Optional[Dict[str, Any]] = None)

Response for Update a row

GetAllWorksheetsResponse dataclass

GetAllWorksheetsResponse(value: Optional[List[WorksheetMetadata]] = None, sensitivity_label_info: Optional[List[SensitivityLabelMetadata]] = None)

Response for Get worksheets

CreateWorksheetInput dataclass

CreateWorksheetInput(name: Optional[str] = None)

Create worksheet

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Worksheet name.

WorksheetMetadata dataclass

WorksheetMetadata(id: Optional[str] = None, name: Optional[str] = None, position: Optional[int] = None, visibility: Optional[str] = None)

Response for Create worksheet

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

Worksheet Id.

name class-attribute instance-attribute

name: Optional[str] = None

Worksheet name.

position class-attribute instance-attribute

position: Optional[int] = None

Worksheet position.

visibility class-attribute instance-attribute

visibility: Optional[str] = None

Worksheet visibility.

GetTablesResponse dataclass

GetTablesResponse(value: Optional[List[Dict[str, Any]]] = None, sensitivity_label_info: Optional[List[SensitivityLabelMetadata]] = None)

Response for Get tables

RunScriptProdInput dataclass

RunScriptProdInput(additional_properties: Dict[str, Any] = dict())

Run script from SharePoint library

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

RunScriptProdResponse dataclass

RunScriptProdResponse(additional_properties: Dict[str, Any] = dict())

Response for Run script from SharePoint library

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

GetSourcesResponse dataclass

GetSourcesResponse(value: Optional[List[Dict[str, Any]]] = None)

Response for Get sources

GetDrivesResponse dataclass

GetDrivesResponse(value: Optional[List[Dict[str, Any]]] = None)

Response for Get drives

GetColumnsResponse dataclass

GetColumnsResponse(value: Optional[List[Dict[str, Any]]] = None)

Response for Get table columns

GetSingleScriptResponse dataclass

GetSingleScriptResponse(parameter_info: Optional[Dict[str, Any]] = None)

Response for Gets one script

CreateFileMetadata dataclass

CreateFileMetadata(file_name: Optional[str] = None, web_url: Optional[str] = None)

Definition: CreateFileMetadata

Attributes

file_name class-attribute instance-attribute

file_name: Optional[str] = field(default=None, metadata={'wire_name': 'FileName'})

Name of the newly created file

web_url class-attribute instance-attribute

web_url: Optional[str] = field(default=None, metadata={'wire_name': 'WebUrl'})

URL to open the file in the browser on your OneDrive

DataSetsMetadata dataclass

DataSetsMetadata(tabular: Optional[TabularDataSetsMetadata] = None, blob: Optional[BlobDataSetsMetadata] = None)

Definition: DataSetsMetadata

TabularDataSetsMetadata dataclass

TabularDataSetsMetadata(source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None, table_display_name: Optional[str] = None, table_plural_name: Optional[str] = None)

Definition: TabularDataSetsMetadata

Attributes

source class-attribute instance-attribute

source: Optional[str] = None

Dataset source

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Dataset display name

url_encoding class-attribute instance-attribute

url_encoding: Optional[str] = field(default=None, metadata={'wire_name': 'urlEncoding'})

Dataset url encoding

table_display_name class-attribute instance-attribute

table_display_name: Optional[str] = field(default=None, metadata={'wire_name': 'tableDisplayName'})

Table display name

table_plural_name class-attribute instance-attribute

table_plural_name: Optional[str] = field(default=None, metadata={'wire_name': 'tablePluralName'})

Table plural display name

BlobDataSetsMetadata dataclass

BlobDataSetsMetadata(source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None)

Definition: BlobDataSetsMetadata

Attributes

source class-attribute instance-attribute

source: Optional[str] = None

Blob dataset source

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Blob dataset display name

url_encoding class-attribute instance-attribute

url_encoding: Optional[str] = field(default=None, metadata={'wire_name': 'urlEncoding'})

Blob dataset url encoding

TablesList dataclass

TablesList(value: Optional[List[Table]] = None)

Definition: TablesList

Attributes

value class-attribute instance-attribute

value: Optional[List[Table]] = None

List of Tables

Table dataclass

Table(name: Optional[str] = None, display_name: Optional[str] = None, dynamic_properties: Optional[Dict[str, Any]] = None)

Definition: Table

Attributes

name class-attribute instance-attribute

name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

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

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'DisplayName'})

The display name of the table.

dynamic_properties class-attribute instance-attribute

dynamic_properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'DynamicProperties'})

Additional table properties provided by the connector to the clients.

TableToCreate dataclass

TableToCreate(table_name: Optional[str] = None, range: Optional[str] = None, columns_names: Optional[str] = None)

Definition: TableToCreate

Attributes

table_name class-attribute instance-attribute

table_name: Optional[str] = field(default=None, metadata={'wire_name': 'TableName'})

Enter the Excel table name.

range class-attribute instance-attribute

range: Optional[str] = field(default=None, metadata={'wire_name': 'Range'})

Enter the table address using A1 notation.

columns_names class-attribute instance-attribute

columns_names: Optional[str] = field(default=None, metadata={'wire_name': 'ColumnsNames'})

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

TableCapabilitiesMetadata dataclass

TableCapabilitiesMetadata(sort_restrictions: Optional[TableSortRestrictionsMetadata] = None, filter_restrictions: Optional[TableFilterRestrictionsMetadata] = None, select_restrictions: Optional[TableSelectRestrictionsMetadata] = None, is_only_server_pagable: Optional[bool] = None, filter_function_support: Optional[List[str]] = None, server_paging_options: Optional[List[str]] = None)

Definition: TableCapabilitiesMetadata

Attributes

is_only_server_pagable class-attribute instance-attribute

is_only_server_pagable: Optional[bool] = field(default=None, metadata={'wire_name': 'isOnlyServerPagable'})

Server paging restrictions

filter_function_support class-attribute instance-attribute

filter_function_support: Optional[List[str]] = field(default=None, metadata={'wire_name': 'filterFunctionSupport'})

List of supported filter capabilities

server_paging_options class-attribute instance-attribute

server_paging_options: Optional[List[str]] = field(default=None, metadata={'wire_name': 'serverPagingOptions'})

List of supported server-driven paging capabilities

ObjectEntity dataclass

ObjectEntity(additional_properties: Dict[str, Any] = dict())

Definition: Object

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

TableSortRestrictionsMetadata dataclass

TableSortRestrictionsMetadata(sortable: Optional[bool] = None, unsortable_properties: Optional[List[str]] = None, ascending_only_properties: Optional[List[str]] = None)

Definition: TableSortRestrictionsMetadata

Attributes

sortable class-attribute instance-attribute

sortable: Optional[bool] = None

Indicates whether this table has sortable columns

unsortable_properties class-attribute instance-attribute

unsortable_properties: Optional[List[str]] = field(default=None, metadata={'wire_name': 'unsortableProperties'})

List of unsortable properties

ascending_only_properties class-attribute instance-attribute

ascending_only_properties: Optional[List[str]] = field(default=None, metadata={'wire_name': 'ascendingOnlyProperties'})

List of properties which support ascending order only

TableFilterRestrictionsMetadata dataclass

TableFilterRestrictionsMetadata(filterable: Optional[bool] = None, non_filterable_properties: Optional[List[str]] = None, required_properties: Optional[List[str]] = None)

Definition: TableFilterRestrictionsMetadata

Attributes

filterable class-attribute instance-attribute

filterable: Optional[bool] = None

Indicates whether this table has filterable columns

non_filterable_properties class-attribute instance-attribute

non_filterable_properties: Optional[List[str]] = field(default=None, metadata={'wire_name': 'nonFilterableProperties'})

List of non filterable properties

required_properties class-attribute instance-attribute

required_properties: Optional[List[str]] = field(default=None, metadata={'wire_name': 'requiredProperties'})

List of required properties

TableSelectRestrictionsMetadata dataclass

TableSelectRestrictionsMetadata(selectable: Optional[bool] = None)

Definition: TableSelectRestrictionsMetadata

Attributes

selectable class-attribute instance-attribute

selectable: Optional[bool] = None

Indicates whether this table has selectable columns

CommentDetails dataclass

CommentDetails(content: Optional[str] = None, content_type: Optional[str] = None)

Definition: CommentDetails

Attributes

content class-attribute instance-attribute

content: Optional[str] = None

The content of the comment.

content_type class-attribute instance-attribute

content_type: Optional[str] = field(default=None, metadata={'wire_name': 'contentType'})

The content type of the comment.

TabularItemsList dataclass

TabularItemsList(value: Optional[List[TabularItem]] = None)

Definition: TabularItemsList

Attributes

value class-attribute instance-attribute

value: Optional[List[TabularItem]] = None

List of Items

TabularItem dataclass

TabularItem(dynamic_properties: Optional[Dict[str, Any]] = None)

Definition: TabularItem

ScriptParameters dataclass

ScriptParameters(additional_properties: Dict[str, Any] = dict())

Definition: ScriptParameters

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ScriptReturnValues dataclass

ScriptReturnValues(additional_properties: Dict[str, Any] = dict())

Definition: ScriptReturnValues

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

RawAndFormattedTableSchema dataclass

RawAndFormattedTableSchema(dynamic_properties: Optional[Dict[str, Any]] = None)

Definition: RawAndFormattedTableSchema

BlobMetadata dataclass

BlobMetadata(id: Optional[str] = None, name: Optional[str] = None, display_name: Optional[str] = None, path: Optional[str] = None, media_type: Optional[str] = None, is_folder: Optional[bool] = None)

Definition: BlobMetadata

Attributes

id class-attribute instance-attribute

id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

The unique id of the file or folder.

name class-attribute instance-attribute

name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

The name of the file or folder.

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'DisplayName'})

The display name of the file or folder.

path class-attribute instance-attribute

path: Optional[str] = field(default=None, metadata={'wire_name': 'Path'})

The path of the file or folder.

media_type class-attribute instance-attribute

media_type: Optional[str] = field(default=None, metadata={'wire_name': 'MediaType'})

The media type of the file or folder.

is_folder class-attribute instance-attribute

is_folder: Optional[bool] = field(default=None, metadata={'wire_name': 'IsFolder'})

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

SensitivityLabelMetadata dataclass

SensitivityLabelMetadata(sensitivity_label_id: Optional[str] = None, name: Optional[str] = None, display_name: Optional[str] = None, tooltip: Optional[str] = None, priority: Optional[int] = None, color: Optional[str] = None, is_encrypted: Optional[bool] = None, is_enabled: Optional[bool] = None, is_parent: Optional[bool] = None, parent_sensitivity_label_id: Optional[str] = None)

Definition: SensitivityLabelMetadata

Attributes

sensitivity_label_id class-attribute instance-attribute

sensitivity_label_id: Optional[str] = field(default=None, metadata={'wire_name': 'sensitivityLabelId'})

SensitivityLabel Id.

name class-attribute instance-attribute

name: Optional[str] = None

SensitivityLabel name.

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

SensitivityLabel displayName info

tooltip class-attribute instance-attribute

tooltip: Optional[str] = None

SensitivityLabel details on tooltip.

priority class-attribute instance-attribute

priority: Optional[int] = None

SensitivityLabel priority.

color class-attribute instance-attribute

color: Optional[str] = None

SensitivityLabel color.

is_encrypted class-attribute instance-attribute

is_encrypted: Optional[bool] = field(default=None, metadata={'wire_name': 'isEncrypted'})

is SensitivityLabel Encrypted.

is_enabled class-attribute instance-attribute

is_enabled: Optional[bool] = field(default=None, metadata={'wire_name': 'isEnabled'})

Whether SensitivityLabel is Enabled.

is_parent class-attribute instance-attribute

is_parent: Optional[bool] = field(default=None, metadata={'wire_name': 'isParent'})

Whether SensitivityLabel is Parent.

parent_sensitivity_label_id class-attribute instance-attribute

parent_sensitivity_label_id: Optional[str] = field(default=None, metadata={'wire_name': 'parentSensitivityLabelId'})

Parent SensitivityLabel Id.

WorkbookRange dataclass

WorkbookRange(address: Optional[str] = None, address_local: Optional[str] = None, cell_count: Optional[int] = None, column_count: Optional[int] = None, row_count: Optional[int] = None, column_index: Optional[int] = None, row_index: Optional[int] = None, values: Optional[List[List[Any]]] = None, text: Optional[List[List[str]]] = None, formulas: Optional[List[List[str]]] = None, number_format: Optional[List[List[str]]] = None, value_types: Optional[List[List[str]]] = None)

Definition: WorkbookRange

Attributes

address class-attribute instance-attribute

address: Optional[str] = None

Range address including the sheet name, e.g. Sheet1!A1:D10.

values class-attribute instance-attribute

values: Optional[List[List[Any]]] = None

2-D array of cell values.

text class-attribute instance-attribute

text: Optional[List[List[str]]] = None

2-D array of display text.

formulas class-attribute instance-attribute

formulas: Optional[List[List[str]]] = None

2-D array of formulas.

value_types class-attribute instance-attribute

value_types: Optional[List[List[str]]] = field(default=None, metadata={'wire_name': 'valueTypes'})

2-D array of value type names (e.g. String, Double, Empty).

ExcelonlinebusinessClient

ExcelonlinebusinessClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for excelonlinebusiness connector.

Initialize a ExcelonlinebusinessClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

create_table_async async

create_table_async(input: TableToCreate, drive: str, file: str, source: str) -> dict[str, Any] | None

Create table

Create a new table in the Excel workbook.

create_id_column_async async

create_id_column_async(drive: str, file: str, table: str, source: str, id_column: Optional[str] = None) -> None

Add a key column to a table

Add a key column to an Excel table. The new column will be appended to the right.

get_items_async async

get_items_async(drive: str, file: str, table: str, source: str, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None, date_time_format: Optional[str] = None, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None) -> dict[str, Any] | None

List rows present in a table

List rows present in a table.

get_comments_async async

get_comments_async(drive: str, file: str, source: Optional[str] = None) -> dict[str, Any] | None

List all comments present in a workbook

List all comments present in a workbook.

get_comment_async async

get_comment_async(drive: str, file: str, commentid: str, source: Optional[str] = None) -> dict[str, Any] | None

Get a comment present in a workbook

Get a comment present in a workbook.

reply_comment_async async

reply_comment_async(input: CommentDetails, drive: str, file: str, commentid: str, source: Optional[str] = None) -> dict[str, Any] | None

Reply to a comment present in a workbook

Reply to a comment present in a workbook.

get_item_async async

get_item_async(drive: str, file: str, table: str, id: str, source: str, id_column: str, date_time_format: Optional[str] = None, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None) -> dict[str, Any] | None

Get a row

Get a row using a key column.

delete_item_async async

delete_item_async(drive: str, file: str, table: str, id: str, source: str, id_column: str) -> None

Delete a row

Delete a row using a key column.

patch_item_async async

patch_item_async(input: Item, drive: str, file: str, table: str, id: str, source: str, id_column: str, date_time_format: Optional[str] = None) -> dict[str, Any] | None

Update a row

Update a row using a key column. The input value will overwrite the specified cells and columns left blank will not be updated. In order to append (instead of overwrite) a value, use the "Get a row" action to retrieve the content first.

get_all_worksheets_async async

get_all_worksheets_async(drive: str, file: str, source: str, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None) -> dict[str, Any] | None

Get worksheets

Get a list of worksheets in the Excel workbook.

create_worksheet_async async

create_worksheet_async(input: CreateWorksheetInput, drive: str, file: str, source: str) -> dict[str, Any] | None

Create worksheet

Create a new worksheet in the Excel workbook.

get_tables_async async

get_tables_async(drive: str, file: str, source: str, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None) -> dict[str, Any] | None

Get tables

Get a list of tables in the Excel workbook.

add_row_async async

add_row_async(input: Item, drive: str, file: str, table: str, source: str, date_time_format: Optional[str] = None) -> dict[str, Any] | None

Add a row into a table

Add a new row into the Excel table.

run_script_prod_async async

run_script_prod_async(input: RunScriptProdInput, drive: str, file: str, script_drive: str, script_id: str, source: str, script_source: str) -> dict[str, Any] | None

Run script from SharePoint library

Runs an Office Script against an Excel workbook. Use this action when the script is saved outside of the default location.

get_sources_async async

get_sources_async(top: Optional[str] = None) -> dict[str, Any] | None

Get sources

Get a list of sources.

get_drives_async async

get_drives_async(source: str) -> dict[str, Any] | None

Get drives

Get a list of drives.

get_columns_async async

get_columns_async(drive: str, file: str, table: str, source: str) -> dict[str, Any] | None

Get table columns

Get table columns.

get_table_async async

get_table_async(drive: str, file: str, table: str, source: str) -> dict[str, Any] | None

Get metadata of a table

Get metadata of a table.

get_single_script_async async

get_single_script_async(script_source: str, script_drive: str, script_id: str) -> dict[str, Any] | None

Gets one script

Gets one of the scripts.