DocumentsCorePack

DocumentsCorePack is a fast & simple document generation based on Dynamics 365 data. Based on MS Word - templates, DocumentsCorePack provides you with a set of tools to create and process documents effectively. From a document generation wizard that guides users through the process to full document automation - DocumentsCorePack will make your business documents look professional and help you to process them efficiently!

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure China regions
Power Automate Premium All Power Automate regions except the following:
     -   China Cloud operated by 21Vianet
Power Apps Premium All Power Apps regions except the following:
     -   China Cloud operated by 21Vianet
Contact
Name mscrm-addons.com
URL https://support.mscrm-addons.com
Email support@mscrm-addons.com
Connector Metadata
Publisher PTM EDV Systeme GmbH
Website https://poweraddons.com
Privacy policy https://www.mscrm-addons.com/LegalDocuments
Categories Productivity;Sales and CRM

Pre-requisites

You need to have a Dynamics 365 or Common Data Service environment.

First of all, you need to

Get the API Key for your environment:

Now you are ready to start using DocumentsCorePack.

If you have troubles please look into following article or send your questions per email to support@mscrm-addons.com

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key securestring Get an API Key - https://www.mscrm-addons.com/getapikey True

Throttling Limits

Name Calls Renewal Period
API calls per connection120060 seconds

Actions

Attach DocumentJob as note (V2)

Attach the Document Content generated by a DocumentJob as a note to a Dynamics 365 entity. Attention! The documentjob must already be finished

Attach DocumentJob as note [DEPRECATED]

This action has been deprecated. Please use Attach DocumentJob as note (V2) instead.

Attach the file generated by a DocumentJob as a note to a Dynamics 365 entity. Attention! The documentjob must already be finished

Attach DocumentJob to email (V2)

Attach the Document Content generated by a DocumentJob as attachment to a Dynamics 365 email

Attach DocumentJob to email [DEPRECATED]

This action has been deprecated. Please use Attach DocumentJob to email (V2) instead.

Attach the file generated by a DocumentJob as attachment to a Dynamics 365 email

Attach file as note (V2)

Attach the Document Content or base64 encoded file as a note to a Dynamics 365 entity. Attention! The documentjob must already be finished

Attach file as note [DEPRECATED]

This action has been deprecated. Please use Attach file as note (V2) instead.

Attach the file supplied as base64 string as a note to a Dynamics 365 entity. Attention! The documentjob must already be finished

Attach file to email (V2)

Attach the Document Content or base64 encoded file as attachment to a Dynamics 365 email

Attach file to email [DEPRECATED]

This action has been deprecated. Please use Attach file to email (V2) instead.

Attach the base64 encoded file as attachment to a Dynamics 365 email

Check API Availibility [DEPRECATED]

This action has been deprecated. Please use Check API Availibility instead.

Verifies, that the API endpoint is currently accessible. Does not require API Key

Concatenate two Document Contents or base64 encoded files (pdf,docx) (V2)

Concatenates two Document Contents or base64 encoded files (pdf,docx)

Concatenate two DocumentJobs (V2)

Concatenate two Document Contents (pdf,docx) generated by two DocumentJobs

Concatenate two DocumentJobs [DEPRECATED]

This action has been deprecated. Please use Concatenate two DocumentJobs (V2) instead.

Concatenate two files (pdf,docx) generated by two DocumentJobs

Concatenate two Files (pdf,docx) [DEPRECATED]

This action has been deprecated. Please use Concatenate two Document Contents or base64 encoded files (pdf,docx) (V2) instead.

Concatenates two supplied files (pdf,docx)

Create document (sync) (V2)

This function creates a new DocumentJob and waits for the result

Create document (sync) [DEPRECATED]

This action has been deprecated. Please use Create document (sync) (V2) instead.

This function creates a new DocumentJob and waits for the result for up to [TimeOut] seconds

Create document based on an XML (sync) (V2)

This function creates a new DocumentJob and waits for the result

Create DocumentJob (async) (V2)

This function creates a new DocumentJob.. Attention! The function does NOT wait for a result

Create DocumentJob (async) [DEPRECATED]

