Skip to content

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] = field(default_factory=dict)

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] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'Id'})

The unique id of the file or folder.

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

The name of the file or folder.

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

The display name of the file or folder.

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

The path of the file or folder.

last_modified class-attribute instance-attribute 
last_modified: Optional[str] = field(default=None, metadata={'wire_name': 'LastModified'})

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

size class-attribute instance-attribute 
size: Optional[int] = field(default=None, metadata={'wire_name': 'Size'})

The size of the file or folder.

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

The media type of the file or folder.

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

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

e_tag class-attribute instance-attribute 
e_tag: Optional[str] = field(default=None, metadata={'wire_name': 'ETag'})

The etag of the file or folder.

file_locator class-attribute instance-attribute 
file_locator: Optional[str] = field(default=None, metadata={'wire_name': 'FileLocator'})

The filelocator of the file or folder.

TablesList dataclass 

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

Response for Get all lists and libraries

Attributes

value class-attribute instance-attribute 
value: Optional[List[Table]] = None

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] = field(default=None, metadata={'wire_name': 'ApprovalToken'})

Approval Token

SharingLinkPermission dataclass 

SharingLinkPermission(link: Optional[SharingLink] = 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] = field(default=None, metadata={'wire_name': 'Id'})

The unique id of the file or folder.

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

The name of the file or folder.

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

The display name of the file or folder.

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

The path of the file or folder.

last_modified class-attribute instance-attribute 
last_modified: Optional[str] = field(default=None, metadata={'wire_name': 'LastModified'})

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

size class-attribute instance-attribute 
size: Optional[int] = field(default=None, metadata={'wire_name': 'Size'})

The size of the file or folder.

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

The media type of the file or folder.

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

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

e_tag class-attribute instance-attribute 
e_tag: Optional[str] = field(default=None, metadata={'wire_name': 'ETag'})

The etag of the file or folder.

file_locator class-attribute instance-attribute 
file_locator: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'Id'})

The unique id of the file or folder.

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

The name of the file or folder.

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

The display name of the file or folder.

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

The path of the file or folder.

last_modified class-attribute instance-attribute 
last_modified: Optional[str] = field(default=None, metadata={'wire_name': 'LastModified'})

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

size class-attribute instance-attribute 
size: Optional[int] = field(default=None, metadata={'wire_name': 'Size'})

The size of the file or folder.

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

The media type of the file or folder.

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

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

e_tag class-attribute instance-attribute 
e_tag: Optional[str] = field(default=None, metadata={'wire_name': 'ETag'})

The etag of the file or folder.

file_locator class-attribute instance-attribute 
file_locator: Optional[str] = field(default=None, 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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = field(default=None, metadata={'wire_name': 'Claims'})

user claims

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

user title

email class-attribute instance-attribute 
email: Optional[str] = field(default=None, metadata={'wire_name': 'Email'})

user email

picture class-attribute instance-attribute 
picture: Optional[str] = field(default=None, metadata={'wire_name': 'Picture'})

user picture

department class-attribute instance-attribute 
department: Optional[str] = field(default=None, metadata={'wire_name': 'Department'})

user department

job_title class-attribute instance-attribute 
job_title: Optional[str] = field(default=None, 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]] = None)

Response for Get form metadata (preview)

Attributes

form_id class-attribute instance-attribute 
form_id: Optional[str] = field(default=None, metadata={'wire_name': 'FormID'})

Gets or sets the form ID

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

Gets or sets the form display name

type_ class-attribute instance-attribute 
type_: Optional[str] = field(default=None, metadata={'wire_name': 'Type'})

Gets or sets the form type

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

Gets or sets the form link/URL

created_by class-attribute instance-attribute 
created_by: Optional[str] = field(default=None, metadata={'wire_name': 'CreatedBy'})

Gets or sets the user who created the form

created class-attribute instance-attribute 
created: Optional[str] = field(default=None, metadata={'wire_name': 'Created'})

Gets or sets the date the form was created

modified class-attribute instance-attribute 
modified: Optional[str] = field(default=None, metadata={'wire_name': 'Modified'})

