SharepointonlineClient

Attributes

TRIGGER_OPERATIONS `module-attribute`

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'GetOnChangedItems': {'operation_id': 'GetOnChangedItems', 'path': '/{connectionId}/datasets/{dataset}/tables/{table}/onchangeditems', 'method': 'get', 'required_parameters': ['dataset', 'table'], 'callback_payload_type': 'ItemsList'}, 'GetOnDeletedFileItems': {'operation_id': 'GetOnDeletedFileItems', 'path': '/{connectionId}/datasets/{dataset}/tables/{table}/ondeletedfileitems', 'method': 'get', 'required_parameters': ['dataset', 'table'], 'callback_payload_type': 'DeletedItemList'}, 'GetOnDeletedItems': {'operation_id': 'GetOnDeletedItems', 'path': '/{connectionId}/datasets/{dataset}/tables/{table}/ondeleteditems', 'method': 'get', 'required_parameters': ['dataset', 'table'], 'callback_payload_type': 'DeletedItemList'}, 'GetOnNewFileItems': {'operation_id': 'GetOnNewFileItems', 'path': '/{connectionId}/datasets/{dataset}/tables/{table}/onnewfileitems', 'method': 'get', 'required_parameters': ['dataset', 'table'], 'callback_payload_type': 'ItemsList'}, 'GetOnNewItems': {'operation_id': 'GetOnNewItems', 'path': '/{connectionId}/datasets/{dataset}/tables/{table}/onnewitems', 'method': 'get', 'required_parameters': ['dataset', 'table'], 'callback_payload_type': 'ItemsList'}, 'GetOnNewItemsFromForm': {'operation_id': 'GetOnNewItemsFromForm', 'path': '/{connectionId}/datasets/{dataset}/tables/{table}/onnewitemsfromform', 'method': 'get', 'required_parameters': ['dataset', 'table', 'form'], 'callback_payload_type': 'ItemsList'}, 'GetOnRecurrenceDigest': {'operation_id': 'GetOnRecurrenceDigest', 'path': '/{connectionId}/datasets/{dataset}/tables/{table}/onrecurrencedigest', 'method': 'get', 'required_parameters': ['dataset', 'table', 'update', 'add', 'runSchedule'], 'callback_payload_type': 'ItemsList'}, 'GetOnUpdatedFileClassifiedTimes': {'operation_id': 'GetOnUpdatedFileClassifiedTimes', 'path': '/{connectionId}/datasets/{dataset}/tables/{table}/onupdatedfileclassifiedtimes', 'method': 'get', 'required_parameters': ['dataset', 'table'], 'callback_payload_type': 'ItemsList'}, 'GetOnUpdatedFileItems': {'operation_id': 'GetOnUpdatedFileItems', 'path': '/{connectionId}/datasets/{dataset}/tables/{table}/onupdatedfileitems', 'method': 'get', 'required_parameters': ['dataset', 'table'], 'callback_payload_type': 'ItemsList'}, 'GetOnUpdatedItems': {'operation_id': 'GetOnUpdatedItems', 'path': '/{connectionId}/datasets/{dataset}/tables/{table}/onupdateditems', 'method': 'get', 'required_parameters': ['dataset', 'table'], 'callback_payload_type': 'ItemsList'}, 'OnNewFile': {'operation_id': 'OnNewFile', 'path': '/{connectionId}/datasets/{dataset}/triggers/onnewfile', 'method': 'get', 'required_parameters': ['dataset', 'folderId'], 'callback_payload_type': None}, 'OnUpdatedFile': {'operation_id': 'OnUpdatedFile', 'path': '/{connectionId}/datasets/{dataset}/triggers/onupdatedfile', 'method': 'get', 'required_parameters': ['dataset', 'folderId'], 'callback_payload_type': None}}

Classes

CreateAgreementsSolutionDocumentInput `dataclass`

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

Agreements Solution - Generate document within Agreements Solution workspace

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

SPBlobMetadataResponse `dataclass`

SPBlobMetadataResponse(*, item_id: Optional[int] = None, id: Optional[str] = None, name: Optional[str] = None, display_name: Optional[str] = None, path: Optional[str] = None, last_modified: Optional[str] = None, size: Optional[int] = None, media_type: Optional[str] = None, is_folder: Optional[bool] = None, e_tag: Optional[str] = None, file_locator: Optional[str] = None)

Response for Agreements Solution - Generate document within Agreements Solution workspace

Attributes

item_id `class-attribute` `instance-attribute`

item_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ItemId'})

The value that can be used to Get or Update file properties in libraries.

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.

last_modified `class-attribute` `instance-attribute`

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

The date and time the file or folder was last modified.

size `class-attribute` `instance-attribute`

size: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Size'})

The size 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.

e_tag `class-attribute` `instance-attribute`

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

The etag of the file or folder.

file_locator `class-attribute` `instance-attribute`

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

The filelocator of the file or folder.

TablesList `dataclass`

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

Response for Get all lists and libraries

Attributes

value `class-attribute` `instance-attribute`

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

List of Tables

ApproveHubSiteJoinResponse `dataclass`

ApproveHubSiteJoinResponse(*, approval_token: Optional[str] = None)

Response for Approve hub site join request

Attributes

approval_token `class-attribute` `instance-attribute`

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

Approval Token

SharingLinkPermission `dataclass`

SharingLinkPermission(*, link: Optional[SharingLink | Mapping[str, Any]] = None)

Response for Create sharing link for a file or folder

BlobMetadata `dataclass`

BlobMetadata(*, id: Optional[str] = None, name: Optional[str] = None, display_name: Optional[str] = None, path: Optional[str] = None, last_modified: Optional[str] = None, size: Optional[int] = None, media_type: Optional[str] = None, is_folder: Optional[bool] = None, e_tag: Optional[str] = None, file_locator: Optional[str] = None)

Response for Copy file (deprecated)

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.

last_modified `class-attribute` `instance-attribute`

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

The date and time the file or folder was last modified.

size `class-attribute` `instance-attribute`

size: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Size'})

The size 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.

e_tag `class-attribute` `instance-attribute`

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

The etag of the file or folder.

file_locator `class-attribute` `instance-attribute`

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

The filelocator of the file or folder.

BlobMetadataResponse `dataclass`

BlobMetadataResponse(*, id: Optional[str] = None, name: Optional[str] = None, display_name: Optional[str] = None, path: Optional[str] = None, last_modified: Optional[str] = None, size: Optional[int] = None, media_type: Optional[str] = None, is_folder: Optional[bool] = None, e_tag: Optional[str] = None, file_locator: Optional[str] = None)

Response for Update file

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.

last_modified `class-attribute` `instance-attribute`

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

The date and time the file or folder was last modified.

size `class-attribute` `instance-attribute`

size: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Size'})

The size 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.

e_tag `class-attribute` `instance-attribute`

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

The etag of the file or folder.

file_locator `class-attribute` `instance-attribute`

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

The filelocator of the file or folder.

CreateNewDocumentSetResponse `dataclass`

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

Response for Create new document set

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

CreateNewFolderResponse `dataclass`

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

Response for Create new folder

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

SPListExpandedUser `dataclass`

SPListExpandedUser(*, claims: Optional[str] = None, display_name: Optional[str] = None, email: Optional[str] = None, picture: Optional[str] = None, department: Optional[str] = None, job_title: Optional[str] = None, type_: Optional[str] = None)

Response for Resolve person

Attributes

claims `class-attribute` `instance-attribute`

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

user claims

display_name `class-attribute` `instance-attribute`

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

user title

email `class-attribute` `instance-attribute`

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

user email

picture `class-attribute` `instance-attribute`

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

user picture

department `class-attribute` `instance-attribute`

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

user department

job_title `class-attribute` `instance-attribute`

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

user job title

TableForm `dataclass`

TableForm(*, form_id: Optional[str] = None, display_name: Optional[str] = None, type_: Optional[str] = None, link: Optional[str] = None, created_by: Optional[str] = None, created: Optional[str] = None, modified: Optional[str] = None, modified_by: Optional[str] = None, output_format: Optional[str] = None, fields_metadata: Optional[List[FormFieldMetadata | Mapping[str, Any]]] = None)

Response for Get form metadata (preview)