This action has been deprecated. Please use Create DocumentJob (async) (V2) instead.

This function creates a new DocumentJob.. Attention! The function does NOT wait for a result

Create DocumentJob based on an XML (async) (V2)

This function creates a new DocumentJob. Attention! The function does NOT wait for a result

Create DocumentJob based on an XML (async) [DEPRECATED]

This action has been deprecated. Please use Create DocumentJob based on an XML (async) (V2) instead.

This function creates a new DocumentJob. Attention! The function does NOT wait for a result

Create DocumentJob based on an XML (sync) [DEPRECATED]

This action has been deprecated. Please use Create document based on an XML (sync) (V2) instead.

This function creates a new DocumentJob and waits for the result for up to [TimeOut] seconds

CreateSharepointFolder (V2)

This function creates sharepoint folders

Get connection details [DEPRECATED]

Verifies, that the API endpoint is currently accessible. Does not require API Key

Get DCP Printer

Retrieve available printer names, optionally filtered by user

Get DocumentJob Result (V2)

Retrieves a DocumentJobs status information. The result will include the result document, if the job is finished

Get DocumentJob Result [DEPRECATED]

This action has been deprecated. Please use Get DocumentJob Result (V2) instead.

Retrieves a DocumentJobs status information. The result will include the result document, if the job is finished

Get DocumentJob Status (V2)

Retrieves the status of a DocumentJob. Dynamics 365 state/statuscode rules apply

Get DocumentJob Status [DEPRECATED]

This action has been deprecated. Please use Get DocumentJob Status (V2) instead.

Retrieves the status of a DocumentJob. Dynamics 365 state/statuscode rules apply

Get OneClickActions

This function returns all OneClickActions in Dynamics 365

Get Profiles for a UserAPIKey

This function returns all Profile Ids in Dynamics 365

Get SignProviders

This function returns all SignProviders known in the AutomergeSolution

Get Templates

This function returns a list of available DocumentsCorePack Templates

IsServiceAlive [DEPRECATED]

returns true, if the service has been responsive recently, false, if not.

Print DocumentJob (V2)

Print the Document Content generated by a DocumentJob. Attention! The documentjob must already be finished

Print DocumentJob [DEPRECATED]

This action has been deprecated. Please use Print DocumentJob (V2) instead.

Print a Document generated by a DocumentJob. Attention! The documentjob must already be finished

Print File (V2)

Prints a Document Content or base64 encoded file. Supported file-formats are PDF and DOCX

Print File [DEPRECATED]

This action has been deprecated. Please use Print File (V2) instead.

Prints a base64 encoded file. Supported file-formats are PDF and DOCX

Run OneClickAction (async) (V2)

This function runs a OneClickAction. Attention! The function does NOT wait for a result

Run OneClickAction (sync) (V2)

This function runs a OneClickAction and waits for the result

Send email (V2)

Send the specified email

Send email [DEPRECATED]

This action has been deprecated. Please use Send email (V2) instead.

Send the specified email

Sign DocumentJob based on an XML (sync) (V2)

This function digitally signs a DocumentJob and waits for the result

WhoAmI (V2)

Returns information about the currently used API Key and associated Service

WhoAmI [DEPRECATED]

This action has been deprecated. Please use WhoAmI (V2) instead.

Returns information about the currently used API Key and assoicated Service

Attach DocumentJob as note (V2)

Attach the Document Content generated by a DocumentJob as a note to a Dynamics 365 entity. Attention! The documentjob must already be finished

Parameters

Name Key Required Type Description
Environment
Environment True integer

Select the Environment for his operation

DocumentJobId
DocumentJobId True string

The DocumentJob ID of the generated document to attach to the note

User
User string
Schemaname
Schemaname True string
Note description
Description string

Set this text as Notes description

Note subject
Subject string

Set this text as Notes subjects

Entity Id
EntityId True string

The Guid of the entity to attach the note to

Returns

Attach DocumentJob as note [DEPRECATED]

This action has been deprecated. Please use Attach DocumentJob as note (V2) instead.