Gets or sets the date the form was last modified

modified_by class-attribute instance-attribute 
modified_by: Optional[str] = field(default=None, metadata={'wire_name': 'ModifiedBy'})

Gets or sets the user who last modified the form

output_format class-attribute instance-attribute 
output_format: Optional[str] = field(default=None, 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]] = field(default=None, 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] = field(default_factory=dict)

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

ItemsList dataclass 

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

Response for Get files (properties only)

Attributes

value class-attribute instance-attribute 
value: Optional[List[Item]] = None

List of Items

PostItemInput dataclass 

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

Create item

Attributes

additional_properties class-attribute instance-attribute 
additional_properties: Dict[str, Any] = field(default_factory=dict)

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

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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

ApprovalData dataclass 

ApprovalData(approval_id: Optional[str] = None)

Response for Create an approval request for an item or file

Attributes

approval_id class-attribute instance-attribute 
approval_id: Optional[str] = field(default=None, 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] = field(default_factory=dict)

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

Item dataclass 

Item(dynamic_properties: Optional[Dict[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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = field(default=None, metadata={'wire_name': 'ETag'})

ETag of the item after the approval status was set

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

A link to the item that needs approval

publish_start_date class-attribute instance-attribute 
publish_start_date: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'ContentApprovalStatus'})

The content approval status of the list item

scheduled_version class-attribute instance-attribute 
scheduled_version: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'Id'})

File identifier

absolute_uri class-attribute instance-attribute 
absolute_uri: Optional[str] = field(default=None, metadata={'wire_name': 'AbsoluteUri'})

Link to attachment

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

Name

DeletedItemList dataclass 

DeletedItemList(value: Optional[List[DeletedItem]] = None)

Response for When a file is deleted

Attributes

value class-attribute instance-attribute 
value: Optional[List[DeletedItem]] = None

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] = field(default_factory=dict)

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, Any]] = None)

Response for Get list views

Attributes

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

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

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

The display name of the table.

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

Additional table properties provided by the connector to the clients.

DataSetsList dataclass 

DataSetsList(value: Optional[List[DataSet]] = None)

Response for Get datasets

Attributes

value class-attribute instance-attribute 
value: Optional[List[DataSet]] = None

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] = None, schema: Optional[ObjectEntity] = None, referenced_entities: Optional[ObjectEntity] = None, web_url: Optional[str] = None)

Response for Agreements Solution - Get template fields

Attributes

name class-attribute instance-attribute 
name: Optional[str] = None

Table name

title class-attribute instance-attribute 
title: Optional[str] = None

Table title

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

Table permission

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

URL link

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] = field(default=None, metadata={'wire_name': 'Id'})

The Id of the SPField

entity_type class-attribute instance-attribute 
entity_type: Optional[str] = field(default=None, metadata={'wire_name': 'EntityType'})

What type of entity (field) this is

ObjectEntity dataclass 

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

Response for Get SPViewScope options to use for folder querying behavior

Attributes

additional_properties class-attribute instance-attribute 
additional_properties: Dict[str, Any] = field(default_factory=dict)

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

GetItemChangesMetadataResponse dataclass 

GetItemChangesMetadataResponse(schema: Optional[ObjectEntity] = 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] = field(default=None, 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] = None

Blob dataset source

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

Blob dataset display name

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

Blob dataset url encoding

BlobMetadataPage dataclass 

BlobMetadataPage(value: Optional[List[BlobMetadata]] = None)

Definition: BlobMetadataPage

Attributes

value class-attribute instance-attribute 
value: Optional[List[BlobMetadata]] = None

Blob metadata collection.

CopyFileParameters dataclass 

CopyFileParameters(source_file_id: Optional[str] = None, destination_dataset: Optional[str] = None, destination_folder_path: Optional[str] = None, name_conflict_behavior: Optional[int] = None)

Definition: CopyFileParameters

Attributes

source_file_id class-attribute instance-attribute 
source_file_id: Optional[str] = field(default=None, metadata={'wire_name': 'sourceFileId'})

File Identifier

