DocFusion365 – SP

DocFusion® 365 is a dynamic, cloud-based document composition and automation engine designed to help you manage all of your document content and processes within the Office 365 environment.

Status: Preview

Tier: Premium

Version: 1.0.0

Actions:

Name	Summary
GetApiVersion ()	Get api version
GetTheLinkedListTemplates (string siteUrl, string listName)	Get the linked list templates
ComposeALinkedTemplate (string siteUrl, string listName, integer TemplateId, integer listItemId, boolean skipPostProcess)	Compose a linked template
ComposeAllTheLinkedTemplates (string siteUrl, string listName, integer listItemId, [advanced]boolean skipPostProcess)	Compose all the linked templates
GetSiteLists (string siteUrl)	GetSiteLists
GetListTemplates (string siteUrl, string listName)	GetListTemplates

Triggers:

Name

Summary

Objects:

Name	Summary
ComposeLinkedTemplateResponse
DFTemplate
DFTemplateCollection
GetLinkedListTemplatesResponse
SPList
SPListCollection
VersionResponse

Actions:

GetApiVersion

Summary: Get api version

Description: This operation retrieves the current DocFusion365 API version.

Syntax:

DocFusion365–SP.GetApiVersion ()

Returns:

Type:VersionResponse

GetTheLinkedListTemplates

Summary: Get the linked list templates

Description: This operation retrieves the linked DocFusion365 templates of a SharePoint list.

Syntax:

DocFusion365–SP.GetTheLinkedListTemplates (string siteUrl, string listName)

Parameters:

Name

Type

Summary

Required

Related Action

siteUrl

string

(Site Url)

The site Url the SharePoint list exists in.

True

listName

string

(List Name)

The name of the list.

True

GetSiteLists

Returns:

Type:array of (GetLinkedListTemplatesResponse)

ComposeALinkedTemplate

Summary: Compose a linked template

Description: This operation composes a template that is linked to a SharePoint list.

Syntax:

DocFusion365–SP.ComposeALinkedTemplate (string siteUrl, string listName, integer TemplateId, integer listItemId, boolean skipPostProcess)

Parameters:

Name	Type	Summary	Required	Related Action
siteUrl	string (Site Url)	The site Url the SharePoint list exists in.	True
listName	string (List Name)	The name of the list.	True	GetSiteLists
TemplateId	integer(int64) (Template Id)	The id of the template you want to compose.	True	GetListTemplates
listItemId	integer(int32) (List Item Id)	The id of the item in the list you want to compose against.	True
skipPostProcess	boolean (Skip Post Process)	Use this to ignore all post processes configured.	True

Returns:

Type:ComposeLinkedTemplateResponse

ComposeAllTheLinkedTemplates

Summary: Compose all the linked templates

Description: This operation composes all templates that are linked to a SharePoint list.

Syntax:

DocFusion365–SP.ComposeAllTheLinkedTemplates (string siteUrl, string listName, integer listItemId, [advanced]boolean skipPostProcess)

Parameters:

Name	Type	Summary	Required	Related Action
siteUrl	string (Site Url)	The site Url the SharePoint list exists in.	True
listName	string (List Name)	The name of the list.	True	GetSiteLists
listItemId	integer(int32) (List Item Id)	The id of the item in the list you want to compose against.	True
skipPostProcess	boolean (Skip Post Process)	Use this to ignore all post processes configured.	True

Returns:

Type:array of (ComposeLinkedTemplateResponse)

GetSiteLists

Summary: GetSiteLists

Description:

Syntax:

DocFusion365–SP.GetSiteLists (string siteUrl)

Parameters:

Name

Type

Summary

Required

Related Action

siteUrl

string

True

Returns:

Type:SPListCollection

GetListTemplates

Summary: GetListTemplates

Description:

Syntax:

DocFusion365–SP.GetListTemplates (string siteUrl, string listName)

Parameters:

Name

Type

Summary

Required

Related Action

siteUrl

string

True

listName

string

True

Returns:

Type:DFTemplateCollection

ComposeLinkedTemplateResponse

Summary:

Description:

Properties:

Name	Type	Summary
Error	string Error	The error message displayed if something failed.
Succeeded	boolean Succeeded	Did the compose succeed.
OutputItemUrl	string Output Item Url	The url of the composed item.
LogListUrl	string Log List Url	The url of the compose log.
ListName	string List Name	The name of the list that was composed against.
ListItemId	integer(int32) List Item Id	The id of the item in the list that was composed against.

DFTemplate

Summary:

Description:

Properties:

Name

Type

Summary

TemplateName

string

TemplateId

integer(int64)

DFTemplateCollection

Summary:

Description:

Properties:

Name

Type

Summary

Templates

array of (DFTemplate)

GetLinkedListTemplatesResponse

Summary:

Description:

Properties:

Name	Type	Summary
Id	integer(int64) Id	The id of the template.
DisplayName	string Display Name	The display name of the template.
OutputFormat	string Output Format	The output format the template will compose to.

SPList

Summary:

Description:

Properties:

Name

Type

Summary

Title

string

string(uuid)

SPListCollection

Summary:

Description:

Properties:

Name

Type

Summary

Lists

array of (SPList)

VersionResponse

Summary:

Description:

Properties:

Name

Type

Summary

ApiVersion

string

Api Version

The version of the api.