Attach the file generated by a DocumentJob as a note to a Dynamics 365 entity. Attention! The documentjob must already be finished

Parameters

Name Key Required Type Description
DocumentJobId
DocumentJobId True string

The DocumentJob ID of the generated document to attach to the note

DeactivateOnTimeout
DeactivateOnTimeout boolean

Deactivates the working item on a timeout, preventing the document generation

UserId
UserId string
Schemaname
Schemaname True string
Note description
Note description string

Set this text as Notes description

Note subject
Note subject string

Set this text as Notes subjects

Entity Id
Entity Id True string

The Guid of the entity to attach the note to

Returns

Attach DocumentJob to email (V2)

Attach the Document Content generated by a DocumentJob as attachment to a Dynamics 365 email

Parameters

Name Key Required Type Description
Environment
Environment True integer

Select the Environment for his operation

DocumentJobId
DocumentJobId True string

The DocumentJob ID of the generated document to attach to the email

User
User string
EmailId
EmailId True string

The email the document should be attached to

Returns

Attach DocumentJob to email [DEPRECATED]

This action has been deprecated. Please use Attach DocumentJob to email (V2) instead.

Attach the file generated by a DocumentJob as attachment to a Dynamics 365 email

Parameters

Name Key Required Type Description
DocumentJobId
DocumentJobId True string

The DocumentJob ID of the generated document to attach to the email

DeactivateOnTimeout
DeactivateOnTimeout boolean

Deactivates the working item on a timeout, preventing the document generation

UserId
UserId string
EmailId
EmailId True string

The email the document should be attached to

Returns

Attach file as note (V2)

Attach the Document Content or base64 encoded file as a note to a Dynamics 365 entity. Attention! The documentjob must already be finished

Parameters

Name Key Required Type Description
Environment
Environment True integer

Select the Environment for his operation

Document content
base64 True byte

A content-object or base64 encoded string representing the files content

Filename
Filename True string

The filename to use for storing the file

Mime-Type
MimeType string

Content mime-type for handling of the file (e.g. application/text)

User
User string
Schemaname
Schemaname True string
Note description
Description string

Set this text as Notes description

Note subject
Subject string

Set this text as Notes subjects

Entity Id
EntityId True string

The Guid of the entity to attach the note to

Returns

Attach file as note [DEPRECATED]

This action has been deprecated. Please use Attach file as note (V2) instead.

Attach the file supplied as base64 string as a note to a Dynamics 365 entity. Attention! The documentjob must already be finished

Parameters

Name Key Required Type Description
Document (base64)
Document (base64) True string

A base64 encoded string representing the files content

Filename
Filename True string

The filename to use for storing the file

Mime-Type
Mime-Type string

Content mime-type for handling of the file (e.g. application/text)

DeactivateOnTimeout
DeactivateOnTimeout boolean

Deactivates the working item on a timeout, preventing the document generation

UserId
UserId string
Schemaname
Schemaname True string
Note description
Note description string

Set this text as Notes description

Note subject
Note subject string

Set this text as Notes subjects

Entity Id
Entity Id True string

The Guid of the entity to attach the note to

Returns

Attach file to email (V2)

Attach the Document Content or base64 encoded file as attachment to a Dynamics 365 email

Parameters

Name Key Required Type Description
Environment
Environment True integer

Select the Environment for his operation

Document content
base64 True byte

A content-object or base64 encoded string representing the files content

Filename
Filename True string

The filename to use for storing the file

Mime-Type
MimeType string

Content mime-type for handling of the file (e.g. application/text)

User
User string
EmailId
EmailId True string

The email the document should be attached to

Returns

Attach file to email [DEPRECATED]

This action has been deprecated. Please use Attach file to email (V2) instead.

Attach the base64 encoded file as attachment to a Dynamics 365 email

Parameters

Name Key Required Type Description
Document (base64)
Document (base64) True string

A base64 encoded string representing the files content

Filename
Filename True string

The filename to use for storing the file

Mime-Type
Mime-Type string

Content mime-type for handling of the file (e.g. application/text)

DeactivateOnTimeout
DeactivateOnTimeout boolean