destination_dataset class-attribute instance-attribute 
destination_dataset: Optional[str] = field(default=None, metadata={'wire_name': 'destinationDataset'})

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

destination_folder_path class-attribute instance-attribute 
destination_folder_path: Optional[str] = field(default=None, metadata={'wire_name': 'destinationFolderPath'})

Destination Folder

name_conflict_behavior class-attribute instance-attribute 
name_conflict_behavior: Optional[int] = field(default=None, metadata={'wire_name': 'nameConflictBehavior'})

Pick one of the options available

CopyFolderParameters dataclass 

CopyFolderParameters(source_folder_id: Optional[str] = None, destination_dataset: Optional[str] = None, destination_folder_path: Optional[str] = None, name_conflict_behavior: Optional[int] = None)

Definition: CopyFolderParameters

Attributes

source_folder_id class-attribute instance-attribute 
source_folder_id: Optional[str] = field(default=None, metadata={'wire_name': 'sourceFolderId'})

File Identifier

destination_dataset class-attribute instance-attribute 
destination_dataset: Optional[str] = field(default=None, metadata={'wire_name': 'destinationDataset'})

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

destination_folder_path class-attribute instance-attribute 
destination_folder_path: Optional[str] = field(default=None, metadata={'wire_name': 'destinationFolderPath'})

Destination Folder

name_conflict_behavior class-attribute instance-attribute 
name_conflict_behavior: Optional[int] = field(default=None, metadata={'wire_name': 'nameConflictBehavior'})

Pick one of the options available

CreateNewDocumentSetParameters dataclass 

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

Definition: CreateNewDocumentSetParameters

Attributes

path class-attribute instance-attribute 
path: Optional[str] = None

Example: folder1/folder2/dsName

content_type_id class-attribute instance-attribute 
content_type_id: Optional[str] = field(default=None, metadata={'wire_name': 'contentTypeId'})

Example: 0x0120D520

CreateNewFolderParameters dataclass 

CreateNewFolderParameters(path: Optional[str] = None)

Definition: CreateNewFolderParameters

Attributes

path class-attribute instance-attribute 
path: Optional[str] = None

Example: folder1/folder2/folder3

DataSet dataclass 

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

Definition: DataSet

Attributes

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

Dataset name

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

Dataset display name

query class-attribute instance-attribute 
query: Optional[List[PassThroughNativeQuery]] = None

Pass-through Native Queries

DataSetsMetadata dataclass 

DataSetsMetadata(tabular: Optional[TabularDataSetsMetadata] = None, blob: Optional[BlobDataSetsMetadata] = 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] = field(default=None, metadata={'wire_name': 'ID'})

List item id

name class-attribute instance-attribute 
name: Optional[str] = field(default=None, 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] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'DeletedByUserName'})

The name of the user who deleted this item

time_deleted class-attribute instance-attribute 
time_deleted: Optional[str] = field(default=None, metadata={'wire_name': 'TimeDeleted'})

When this item was deleted

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

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

FileCheckInParameters dataclass 

FileCheckInParameters(comment: Optional[str] = None, checkin_type: Optional[int] = None)

Definition: FileCheckInParameters

Attributes

comment class-attribute instance-attribute 
comment: Optional[str] = None

Type comments describing what has changed in this version

checkin_type class-attribute instance-attribute 
checkin_type: Optional[int] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'ID'})

Gets or sets the field ID

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

Gets or sets the field Name

is_required class-attribute instance-attribute 
is_required: Optional[bool] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'DataType'})

Gets or sets the field data type

default_value class-attribute instance-attribute 
default_value: Optional[str] = field(default=None, 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] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'RequestingSiteUrl'})

Requesting Site Url

requesting_site_id class-attribute instance-attribute 
requesting_site_id: Optional[str] = field(default=None, metadata={'wire_name': 'RequestingSiteId'})

Requesting Site Id

requesting_site_title class-attribute instance-attribute 
requesting_site_title: Optional[str] = field(default=None, metadata={'wire_name': 'RequestingSiteTitle'})

Requesting Site Title