Attributes

form_id `class-attribute` `instance-attribute`

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

Gets or sets the form ID

display_name `class-attribute` `instance-attribute`

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

Gets or sets the form display name

type_ `class-attribute` `instance-attribute`

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

Gets or sets the form type

link `class-attribute` `instance-attribute`

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

Gets or sets the form link/URL

created_by `class-attribute` `instance-attribute`

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

Gets or sets the user who created the form

created `class-attribute` `instance-attribute`

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

Gets or sets the date the form was created

modified `class-attribute` `instance-attribute`

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

Gets or sets the date the form was last modified

modified_by `class-attribute` `instance-attribute`

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

Gets or sets the user who last modified the form

output_format `class-attribute` `instance-attribute`

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

Gets or sets the output format (e.g. "Word document", "PDF document", "None")

fields_metadata `class-attribute` `instance-attribute`

fields_metadata: Optional[List[FormFieldMetadata | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FieldsMetadata'})

Gets or sets Form Fields

SubmitDocGenFormInput `dataclass`

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

Generate a document from a form (preview)

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

ItemsList `dataclass`

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

Response for Get files (properties only)

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.

PostItemInput `dataclass`

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

Create item

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

PostItemResponse `dataclass`

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

Response for Create item

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

GetItemResponse `dataclass`

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

Response for Get item

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

PatchItemInput `dataclass`

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

Update item

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

PatchItemResponse `dataclass`

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

Response for Update item

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

CreateApprovalRequestInput `dataclass`

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

Create an approval request for an item or file

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

ApprovalData `dataclass`

ApprovalData(approval_id: str)

Response for Create an approval request for an item or file

Attributes

approval_id `class-attribute` `instance-attribute`

approval_id: str = dataclass_field(metadata={'wire_name': 'ApprovalId'})

The ID of the approval request created

GetItemChangesResponse `dataclass`

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

Response for Get changes for an item or a file (properties only)

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

Item `dataclass`

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

Response for Get file properties

PatchFileItemInput `dataclass`

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

Update file properties

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

PatchFileItemResponse `dataclass`

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

Response for Update file properties

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

SetApprovalStatusOutput `dataclass`

SetApprovalStatusOutput(*, e_tag: Optional[str] = None, approval_link: Optional[str] = None, publish_start_date: Optional[str] = None, content_approval_status: Optional[str] = None, scheduled_version: Optional[str] = None)

Response for Set content approval status

Attributes

e_tag `class-attribute` `instance-attribute`

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

ETag of the item after the approval status was set

approval_link `class-attribute` `instance-attribute`

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

A link to the item that needs approval

publish_start_date `class-attribute` `instance-attribute`

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

Date time at which the item will be Published

content_approval_status `class-attribute` `instance-attribute`

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

The content approval status of the list item

scheduled_version `class-attribute` `instance-attribute`

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

The version of the item that has been scheduled

SPListItemAttachment `dataclass`

SPListItemAttachment(*, id: Optional[str] = None, absolute_uri: Optional[str] = None, display_name: Optional[str] = None)

Response for Get attachments

Attributes

id `class-attribute` `instance-attribute`

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

File identifier

absolute_uri `class-attribute` `instance-attribute`

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

Link to attachment

display_name `class-attribute` `instance-attribute`

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

Name

DeletedItemList `dataclass`

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

Response for When a file is deleted

Attributes

value `class-attribute` `instance-attribute`

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

List of Deleted Items

CreateContentAssemblyDocumentInput `dataclass`

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

Generate document using Microsoft Syntex (preview)

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

Table `dataclass`

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

Response for Get list views

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.

DataSetsList `dataclass`

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

Response for Get datasets

Attributes

value `class-attribute` `instance-attribute`

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

List of datasets

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 Agreements Solution - Get template fields

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

ObjectEntity `dataclass`

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

Response for Get thumbnail size options

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

SPListEntity `dataclass`

SPListEntity(*, id: Optional[str] = None, entity_type: Optional[str] = None)

Response for Returns User fields for a list

Attributes

id `class-attribute` `instance-attribute`

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

The Id of the SPField

entity_type `class-attribute` `instance-attribute`

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

What type of entity (field) this is

GetItemChangesMetadataResponse `dataclass`

GetItemChangesMetadataResponse(*, schema: Optional[ObjectEntity | Mapping[str, Any]] = None)

Response for Get metadata about the return type of the GetItemChanges operation

ApplicationPermissionIdentity `dataclass`

ApplicationPermissionIdentity(*, display_name: Optional[str] = None)

Definition: ApplicationPermissionIdentity

Attributes

display_name `class-attribute` `instance-attribute`

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

Application 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

BlobMetadataPage `dataclass`

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

Definition: BlobMetadataPage

Attributes

value `class-attribute` `instance-attribute`

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

Blob metadata collection.

CopyFileParameters `dataclass`

CopyFileParameters(source_file_id: str, destination_dataset: str, destination_folder_path: str, name_conflict_behavior: int)

Definition: CopyFileParameters

Attributes

source_file_id `class-attribute` `instance-attribute`

source_file_id: str = dataclass_field(metadata={'wire_name': 'sourceFileId'})

File Identifier

destination_dataset `class-attribute` `instance-attribute`

destination_dataset: str = dataclass_field(metadata={'wire_name': 'destinationDataset'})

Example: https://contoso.sharepoint.com/sites/sitename

destination_folder_path `class-attribute` `instance-attribute`

destination_folder_path: str = dataclass_field(metadata={'wire_name': 'destinationFolderPath'})

Destination Folder

name_conflict_behavior `class-attribute` `instance-attribute`

name_conflict_behavior: int = dataclass_field(metadata={'wire_name': 'nameConflictBehavior'})

Pick one of the options available

CopyFolderParameters `dataclass`

CopyFolderParameters(source_folder_id: str, destination_dataset: str, destination_folder_path: str, name_conflict_behavior: int)

Definition: CopyFolderParameters

Attributes

source_folder_id `class-attribute` `instance-attribute`

source_folder_id: str = dataclass_field(metadata={'wire_name': 'sourceFolderId'})

File Identifier

destination_dataset `class-attribute` `instance-attribute`

destination_dataset: str = dataclass_field(metadata={'wire_name': 'destinationDataset'})

Example: https://contoso.sharepoint.com/sites/sitename

destination_folder_path `class-attribute` `instance-attribute`

destination_folder_path: str = dataclass_field(metadata={'wire_name': 'destinationFolderPath'})

Destination Folder

name_conflict_behavior `class-attribute` `instance-attribute`

name_conflict_behavior: int = dataclass_field(metadata={'wire_name': 'nameConflictBehavior'})

Pick one of the options available

CreateNewDocumentSetParameters `dataclass`

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

Definition: CreateNewDocumentSetParameters

Attributes

path `instance-attribute`

path: str

Example: folder1/folder2/dsName

content_type_id `class-attribute` `instance-attribute`

content_type_id: str = dataclass_field(metadata={'wire_name': 'contentTypeId'})

Example: 0x0120D520

CreateNewFolderParameters `dataclass`

CreateNewFolderParameters(path: str)

Definition: CreateNewFolderParameters

Attributes

path `instance-attribute`

path: str

Example: folder1/folder2/folder3

DataSet `dataclass`

DataSet(*, name: Optional[str] = None, display_name: Optional[str] = None, query: Optional[List[PassThroughNativeQuery | Mapping[str, Any]]] = None)

Definition: DataSet

Attributes

name `class-attribute` `instance-attribute`

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

Dataset name

display_name `class-attribute` `instance-attribute`

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

Dataset display name

query `class-attribute` `instance-attribute`

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

Pass-through Native Queries

DataSetsMetadata `dataclass`

DataSetsMetadata(*, tabular: Optional[TabularDataSetsMetadata | Mapping[str, Any]] = None, blob: Optional[BlobDataSetsMetadata | Mapping[str, Any]] = None)

Definition: DataSetsMetadata

DeletedItem `dataclass`

DeletedItem(*, id: Optional[int] = None, name: Optional[str] = None, file_name_with_extension: Optional[str] = None, deleted_by_user_name: Optional[str] = None, time_deleted: Optional[str] = None, is_folder: Optional[bool] = None)

Definition: DeletedItem

Attributes

id `class-attribute` `instance-attribute`

id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ID'})

List item id

name `class-attribute` `instance-attribute`

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

File name of the item in document libraries, display name of the item in lists

file_name_with_extension `class-attribute` `instance-attribute`

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

File name with extension of the item in document libraries, same as Name of the item in lists

deleted_by_user_name `class-attribute` `instance-attribute`

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

The name of the user who deleted this item

time_deleted `class-attribute` `instance-attribute`

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

When this item was deleted

is_folder `class-attribute` `instance-attribute`

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

A true/false value to indicate if the item is a folder

FileCheckInParameters `dataclass`

FileCheckInParameters(comment: str, checkin_type: int)

Definition: FileCheckInParameters

Attributes

comment `instance-attribute`

comment: str

Type comments describing what has changed in this version

checkin_type `class-attribute` `instance-attribute`

checkin_type: int = dataclass_field(metadata={'wire_name': 'checkinType'})

Select the type of version you would like to check in

FormFieldMetadata `dataclass`

FormFieldMetadata(*, id: Optional[str] = None, name: Optional[str] = None, is_required: Optional[bool] = None, data_type: Optional[str] = None, default_value: Optional[str] = None)

Definition: FormFieldMetadata

Attributes

id `class-attribute` `instance-attribute`

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

Gets or sets the field ID

name `class-attribute` `instance-attribute`

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

Gets or sets the field Name

is_required `class-attribute` `instance-attribute`

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

Gets or sets a value indicating whether the field is required

data_type `class-attribute` `instance-attribute`

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

Gets or sets the field data type

default_value `class-attribute` `instance-attribute`

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

Gets or sets the default value

GroupPermissionIdentity `dataclass`

GroupPermissionIdentity(*, display_name: Optional[str] = None)

Definition: GroupPermissionIdentity

Attributes

display_name `class-attribute` `instance-attribute`

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

Group display name

HubSiteJoinApprovalOutput `dataclass`

HubSiteJoinApprovalOutput(*, requesting_site_url: Optional[str] = None, requesting_site_id: Optional[str] = None, requesting_site_title: Optional[str] = None, approval_correlation_id: Optional[str] = None)

Definition: HubSiteJoinApprovalOutput

Attributes

requesting_site_url `class-attribute` `instance-attribute`

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

Requesting Site Url

requesting_site_id `class-attribute` `instance-attribute`

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

Requesting Site Id

requesting_site_title `class-attribute` `instance-attribute`

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

Requesting Site Title

approval_correlation_id `class-attribute` `instance-attribute`

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

Approval Correlation Id

ItemGrantAccessBody `dataclass`

ItemGrantAccessBody(recipients: str, role_value: str, *, email_body: Optional[str] = None, send_email: Optional[bool] = None)

Definition: ItemGrantAccessBody

Attributes

recipients `instance-attribute`

recipients: str

A collection of recipients who will receive the sharing invitation

role_value `class-attribute` `instance-attribute`

role_value: str = dataclass_field(metadata={'wire_name': 'roleValue'})

Specify a role that is to be granted to the recipients

email_body `class-attribute` `instance-attribute`

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

A plain text formatted message that is included in the sharing invitation

send_email `class-attribute` `instance-attribute`

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

Specify whether recipients should receive an email notification message

ItemPermissionAddBody `dataclass`

ItemPermissionAddBody(recipients: List[ItemPermissionRecipient | Mapping[str, Any]], roles: List[str], require_sign_in: bool, send_invitation: bool, *, message: Optional[str] = None)

Definition: ItemPermissionAddBody

Attributes

recipients `instance-attribute`

recipients: List[ItemPermissionRecipient | Mapping[str, Any]]

A collection of recipients who will receive access and the sharing invitation.

roles `instance-attribute`

roles: List[str]

Specify the roles that are be granted to the recipients of the sharing invitation.

require_sign_in `class-attribute` `instance-attribute`

require_sign_in: bool = dataclass_field(metadata={'wire_name': 'requireSignIn'})

Specifies where the recipient of the invitation is required to sign-in to view the shared item.

send_invitation `class-attribute` `instance-attribute`

send_invitation: bool = dataclass_field(metadata={'wire_name': 'sendInvitation'})

Specifies if an email or post is generated (true) or if the permission is just created (false).

message `class-attribute` `instance-attribute`

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

A plain text formatted message that is included in the sharing invitation. Maximum length 2000 characters.

ItemPermissionCreateLinkBody `dataclass`

ItemPermissionCreateLinkBody(type_: str, scope: str, *, expiration_date_time: Optional[str] = None)

Definition: ItemPermissionCreateLinkBody

Attributes

type_ `class-attribute` `instance-attribute`

type_: str = dataclass_field(metadata={'wire_name': 'type'})

The type of sharing link to create

scope `instance-attribute`

scope: str

Choose who your sharing link gives access to. "Anyone" option will only work if your administrator has enabled it.

expiration_date_time `class-attribute` `instance-attribute`

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

The date after which the link will expire in yyyy-MM-dd format. Only applicable for anonymous links.

ItemPermissionRecipient `dataclass`

ItemPermissionRecipient(email: str)

Definition: ItemPermissionRecipient

Attributes

email `instance-attribute`

email: str

The email address for the recipient, if the recipient has an associated email address.

ItemPermissionUpdateBody `dataclass`

ItemPermissionUpdateBody(roles: List[str])

Definition: ItemPermissionUpdateBody

Attributes

roles `instance-attribute`

roles: List[str]

Specify updated roles for this permission.

ItemReference `dataclass`

ItemReference(*, name: Optional[str] = None, path: Optional[str] = None, sharepoint_ids: Optional[SharePointIds | Mapping[str, Any]] = None)

Definition: ItemReference

Attributes

name `class-attribute` `instance-attribute`

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

The name of the parent item

path `class-attribute` `instance-attribute`

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

Path that can be used to navigate to the parent item

MoveFileParameters `dataclass`

MoveFileParameters(source_file_id: str, destination_dataset: str, destination_folder_path: str, name_conflict_behavior: int)

Definition: MoveFileParameters

Attributes

source_file_id `class-attribute` `instance-attribute`

source_file_id: str = dataclass_field(metadata={'wire_name': 'sourceFileId'})

File Identifier

destination_dataset `class-attribute` `instance-attribute`

destination_dataset: str = dataclass_field(metadata={'wire_name': 'destinationDataset'})

Example: https://contoso.sharepoint.com/sites/sitename

destination_folder_path `class-attribute` `instance-attribute`

destination_folder_path: str = dataclass_field(metadata={'wire_name': 'destinationFolderPath'})

Destination Folder

name_conflict_behavior `class-attribute` `instance-attribute`

name_conflict_behavior: int = dataclass_field(metadata={'wire_name': 'nameConflictBehavior'})

Pick one of the options available

MoveFolderParameters `dataclass`

MoveFolderParameters(source_folder_id: str, destination_dataset: str, destination_folder_path: str, name_conflict_behavior: int)

Definition: MoveFolderParameters

Attributes

source_folder_id `class-attribute` `instance-attribute`

source_folder_id: str = dataclass_field(metadata={'wire_name': 'sourceFolderId'})

File Identifier

destination_dataset `class-attribute` `instance-attribute`

destination_dataset: str = dataclass_field(metadata={'wire_name': 'destinationDataset'})

Example: https://contoso.sharepoint.com/sites/sitename

destination_folder_path `class-attribute` `instance-attribute`

destination_folder_path: str = dataclass_field(metadata={'wire_name': 'destinationFolderPath'})

Destination Folder

name_conflict_behavior `class-attribute` `instance-attribute`

name_conflict_behavior: int = dataclass_field(metadata={'wire_name': 'nameConflictBehavior'})

Pick one of the options available

PassThroughNativeQuery `dataclass`

PassThroughNativeQuery(*, language: Optional[str] = None)

Definition: PassThroughNativeQuery

Attributes

language `class-attribute` `instance-attribute`

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

Query language

PatchFileItemWithPredictedValuesParameters `dataclass`

PatchFileItemWithPredictedValuesParameters(*, model_id: Optional[str] = None, predict_result: Optional[str] = None)

Definition: PatchFileItemWithPredictedValuesParameters

Attributes

model_id `class-attribute` `instance-attribute`

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

Enter modelId of the Model which is used for prediction

predict_result `class-attribute` `instance-attribute`

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

Enter request content in JSON

Permission `dataclass`

Permission(*, id: Optional[str] = None, granted_to: Optional[PermissionIdentitySet | Mapping[str, Any]] = None, granted_to_identities: Optional[List[SharingLinkPermissionIdentitySet | Mapping[str, Any]]] = None, invitation: Optional[SharingInvitation | Mapping[str, Any]] = None, inherited_from: Optional[ItemReference | Mapping[str, Any]] = None, link: Optional[SharingLink | Mapping[str, Any]] = None, roles: Optional[List[str]] = None)

Definition: Permission

Attributes

id `class-attribute` `instance-attribute`

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

Permission id

granted_to_identities `class-attribute` `instance-attribute`

granted_to_identities: Optional[List[SharingLinkPermissionIdentitySet | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'grantedToIdentities'})

For link type permissions, the details of the users to whom permission was granted

roles `class-attribute` `instance-attribute`

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

The type of permission - read, write, owner, member

PermissionIdentitySet `dataclass`

PermissionIdentitySet(*, application: Optional[ApplicationPermissionIdentity | Mapping[str, Any]] = None, group: Optional[GroupPermissionIdentity | Mapping[str, Any]] = None, user: Optional[UserPermissionIdentity | Mapping[str, Any]] = None)

Definition: PermissionIdentitySet

PermissionsList `dataclass`

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

Definition: PermissionsList

Attributes

value `class-attribute` `instance-attribute`

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

List of Permissions

Procedure `dataclass`

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

Definition: Procedure

Attributes

name `class-attribute` `instance-attribute`

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

Procedure name

display_name `class-attribute` `instance-attribute`

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

Procedure display name

PublishedResult `dataclass`

PublishedResult(is_file_published: bool)

Definition: PublishedResult

Attributes

is_file_published `class-attribute` `instance-attribute`

is_file_published: bool = dataclass_field(metadata={'wire_name': 'IsFilePublished'})

A boolean value (true, false) to indicate whether the scheduled version of the file has been published

SharePointHttpRequestBodyParameters `dataclass`

SharePointHttpRequestBodyParameters(method: str, uri: str, *, headers: Optional[Dict[str, str]] = None, body: Optional[str] = None)

Definition: SharePointHttpRequestBodyParameters

Attributes

method `instance-attribute`

method: str

Http Method

uri `instance-attribute`

uri: str

Example: _api/web/lists/getbytitle('Documents')

headers `class-attribute` `instance-attribute`

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

Enter JSON object of request headers

body `class-attribute` `instance-attribute`

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

Enter request content in JSON

SharePointIds `dataclass`

SharePointIds(*, list_id: Optional[str] = None, list_item_id: Optional[str] = None, list_item_unique_id: Optional[str] = None, site_id: Optional[str] = None, site_url: Optional[str] = None, tenant_id: Optional[str] = None, web_id: Optional[str] = None)

Definition: SharePointIds

Attributes

list_id `class-attribute` `instance-attribute`

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

The unique identifier (guid) for the item's list in SharePoint

list_item_id `class-attribute` `instance-attribute`

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

An integer identifier for the item within the containing list

list_item_unique_id `class-attribute` `instance-attribute`

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

The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site

site_id `class-attribute` `instance-attribute`

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

The unique identifier (guid) for the item's site collection (SPSite)

site_url `class-attribute` `instance-attribute`

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

The SharePoint URL for the site that contains the item

tenant_id `class-attribute` `instance-attribute`

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

The unique identifier (guid) for the tenancy

web_id `class-attribute` `instance-attribute`

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

The unique identifier (guid) for the item's site (SPWeb)

SharingInvitation `dataclass`

SharingInvitation(*, email: Optional[str] = None, sign_in_required: Optional[bool] = None)

Definition: SharingInvitation

Attributes

email `class-attribute` `instance-attribute`

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

The email address provided for the recipient of the sharing invitation

sign_in_required `class-attribute` `instance-attribute`

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

If true the recipient of the invitation needs to sign in in order to access the shared item

SharingLink `dataclass`

SharingLink(*, web_url: Optional[str] = None)

Definition: SharingLink

Attributes

web_url `class-attribute` `instance-attribute`

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

A link to the item

SharingLinkPermissionIdentitySet `dataclass`

SharingLinkPermissionIdentitySet(*, user: Optional[SharingLinkUserPermissionIdentity | Mapping[str, Any]] = None)

Definition: SharingLinkPermissionIdentitySet

SharingLinkUserPermissionIdentity `dataclass`

SharingLinkUserPermissionIdentity(*, display_name: Optional[str] = None, email: Optional[str] = None)

Definition: SharingLinkUserPermissionIdentity

Attributes

display_name `class-attribute` `instance-attribute`

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

User display name

email `class-attribute` `instance-attribute`

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

User email

SPContentType `dataclass`

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

Definition: SPContentType

Attributes

id `class-attribute` `instance-attribute`

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

Content type Id

name `class-attribute` `instance-attribute`

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

Content type name

SPForASelectedFileResponse `dataclass`

SPForASelectedFileResponse(*, id: Optional[int] = None, item_url: Optional[str] = None, file_name: Optional[str] = None)

Definition: SPForASelectedFileResponse

Attributes

id `class-attribute` `instance-attribute`

id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ID'})

File Identifier

item_url `class-attribute` `instance-attribute`

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

File Url

file_name `class-attribute` `instance-attribute`

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

File Name

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, count_restrictions: Optional[TableCountRestrictionsMetadata | 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

TableCountRestrictionsMetadata `dataclass`

TableCountRestrictionsMetadata(*, countable: Optional[bool] = None)

Definition: TableCountRestrictionsMetadata

Attributes

countable `class-attribute` `instance-attribute`

countable: Optional[bool] = dataclass_field(default=None, kw_only=True)

Indicates whether this table has countable columns

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

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

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

UserPermissionIdentity `dataclass`

UserPermissionIdentity(*, display_name: Optional[str] = None, email: Optional[str] = None)

Definition: UserPermissionIdentity

Attributes

display_name `class-attribute` `instance-attribute`

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

User display name

email `class-attribute` `instance-attribute`

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

User email

SharepointonlineClient

SharepointonlineClient(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 sharepointonline connector.

Initialize a SharepointonlineClient.

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_agreements_solution_document `async`

create_agreements_solution_document(input: CreateAgreementsSolutionDocumentInput | Mapping[str, Any], dataset: str, template: str, *, document_name: 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

Agreements Solution - Generate document within Agreements Solution workspace

Use this action to create documents based on modern templates in a Agreements Solution workspace. This is behind a payment wall currently in planning (either license or PayG).

Swagger operation ID: CreateAgreementsSolutionDocument.

Parameters:

Name	Type	Description	Default
`input`	`CreateAgreementsSolutionDocumentInput \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`template`	`str`	Agreements Solution template.	required
`document_name`	`Optional[str]`	Document file 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:

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_tables

list_all_tables(dataset: 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 all lists and libraries

Get all lists and libraries.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetAllTables.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	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.

approve_hub_site_join `async`

approve_hub_site_join(dataset: str, joining_site_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

Approve hub site join request

Approve hub site join request. This will return an approval token that can be used to complete the join request using the join hub site action.

Swagger operation ID: ApproveHubSiteJoin.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`joining_site_id`	`str`	Id of the requesting site.	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.

cancel_hub_site_join_approval `async`

cancel_hub_site_join_approval(dataset: str, *, approval_correlation_id: 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

Cancel hub site join request

Cancel hub join request. If applicable, you should specify the same Approval Correlation Id as used in the "Set hub site join status to pending" action.

Swagger operation ID: CancelHubSiteJoinApproval.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`approval_correlation_id`	`Optional[str]`	Approval correlation identifier for this request.	`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.

create_sharing_link `async`

create_sharing_link(input: ItemPermissionCreateLinkBody | Mapping[str, Any], dataset: str, table: str, id: int, *, 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 sharing link for a file or folder

Create sharing link for a file or folder.

Swagger operation ID: CreateSharingLink.

Parameters:

Name	Type	Description	Default
`input`	`ItemPermissionCreateLinkBody \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint library name.	required
`id`	`int`	Id of the file or folder item.	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.

copy_file `async`

copy_file(dataset: str, source: str, destination: str, *, overwrite: 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

Copy file (deprecated)

Copies a file to a SharePoint site.

Swagger operation ID: CopyFile.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`source`	`str`	Path to the source file.	required
`destination`	`str`	Path to the destination file.	required
`overwrite`	`Optional[bool]`	Whether or not to overwrite the destination file if it exists.	`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.

copy_file_2 `async`

copy_file_2(input: CopyFileParameters | Mapping[str, Any], dataset: 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

Copy file

Copies a file. Works in a similar way to the "Copy to" command in SharePoint libraries. Returns information about the new file after copy.

Swagger operation ID: CopyFileAsync.

Parameters:

Name	Type	Description	Default
`input`	`CopyFileParameters \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	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.

copy_folder `async`

copy_folder(input: CopyFolderParameters | Mapping[str, Any], dataset: 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

Copy folder

Copies a folder. Works in a similar way to the "Copy to" command in SharePoint libraries. Returns information about the new folder after copy.

Swagger operation ID: CopyFolderAsync.

Parameters:

Name	Type	Description	Default
`input`	`CopyFolderParameters \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	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_file `async`

create_file(input: bytes, dataset: str, folder_path: str, name: 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 file

Uploads a file to a SharePoint site. Make sure to pick an existing library.

Swagger operation ID: CreateFile.

Parameters:

Name	Type	Description	Default
`input`	`bytes`	The binary request body.	required
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`folder_path`	`str`	Must start with an existing library. Add folders if needed.	required
`name`	`str`	Name of the file.	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_file_metadata `async`

get_file_metadata(dataset: str, 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

Get file metadata

Gets information about the file such as size, etag, created date, etc. Uses a file identifier to pick the file. Use "Get file properties" action to get to the values stored in the columns in the library.

Swagger operation ID: GetFileMetadata.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`id`	`str`	Select a file.	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.

update_file `async`

update_file(input: bytes, dataset: str, 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

Update file

Updates the contents of the file specified by the file identifier.

Swagger operation ID: UpdateFile.

Parameters:

Name	Type	Description	Default
`input`	`bytes`	The binary request body.	required
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`id`	`str`	Select a file.	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.

delete_file `async`

delete_file(dataset: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete file

Deletes the file specified by the file identifier.

Swagger operation ID: DeleteFile.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`id`	`str`	Select a file.	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.

get_file_content `async`

get_file_content(dataset: str, id: str, *, infer_content_type: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Get file content

Gets file contents using the file identifier. The contents can be copied somewhere else, or be used as an attachment.

Swagger operation ID: GetFileContent.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`id`	`str`	Select a file.	required
`infer_content_type`	`Optional[bool]`	Infer content-type based on extension.	`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
`bytes`	`bytes`	The connector operation result.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

get_file_thumbnail `async`

get_file_thumbnail(dataset: str, id: str, size: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Get file thumbnail

Gets the thumbnail of a file by its file identifier.

Swagger operation ID: GetFileThumbnail.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`id`	`str`	Select a file.	required
`size`	`str`	The size of the thumbnail to retrieve.	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
`bytes`	`bytes`	The connector operation result.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

list_root_folder

list_root_folder(dataset: 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]]

List root folder

Returns files in the root SharePoint folder.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListRootFolder.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	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_folder

list_folder(dataset: str, id: 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]]

List folder

Returns files contained in a SharePoint folder.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListFolder.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`id`	`str`	Unique identifier of the folder.	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_file_metadata_by_path `async`

get_file_metadata_by_path(dataset: str, path: 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 file metadata using path

Gets information about the file such as size, etag, created date, etc. Uses a file path to pick the file. Use "Get file properties" action to get to the values stored in the columns in the library.

Swagger operation ID: GetFileMetadataByPath.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`path`	`str`	Select a file.	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_file_content_by_path `async`

get_file_content_by_path(dataset: str, path: str, *, infer_content_type: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Get file content using path

Gets file contents using the file path.

Swagger operation ID: GetFileContentByPath.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`path`	`str`	Select a file.	required
`infer_content_type`	`Optional[bool]`	Infer content-type based on extension.	`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
`bytes`	`bytes`	The connector operation result.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

get_folder_metadata `async`

get_folder_metadata(dataset: str, 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

Get folder metadata

Gets information about the folder. Uses a file identifier to pick the folder.

Swagger operation ID: GetFolderMetadata.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`id`	`str`	Select a folder.	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_folder_metadata_by_path `async`

get_folder_metadata_by_path(dataset: str, path: 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 folder metadata using path

Gets information about the folder. Uses a folder path to pick the folder.

Swagger operation ID: GetFolderMetadataByPath.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`path`	`str`	Select a folder.	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.

http_request `async`

http_request(input: SharePointHttpRequestBodyParameters | Mapping[str, Any], dataset: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Send an HTTP request to SharePoint

Construct a SharePoint REST API to invoke. Note - This action may execute any SharePoint REST API you have access to. Please proceed with caution.

Swagger operation ID: HttpRequest.

Parameters:

Name	Type	Description	Default
`input`	`SharePointHttpRequestBodyParameters \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	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.

join_hub_site `async`

join_hub_site(dataset: str, hub_site_id: str, *, approval_token: Optional[str] = None, approval_correlation_id: 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

Join hub site

Join the requested site to the hub site. An Approval Token is required to complete the join successfully if that hub requires approval. If applicable, you should specify the same Approval Correlation Id as used in the "Set hub site join status to pending" action.

Swagger operation ID: JoinHubSite.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`hub_site_id`	`str`	Id of the hub site.	required
`approval_token`	`Optional[str]`	Approval token for this request.	`None`
`approval_correlation_id`	`Optional[str]`	Approval correlation identifier for this request.	`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.

move_file `async`

move_file(input: MoveFileParameters | Mapping[str, Any], dataset: 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

Move file

Moves a file. Works in a similar way to the "Move to" command in SharePoint libraries. Returns information about the new file after move.

Swagger operation ID: MoveFileAsync.

Parameters:

Name	Type	Description	Default
`input`	`MoveFileParameters \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	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.

move_folder `async`

move_folder(input: MoveFolderParameters | Mapping[str, Any], dataset: 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

Move folder

Moves a folder. Works in a similar way to the "Move to" command in SharePoint libraries. Returns information about the new folder after move.

Swagger operation ID: MoveFolderAsync.

Parameters:

Name	Type	Description	Default
`input`	`MoveFolderParameters \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	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.

notify_hub_site_join_approval_started `async`

notify_hub_site_join_approval_started(dataset: str, *, approval_correlation_id: 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

Set hub site join status to pending

Set the requested site's hub join request status to pending. The Approval Correlation Id is an optional parameter that helps SharePoint identify a particular hub join request. The requesting site can only have one pending request at a given time.

Swagger operation ID: NotifyHubSiteJoinApprovalStarted.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`approval_correlation_id`	`Optional[str]`	Approval correlation identifier for this request.	`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_tables

list_tables(dataset: 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 lists

Gets SharePoint lists from a site.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetTables.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	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.

create_new_document_set `async`

create_new_document_set(input: CreateNewDocumentSetParameters | Mapping[str, Any], dataset: str, table: 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 new document set

Creates a new document set list item.

Swagger operation ID: CreateNewDocumentSet.

Parameters:

Name	Type	Description	Default
`input`	`CreateNewDocumentSetParameters \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint library name.	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_new_folder `async`

create_new_folder(input: CreateNewFolderParameters | Mapping[str, Any], dataset: str, table: str, *, view: 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

Create new folder

Creates a new folder or folder path.

Swagger operation ID: CreateNewFolder.

Parameters:

Name	Type	Description	Default
`input`	`CreateNewFolderParameters \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint list or library name.	required
`view`	`Optional[str]`	Avoid column threshold issues by only using columns defined in a view.	`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.

search_for_user `async`

search_for_user(dataset: str, table: str, entity_id: str, search_value: str, *, view: 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

Resolve person

Returns a single matching user value so it can be assigned to a column of type person. If there are no matches, or multiple matches, this action will error out.

Swagger operation ID: SearchForUser.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	Pick the list or library that the column is in.	required
`entity_id`	`str`	Pick the column you want to assign the value to.	required
`search_value`	`str`	Use the email address, or the full name of the user.	required
`view`	`Optional[str]`	Avoid column threshold issues by only using columns defined in a view.	`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_table_form `async`

get_table_form(dataset: str, table: str, form: 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 form metadata (preview)

Use this action to get the form metadata, which includes the form ID, title, link, form type, and the output format. It also gets the form questions used to collect information. Document generation forms is a part of AI in SharePoint Public Preview. For more info on getting started, see: https://learn.microsoft.com/sharepoint/dev/declarative-customization/structured-documents.

Swagger operation ID: GetTableForm.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint list name.	required
`form`	`str`	Form identifier.	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.

submit_doc_gen_form `async`

submit_doc_gen_form(input: SubmitDocGenFormInput | Mapping[str, Any], dataset: str, table: str, form: str, *, view: 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

Generate a document from a form (preview)

Use this action to create documents from a document generation template. Map the template fields to the corresponding content in the data source. Document generation forms is a part of AI in SharePoint Public Preview. For more info on getting started, see: https://learn.microsoft.com/sharepoint/dev/declarative-customization/structured-documents.

Swagger operation ID: SubmitDocGenForm.

Parameters:

Name	Type	Description	Default
`input`	`SubmitDocGenFormInput \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint document library name.	required
`form`	`str`	Form identifier.	required
`view`	`Optional[str]`	This parameter does nothing. Please do not use.	`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_file_items

list_file_items(dataset: str, table: str, *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, folder_path: Optional[str] = None, view_scope_option: Optional[str] = None, view: 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 files (properties only)

Gets the properties saved in the columns in the library for all folders and files stored in the library. You can also filter down to the items that match a condition. An "Apply to each" section is usually used to work with the output from this action. When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually.

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

Swagger operation ID: GetFileItems.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint library name.	required
`filter`	`Optional[str]`	An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).	`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`
`folder_path`	`Optional[str]`	Select a folder, or leave blank for the whole library.	`None`
`view_scope_option`	`Optional[str]`	Return entries contained in sub-folders (default = true).	`None`
`view`	`Optional[str]`	Avoid column threshold issues by only using columns defined in a view.	`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_items

list_items(dataset: str, table: str, *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, folder_path: Optional[str] = None, view_scope_option: Optional[str] = None, view: 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 items

Gets items from a SharePoint list.

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

Swagger operation ID: GetItems.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint list name.	required
`filter`	`Optional[str]`	An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).	`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`
`folder_path`	`Optional[str]`	Select a folder, or leave blank for the whole list.	`None`
`view_scope_option`	`Optional[str]`	Return entries contained in sub-folders (default = true).	`None`
`view`	`Optional[str]`	Avoid column threshold issues by only using columns defined in a view.	`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.

post_item `async`

post_item(input: PostItemInput | Mapping[str, Any], dataset: str, table: str, *, view: 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

Create item

Creates a new item in a SharePoint list.

Swagger operation ID: PostItem.

Parameters:

Name	Type	Description	Default
`input`	`PostItemInput \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint list name.	required
`view`	`Optional[str]`	Avoid column threshold issues by only using columns defined in a view.	`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(dataset: str, table: str, id: int, *, view: 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 item

Gets a single item by its id from a SharePoint list.

Swagger operation ID: GetItem.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint list name.	required
`id`	`int`	Unique identifier of item to be retrieved.	required
`view`	`Optional[str]`	Avoid column threshold issues by only using columns defined in a view.	`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(dataset: str, table: str, id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete item

Deletes an item from a SharePoint list.

Swagger operation ID: DeleteItem.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint list name.	required
`id`	`int`	Unique identifier of item to be deleted.	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: PatchItemInput | Mapping[str, Any], dataset: str, table: str, id: int, *, view: 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 item

Updates an item in a SharePoint list.

Swagger operation ID: PatchItem.

Parameters:

Name	Type	Description	Default
`input`	`PatchItemInput \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint list name.	required
`id`	`int`	Unique identifier of item to be updated.	required
`view`	`Optional[str]`	Avoid column threshold issues by only using columns defined in a view.	`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.

create_approval_request `async`

create_approval_request(input: CreateApprovalRequestInput | Mapping[str, Any], dataset: str, table: str, id: int, approval_type: int, *, 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 an approval request for an item or file

Creates an approval request for an item or file.

Swagger operation ID: CreateApprovalRequest.

Parameters:

Name	Type	Description	Default
`input`	`CreateApprovalRequestInput \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint list or library name.	required
`id`	`int`	Id of the item the approval request is being created for.	required
`approval_type`	`int`	Select an approval type.	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_item_changes `async`

get_item_changes(dataset: str, table: str, id: int, since: str, *, until: Optional[str] = None, include_drafts: Optional[bool] = None, view: 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 changes for an item or a file (properties only)

Returns information about columns that have changed within a given time window. Note: The list must have Versioning turned on.

Swagger operation ID: GetItemChanges.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint list or library name.	required
`id`	`int`	Id of the item you want to fetch changes for.	required
`since`	`str`	Trigger Window Start token or an item version label (ex: 3.0) or an ISO 8601 date (YYYY-MM-DDThh:mmZ).	required
`until`	`Optional[str]`	Trigger Window End token or an item version label (ex: 3.0) or an ISO 8601 date (YYYY-MM-DDThh:mmZ). If blank, defaults to latest version.	`None`
`include_drafts`	`Optional[bool]`	Boolean for whether to consider changes from minor (draft) versions.	`None`
`view`	`Optional[str]`	Returns only columns defined in a view.	`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.

check_in_file `async`

check_in_file(input: FileCheckInParameters | Mapping[str, Any], dataset: str, table: str, id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Check in file

Check in a checked out file in a document library, which makes the version of the document available to others.

Swagger operation ID: CheckInFile.

Parameters:

Name	Type	Description	Default
`input`	`FileCheckInParameters \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint library name.	required
`id`	`int`	Id of the list item the file is attached to.	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.

check_out_file `async`

check_out_file(dataset: str, table: str, id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Check out file

Check out a file in a document library to prevent others from editing the document, and your changes from being visible until the documented is checked in.

Swagger operation ID: CheckOutFile.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint library name.	required
`id`	`int`	Id of the list item the file is attached to.	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.

discard_file_check_out `async`

discard_file_check_out(dataset: str, table: str, id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Discard check out

If you check out a file and don't make changes to it, or you make changes that you don't want to keep, you can simply discard the checkout, rather than saving the file. If your organization tracks versions, a new version is created each time you check a file back into the library. By discarding the checkout, you can avoid making new versions when you haven't made any changes to the file.

Swagger operation ID: DiscardFileCheckOut.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint library name.	required
`id`	`int`	Id of the list item the file is attached to.	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.

get_file_item `async`

get_file_item(dataset: str, table: str, id: int, *, view: 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 file properties

Gets the properties saved in the columns in the library for the item specified by the item id. You can add a "Get file content" step and use the "File identifier" property returned by this action to get to the contents of the file. When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually.

Swagger operation ID: GetFileItem.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint library name.	required
`id`	`int`	Unique identifier of item to be retrieved.	required
`view`	`Optional[str]`	Avoid column threshold issues by only using columns defined in a view.	`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.

grant_access `async`

grant_access(input: ItemGrantAccessBody | Mapping[str, Any], dataset: str, table: str, id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Grant access to an item or a folder

Grant access to an item or a folder in SharePoint to specific people.

Swagger operation ID: GrantAccess.

Parameters:

Name	Type	Description	Default
`input`	`ItemGrantAccessBody \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint list or library name.	required
`id`	`int`	Unique identifier of the item or folder you want to grant access to.	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_file_item `async`

patch_file_item(input: PatchFileItemInput | Mapping[str, Any], dataset: str, table: str, id: int, *, view: 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 file properties

Updates the properties stored in columns in a library for the item specified by the item id. Use "Update file" action to update file contents. When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually.

Swagger operation ID: PatchFileItem.

Parameters:

Name	Type	Description	Default
`input`	`PatchFileItemInput \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint library name.	required
`id`	`int`	Unique identifier of item to be updated.	required
`view`	`Optional[str]`	Avoid column threshold issues by only using columns defined in a view.	`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.

patch_file_item_with_predicted_values `async`

patch_file_item_with_predicted_values(input: PatchFileItemWithPredictedValuesParameters | Mapping[str, Any], dataset: str, table: str, id: int, *, 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 file properties using AI Builder model results

Updates the values stored in library columns for a file analyzed by the model specified by the ModelId.

Swagger operation ID: PatchFileItemWithPredictedValues.

Parameters:

Name	Type	Description	Default
`input`	`PatchFileItemWithPredictedValuesParameters \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	Library Name.	required
`id`	`int`	Unique identifier of item to be updated.	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.

set_approval_status `async`

set_approval_status(dataset: str, table: str, id: int, approval_action: str, *, comments: Optional[str] = None, entity_tag: 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

Set content approval status

Sets the content approval status for an item in a list or library that has content approval turned on. You must provide an ETag for pages and files. You can get the ETag using the Get File Metadata action. This action is only available for SharePoint Online and SharePoint 2019.

Swagger operation ID: SetApprovalStatus.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint library name.	required
`id`	`int`	Id of the item you are setting the status of.	required
`approval_action`	`str`	Pick the approval action.	required
`comments`	`Optional[str]`	Add the comments from the approver.	`None`
`entity_tag`	`Optional[str]`	Add an ETag (required for files and pages).	`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.

unshare_item `async`

unshare_item(dataset: str, table: str, id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Stop sharing an item or a file

Delete all links giving access to an item or a file and remove all people with direct access except for owners.

Swagger operation ID: UnshareItem.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint list or library name.	required
`id`	`int`	Unique identifier of the item or file you want to stop sharing.	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.

list_item_attachments

list_item_attachments(dataset: str, table: str, item_id: 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 attachments

Returns the list of attachments for the specified list item. You can add a "Get attachment content" step and use the "File identifier" property returned by this action to get to the contents of the file.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetItemAttachments.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint list name.	required
`item_id`	`str`	Id of the list item to get attachments from.	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.

create_attachment `async`

create_attachment(input: bytes, dataset: str, table: str, item_id: int, display_name: 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

Add attachment

Adds a new attachment to the specified list item.

Swagger operation ID: CreateAttachment.

Parameters:

Name	Type	Description	Default
`input`	`bytes`	The binary request body.	required
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint list name.	required
`item_id`	`int`	Id of the list item to attach the file to.	required
`display_name`	`str`	File name.	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.

delete_attachment `async`

delete_attachment(dataset: str, table: str, item_id: int, attachment_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete attachment

Deletes the specified attachment.

Swagger operation ID: DeleteAttachment.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint list name.	required
`item_id`	`int`	Id of the list item the file is attached to.	required
`attachment_id`	`str`	File identifier for the attachment.	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.

get_attachment_content `async`

get_attachment_content(dataset: str, table: str, item_id: int, attachment_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Get attachment content

Returns file contents using the file identifier. The contents can be copied somewhere else, or be used as an attachment.

Swagger operation ID: GetAttachmentContent.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint list name.	required
`item_id`	`int`	Id of the list item the file is attached to.	required
`attachment_id`	`str`	File identifier for the attachment.	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
`bytes`	`bytes`	The connector operation result.

Raises:

Type	Description
`ConnectorException`	If the connector request fails.

create_content_assembly_document `async`

create_content_assembly_document(input: CreateContentAssemblyDocumentInput | Mapping[str, Any], dataset: str, table: str, template: str, *, folder_path: Optional[str] = None, file_name: Optional[str] = None, view: 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

Generate document using Microsoft Syntex (preview)

Use this action to create documents based on modern templates from Microsoft Syntex. This preview requires a Syntex license. Pricing is subject to change. For more info see: https://docs.microsoft.com/en-us/microsoft-365/contentunderstanding/content-assembly.

Swagger operation ID: CreateContentAssemblyDocument.

Parameters:

Name	Type	Description	Default
`input`	`CreateContentAssemblyDocumentInput \| Mapping[str, Any]`	The request body. Mapping keys use serialized Swagger wire names.	required
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint document library name.	required
`template`	`str`	Document template.	required
`folder_path`	`Optional[str]`	Must start with an existing library.	`None`
`file_name`	`Optional[str]`	Document file name.	`None`
`view`	`Optional[str]`	This parameter does nothing. Please do not use.	`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_table_views

list_table_views(dataset: str, table: 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 list views

Gets views from a SharePoint list.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetTableViews.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint list name.	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.

extract_folder `async`

extract_folder(dataset: str, source: str, destination: str, *, overwrite: 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

Extract folder

Extracts an archive file into a SharePoint folder (example: .zip).

Swagger operation ID: ExtractFolderV2.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`source`	`str`	Path to the source file.	required
`destination`	`str`	Path to the destination folder.	required
`overwrite`	`Optional[bool]`	Whether or not to overwrite the destination file if it exists.	`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_data_sets

list_data_sets(*, 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 datasets

Gets the most recently used SharePoint sites.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetDataSets.

Parameters:

Name	Type	Description	Default
`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_agreements_solution_templates

list_agreements_solution_templates(dataset: 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]]

Agreements Solution - Get Templates

Gets templates from a Agreements Solution workspace.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetAgreementsSolutionTemplates.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	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_agreements_solution_template_fields `async`

get_agreements_solution_template_fields(dataset: str, template: 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

Agreements Solution - Get template fields

Gets fields from template in a Agreements Solution workspace.

Swagger operation ID: GetAgreementsSolutionTemplateFields.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`template`	`str`	Agreements Solution template.	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_for_libraries

list_tables_for_libraries(dataset: 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 libraries

Returns a single-page Azure Core async collection.

Swagger operation ID: GetTablesForLibraries.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	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_thumbnail_size_options `async`

get_thumbnail_size_options(*, 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 thumbnail size options

Internal operation to get thumbnail size options.

Swagger operation ID: GetThumbnailSizeOptions.

Parameters:

Name	Type	Description	Default
`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_table `async`

get_table(dataset: str, table: str, *, view: Optional[str] = None, content_type_id: 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 list metadata

Gets metadata from a SharePoint list.

Swagger operation ID: GetTable.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint list name.	required
`view`	`Optional[str]`	Avoid column threshold issues by only using columns defined in a view.	`None`
`content_type_id`	`Optional[str]`	Contentype Id to filter columns by content type.	`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_tables_for_lists_and_libraries

list_tables_for_lists_and_libraries(dataset: 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 lists and libraries

Returns a single-page Azure Core async collection.

Swagger operation ID: GetTablesForListsAndLibraries.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	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_entities_for_user

list_entities_for_user(dataset: str, table: str, *, view: 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]]

Returns User fields for a list

Returns User fields for a list.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetEntitiesForUser.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint list name.	required
`view`	`Optional[str]`	Avoid column threshold issues by only using columns defined in a view.	`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_table_forms

list_table_forms(dataset: str, table: 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 list forms

Gets forms from a SharePoint list.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetTableForms.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint list name.	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_doc_gen_forms

list_doc_gen_forms(dataset: str, table: 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 document generation forms

Gets published document generation forms from a SharePoint document library.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetDocGenForms.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint document library name.	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_doc_gen_form_fields `async`

get_doc_gen_form_fields(dataset: str, table: str, form: 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 document generation form fields

Gets fields from a document generation form in a SharePoint list.

Swagger operation ID: GetDocGenFormFields.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint list name.	required
`form`	`str`	Form identifier.	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_view_scope_options

list_view_scope_options(*, 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 SPViewScope options to use for folder querying behavior

Default - Only query current folder (non-recursive). Return both Files and Folders. RecursiveAll - Recursively query the folder. Return both Files and Folders.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetViewScopeOptions.

Parameters:

Name	Type	Description	Default
`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_tables_for_lightweight_approval

list_tables_for_lightweight_approval(dataset: 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 lists and libraries where lightweight approvals is enabled

Returns a single-page Azure Core async collection.

Swagger operation ID: GetTablesForLightweightApproval.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	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_approval_types `async`

get_approval_types(*, 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 available approval request types

Internal operation to get the available approval request types.

Swagger operation ID: GetApprovalTypes.

Parameters:

Name	Type	Description	Default
`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_approval_schema `async`

get_approval_schema(approval_type: int, *, 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 the appropriate creation schema for the approval request type

Internal operation to fetch the schema for approval request creation based on the approval type.

Swagger operation ID: GetApprovalSchema.

Parameters:

Name	Type	Description	Default
`approval_type`	`int`	Type of approval request.	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_item_changes_metadata `async`

get_item_changes_metadata(dataset: str, table: 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 about the return type of the GetItemChanges operation

Get metadata about the return type of the GetItemChanges operation.

Swagger operation ID: GetItemChangesMetadata.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint list or library name.	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_for_approval

list_tables_for_approval(dataset: 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 libraries where Content Approval is supported

Returns a single-page Azure Core async collection.

Swagger operation ID: GetTablesForApproval.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	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_day_of_week_options `async`

get_day_of_week_options(*, 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

When to send updates

Internal operation to get day of week options.

Swagger operation ID: GetDayOfWeekOptions.

Parameters:

Name	Type	Description	Default
`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_content_assembly_templates

list_content_assembly_templates(dataset: str, table: 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 document library templates

Gets templates from a SharePoint document library.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetContentAssemblyTemplates.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint document library name.	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_content_assembly_placeholders `async`

get_content_assembly_placeholders(dataset: str, table: str, template: 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 placeholders from template

Gets placeholders from template in a SharePoint document library.

Swagger operation ID: GetContentAssemblyPlaceholders.

Parameters:

Name	Type	Description	Default
`dataset`	`str`	Example: https://contoso.sharepoint.com/sites/sitename.	required
`table`	`str`	SharePoint document library name.	required
`template`	`str`	Document template.	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.

SharepointonlineClient

Attributes

TRIGGER_OPERATIONS module-attribute

Classes

CreateAgreementsSolutionDocumentInput dataclass

Attributes

additional_properties class-attribute instance-attribute

SPBlobMetadataResponse dataclass

Attributes

item_id class-attribute instance-attribute

id class-attribute instance-attribute

name class-attribute instance-attribute

display_name class-attribute instance-attribute

path class-attribute instance-attribute

last_modified class-attribute instance-attribute

size class-attribute instance-attribute

media_type class-attribute instance-attribute

is_folder class-attribute instance-attribute

e_tag class-attribute instance-attribute

file_locator class-attribute instance-attribute

TablesList dataclass

Attributes

value class-attribute instance-attribute

ApproveHubSiteJoinResponse dataclass

Attributes

approval_token class-attribute instance-attribute

SharingLinkPermission dataclass

BlobMetadata dataclass

Attributes

id class-attribute instance-attribute

name class-attribute instance-attribute

display_name class-attribute instance-attribute

path class-attribute instance-attribute

last_modified class-attribute instance-attribute

size class-attribute instance-attribute

media_type class-attribute instance-attribute

is_folder class-attribute instance-attribute

e_tag class-attribute instance-attribute

file_locator class-attribute instance-attribute

BlobMetadataResponse dataclass

Attributes

id class-attribute instance-attribute

name class-attribute instance-attribute

display_name class-attribute instance-attribute

path class-attribute instance-attribute

last_modified class-attribute instance-attribute

size class-attribute instance-attribute

media_type class-attribute instance-attribute

is_folder class-attribute instance-attribute

e_tag class-attribute instance-attribute

file_locator class-attribute instance-attribute

CreateNewDocumentSetResponse dataclass

Attributes

additional_properties class-attribute instance-attribute

CreateNewFolderResponse dataclass

Attributes

additional_properties class-attribute instance-attribute

SPListExpandedUser dataclass

Attributes

claims class-attribute instance-attribute

display_name class-attribute instance-attribute

email class-attribute instance-attribute

picture class-attribute instance-attribute

department class-attribute instance-attribute

job_title class-attribute instance-attribute

TableForm dataclass

Attributes

form_id class-attribute instance-attribute

display_name class-attribute instance-attribute

type_ class-attribute instance-attribute

link class-attribute instance-attribute

created_by class-attribute instance-attribute

created class-attribute instance-attribute

modified class-attribute instance-attribute

modified_by class-attribute instance-attribute

output_format class-attribute instance-attribute

fields_metadata class-attribute instance-attribute

SubmitDocGenFormInput dataclass

Attributes

additional_properties class-attribute instance-attribute

TRIGGER_OPERATIONS `module-attribute`

CreateAgreementsSolutionDocumentInput `dataclass`

additional_properties `class-attribute` `instance-attribute`

SPBlobMetadataResponse `dataclass`

item_id `class-attribute` `instance-attribute`

id `class-attribute` `instance-attribute`

name `class-attribute` `instance-attribute`

display_name `class-attribute` `instance-attribute`

path `class-attribute` `instance-attribute`

last_modified `class-attribute` `instance-attribute`

size `class-attribute` `instance-attribute`

media_type `class-attribute` `instance-attribute`

is_folder `class-attribute` `instance-attribute`

e_tag `class-attribute` `instance-attribute`

file_locator `class-attribute` `instance-attribute`

TablesList `dataclass`

value `class-attribute` `instance-attribute`

ApproveHubSiteJoinResponse `dataclass`

approval_token `class-attribute` `instance-attribute`

SharingLinkPermission `dataclass`

BlobMetadata `dataclass`

id `class-attribute` `instance-attribute`

name `class-attribute` `instance-attribute`

display_name `class-attribute` `instance-attribute`

path `class-attribute` `instance-attribute`

last_modified `class-attribute` `instance-attribute`

size `class-attribute` `instance-attribute`

media_type `class-attribute` `instance-attribute`

is_folder `class-attribute` `instance-attribute`

e_tag `class-attribute` `instance-attribute`

file_locator `class-attribute` `instance-attribute`

BlobMetadataResponse `dataclass`

id `class-attribute` `instance-attribute`

name `class-attribute` `instance-attribute`

display_name `class-attribute` `instance-attribute`

path `class-attribute` `instance-attribute`

last_modified `class-attribute` `instance-attribute`

size `class-attribute` `instance-attribute`

media_type `class-attribute` `instance-attribute`

is_folder `class-attribute` `instance-attribute`

e_tag `class-attribute` `instance-attribute`

file_locator `class-attribute` `instance-attribute`

CreateNewDocumentSetResponse `dataclass`

additional_properties `class-attribute` `instance-attribute`

CreateNewFolderResponse `dataclass`

additional_properties `class-attribute` `instance-attribute`

SPListExpandedUser `dataclass`

claims `class-attribute` `instance-attribute`

display_name `class-attribute` `instance-attribute`

email `class-attribute` `instance-attribute`

picture `class-attribute` `instance-attribute`

department `class-attribute` `instance-attribute`

job_title `class-attribute` `instance-attribute`

TableForm `dataclass`

form_id `class-attribute` `instance-attribute`

display_name `class-attribute` `instance-attribute`

type_ `class-attribute` `instance-attribute`

link `class-attribute` `instance-attribute`

created_by `class-attribute` `instance-attribute`

created `class-attribute` `instance-attribute`

modified `class-attribute` `instance-attribute`

modified_by `class-attribute` `instance-attribute`

output_format `class-attribute` `instance-attribute`

fields_metadata `class-attribute` `instance-attribute`

SubmitDocGenFormInput `dataclass`

additional_properties `class-attribute` `instance-attribute`

ItemsList `dataclass`

value `class-attribute` `instance-attribute`

next_link `class-attribute` `instance-attribute`

PostItemInput `dataclass`

additional_properties `class-attribute` `instance-attribute`

PostItemResponse `dataclass`

additional_properties `class-attribute` `instance-attribute`

GetItemResponse `dataclass`

additional_properties `class-attribute` `instance-attribute`

PatchItemInput `dataclass`

additional_properties `class-attribute` `instance-attribute`

PatchItemResponse `dataclass`

additional_properties `class-attribute` `instance-attribute`

CreateApprovalRequestInput `dataclass`