Deactivates the working item on a timeout, preventing the document generation

UserId
UserId string
EmailId
EmailId True string

The email the document should be attached to

Returns

Check API Availibility [DEPRECATED]

This action has been deprecated. Please use Check API Availibility instead.

Verifies, that the API endpoint is currently accessible. Does not require API Key

Returns

Concatenate two Document Contents or base64 encoded files (pdf,docx) (V2)

Concatenates two Document Contents or base64 encoded files (pdf,docx)

Parameters

Name Key Required Type Description
Environment
Environment True integer

Select the Environment for his operation

First Filename
FileName_1 True string

The filename of the first document

First Mime-Type
MimeType_1 True string

Content mime-type for handling of the first document (e.g. application/pdf)

First Document content
base64_1 True byte

A content-object or base64 encoded string representing the files content

Second Filename
FileName_2 True string

The filename of the second document

Second Mime-Type
MimeType_2 True string

Content mime-type for handling of the second document (e.g. application/pdf)

Second Document content
base64_2 True byte

A content-object or base64 encoded string representing the files content

User
User string
CombineType
CombineType True integer
OutputFileType
OutputFileType True integer

Returns

Concatenate two DocumentJobs (V2)

Concatenate two Document Contents (pdf,docx) generated by two DocumentJobs

Parameters

Name Key Required Type Description
Environment
Environment True integer

Select the Environment for his operation

First DocumentJob
DocumentJob1 True uuid

First DocumentJobId of ConcatenationJob

Second DocumentJob
DocumentJob2 True uuid

Second DocumentJobId of ConcatenationJob

User
User string
CombineType
CombineType True integer
OutputFileType
OutputFileType True integer

Returns

Concatenate two DocumentJobs [DEPRECATED]

This action has been deprecated. Please use Concatenate two DocumentJobs (V2) instead.

Concatenate two files (pdf,docx) generated by two DocumentJobs

Parameters

Name Key Required Type Description
First DocumentJob
First DocumentJob True uuid

First DocumentJobId of ConcatenationJob

Second DocumentJob
Second DocumentJob True uuid

Second DocumentJobId of ConcatenationJob

DeactivateOnTimeout
DeactivateOnTimeout boolean

Deactivates the working item on a timeout, preventing the document generation

UserId
UserId string
CombineType
CombineType True integer
OutputFileType
OutputFileType True integer

Returns

Concatenate two Files (pdf,docx) [DEPRECATED]

This action has been deprecated. Please use Concatenate two Document Contents or base64 encoded files (pdf,docx) (V2) instead.

Concatenates two supplied files (pdf,docx)

Parameters

Name Key Required Type Description
First Filename
First Filename True string

The filename of the first document

First Mime-Type
First Mime-Type True string

Content mime-type for handling of the first document (e.g. application/pdf)

First Document (base64)
First Document (base64) True string

A base64 encoded string representing the first document content

Second Filename
Second Filename True string

The filename of the second document

Second Mime-Type
Second Mime-Type True string

Content mime-type for handling of the second document (e.g. application/pdf)

Second Document (base64)
Second Document (base64) True string

A base64 encoded string representing the second document content

DeactivateOnTimeout
DeactivateOnTimeout boolean

Deactivates the working item on a timeout, preventing the document generation

UserId
UserId string
CombineType
CombineType True integer
OutputFileType
OutputFileType True integer

Returns

Create document (sync) (V2)

This function creates a new DocumentJob and waits for the result

Parameters

Name Key Required Type Description
Environment
Environment True integer

Specifies the connection to use for a perUser APIKey

Template
Template True uuid

Select the template for this DocumentJob

EntityId
EntityId True uuid

Dynamics 365 source record id

FileType
FileType True string

Select a filetype for the document result

User
User string

Optional, supply Dynamics 365 users domain name or id

SaveToSharepoint
SaveToSharepoint boolean

Optional, save document to sharepoint

DCPPrinterName
DCPPrinterName string

Optional, Select the DCP printer for a PrintDocument operation

AttachToEmail
AttachToEmailId uuid

Specifies the email to attach the Job to