approval_correlation_id class-attribute instance-attribute 
approval_correlation_id: Optional[str] = field(default=None, metadata={'wire_name': 'ApprovalCorrelationId'})

Approval Correlation Id

ItemGrantAccessBody dataclass 

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

Definition: ItemGrantAccessBody

Attributes

recipients class-attribute instance-attribute 
recipients: Optional[str] = None

A collection of recipients who will receive the sharing invitation

role_value class-attribute instance-attribute 
role_value: Optional[str] = field(default=None, 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] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'sendEmail'})

Specify whether recipients should receive an email notification message

ItemPermissionAddBody dataclass 

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

Definition: ItemPermissionAddBody

Attributes

recipients class-attribute instance-attribute 
recipients: Optional[List[ItemPermissionRecipient]] = None

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

roles class-attribute instance-attribute 
roles: Optional[List[str]] = None

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

require_sign_in class-attribute instance-attribute 
require_sign_in: Optional[bool] = field(default=None, 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: Optional[bool] = field(default=None, 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] = None

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

ItemPermissionCreateLinkBody dataclass 

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

Definition: ItemPermissionCreateLinkBody

Attributes

type_ class-attribute instance-attribute 
type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

The type of sharing link to create

scope class-attribute instance-attribute 
scope: Optional[str] = None

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] = field(default=None, 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: Optional[str] = None)

Definition: ItemPermissionRecipient

Attributes

email class-attribute instance-attribute 
email: Optional[str] = None

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

ItemPermissionUpdateBody dataclass 

ItemPermissionUpdateBody(roles: Optional[List[str]] = None)

Definition: ItemPermissionUpdateBody

Attributes

roles class-attribute instance-attribute 
roles: Optional[List[str]] = None

Specify updated roles for this permission.

ItemReference dataclass 

ItemReference(name: Optional[str] = None, path: Optional[str] = None, sharepoint_ids: Optional[SharePointIds] = None)

Definition: ItemReference

Attributes

name class-attribute instance-attribute 
name: Optional[str] = None

The name of the parent item

path class-attribute instance-attribute 
path: Optional[str] = None

Path that can be used to navigate to the parent item

MoveFileParameters dataclass 

MoveFileParameters(source_file_id: Optional[str] = None, destination_dataset: Optional[str] = None, destination_folder_path: Optional[str] = None, name_conflict_behavior: Optional[int] = None)

Definition: MoveFileParameters

Attributes

source_file_id class-attribute instance-attribute 
source_file_id: Optional[str] = field(default=None, metadata={'wire_name': 'sourceFileId'})

File Identifier

destination_dataset class-attribute instance-attribute 
destination_dataset: Optional[str] = field(default=None, metadata={'wire_name': 'destinationDataset'})

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

destination_folder_path class-attribute instance-attribute 
destination_folder_path: Optional[str] = field(default=None, metadata={'wire_name': 'destinationFolderPath'})

Destination Folder

name_conflict_behavior class-attribute instance-attribute 
name_conflict_behavior: Optional[int] = field(default=None, metadata={'wire_name': 'nameConflictBehavior'})

Pick one of the options available

MoveFolderParameters dataclass 

MoveFolderParameters(source_folder_id: Optional[str] = None, destination_dataset: Optional[str] = None, destination_folder_path: Optional[str] = None, name_conflict_behavior: Optional[int] = None)

Definition: MoveFolderParameters

Attributes

source_folder_id class-attribute instance-attribute 
source_folder_id: Optional[str] = field(default=None, metadata={'wire_name': 'sourceFolderId'})

File Identifier

destination_dataset class-attribute instance-attribute 
destination_dataset: Optional[str] = field(default=None, metadata={'wire_name': 'destinationDataset'})

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

destination_folder_path class-attribute instance-attribute 
destination_folder_path: Optional[str] = field(default=None, metadata={'wire_name': 'destinationFolderPath'})

Destination Folder

name_conflict_behavior class-attribute instance-attribute 
name_conflict_behavior: Optional[int] = field(default=None, 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] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'modelId'})

Enter modelId of the Model which is used for prediction

