Connectors Reference
Xpertdoc enables business users to simplify, optimize and automate consistent document generation processes, leveraging Microsoft Dynamics 365 and external data sources as well as seamless integrations to leading applications. Our robust and user-friendly features let you easily create, generate, manage, store, deliver and e-sign business-critical documents like quotes, proposals, contracts, invoices and more without code.
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
Get Documents |
|
|
Get Execution Status |
|
|
Download Document |
|
|
Execute Flow |
|
|
Execute Dynamics Flow |
|
|
Get Flows |
|
|
Get Flow Schema |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get Documents
Description: Get documents from a flow execution.
Syntax:
Xpertdoc.GetDocuments (GetDocumentsRequest req)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
req |
|
|
True |
Returns:
Type:array of (GetDocumentsResponse)
Summary: Get Execution Status
Description: Get the status of an execution.
Syntax:
Xpertdoc.GetExecutionStatus (GetExecutionStatusRequest req)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
req |
|
|
True |
Returns:
Summary: Download Document
Description: Downloads the document from an execution.
Syntax:
Xpertdoc.DownloadDocument (DownloadDocumentRequest req)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
req |
|
|
True |
Returns:
Type:string(binary)Document Content
Title: Document Content
Summary: Execute Flow
Description: Execute a Flow.
Syntax:
Xpertdoc.ExecuteFlow (ExecuteFlowRequest req)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
req |
|
|
True |
Returns:
Summary: Execute Dynamics Flow
Description: Execute a flow for a Dynamics 365 data set.
Syntax:
Xpertdoc.ExecuteDynamicsFlow (ExecuteDynamicsFlowRequest req)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
req |
|
|
True |
Returns:
Summary: Get Flows
Description:
Syntax:
Xpertdoc.GetFlows ()
Returns:
Type:array of (FlowResponse)
Summary: Get Flow Schema
Description:
Syntax:
Xpertdoc.GetFlowSchema (string flowId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
flowId |
string
|
|
True |
Returns:
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentId |
string
|
Unique identifier of the document to download. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
entityId |
string
|
Unique identifier of the entity you want to launch the flow from. |
|
flowId |
string
|
The flow to execute. |
|
userName |
string
|
The user name of the user to execute the flow with. If none provided, the user of the connector will be used. |
|
timeout |
integer(int32)
|
The amount of seconds that the operation will wait for the flow execution to complete. (1 minute if left empty) |
|
executionMode |
string
|
The execution mode of the selected flow. Values: [Default, Batch] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
flowId |
string
|
The flow to execute. |
|
executionData |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
executionId |
string
|
Execution unique identifier. |
|
message |
string
|
|
|
status |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
description |
string
|
|
|
displayName |
string
|
|
|
flowId |
string
|
|
|
type |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
executionId |
string
|
Unique identifier of the execution to get the documents from. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
contentType |
string
|
|
|
documentId |
string
|
|
|
documentName |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
executionId |
string
|
Unique identifier of the execution to get the execution status from. |