AttachToEntity
AttachToEntityId uuid

Specifies the entityId to attach the Job to

AttachToEntity - SchemaName
AttachToEntitySchemaName string

Specifies the entity schema name to attach the DocumentJob to

Returns

Create document (sync) [DEPRECATED]

This action has been deprecated. Please use Create document (sync) (V2) instead.

This function creates a new DocumentJob and waits for the result for up to [TimeOut] seconds

Parameters

Name Key Required Type Description
TemplateId
TemplateId True uuid

Select the template for this DocumentJob

EntityId
EntityId True uuid

Dynamics 365 source record id

FileType
FileType True string

Select a filetype for the document result

TimeOut
TimeOut integer

Max. time to wait for document

UserId
UserId string

Optional, supply Dynamics 365 users domain name or id

SaveToSharepoint
SaveToSharepoint boolean

Optional, save document to sharepoint

DCPPrinterName
DCPPrinterName string

Optional, Select the DCP printer for a PrintDocument operation

DeactivateOnTimeout
DeactivateOnTimeout boolean

Deactivates the working item on a timeout, preventing the document generation

Returns

Create document based on an XML (sync) (V2)

This function creates a new DocumentJob and waits for the result

Parameters

Name Key Required Type Description
Environment
Environment True integer

Select the Environment for his operation

MultiPartXml
MultiPartXml True string

Multipart XML document for the DocumentJob

User
User string

Returns

Create DocumentJob (async) (V2)

This function creates a new DocumentJob.. Attention! The function does NOT wait for a result

Parameters

Name Key Required Type Description
Environment
Environment True integer

Specifies the connection to use for a perUser APIKey

Template
Template True uuid

Select the template for this DocumentJob

EntityId
EntityId True uuid

Dynamics 365 source record id

FileType
FileType True string

Select a filetype for the document result

User
User string

Optional, the user to run this operation

SaveToSharepoint
SaveToSharepoint boolean

Optional, save document to sharepoint

DCPPrinterName
DCPPrinterName string

Optional, Select the printer for a PrintDocument operation

AttachToEmail
AttachToEmailId uuid

Specifies the email to attach the Job to

AttachToEntity
AttachToEntityId uuid

Specifies the entityId to attach the Job to

AttachToEntity - SchemaName
AttachToEntitySchemaName string

Specifies the entity schema name to attach the DocumentJob to

Returns

Create DocumentJob (async) [DEPRECATED]

This action has been deprecated. Please use Create DocumentJob (async) (V2) instead.

This function creates a new DocumentJob.. Attention! The function does NOT wait for a result

Parameters

Name Key Required Type Description
TemplateId
TemplateId True uuid

Select the template for this DocumentJob

EntityId
EntityId True uuid

Dynamics 365 source record id

FileType
FileType True string

Select a filetype for the document result

UserId
UserId string

Optional, the user to run this operation

SaveToSharepoint
SaveToSharepoint boolean

Optional, save document to sharepoint

DCPPrinterName
DCPPrinterName string

Optional, Select the printer for a PrintDocument operation

Returns

Create DocumentJob based on an XML (async) (V2)

This function creates a new DocumentJob. Attention! The function does NOT wait for a result

Parameters

Name Key Required Type Description
Environment
Environment True integer

Select the Environment for his operation

MultiPartXml
MultiPartXml True string

Multipart XML document for the DocumentJob

User
User string

Returns

Create DocumentJob based on an XML (async) [DEPRECATED]

This action has been deprecated. Please use Create DocumentJob based on an XML (async) (V2) instead.

This function creates a new DocumentJob. Attention! The function does NOT wait for a result

Parameters

Name Key Required Type Description
DeactivateOnTimeout
DeactivateOnTimeout boolean

Deactivates the working item on a timeout, preventing the document generation

TimeOut
TimeOut integer

Timeout for document creation

MultiPartXml
MultiPartXml True string

Multipart XML document for the DocumentJob

User
User string

Returns

Create DocumentJob based on an XML (sync) [DEPRECATED]

This action has been deprecated. Please use Create document based on an XML (sync) (V2) instead.