predict_result class-attribute instance-attribute 
predict_result: Optional[str] = field(default=None, metadata={'wire_name': 'predictResult'})

Enter request content in JSON

Permission dataclass 

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

Definition: Permission

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

Permission id

granted_to_identities class-attribute instance-attribute 
granted_to_identities: Optional[List[SharingLinkPermissionIdentitySet]] = field(default=None, 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]] = None

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

PermissionIdentitySet dataclass 

PermissionIdentitySet(application: Optional[ApplicationPermissionIdentity] = None, group: Optional[GroupPermissionIdentity] = None, user: Optional[UserPermissionIdentity] = None)

Definition: PermissionIdentitySet

PermissionsList dataclass 

PermissionsList(value: Optional[List[Permission]] = None)

Definition: PermissionsList

Attributes

value class-attribute instance-attribute 
value: Optional[List[Permission]] = None

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] = field(default=None, metadata={'wire_name': 'Name'})

Procedure name

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

Procedure display name

PublishedResult dataclass 

PublishedResult(is_file_published: Optional[bool] = None)

Definition: PublishedResult

Attributes

is_file_published class-attribute instance-attribute 
is_file_published: Optional[bool] = field(default=None, 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: Optional[str] = None, uri: Optional[str] = None, headers: Optional[Dict[str, Any]] = None, body: Optional[str] = None)

Definition: SharePointHttpRequestBodyParameters

Attributes

method class-attribute instance-attribute 
method: Optional[str] = None

Http Method

uri class-attribute instance-attribute 
uri: Optional[str] = None

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

headers class-attribute instance-attribute 
headers: Optional[Dict[str, Any]] = None

Enter JSON object of request headers

body class-attribute instance-attribute 
body: Optional[str] = None

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] = field(default=None, 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] = field(default=None, 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] = field(default=None, 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] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'siteUrl'})

The SharePoint URL for the site that contains the item

tenant_id class-attribute instance-attribute 
tenant_id: Optional[str] = field(default=None, metadata={'wire_name': 'tenantId'})

The unique identifier (guid) for the tenancy

web_id class-attribute instance-attribute 
web_id: Optional[str] = field(default=None, 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] = None

The email address provided for the recipient of the sharing invitation

sign_in_required class-attribute instance-attribute 
sign_in_required: Optional[bool] = field(default=None, metadata={'wire_name': 'signInRequired'})

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

SharingLink(web_url: Optional[str] = None)

Definition: SharingLink

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

A link to the item

SharingLinkPermissionIdentitySet dataclass 

SharingLinkPermissionIdentitySet(user: Optional[SharingLinkUserPermissionIdentity] = 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] = field(default=None, metadata={'wire_name': 'displayName'})

User display name

email class-attribute instance-attribute 
email: Optional[str] = None

User email

SPContentType dataclass 

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

Definition: SPContentType

Attributes

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

Content type Id

name class-attribute instance-attribute 
name: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'ID'})

File Identifier

item_url class-attribute instance-attribute 
item_url: Optional[str] = field(default=None, metadata={'wire_name': 'itemUrl'})

File Url

file_name class-attribute instance-attribute 
file_name: Optional[str] = field(default=None, metadata={'wire_name': 'fileName'})

File Name

TableCapabilitiesMetadata dataclass 

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

Definition: TableCapabilitiesMetadata

Attributes

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

Server paging restrictions

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

List of supported filter capabilities

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

List of supported server-driven paging capabilities

TableCountRestrictionsMetadata dataclass 

TableCountRestrictionsMetadata(countable: Optional[bool] = None)

Definition: TableCountRestrictionsMetadata

Attributes

countable class-attribute instance-attribute 
countable: Optional[bool] = None

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] = None

Indicates whether this table has filterable columns

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

List of non filterable properties

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

List of required properties

TableSelectRestrictionsMetadata dataclass 

TableSelectRestrictionsMetadata(selectable: Optional[bool] = None)

Definition: TableSelectRestrictionsMetadata

Attributes

selectable class-attribute instance-attribute 
selectable: Optional[bool] = None

Indicates whether this table has selectable columns

