ExcelonlinebusinessClient

Classes

TableMetadata dataclass

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

Response for Create table

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Table name

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Table title

x_ms_permission class-attribute instance-attribute

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

Table permission

web_url class-attribute instance-attribute

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

Url link

ItemsList dataclass

ItemsList(*, value: Optional[List[Item | Mapping[str, Any]]] = None, sensitivity_label_info: Optional[List[SensitivityLabelMetadata | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List rows present in a table

Attributes

value class-attribute instance-attribute

value: Optional[List[Item | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Items

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

The URL to retrieve the next page.

CommentsList dataclass

CommentsList(*, value: Optional[List[Comment | Mapping[str, Any]]] = None)

Response for List all comments present in a workbook

Attributes

value class-attribute instance-attribute

value: Optional[List[Comment | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

The unique identifier for the comment.

content class-attribute instance-attribute

content: Optional[str] = dataclass_field(default=None, kw_only=True)

The content of the comment.

content_type class-attribute instance-attribute

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

The content type of the comment.

GetItemResponse dataclass

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

Response for Get a row

Item dataclass

Item(*, dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = None)

Response for Update a row

GetAllWorksheetsResponse dataclass

GetAllWorksheetsResponse(*, value: Optional[List[WorksheetMetadata | Mapping[str, Any]]] = None, sensitivity_label_info: Optional[List[SensitivityLabelMetadata | Mapping[str, Any]]] = None)

Response for Get worksheets

CreateWorksheetInput dataclass

CreateWorksheetInput(*, name: Optional[str] = None)

Create worksheet

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

Worksheet Id.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Worksheet name.

position class-attribute instance-attribute

position: Optional[int] = dataclass_field(default=None, kw_only=True)

Worksheet position.

visibility class-attribute instance-attribute

visibility: Optional[str] = dataclass_field(default=None, kw_only=True)

Worksheet visibility.

GetTablesResponse dataclass

GetTablesResponse(*, value: Optional[List[Dict[str, Any]]] = None, sensitivity_label_info: Optional[List[SensitivityLabelMetadata | Mapping[str, Any]]] = 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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FileName'})

Name of the newly created file

web_url class-attribute instance-attribute

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

URL to open the file in the browser on your OneDrive

DataSetsMetadata dataclass

DataSetsMetadata(*, tabular: Optional[TabularDataSetsMetadata | Mapping[str, Any]] = None, blob: Optional[BlobDataSetsMetadata | Mapping[str, Any]] = 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] = dataclass_field(default=None, kw_only=True)

Dataset source

display_name class-attribute instance-attribute

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

Dataset display name

url_encoding class-attribute instance-attribute

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

Dataset url encoding

table_display_name class-attribute instance-attribute

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

Table display name

table_plural_name class-attribute instance-attribute

table_plural_name: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

Blob dataset source

display_name class-attribute instance-attribute

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

Blob dataset display name

url_encoding class-attribute instance-attribute

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

Blob dataset url encoding

TablesList dataclass

TablesList(*, value: Optional[List[Table | Mapping[str, Any]]] = None)

Definition: TablesList

Attributes

value class-attribute instance-attribute

value: Optional[List[Table | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Tables

Table dataclass

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

Definition: Table

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DisplayName'})

The display name of the table.

dynamic_properties class-attribute instance-attribute

dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DynamicProperties'})

Additional table properties provided by the connector to the clients.

TableToCreate dataclass

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

Definition: TableToCreate

Attributes

table_name class-attribute instance-attribute

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

Enter the Excel table name.

range class-attribute instance-attribute

range: str = dataclass_field(metadata={'wire_name': 'Range'})

Enter the table address using A1 notation.

columns_names class-attribute instance-attribute

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

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

TableCapabilitiesMetadata dataclass

TableCapabilitiesMetadata(*, sort_restrictions: Optional[TableSortRestrictionsMetadata | Mapping[str, Any]] = None, filter_restrictions: Optional[TableFilterRestrictionsMetadata | Mapping[str, Any]] = None, select_restrictions: Optional[TableSelectRestrictionsMetadata | Mapping[str, Any]] = 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isOnlyServerPagable'})

Server paging restrictions

filter_function_support class-attribute instance-attribute

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

List of supported filter capabilities

server_paging_options class-attribute instance-attribute

server_paging_options: Optional[List[str]] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

Indicates whether this table has sortable columns

unsortable_properties class-attribute instance-attribute

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

List of unsortable properties

ascending_only_properties class-attribute instance-attribute

ascending_only_properties: Optional[List[str]] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

Indicates whether this table has filterable columns

non_filterable_properties class-attribute instance-attribute

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

List of non filterable properties

required_properties class-attribute instance-attribute

required_properties: Optional[List[str]] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

The content of the comment.

content_type class-attribute instance-attribute

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

The content type of the comment.

TabularItemsList dataclass

TabularItemsList(*, value: Optional[List[TabularItem | Mapping[str, Any]]] = None)

Definition: TabularItemsList

Attributes

value class-attribute instance-attribute

value: Optional[List[TabularItem | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Items

TabularItem dataclass

TabularItem(*, dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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

RawAndFormattedTableSchema dataclass

RawAndFormattedTableSchema(*, dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The unique id of the file or folder.

name class-attribute instance-attribute

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

The name of the file or folder.

display_name class-attribute instance-attribute

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

The display name of the file or folder.

path class-attribute instance-attribute

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

The path of the file or folder.

media_type class-attribute instance-attribute

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

The media type of the file or folder.

is_folder class-attribute instance-attribute

is_folder: Optional[bool] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'sensitivityLabelId'})

SensitivityLabel Id.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

SensitivityLabel name.

display_name class-attribute instance-attribute

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

SensitivityLabel displayName info

tooltip class-attribute instance-attribute

tooltip: Optional[str] = dataclass_field(default=None, kw_only=True)

SensitivityLabel details on tooltip.

priority class-attribute instance-attribute

priority: Optional[int] = dataclass_field(default=None, kw_only=True)

SensitivityLabel priority.

color class-attribute instance-attribute

color: Optional[str] = dataclass_field(default=None, kw_only=True)

SensitivityLabel color.

is_encrypted class-attribute instance-attribute

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

is SensitivityLabel Encrypted.

is_enabled class-attribute instance-attribute

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

Whether SensitivityLabel is Enabled.

is_parent class-attribute instance-attribute

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

Whether SensitivityLabel is Parent.

parent_sensitivity_label_id class-attribute instance-attribute

parent_sensitivity_label_id: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

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

values class-attribute instance-attribute

values: Optional[List[List[Any]]] = dataclass_field(default=None, kw_only=True)

2-D array of cell values.

text class-attribute instance-attribute

text: Optional[List[List[str]]] = dataclass_field(default=None, kw_only=True)

2-D array of display text.

formulas class-attribute instance-attribute

formulas: Optional[List[List[str]]] = dataclass_field(default=None, kw_only=True)

2-D array of formulas.

value_types class-attribute instance-attribute

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

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

ExcelonlinebusinessClient

ExcelonlinebusinessClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

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
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

create_table async

create_table(input: TableToCreate | Mapping[str, Any], drive: str, file: str, source: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create table

Create a new table in the Excel workbook.

Swagger operation ID: CreateTable.

Parameters:

Name	Type	Description	Default
input	TableToCreate | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
drive	str	Select a document library from the drop-down.	required
file	str	Select an Excel file through File Browse.	required
source	str	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).	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_id_column async

create_id_column(drive: str, file: str, table: str, source: str, *, id_column: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = 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.

Swagger operation ID: CreateIdColumn.

Parameters:

Name	Type	Description	Default
drive	str	Select a document library from the drop-down.	required
file	str	Select an Excel file through File Browse.	required
table	str	Select a table from the drop-down.	required
source	str	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).	required
id_column	Optional[str]	Provide the key column name.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_items

list_items(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, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List rows present in a table

List rows present in a table.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetItems.

Parameters:

Name	Type	Description	Default
drive	str	Select a document library from the drop-down.	required
file	str	Select an Excel file through File Browse.	required
table	str	Select a table from the drop-down.	required
source	str	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).	required
filter	Optional[str]	An ODATA filter query to restrict the entries returned.	None
orderby	Optional[str]	An ODATA orderBy query for specifying the order of entries.	None
top	Optional[int]	Total number of entries to retrieve (default = all).	None
skip	Optional[int]	The number of entries to skip (default = 0).	None
select	Optional[str]	Comma-separated list of columns to retrieve (first 500 by default).	None
date_time_format	Optional[str]	DateTime Format.	None
extract_sensitivity_label	Optional[bool]	A boolean whether to extract sensitivity label Id for associated artefact.	None
fetch_sensitivity_label_metadata	Optional[bool]	A boolean whether to fetch sensitivity label Metadata for associated LabelId.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_comments

list_comments(drive: str, file: str, *, source: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List all comments present in a workbook

List all comments present in a workbook.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetComments.

Parameters:

Name	Type	Description	Default
drive	str	Ask user to select a document library from the drop-down.	required
file	str	Ask user to select an Excel file through File Browse.	required
source	Optional[str]	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).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_comment async

get_comment(drive: str, file: str, commentid: str, *, source: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a comment present in a workbook

Get a comment present in a workbook.

Swagger operation ID: GetComment.

Parameters:

Name	Type	Description	Default
drive	str	Select a document library from the drop-down.	required
file	str	Select an Excel file through File Browse.	required
commentid	str	Provide a comment Id .	required
source	Optional[str]	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).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

reply_comment async

reply_comment(input: CommentDetails | Mapping[str, Any], drive: str, file: str, commentid: str, *, source: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Reply to a comment present in a workbook

Reply to a comment present in a workbook.

Swagger operation ID: ReplyComment.

Parameters:

Name	Type	Description	Default
input	CommentDetails | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
drive	str	Ask user to select a document library from the drop-down.	required
file	str	Ask user to select an Excel file through File Browse.	required
commentid	str	Provide a comment Id .	required
source	Optional[str]	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).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_item async

get_item(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, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a row

Get a row using a key column.

Swagger operation ID: GetItem.

Parameters:

Name	Type	Description	Default
drive	str	Select a document library from the drop-down.	required
file	str	Select an Excel file through File Browse.	required
table	str	Select a table from the drop-down.	required
id	str	Enter the key value.	required
source	str	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).	required
id_column	str	Select a column from the drop-down.	required
date_time_format	Optional[str]	DateTime Format.	None
extract_sensitivity_label	Optional[bool]	A boolean whether to extract sensitivity label Id for associated artefact.	None
fetch_sensitivity_label_metadata	Optional[bool]	A boolean whether to fetch sensitivity label Metadata for associated LabelId.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_item async

delete_item(drive: str, file: str, table: str, id: str, source: str, id_column: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete a row

Delete a row using a key column.

Swagger operation ID: DeleteItem.

Parameters:

Name	Type	Description	Default
drive	str	Select a document library from the drop-down.	required
file	str	Select an Excel file through File Browse.	required
table	str	Select a table from the drop-down.	required
id	str	Enter the key value.	required
source	str	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).	required
id_column	str	Select a column from the drop-down.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

patch_item async

patch_item(input: Item | Mapping[str, Any], drive: str, file: str, table: str, id: str, source: str, id_column: str, *, date_time_format: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = 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.

Swagger operation ID: PatchItem.

Parameters:

Name	Type	Description	Default
input	Item | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
drive	str	Select a document library from the drop-down.	required
file	str	Select an Excel file through File Browse.	required
table	str	Select a table from the drop-down.	required
id	str	Enter the key value.	required
source	str	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).	required
id_column	str	Select a column from the drop-down.	required
date_time_format	Optional[str]	DateTime Format.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_all_worksheets

list_all_worksheets(drive: str, file: str, source: str, *, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get worksheets

Get a list of worksheets in the Excel workbook.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetAllWorksheets.

Parameters:

Name	Type	Description	Default
drive	str	Select a document library from the drop-down.	required
file	str	Select an Excel file through File Browse.	required
source	str	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).	required
extract_sensitivity_label	Optional[bool]	A boolean whether to extract sensitivity label Id for associated artefact.	None
fetch_sensitivity_label_metadata	Optional[bool]	A boolean whether to fetch sensitivity label Metadata for associated LabelId.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_worksheet async

create_worksheet(input: CreateWorksheetInput | Mapping[str, Any], drive: str, file: str, source: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create worksheet

Create a new worksheet in the Excel workbook.

Swagger operation ID: CreateWorksheet.

Parameters:

Name	Type	Description	Default
input	CreateWorksheetInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
drive	str	Select a document library from the drop-down.	required
file	str	Select an Excel file through File Browse.	required
source	str	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).	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_tables

list_tables(drive: str, file: str, source: str, *, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get tables

Get a list of tables in the Excel workbook.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetTables.

Parameters:

Name	Type	Description	Default
drive	str	Select a document library from the drop-down.	required
file	str	Select an Excel file through File Browse.	required
source	str	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).	required
extract_sensitivity_label	Optional[bool]	A boolean whether to extract sensitivity label Id for associated artefact.	None
fetch_sensitivity_label_metadata	Optional[bool]	A boolean whether to fetch sensitivity label Metadata for associated LabelId.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

add_row async

add_row(input: Item | Mapping[str, Any], drive: str, file: str, table: str, source: str, *, date_time_format: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Add a row into a table

Add a new row into the Excel table.

Swagger operation ID: AddRowV2.

Parameters:

Name	Type	Description	Default
input	Item | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
drive	str	Select a document library from the drop-down.	required
file	str	Select an Excel file through File Browse.	required
table	str	Select a table from the drop-down.	required
source	str	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).	required
date_time_format	Optional[str]	DateTime Format.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

run_script_prod async

run_script_prod(input: RunScriptProdInput | Mapping[str, Any], drive: str, file: str, script_drive: str, script_id: str, source: str, script_source: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: RunScriptProdV2.

Parameters:

Name	Type	Description	Default
input	RunScriptProdInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
drive	str	Select a document library from the drop-down.	required
file	str	Select an Excel workbook through File Browse.	required
script_drive	str	Select the SharePoint library of your Office Script file (.osts) from the drop-down.	required
script_id	str	Select an Office Script file (.osts) in a SharePoint library from the drop-down.	required
source	str	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).	required
script_source	str	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).	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_sources

list_sources(*, top: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get sources

Get a list of sources.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetSources.

Parameters:

Name	Type	Description	Default
top	Optional[str]	Top.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_drives

list_drives(source: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get drives

Get a list of drives.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetDrives.

Parameters:

Name	Type	Description	Default
source	str	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).	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_columns

list_columns(drive: str, file: str, table: str, source: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get table columns

Get table columns.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetColumns.

Parameters:

Name	Type	Description	Default
drive	str	Select a document library from the drop-down.	required
file	str	Select an Excel file through File Browse.	required
table	str	Select a table from the drop-down.	required
source	str	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).	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_table async

get_table(drive: str, file: str, table: str, source: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get metadata of a table

Get metadata of a table.

Swagger operation ID: GetTable.

Parameters:

Name	Type	Description	Default
drive	str	Select a document library from the drop-down.	required
file	str	Select an Excel file through File Browse.	required
table	str	Select a table from the drop-down.	required
source	str	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).	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_single_script async

get_single_script(script_source: str, script_drive: str, script_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Gets one script

Gets one of the scripts.

Swagger operation ID: GetSingleScriptV2.

Parameters:

Name	Type	Description	Default
script_source	str	script source.	required
script_drive	str	script drive.	required
script_id	str	Script chosen to use.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.