This function creates a new DocumentJob and waits for the result for up to [TimeOut] seconds

Parameters

Name Key Required Type Description
DeactivateOnTimeout
DeactivateOnTimeout boolean

Deactivates the working item on a timeout, preventing the document generation

TimeOut
TimeOut integer

Timeout for document creation

MultiPartXml
MultiPartXml True string

Multipart XML document for the DocumentJob

User
User string

Returns

CreateSharepointFolder (V2)

This function creates sharepoint folders

Parameters

Name Key Required Type Description
Environment
Environment True integer

Select the Environment for his operation

Folder name enumeration
Folder name enumeration string
EntityId
EntityId True string

The Guid of the entity to create the folders for

Dynamics Schemaname
Schemaname True string

The schemaname of the entity to create the folders for

User
User string
DocumentLocation
DocumentLocation string

Returns

Get connection details [DEPRECATED]

Verifies, that the API endpoint is currently accessible. Does not require API Key

Returns

Get DCP Printer

Retrieve available printer names, optionally filtered by user

Parameters

Name Key Required Type Description
envId
envId True integer

Specify Environment

User
User string

Optional, supply Dynamics 365 users domain name or id

Returns

Get DocumentJob Result (V2)

Retrieves a DocumentJobs status information. The result will include the result document, if the job is finished

Parameters

Name Key Required Type Description
Environment
Environment True integer

Specifies the connection to use for a perUser APIKey

DocumentJobId
DocumentJobId True uuid

Guid of the DocumentJob Id to retrieve the result of

Returns

Get DocumentJob Result [DEPRECATED]

This action has been deprecated. Please use Get DocumentJob Result (V2) instead.

Retrieves a DocumentJobs status information. The result will include the result document, if the job is finished

Parameters

Name Key Required Type Description
DocumentJobId
DocumentJobId True uuid

Guid of the DocumentJob Id to retrieve the result of

DeactivateOnTimeout
DeactivateOnTimeout boolean

Deactivates the working item on a timeout, preventing the document generation

Returns

Get DocumentJob Status (V2)

Retrieves the status of a DocumentJob. Dynamics 365 state/statuscode rules apply

Parameters

Name Key Required Type Description
Environment
Environment True integer

Specifies the connection to use for a perUser APIKey

DocumentJobId
DocumentJobId True uuid

Guid of the DocumentJob Id to retrieve the status of

Returns

Get DocumentJob Status [DEPRECATED]

This action has been deprecated. Please use Get DocumentJob Status (V2) instead.

Retrieves the status of a DocumentJob. Dynamics 365 state/statuscode rules apply

Parameters

Name Key Required Type Description
DocumentJobId
DocumentJobId True uuid

Guid of the DocumentJob Id to retrieve the status of

DeactivateOnTimeout
DeactivateOnTimeout boolean

Deactivates the working item on a timeout, preventing the document generation

Returns

Get OneClickActions

This function returns all OneClickActions in Dynamics 365

Parameters

Name Key Required Type Description
envId
envId True integer

Returns

Get Profiles for a UserAPIKey

This function returns all Profile Ids in Dynamics 365

Returns

Get SignProviders

This function returns all SignProviders known in the AutomergeSolution

Parameters

Name Key Required Type Description
envId
envId True integer

Returns

Get Templates

This function returns a list of available DocumentsCorePack Templates

Parameters

Name Key Required Type Description
EntityName
EntityName string

Filter by Entity (etc or etn). Optional wildcard [etn]

TemplateNameFilter
TemplateNameFilter string

Filter by template name. Optional wildcard [name]

GroupFilter
GroupFilter string

Filter by group name. Optional wildcard [name]

UserId
UserId string

Only retrieve templates accessible to this user

envId
envId integer

Specify Environment

Returns

IsServiceAlive [DEPRECATED]

returns true, if the service has been responsive recently, false, if not.

Returns

Print the Document Content generated by a DocumentJob. Attention! The documentjob must already be finished

Parameters

Name Key Required Type Description
Environment
Environment True integer

Specifies the connection to use for a perUser APIKey

DocumentJobId
DocumentJobId True uuid