TableSortRestrictionsMetadata dataclass 

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

Definition: TableSortRestrictionsMetadata

Attributes

sortable class-attribute instance-attribute 
sortable: Optional[bool] = None

Indicates whether this table has sortable columns

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

List of unsortable properties

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

List of properties which support ascending order only

TabularDataSetsMetadata dataclass 

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

Definition: TabularDataSetsMetadata

Attributes

source class-attribute instance-attribute 
source: Optional[str] = None

Dataset source

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

Dataset display name

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

Dataset url encoding

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

Table display name

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

Table plural display name

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] = field(default=None, metadata={'wire_name': 'displayName'})

User display name

email class-attribute instance-attribute 
email: Optional[str] = None

User email

SharepointonlineClient 

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

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
token_provider Optional[TokenProvider]

Optional token provider. Defaults to ManagedIdentityTokenProvider.

 None
options Optional[ConnectorClientOptions]

Optional connector client options.

 None

Methods:

create_agreements_solution_document_async async 
create_agreements_solution_document_async(input: CreateAgreementsSolutionDocumentInput, dataset: str, template: str, document_name: Optional[str] = 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).

get_all_tables_async async 
get_all_tables_async(dataset: str) -> dict[str, Any] | None

Get all lists and libraries

Get all lists and libraries.

approve_hub_site_join_async async 
approve_hub_site_join_async(dataset: str, joining_site_id: str) -> 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.

