Connectors Reference

Xbridger Document Manager

With this connector you can merge documents, convert documents from one format to another, create modern pages from Word document and do much more.

 

Status: Preview

Tier: Premium

Version: v1

 

Actions:

Name

Summary

Convert2ModernPage (PageRequest request)

Convert Word to modern page

Convert2NonModernPage (FileRequest request)

Convert Word to non-modern page

ExportList2PDF (Export2pdfFlowProp request)

Export list or library data to PDF

ExtractWordImages (FileRequest request)

Extract images from Word

PDFMerge (MergeRequest request)

Merge documents to PDF

WordMerge (MergeRequest request)

Merge Word documents

Wordtopdf (SingleFileMergeRequest request)

Convert to PDF

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

Convert2ModernPageResponse

 

Convert2NonModernPageResponse

 

Export2pdfFlowProp

 

ExportList2PDFResponse

 

ExtractWordImagesResponse

 

FileRequest

 

MergeRequest

 

PageRequest

 

PDFMergeResponse

 

SingleFileMergeRequest

 

WordMergeResponse

 

WordtopdfResponse

 

 

Actions:

Convert2ModernPage

Summary: Convert Word to modern page

Description: Create a modern page from Word documents - https://xbridger.com/docs/getting-started/convert-word-to-modern-page/

 

Syntax:

XbridgerDocumentManager.Convert2ModernPage (PageRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

PageRequest

 

 

True

 

Returns:

          Type:Convert2ModernPageResponse

 

Convert2NonModernPage

Summary: Convert Word to non-modern page

Description: Convert Word document to a simple aspx page -https://xbridger.com/docs/getting-started/convert-word-to-non-modern-page-overview

 

Syntax:

XbridgerDocumentManager.Convert2NonModernPage (FileRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

FileRequest

 

 

True

 

Returns:

          Type:Convert2NonModernPageResponse

 

ExportList2PDF

Summary: Export list or library data to PDF

Description: Export list or library data to PDF. This operation supports 4 columns and one group parameter - https://xbridger.com/docs/getting-started/export-list-or-library-data-to-pdf/

 

Syntax:

XbridgerDocumentManager.ExportList2PDF (Export2pdfFlowProp request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

Export2pdfFlowProp

 

 

True

 

Returns:

          Type:ExportList2PDFResponse

 

ExtractWordImages

Summary: Extract images from Word

Description: Extract images from Word documents - https://xbridger.com/docs/getting-started/extract-images-from-word/

 

Syntax:

XbridgerDocumentManager.ExtractWordImages (FileRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

FileRequest

 

 

True

 

Returns:

          Type:ExtractWordImagesResponse

 

PDFMerge

Summary: Merge documents to PDF

Description: Merge multiple documents format to pdf - https://xbridger.com/docs/getting-started/merge-documents-to-pdf/

 

Syntax:

XbridgerDocumentManager.PDFMerge (MergeRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

MergeRequest

 

 

True

 

Returns:

          Type:PDFMergeResponse

 

WordMerge

Summary: Merge Word documents

Description: Merge multiple Word documents into one - https://xbridger.com/docs/getting-started/merge-word-documents

 

Syntax:

XbridgerDocumentManager.WordMerge (MergeRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

MergeRequest

 

 

True

 

Returns:

          Type:WordMergeResponse

 

Wordtopdf

Summary: Convert to PDF

Description: Convert a document to PDF - https://xbridger.com/docs/getting-started/convert-to-pdf/

 

Syntax:

XbridgerDocumentManager.Wordtopdf (SingleFileMergeRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

SingleFileMergeRequest

 

 

True

 

Returns:

          Type:WordtopdfResponse

 


 

Convert2ModernPageResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

HTMLString

string

 

HTML String representation of the word document

JSONObject

string

 

JSON object

InstanceId

string

 

Instance Id of the text component

SiteUrl

string

 

Current site address


 

Convert2NonModernPageResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileContent

string

 

The processed document.


 

Export2pdfFlowProp

Summary:

Description:

 

          Properties:

Name

Type

Summary

DocumentTitle

string

 

Title to use in the header section of the exported PDF.

Data

string

 

List or library data to export.

FieldArray

string

 

Array of fields in the current view.


 

ExportList2PDFResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileContent

string

 

The processed document.


 

ExtractWordImagesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Value

array of (ValueItem)

 

Value

 

ValueItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

ImageExtension

string

 

Image extension.

ImageCounter

integer(int32)

 

Image number in the array.

ImageMimeType

string

 

MIME type of this image extension.

ImageContent

string

 

The processed image content.

 


 

FileRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileContent

string

 

Document content. Example: body('Get_file_content')?['$content'].


 

MergeRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileContentArray

string

 

JSON Array of document content and filename.


 

PageRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileContent

string

 

Document content. Example: body('Get_file_content')?['$content'].

FolderPath

string

 

Path to the image folder e.g. Shared Documents/Images.

SiteUrl

string

 

Full site address e.g. https://xbridger.sharepoint.com/sites/dev.

PageTitle

string

 

The page title.

Author

string

 

Email address of the author e.g. admin@xbridger.com.

BannerImageUrl

string

 

Relative url for the page banner e.g. /sites/dev/PublishingImages/demo.png.


 

PDFMergeResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileContent

string

 

The processed document.


 

SingleFileMergeRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileContent

string

 

Document content. Example: body('Get_file_content')?['$content'].

FileName

string

 

Name of file to process.


 

WordMergeResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileContent

string

 

The processed document.


 

WordtopdfResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileContent

string

 

The processed document.

FileName

string

 

Filename of the converted document.