Guid of the DocumentJob Id to print

DCPPrinterName
DCPPrinterName True string

DCP Printername of the printer to use

Returns

This action has been deprecated. Please use Print DocumentJob (V2) instead.

Print a Document generated by a DocumentJob. Attention! The documentjob must already be finished

Parameters

Name Key Required Type Description
DocumentJobId
DocumentJobId True uuid

Guid of the DocumentJob Id to print

DCPPrinterName
DCPPrinterName True string

DCP Printername of the printer to use

DeactivateOnTimeout
DeactivateOnTimeout boolean

Deactivates the working item on a timeout, preventing the document generation

Returns

Prints a Document Content or base64 encoded file. Supported file-formats are PDF and DOCX

Parameters

Name Key Required Type Description
Environment
Environment True integer

Select the Environment for his operation

Document content
base64 True byte

A content-object or base64 encoded string representing the files content

Filename
Filename True string

The filename to use for storing the file

DCPPrinterName
DCPPrinterName True string

Returns

This action has been deprecated. Please use Print File (V2) instead.

Prints a base64 encoded file. Supported file-formats are PDF and DOCX

Parameters

Name Key Required Type Description
DeactivateOnTimeout
DeactivateOnTimeout boolean

Deactivates the working item on a timeout, preventing the document generation

Document (base64)
Document (base64) True string

A base64 encoded string representing the files content

Filename
Filename True string

The filename to use for storing the file

DCPPrinterName
DCPPrinterName True string

Returns

Run OneClickAction (async) (V2)

This function runs a OneClickAction. Attention! The function does NOT wait for a result

Parameters

Name Key Required Type Description
Environment
Environment True integer

Specifies the connection to use for a perUser APIKey

EntityId
EntityId True uuid

Dynamics 365 source record id

OneClickAction
OneClickAction True uuid

Id of the OneClickAction to apply

User
User string

Only retrieve templates accessible to this user

Returns

Run OneClickAction (sync) (V2)

This function runs a OneClickAction and waits for the result

Parameters

Name Key Required Type Description
Environment
Environment True integer

Specifies the connection to use for a perUser APIKey

EntityId
EntityId True uuid

Dynamics 365 source record id

OneClickAction
OneClickAction True uuid

Id of the OneClickAction to apply

User
User string

Only retrieve templates accessible to this user

Returns

Send email (V2)

Send the specified email

Parameters

Name Key Required Type Description
Environment
Environment True integer

Select the Environment for his operation

EmailToSend
EmailToSend True string

Guid of email to send

User
User string
Sender (userid)
SenderId uuid

Guid of email sender

Sender (Schemaname)
SenderLogicalName string

Schema name of the sender, default is systemuser

Regarding (Id)
RegardingObjectId uuid

Guid of the entity to set as regarding

Regarding (Schemaname)
RegardingObjectLogicalName string
Id
Id uuid
Schemaname
Schemaname string
Id
Id uuid
Schemaname
Schemaname string
Id
Id uuid
Schemaname
Schemaname string

Returns

Send email [DEPRECATED]

This action has been deprecated. Please use Send email (V2) instead.

Send the specified email

Parameters

Name Key Required Type Description
DeactivateOnTimeout
DeactivateOnTimeout boolean

Deactivates the working item on a timeout, preventing the document generation

EmailToSend
EmailToSend True string

Guid of email to send

User
User string
Sender (userid)
Sender (userid) uuid

Guid of email sender

Sender (Schemaname)
Sender (Schemaname) string

Schema name of the sender, default is systemuser

Regarding (Id)
Regarding (Id) uuid

Guid of the entity to set as regarding

Regarding (Schemaname)
Regarding (Schemaname) string
Id
Id uuid
Schemaname
Schemaname string
Id
Id uuid
Schemaname
Schemaname string
Id
Id uuid
Schemaname
Schemaname string

Returns

Sign DocumentJob based on an XML (sync) (V2)

This function digitally signs a DocumentJob and waits for the result

Parameters

Name Key Required Type Description
Environment
Environment True integer

Select the Environment for his operation