cancel_hub_site_join_approval_async async 
cancel_hub_site_join_approval_async(dataset: str, approval_correlation_id: Optional[str] = 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.

create_sharing_link_async(input: ItemPermissionCreateLinkBody, dataset: str, table: str, id: int) -> dict[str, Any] | None

Create sharing link for a file or folder

Create sharing link for a file or folder.

copy_file_async async 
copy_file_async(dataset: str, source: str, destination: str, overwrite: Optional[bool] = None) -> dict[str, Any] | None

Copy file (deprecated)

Copies a file to a SharePoint site.

copy_file_2_async async 
copy_file_2_async(input: CopyFileParameters, dataset: str) -> 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.

copy_folder_async async 
copy_folder_async(input: CopyFolderParameters, dataset: str) -> 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.

create_file_async async 
create_file_async(input: bytes, dataset: str, folder_path: str, name: str) -> dict[str, Any] | None

Create file

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

get_file_metadata_async async 
get_file_metadata_async(dataset: str, id: str) -> 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.

update_file_async async 
update_file_async(input: bytes, dataset: str, id: str) -> dict[str, Any] | None

Update file

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

delete_file_async async 
delete_file_async(dataset: str, id: str) -> None

Delete file

Deletes the file specified by the file identifier.

get_file_content_async async 
get_file_content_async(dataset: str, id: str, infer_content_type: Optional[bool] = 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.

list_root_folder_async async 
list_root_folder_async(dataset: str) -> dict[str, Any] | None

List root folder

Returns files in the root SharePoint folder.

list_folder_async async 
list_folder_async(dataset: str, id: str) -> dict[str, Any] | None

List folder

Returns files contained in a SharePoint folder.

get_file_metadata_by_path_async async 
get_file_metadata_by_path_async(dataset: str, path: str) -> 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.

get_file_content_by_path_async async 
get_file_content_by_path_async(dataset: str, path: str, infer_content_type: Optional[bool] = None) -> bytes

Get file content using path

Gets file contents using the file path.

get_folder_metadata_async async 
get_folder_metadata_async(dataset: str, id: str) -> dict[str, Any] | None

Get folder metadata

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

get_folder_metadata_by_path_async async 
get_folder_metadata_by_path_async(dataset: str, path: str) -> dict[str, Any] | None

Get folder metadata using path

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

http_request_async async 
http_request_async(input: SharePointHttpRequestBodyParameters, dataset: str) -> 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.

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

move_file_async async 
move_file_async(input: MoveFileParameters, dataset: str) -> 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.

move_folder_async async 
move_folder_async(input: MoveFolderParameters, dataset: str) -> 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.

notify_hub_site_join_approval_started_async async 
notify_hub_site_join_approval_started_async(dataset: str, approval_correlation_id: Optional[str] = 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.

get_tables_async async 
get_tables_async(dataset: str) -> dict[str, Any] | None

Get lists

Gets SharePoint lists from a site.

create_new_document_set_async async 
create_new_document_set_async(input: CreateNewDocumentSetParameters, dataset: str, table: str) -> dict[str, Any] | None

Create new document set

Creates a new document set list item.

create_new_folder_async async 
create_new_folder_async(input: CreateNewFolderParameters, dataset: str, table: str, view: Optional[str] = None) -> dict[str, Any] | None

Create new folder

Creates a new folder or folder path.

search_for_user_async async 
search_for_user_async(dataset: str, table: str, entity_id: str, search_value: str, view: Optional[str] = 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.

get_table_form_async async 
get_table_form_async(dataset: str, table: str, form: str) -> 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.

submit_doc_gen_form_async async 
submit_doc_gen_form_async(input: SubmitDocGenFormInput, dataset: str, table: str, form: str, view: Optional[str] = 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.

get_file_items_async async 
get_file_items_async(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) -> dict[str, Any] | None

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.

get_items_async async 
get_items_async(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) -> dict[str, Any] | None

Get items

Gets items from a SharePoint list.

post_item_async async 
post_item_async(input: PostItemInput, dataset: str, table: str, view: Optional[str] = None) -> dict[str, Any] | None

Create item

Creates a new item in a SharePoint list.

get_item_async async 
get_item_async(dataset: str, table: str, id: int, view: Optional[str] = None) -> dict[str, Any] | None

Get item

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

delete_item_async async 
delete_item_async(dataset: str, table: str, id: int) -> None

Delete item

Deletes an item from a SharePoint list.

patch_item_async async 
patch_item_async(input: PatchItemInput, dataset: str, table: str, id: int, view: Optional[str] = None) -> dict[str, Any] | None

Update item

Updates an item in a SharePoint list.

create_approval_request_async async 
create_approval_request_async(input: CreateApprovalRequestInput, dataset: str, table: str, id: int, approval_type: int) -> dict[str, Any] | None

Create an approval request for an item or file

Creates an approval request for an item or file.

get_item_changes_async async 
get_item_changes_async(dataset: str, table: str, id: int, since: str, until: Optional[str] = None, include_drafts: Optional[bool] = None, view: Optional[str] = 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.

check_in_file_async async 
check_in_file_async(input: FileCheckInParameters, dataset: str, table: str, id: int) -> None

Check in file

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

check_out_file_async async 
check_out_file_async(dataset: str, table: str, id: int) -> 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.

discard_file_check_out_async async 
discard_file_check_out_async(dataset: str, table: str, id: int) -> 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.

get_file_item_async async 
get_file_item_async(dataset: str, table: str, id: int, view: Optional[str] = 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.

grant_access_async async 
grant_access_async(input: ItemGrantAccessBody, dataset: str, table: str, id: int) -> None

Grant access to an item or a folder

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

patch_file_item_async async 
patch_file_item_async(input: PatchFileItemInput, dataset: str, table: str, id: int, view: Optional[str] = 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.

patch_file_item_with_predicted_values_async async 
patch_file_item_with_predicted_values_async(input: PatchFileItemWithPredictedValuesParameters, dataset: str, table: str, id: int) -> 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.

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

unshare_item_async async 
unshare_item_async(dataset: str, table: str, id: int) -> 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.

get_item_attachments_async async 
get_item_attachments_async(dataset: str, table: str, item_id: str) -> dict[str, Any] | None

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.

create_attachment_async async 
create_attachment_async(input: bytes, dataset: str, table: str, item_id: int, display_name: str) -> dict[str, Any] | None

Add attachment

Adds a new attachment to the specified list item.

delete_attachment_async async 
delete_attachment_async(dataset: str, table: str, item_id: int, attachment_id: str) -> None

Delete attachment

Deletes the specified attachment.

get_attachment_content_async async 
get_attachment_content_async(dataset: str, table: str, item_id: int, attachment_id: str) -> bytes

Get attachment content

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

create_content_assembly_document_async async 
create_content_assembly_document_async(input: CreateContentAssemblyDocumentInput, dataset: str, table: str, template: str, folder_path: Optional[str] = None, file_name: Optional[str] = None, view: Optional[str] = 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.

get_table_views_async async 
get_table_views_async(dataset: str, table: str) -> dict[str, Any] | None

Get list views

Gets views from a SharePoint list.

extract_folder_async async 
extract_folder_async(dataset: str, source: str, destination: str, overwrite: Optional[bool] = None) -> dict[str, Any] | None

Extract folder

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

get_data_sets_async async 
get_data_sets_async() -> dict[str, Any] | None

Get datasets

Gets the most recently used SharePoint sites.

get_agreements_solution_templates_async async 
get_agreements_solution_templates_async(dataset: str) -> dict[str, Any] | None

Agreements Solution - Get Templates

Gets templates from a Agreements Solution workspace.

get_agreements_solution_template_fields_async async 
get_agreements_solution_template_fields_async(dataset: str, template: str) -> dict[str, Any] | None

Agreements Solution - Get template fields

Gets fields from template in a Agreements Solution workspace.

get_tables_for_libraries_async async 
get_tables_for_libraries_async(dataset: str) -> dict[str, Any] | None

Get libraries

Get libraries

get_table_async async 
get_table_async(dataset: str, table: str, view: Optional[str] = None, content_type_id: Optional[str] = None) -> dict[str, Any] | None

Get list metadata

Gets metadata from a SharePoint list.

get_tables_for_lists_and_libraries_async async 
get_tables_for_lists_and_libraries_async(dataset: str) -> dict[str, Any] | None

Get lists and libraries

Get lists and libraries

get_entities_for_user_async async 
get_entities_for_user_async(dataset: str, table: str, view: Optional[str] = None) -> dict[str, Any] | None

Returns User fields for a list

Returns User fields for a list.

get_table_forms_async async 
get_table_forms_async(dataset: str, table: str) -> dict[str, Any] | None

Get list forms

Gets forms from a SharePoint list.

get_doc_gen_forms_async async 
get_doc_gen_forms_async(dataset: str, table: str) -> dict[str, Any] | None

Get document generation forms

Gets published document generation forms from a SharePoint document library.

get_doc_gen_form_fields_async async 
get_doc_gen_form_fields_async(dataset: str, table: str, form: str) -> dict[str, Any] | None

Get document generation form fields

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

get_view_scope_options_async async 
get_view_scope_options_async() -> dict[str, Any] | None

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.

get_tables_for_lightweight_approval_async async 
get_tables_for_lightweight_approval_async(dataset: str) -> dict[str, Any] | None

Get lists and libraries where lightweight approvals is enabled

Get lists and libraries where lightweight approvals is enabled

get_approval_types_async async 
get_approval_types_async() -> dict[str, Any] | None

Get available approval request types

Internal operation to get the available approval request types.

get_approval_schema_async async 
get_approval_schema_async(approval_type: int) -> 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.

get_item_changes_metadata_async async 
get_item_changes_metadata_async(dataset: str, table: str) -> dict[str, Any] | None

Get metadata about the return type of the GetItemChanges operation

Get metadata about the return type of the GetItemChanges operation.

get_tables_for_approval_async async 
get_tables_for_approval_async(dataset: str) -> dict[str, Any] | None

Get libraries where Content Approval is supported

Get libraries where Content Approval is supported

get_day_of_week_options_async async 
get_day_of_week_options_async() -> dict[str, Any] | None

When to send updates

Internal operation to get day of week options.

get_content_assembly_templates_async async 
get_content_assembly_templates_async(dataset: str, table: str) -> dict[str, Any] | None

Get document library templates

Gets templates from a SharePoint document library.

get_content_assembly_placeholders_async async 
get_content_assembly_placeholders_async(dataset: str, table: str, template: str) -> dict[str, Any] | None

Get placeholders from template

Gets placeholders from template in a SharePoint document library.