Word Online (Business)

Word Online (Business) connector lets you work with Word files in document libraries supported by Microsoft Graph (OneDrive for Business, SharePoint Sites, and Office 365 Groups).

Status: Production

Tier: Premium

Version: 1.0

Actions:

Name	Summary
GetFileSchema (string source, string drive, string file)	Fetches the schema of the selected file
CreateFileItem (string source, string drive, string file, [Optional]CreateFileItemParameterDynamicFileSchema dynamicFileSchema)	Populate a Microsoft Word template
GetSources ([internal][Optional]string $top, [internal][Optional]string $select)	Get sources
GetDrives ([internal]string source, [internal][Optional]string $select)	Get drives
ListRootFolder (string source, string drive)	List the root folder
ListFolder (string source, string drive, string id)	List blobs under a given folder
GetFilePDF (string source, string drive, string file, [internal]string format)	Convert Word Document to PDF

Objects:

Name	Summary
BlobMetadata
CreateFileItemParameterDynamicFileSchema
GetDrivesResponse
GetFileSchemaResponse
GetSourcesResponse

Actions:

GetFileSchema

Summary: Fetches the schema of the selected file

Description: Fetches the schema of the selected file.

Syntax:

WordOnline(Business).GetFileSchema (string source, string drive, string file)

Parameters:

Name	Type	Summary	Required	Related Action
source	string		True
drive	string		True
file	string		True

Returns:

Type:GetFileSchemaResponse

CreateFileItem

Summary: Populate a Microsoft Word template

Description: Reads a Microsoft Word template to then fill the template fields with selected dynamic values to generate a Word Document.

Syntax:

WordOnline(Business).CreateFileItem (string source, string drive, string file, [Optional]CreateFileItemParameterDynamicFileSchema dynamicFileSchema)

Parameters:

Name	Type	Summary	Required	Related Action
source	string (Location)	Select from the drop-down or specify one of the following: - "me" - "SharePoint Site URL" - "users/someone's UPN" - "groups/group Id" - "sites/SharePoint Site URL:/teams/team name:" (colons are required).	True	GetSources
drive	string (Document Library)	Select a document library from the drop-down.	True	GetDrives
file	string (File)	Select a Word file through File Browse.	True
dynamicFileSchema	CreateFileItemParameterDynamicFileSchema		False

Returns:

Type:string(binary)Microsoft Word document

Title: Microsoft Word document

GetSources

Summary: Get sources

Description: Get a list of sources.

Syntax:

WordOnline(Business).GetSources ([internal][Optional]string $top, [internal][Optional]string $select)

Parameters:

Name

Type

Summary

Required

Related Action

$top

string

(Top)

Top.

False

$select

string

(Select)

Select.

False

Returns:

Type:GetSourcesResponse

GetDrives

Summary: Get drives

Description: Get a list of drives.

Syntax:

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

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

Select from the drop-down or specify one of the following: - "me" - "SharePoint Site URL" - "users/someone's UPN" - "groups/group Id" - "sites/SharePoint Site URL:/teams/team name:" (colons are required).

True

GetSources

$select

string

(Select)

Select.

False

Returns:

Type:GetDrivesResponse

ListRootFolder

Summary: List the root folder

Description: List the root folder.

Syntax:

WordOnline(Business).ListRootFolder (string source, string drive)

Parameters:

Name

Type

Summary

Required

Related Action

source

string

(Location)

True

GetSources

drive

string

(Document Library)

Select a document library from the drop-down.

True

GetDrives

Returns:

Type:array of (BlobMetadata)

ListFolder

Summary: List blobs under a given folder

Description: List blobs under a given folder.

Syntax:

WordOnline(Business).ListFolder (string source, string drive, string id)

Parameters:

Name	Type	Summary	Required	Related Action
source	string (Location)	Select from the drop-down or specify one of the following: - "me" - "SharePoint Site URL" - "users/someone's UPN" - "groups/group Id" - "sites/SharePoint Site URL:/teams/team name:" (colons are required).	True	GetSources
drive	string (Document Library)	Select a document library from the drop-down.	True	GetDrives
id	string (Folder)	Folder Id.	True

Returns:

Type:array of (BlobMetadata)

GetFilePDF

Summary: Convert Word Document to PDF

Description: Gets a PDF version of the selected file

Syntax:

WordOnline(Business).GetFilePDF (string source, string drive, string file, [internal]string format)

Parameters:

Name	Type	Summary	Required	Related Action
source	string (Location)	Select from the drop-down or specify one of the following: - "me" - "SharePoint Site URL" - "users/someone's UPN" - "groups/group Id" - "sites/SharePoint Site URL:/teams/team name:" (colons are required).	True	GetSources
drive	string (Document Library)	Select a document library from the drop-down.	True	GetDrives
file	string (File)	Select a Word file through File Browse.	True
format	string	Format of the content	True

Returns:

Type:string(binary)PDF document

Title: PDF document

BlobMetadata

Summary:

Description: Blob metadata

Properties:

Name	Type	Summary
Id	string Id	The unique identifier of the file or folder.
Name	string Name	The name of the file or folder.
DisplayName	string Display name	The display name of the file or folder.
Path	string Path	The path of the file or folder.
MediaType	string Media type	The media type of the file or folder.
IsFolder	boolean Is folder?	A boolean value (true, false) to indicate whether or not the blob is a folder.
FileLocator	string File locator	The file locator of the file or folder.

CreateFileItemParameterDynamicFileSchema

Summary:

Description:

Properties:

Name

Type

Summary

GetDrivesResponse

Summary:

Description:

Properties:

Name

Type

Summary

value

array of (ValueItem)

ValueItem

Summary:

Description:

Properties:

Name

Type

Summary

string

Drive Id.

name

string

Name

Drive name.

GetFileSchemaResponse

Summary:

Description:

Properties:

Name

Type

Summary

GetSourcesResponse

Summary:

Description:

Properties:

Name

Type

Summary

value

array of (ValueItem)

ValueItem

Summary:

Description:

Properties:

Name

Type

Summary

string

Id.

displayName

string

Name

Name.