EntityId
EntityId True string

The Guid of the Entity the eSign record wil be attached to

Schemaname
Schemaname True string

The Schemaname of the Entity the eSign record wil be attached to

DocumentJob
DocumentJob True uuid

DocumentJobId containing the document to sign

User
User string
Signing Provider
SignProvider True integer

The provider that should be used to sign this document

Email Default Subject
Subject string

Default subject in signing request email

Email Default Message
Message string

Default message in signing request email

Name
Name True string

The display name of the Signee

Email
Email True string

The email address of the Signee

InPerson Signing
InPerson True boolean

Generates a link to start the signing process

Subject
Subject string

Personalized subject in signing request email

Message
Message string

Personalized message in signing request email

Telephonenumber
TelNr string

Signees telephone number for SMS authentication (DocuSign only)

DocuSign Hostname
HostName string

Signing hosts name for inPerson signing (DocuSign only)

Hostemail
Hostemail string

Signing hosts emailaddress for inPerson signing (DocuSign only)

Returns

WhoAmI (V2)

Returns information about the currently used API Key and associated Service

Parameters

Name Key Required Type Description
Environment
Environment True integer

Specifies the connection to use for a perUser APIKey

Returns

Body
WhoAmi

WhoAmI [DEPRECATED]

This action has been deprecated. Please use WhoAmI (V2) instead.

Returns information about the currently used API Key and assoicated Service

Returns

Body
WhoAmi

Definitions

DocumentJobStatusResponse

Name Path Type Description
Success
Success boolean
Return value
Return value string
Return value 2
Return value 2 string
DocumentJobId
DocumentJobId string

JSONCreateNoteResponse

Name Path Type Description
annotationid
annotationid string
Success
Success boolean
Return value
Return value string
Return value 2
Return value 2 string

DocumentJobResponse

Name Path Type Description
File name
File name string
File size
File size integer
Document (Base64 encoded)
Document (Base64 encoded) string
Mime-Type
Mime-Type string
Temporary Record Id
Temporary Record Id string
Success
Success boolean
Return value
Return value string
Return value 2
Return value 2 string
DocumentJobId
DocumentJobId string

DocumentJobResponseV2

Name Path Type Description
File name
File name string
File size
File size integer
Document content
Document content byte
Mime-Type
Mime-Type string
Temporary Record Id
Temporary Record Id string
Success
Success boolean
Return value
Return value string
Return value 2
Return value 2 string
DocumentJobId
DocumentJobId string

JSONDCPTemplate

Name Path Type Description
ptm_mscrmaddons_dcptemplatesid
ptm_mscrmaddons_dcptemplatesid string
ptm_name
ptm_name string
ptm_entitytype
ptm_entitytype string

JSONEnvironment

Name Path Type Description
EnvironmentName
EnvironmentName string
EnvironmentId
EnvironmentId integer

JSONOneClickAction

Name Path Type Description
DisplayName
DisplayName string
OcaID
OcaID uuid
@odata.etag
@odata.etag string
ptm_entity
ptm_entity string
ptm_position
ptm_position integer
_owningbusinessunit_value
_owningbusinessunit_value string
ptm_mscrmaddonscomoneclickactionid
ptm_mscrmaddonscomoneclickactionid string
ptm_name
ptm_name string
statecode
statecode integer
statuscode
statuscode integer
_createdby_value
_createdby_value string
ptm_oca
ptm_oca string
_ownerid_value
_ownerid_value string
modifiedon
modifiedon date-time
_owninguser_value
_owninguser_value string
_modifiedby_value
_modifiedby_value string
versionnumber
versionnumber integer
createdon
createdon date-time
_ptm_groupid_value
_ptm_groupid_value string

JSONPrinterResponse

Name Path Type Description
DCPPrinterName
DCPPrinterName string

JSONSignProvider

Name Path Type Description
SignProviderName
SignProviderName string
OptionValue
OptionValue integer

UserMessage

Name Path Type Description
Message
Message string

WhoAmi

Name Path Type Description
ApiKey
ApiKey string
ApiOwner
ApiOwner string
Environment
Environment integer