DocumentsCorePack
DocumentsCorePack 是基于 Dynamics 365 数据的快速和简单的文档生成。 DocumentsCorePack 基于 MS Word - 模板提供一组工具，用于有效创建和处理文档。 从文档生成向导引导用户完成整个文档自动化 - DocumentsCorePack 将使业务文档看起来更专业，并帮助你高效地处理它们！
此连接器在以下产品和区域中可用：
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 高级 | 除以下各项外的所有 Power Automate 区域 ： - 由世纪互联运营的中国云 |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 ： - Azure 中国区域 |
| Power Apps | 高级 | 除以下各项外的所有 Power Apps 区域 ： - 由世纪互联运营的中国云 |
| Power Automate | 高级 | 除以下各项外的所有 Power Automate 区域 ： - 由世纪互联运营的中国云 |
| 联系人 | |
|---|---|
| Name | mscrm-addons.com |
| URL | https://support.mscrm-addons.com |
| support@mscrm-addons.com |
| 连接器元数据 | |
|---|---|
| 发布者 | mscrm-addons.com |
| 网站 | https://poweraddons.com |
| 隐私策略 | https://www.mscrm-addons.com/LegalDocuments |
| 类别 | 生产力;销售和 CRM |
DocumentsCorePack 连接器
DocumentsCorePack 允许生成和自动化合并 Dataverse 和 Dynamics 365 数据的文档。 DocumentsCorePack 连接器基于 Microsoft Word 模板，提供各种作来创建和处理文档。
DocumentsCorePack 连接器将此功能引入 Power Automate 和 Flow。 详细信息
按照 此链接 查看分步教程、作方法并获取详细信息。
发布者：PTM EDV Systeme GmbH - mscrm-addons.com 公司。
先决条件
- Dynamics 365 或 Dataverse 环境。
- DocumentsCorePack 服务（可以使用 此链接启动试用版）
为环境生成 API 密钥
可以从 DocumentsCorePack 服务配置生成 API 密钥（请注意，如果没有服务，可以使用 此链接启动免费试用）。
在 Service-Configuration 中，单击 “选择 API 密钥”。
如果遇到问题，请查看以下 文章 或发送电子邮件 support@mscrm-addons.com
API 文档
可在此处找到 API 文档
支持的作
创建文档 （同步） （V4）
创建新文档。 有关详细信息， 请单击此处。
创建 DocumentJob （异步） （V4）
创建新文档。 该作不会等待结果。 有关详细信息， 请单击此处。
创建多部分文档 （异步） （V4）
创建由多个组件组成的文档。 该作不会等待结果。 有关详细信息， 请单击此处。
签名 DocumentJob （同步） （V4）
发送用于电子签名的文档。
运行一Click-Action（同步）（V4）
运行一Click-Action 并等待结果。 有关详细信息， 请单击此处。
运行一Click-Action（异步）（V4）
运行一键式作。 该作不会等待结果。 有关详细信息， 请单击此处。
创建多部分文档 （同步） （V4）
创建由多个组件组成的文档。 有关详细信息， 请单击此处。
获取 DocumentJob 结果 （V4）
检索 DocumentJob 的状态信息。 结果将包含生成的文档。
获取 DocumentJob 状态 （V4）
检索 DocumentJob 的状态。
打印 DocumentJob （V4）
打印 DocumentJob 生成的文档。
打印文件 （V4）
打印文档内容或 base64 编码文件。 支持的文件类型：pdf、docx。
将 DocumentJob 附加为注释 （V4）
将 DocumentJob 生成的文档作为备注附加到 Dynamics 365 记录。
按说明附加文件 （V4）
将文档内容或 base64 编码文件作为备注附加到 Dynamics 365 记录。
将 DocumentJob 附加到电子邮件（V4）
将 DocumentJob 生成的文档内容作为附件附加到 Dynamics 365 电子邮件。
连接两个 DocumentJobs （V4）
连接两个 DocumentJobs 生成的两个文档。 支持的文件类型：pdf、docx。
连接两个文档内容或 base64 编码文件 （pdf，docx） （V4）
连接两个文档内容或 base64 编码文件。 支持的文件类型：pdf、docx。
将文件附加到电子邮件（V4）
将文档内容或 base64 编码的文件作为附件附加到 Dynamics 365 电子邮件。
发送电子邮件（V4）
发送 Dataverse 电子邮件。
创建 SharePoint 文件夹 （V4）
在 Dynamics 365 记录的文档位置中创建 SharePoint 上的文件夹。
在客户旅程中处理批处理 （同步） （V4）
为客户旅程中的记录批量创建和处理文档。 有关详细信息， 请单击此处。
在客户旅程中处理批处理 （异步） （V4）
为客户旅程中的记录批量创建和处理文档。 此作不会等待结果。 有关详细信息， 请单击此处。
获取此 ApiKey 的默认环境
返回已用 ApiKey 的环境 ID。
获取 User APIKey 的配置文件
检索此 ApiKey 的所有配置文件 ID。
获取文档模板
检索可用 DocumentsCorePack 模板的列表。
获取 DocumentLocations 的列表
检索 Dynamics DocumentLocations 的列表。
获取打印机
检索可用的打印机。
获取 Dynamics 用户列表
检索 Dynamics 用户的列表。
获取一Click-Actions
检索 Dynamics 365 中配置的所有 One-Click-Actions。
检索具有批注功能的表名
检索支持批注的 Dynamics 表的列表。
获取电子签名提供程序
检索 DocumentsCorePack 中提供的所有电子签名提供程序。
WhoAmI （V4）
检索有关已用 API 密钥和关联的 DocumentsCorePack 服务的信息。
获取凭据
首先，需要 创建帐户 并注册 DocumentsCorePack 服务（14 天免费试用版可用）。
获取环境的 API 密钥：
如有疑问，请发送电子邮件至 support@mscrm-addons.com
已知问题和限制
N/A
创建连接
连接器支持以下身份验证类型：
| 默认 | 用于创建连接的参数。 | 所有区域 | 可共享 |
违约
适用：所有区域
用于创建连接的参数。
这是可共享的连接。 如果 Power App 与其他用户共享，则连接也会共享。 有关详细信息，请参阅 画布应用的连接器概述 - Power Apps |Microsoft Docs
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| API 密钥 | securestring | 获取 API 密钥 - https://www.mscrm-addons.com/getapikey | True |
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 1200 | 60 秒 |
操作
|
Create |
此作已弃用。 请改用“创建 SharePoint”文件夹（V4）。
|
|
Is |
如果服务最近响应，则返回 true，否则返回 false。 |
|
Print Document |
此作已弃用。 请改用 Print DocumentJob （V4）。
|
|
Who |
此作已弃用。 请改用 WhoAmI （V4）。
|
|
Who |
此作已弃用。 请改用 WhoAmI （V4）。
|
|
Who |
此作已弃用。 请改用 WhoAmI （V4）。
|
|
Who |
检索有关已用 API 密钥和关联的 DocumentsCorePack 服务的信息。 |
|
创建 Document |
此作已弃用。 请改用 Create DocumentJob （async） （V4）。
|
|
创建 Document |
此作已弃用。 请改用 Create DocumentJob （async） （V4）。
|
|
创建 Document |
此作已弃用。 请改用 Create DocumentJob （async） （V4）。
|
|
创建 Document |
创建新文档。 该作不会等待结果。 有关详细信息 https://short.mscrm-addons.com/createdocumentjobasync |
|
创建 Share |
此作已弃用。 请改用“创建 SharePoint”文件夹（V4）。
|
|
创建 Share |
在 Dynamics 365 记录的文档位置中创建 SharePoint 上的文件夹。 |
| 创建多部分文档 （同步） （V3） [已弃用] |
此作已弃用。 请改用 “创建多部分”文档（同步）（V4 ）。
|
| 创建多部分文档 （同步） （V4） |
创建由多个组件组成的文档。 有关详细信息 https://short.mscrm-addons.com/multipart |
| 创建多部分文档 （异步） （V3） [已弃用] |
此作已弃用。 请改用“创建多部分”文档（async）（V4）。
|
| 创建多部分文档 （异步） （V4） |
创建由多个组件组成的文档。 该作不会等待结果。 有关详细信息 https://short.mscrm-addons.com/multipart |
| 创建文档 （同步） [已弃用] |
此作已弃用。 请改用“创建文档”（同步）（V4）。
|
| 创建文档 （同步） （V2） [已弃用] |
此作已弃用。 请改用“创建文档”（同步）（V4）。
|
| 创建文档 （同步） （V3） [已弃用] |
此作已弃用。 请改用“创建文档”（同步）（V4）。
|
| 创建文档 （同步） （V4） |
创建新文档。 有关详细信息 https://short.mscrm-addons.com/createdocumentjob |
| 发送电子邮件 [已弃用] |
此作已弃用。 请改用发送电子邮件（V4）。
|
| 发送电子邮件 （V2） [已弃用] |
此作已弃用。 请改用发送电子邮件（V4）。
|
| 发送电子邮件 （V3） [已弃用] |
此作已弃用。 请改用发送电子邮件（V4）。
|
| 发送电子邮件（V4） |
发送 Dataverse 电子邮件。 |
| 在客户旅程中处理批处理 （同步） （V4） |
创建新文档。 有关详细信息 https://short.mscrm-addons.com/createdocumentjob |
| 在客户旅程中处理批处理 （异步） （V4） |
创建新文档。 有关详细信息 https://short.mscrm-addons.com/createdocumentjob |
|
基于 XML 创建 Document |
此作已弃用。 请改用“创建多部分”文档（async）（V4）。
|
|
基于 XML 创建 Document |
此作已弃用。 请改用 “创建多部分”文档（同步）（V4 ）。
|
|
基于 XML （async） （V2） 创建 Document |
此作已弃用。 请改用“创建多部分”文档（async）（V4）。
|
| 基于 XML（同步）（V2）创建文档 [已弃用] |
此作已弃用。 请改用 “创建多部分”文档（同步）（V4 ）。
|
|
基于 XML（同步）（V2）对 Document |
此作已弃用。 请改用 Sign DocumentJob （sync） （V4）。
|
|
将 Document |
此作已弃用。 请改用 Attach DocumentJob 作为注释（V4）。
|
|
将 Document |
此作已弃用。 请改用 Attach DocumentJob 作为注释（V4）。
|
|
将 Document |
将 DocumentJob 生成的文档作为备注附加到 Dynamics 365 记录。 |
|
将 Document |
此作已弃用。 请改用“附加 DocumentJob”发送电子邮件（V4）。
|
|
将 Document |
此作已弃用。 请改用“附加 DocumentJob”发送电子邮件（V4）。
|
|
将 Document |
此作已弃用。 请改用“附加 DocumentJob”发送电子邮件（V4）。
|
|
将 Document |
将 DocumentJob 生成的文档内容作为附件附加到 Dynamics 365 电子邮件。 |
| 将文件附加到电子邮件 [已弃用] |
此作已弃用。 请改用“附加到电子邮件”文件（V4）。
|
| 将文件附加到电子邮件 （V2） [已弃用] |
此作已弃用。 请改用“附加到电子邮件”文件（V4）。
|
| 将文件附加到电子邮件 （V3） [已弃用] |
此作已弃用。 请改用“附加到电子邮件”文件（V4）。
|
| 将文件附加到电子邮件（V4） |
将文档内容或 base64 编码的文件作为附件附加到 Dynamics 365 电子邮件。 |
|
打印 Document |
此作已弃用。 请改用 Print DocumentJob （V4）。
|
|
打印 Document |
此作已弃用。 请改用 Print DocumentJob （V4）。
|
|
打印 Document |
打印 DocumentJob 生成的文档。 |
| 打印文件 [已弃用] |
此作已弃用。 请改用打印文件（V4）。
|
| 打印文件 （V2） [已弃用] |
此作已弃用。 请改用打印文件（V4）。
|
| 打印文件 （V3） [已弃用] |
此作已弃用。 请改用打印文件（V4）。
|
| 打印文件 （V4） |
打印文档内容或 base64 编码文件。 支持的文件类型：pdf、docx。 |
|
按说明附加 Document |
此作已弃用。 请改用 Attach DocumentJob 作为注释（V4）。
|
| 按说明附加文件 [已弃用] |
此作已弃用。 请改用附加文件（V4）。
|
| 按说明附加文件 （V4） |
将文档内容或 base64 编码文件作为备注附加到 Dynamics 365 记录。 |
| 检查 API 可用性 [已弃用] |
此作已弃用。 请改用 Check API 可用性 。
|
|
签名 Document |
此作已弃用。 请改用 Sign DocumentJob （sync） （V4）。
|
|
签名 Document |
发送用于电子签名的文档。 |
| 获取 DCP 打印机 [已弃用] |
此作已弃用。 请改用 “获取打印机 ”。
|
|
获取 Document |
此作已弃用。 请改用 Get DocumentJob 状态（V4）。
|
|
获取 Document |
此作已弃用。 请改用 Get DocumentJob 状态（V4）。
|
|
获取 Document |
此作已弃用。 请改用 Get DocumentJob 状态（V4）。
|
|
获取 Document |
检索 DocumentJob 的状态。 |
|
获取 Document |
此作已弃用。 请改用 Get DocumentJob 结果（V4）。
|
|
获取 Document |
此作已弃用。 请改用 Get DocumentJob 结果（V4）。
|
|
获取 Document |
此作已弃用。 请改用 Get DocumentJob 结果（V4）。
|
|
获取 Document |
检索 DocumentJob 的状态信息。 结果将包含生成的文档。 |
| 获取 One-Click-Actions [已弃用] |
此作已弃用。 请改用 “获取一键式作 ”。
|
|
获取 One |
此作已弃用。 请改用 “获取一键式作 ”。
|
|
获取 Sign |
此函数返回 AutomergeSolution 中已知的所有 SignProviders |
| 获取 User APIKey 的配置文件 |
检索此 ApiKey 的所有配置文件 ID。 |
|
获取 User |
此作已弃用。 请改 用 User APIKey 的“获取配置文件 ”。
|
| 获取一Click-Actions |
检索 Dynamics 365 中配置的所有 One-Click-Actions。 |
| 获取打印机 |
检索可用的打印机。 |
| 获取打印机 [已弃用] |
此作已弃用。 请改用 “获取打印机 ”。
|
| 获取文档模板 |
检索可用 DocumentsCorePack 模板的列表。 |
| 获取文档模板 [已弃用] |
此作已弃用。 请改用 “获取文档模板 ”。
|
| 获取模板 [已弃用] |
此作已弃用。 请改用 “获取文档模板 ”。
|
|
获取此 Api |
返回已用 ApiKey 的环境 ID。 |
|
获取此 Api |
返回已用 ApiKey 的环境 ID。 |
| 获取用户 APIKey 的配置文件 [已弃用] |
此作已弃用。 请改 用 User APIKey 的“获取配置文件 ”。
|
| 获取电子签名提供程序 [已弃用] |
检索 DocumentsCorePack 中提供的所有电子签名提供程序。 |
| 获取电子签名提供程序 [已弃用] |
检索 DocumentsCorePack 中提供的所有电子签名提供程序。 |
| 获取连接详细信息 [已弃用] |
验证 API 终结点当前是否可访问。 不需要 API 密钥 |
|
运行 One |
此作已弃用。 请改用“运行一Click-Action（异步）（V4）。
|
|
运行 One |
此作已弃用。 请改用“运行一Click-Action（同步）（V4）。
|
| 运行一Click-Action（同步）（V3） [已弃用] |
此作已弃用。 请改用“运行一Click-Action（同步）（V4）。
|
| 运行一Click-Action（同步）（V4） |
运行一Click-Action 并等待结果。 有关详细信息 https://short.mscrm-addons.com/oca |
| 运行一Click-Action（异步）（V3） [已弃用] |
此作已弃用。 请改用“运行一Click-Action（异步）（V4）。
|
| 运行一Click-Action（异步）（V4） |
运行一键式作。 该作不会等待结果。 有关详细信息 https://short.mscrm-addons.com/oca |
|
连接两个 Document |
此作已弃用。 请改用连接两个 DocumentJobs （V4）。
|
|
连接两个 Document |
此作已弃用。 请改用连接两个 DocumentJobs （V4）。
|
|
连接两个 Document |
此作已弃用。 请改用连接两个 DocumentJobs （V4）。
|
|
连接两个 Document |
连接两个 DocumentJobs。 支持的文件类型：pdf、docx。 |
| 连接两个文件 （pdf，docx） [已弃用] |
此作已弃用。 请使用 连接两个文档。支持的文件类型：pdf、docx 。
|
| 连接两个文档。 支持的文件类型：pdf、docx |
连接两个文档内容或 base64 编码文件。 支持的文件类型：pdf、docx。 |
| 连接两个文档。 支持的文件类型：pdf、docx [已弃用] |
此作已弃用。 请使用 连接两个文档。支持的文件类型：pdf、docx 。
|
| 连接两个文档内容或 base64 编码文件 （pdf，docx） （V2） [已弃用] |
此作已弃用。 请使用 连接两个文档。支持的文件类型：pdf、docx 。
|
| 附加文件（V2） [已弃用] |
此作已弃用。 请改用附加文件（V4）。
|
| 附加文件（V3） [已弃用] |
此作已弃用。 请改用附加文件（V4）。
|
CreateSharepointFolder （V2） [已弃用]
此作已弃用。 请改用“创建 SharePoint”文件夹（V4）。
此函数创建 sharepoint 文件夹
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | True | integer |
为作选择环境 |
|
文件夹名称枚举
|
FolderNames | array of string |
提供要创建的所有文件夹名称 |
|
|
关于 ObjectId
|
EntityId | True | string |
要为其创建文件夹的实体的 Guid |
|
Dynamics Schemaname
|
Schemaname | True | string |
要为其创建文件夹的实体的架构名称 |
|
用户
|
User | string | ||
|
DocumentLocation
|
DocumentLocation | string |
返回
IsServiceAlive [已弃用]
Print DocumentJob [已弃用]
此作已弃用。 请改用 Print DocumentJob （V4）。
打印 DocumentJob 生成的文档。 注意力！ documentjob 必须已完成
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
DocumentJobId
|
DocumentJobId | True | uuid |
要打印的 DocumentJob ID 的 Guid |
|
DCPPrinterName
|
DCPPrinterName | True | string |
要使用的打印机的 DCP Printername |
|
DeactivateOnTimeout
|
DeactivateOnTimeout | boolean |
在超时时停用工作项，防止生成文档 |
返回
WhoAmI [已弃用]
WhoAmI （V2） [已弃用]
此作已弃用。 请改用 WhoAmI （V4）。
返回有关当前使用的 API 密钥和关联的服务的信息
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | True | integer |
指定要用于 perUser APIKey 的连接 |
返回
- Body
- WhoAmi
WhoAmI （V3） [已弃用]
此作已弃用。 请改用 WhoAmI （V4）。
检索有关已用 API 密钥和关联的 DocumentsCorePack 服务的信息。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
- Body
- WhoAmi
WhoAmI （V4）
检索有关已用 API 密钥和关联的 DocumentsCorePack 服务的信息。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
- Body
- WhoAmi
创建 DocumentJob （async） （V2） [已弃用]
此作已弃用。 请改用 Create DocumentJob （async） （V4）。
此函数创建新的 DocumentJob.。 注意力！ 函数不会等待结果
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | True | integer |
指定要用于 perUser APIKey 的连接 |
|
Template
|
Template | True | uuid |
选择此 DocumentJob 的模板 |
|
实体ID
|
EntityId | True | uuid |
Dynamics 365 源记录 ID |
|
FileType
|
FileType | True | string |
为文档结果选择文件类型 |
|
用户
|
User | string |
可选，用于运行此作的用户 |
|
|
SaveToSharepoint
|
SaveToSharepoint | boolean |
可选，将文档保存到 sharepoint |
|
|
DCPPrinterName
|
DCPPrinterName | string |
可选，选择 PrintDocument作的打印机 |
|
|
AttachToEmail
|
AttachToEmailId | uuid |
指定要将作业附加到的电子邮件 |
|
|
AttachToEntity
|
AttachToEntityId | uuid |
指定要将作业附加到的 entityId |
|
|
AttachToEntity - SchemaName
|
AttachToEntitySchemaName | string |
指定要将 DocumentJob 附加到的实体架构名称 |
返回
创建 DocumentJob （异步） [已弃用]
此作已弃用。 请改用 Create DocumentJob （async） （V4）。
此函数创建新的 DocumentJob.。 注意力！ 函数不会等待结果
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
TemplateId
|
TemplateId | True | uuid |
选择此 DocumentJob 的模板 |
|
实体ID
|
EntityId | True | uuid |
Dynamics 365 源记录 ID |
|
FileType
|
FileType | True | string |
为文档结果选择文件类型 |
|
UserId
|
UserId | string |
可选，用于运行此作的用户 |
|
|
SaveToSharepoint
|
SaveToSharepoint | boolean |
可选，将文档保存到 sharepoint |
|
|
DCPPrinterName
|
DCPPrinterName | string |
可选，选择 PrintDocument作的打印机 |
返回
创建 DocumentJob （异步） （V3） [已弃用]
此作已弃用。 请改用 Create DocumentJob （async） （V4）。
创建新文档。 该作不会等待结果。 有关详细信息 https://short.mscrm-addons.com/createdocumentjobasync
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Template
|
Template | True | uuid |
为此 DocumentJob 选择模板。 |
|
行 ID
|
EntityId | True | uuid |
要为其运行此模板的记录的唯一标识符。 |
|
文件类型
|
FileType | True | string |
选择文件类型。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
保存到 SharePoint
|
SaveToSharepoint | boolean |
将文档保存到 SharePoint。 |
|
|
附加到电子邮件
|
AttachToEmailId | uuid |
要向其附加文档的电子邮件的唯一标识符。 |
|
|
Printer
|
DCPPrinterName | string |
选择打印机。 |
|
|
附加到 [行 ID]
|
AttachToEntityId | uuid |
要附加到此文档的记录的唯一标识符。 |
|
|
附加到 [表]
|
AttachToEntitySchemaName | string |
选择要将此文档附加到的表。 |
|
|
Name
|
Name | string |
提示的名称/ID。 |
|
|
价值
|
Value | string |
提示的值。 |
|
|
IsValid
|
IsValid | boolean | ||
|
JSON 数据源
|
JSONDataSource | string |
使用此 JSON 数据创建文档。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
创建 DocumentJob （异步） （V4）
创建新文档。 该作不会等待结果。 有关详细信息 https://short.mscrm-addons.com/createdocumentjobasync
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Template
|
Template | True | uuid |
为此 DocumentJob 选择模板。 |
|
行 ID
|
EntityId | True | uuid |
要为其运行此模板的记录的唯一标识符。 |
|
文件类型
|
FileType | True | string |
选择文件类型。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
保存到 SharePoint
|
SaveToSharepoint | boolean |
将文档保存到 SharePoint。 |
|
|
附加到电子邮件
|
AttachToEmailId | uuid |
要向其附加文档的电子邮件的唯一标识符。 |
|
|
Printer
|
DCPPrinterName | string |
选择打印机。 |
|
|
附加到 [行 ID]
|
AttachToEntityId | uuid |
要附加到此文档的记录的唯一标识符。 |
|
|
附加到 [表]
|
AttachToEntitySchemaName | string |
选择要将此文档附加到的表。 |
|
|
Name
|
Name | string |
提示的名称/ID。 |
|
|
价值
|
Value | string |
提示的值。 |
|
|
IsValid
|
IsValid | boolean | ||
|
JSON 数据源
|
JSONDataSource | string |
使用此 JSON 数据创建文档。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
创建 SharePoint 文件夹 （V3） [已弃用]
此作已弃用。 请改用“创建 SharePoint”文件夹（V4）。
在 Dynamics 365 记录的文档位置中创建 SharePoint 上的文件夹。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
文件夹名称
|
FolderNames | array of string |
提供要创建的所有文件夹名称。 |
|
|
行 ID
|
EntityId | True | string |
要为其创建文件夹的记录的唯一标识符。 |
|
表名称
|
Schemaname | True | string |
要为其创建文件夹的记录的表名。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
DocumentLocation ID
|
DocumentLocation | string |
选择要在其中创建文件夹的文档位置。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
创建 SharePoint 文件夹 （V4）
在 Dynamics 365 记录的文档位置中创建 SharePoint 上的文件夹。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
文件夹名称
|
FolderNames | array of string |
提供要创建的所有文件夹名称。 |
|
|
行 ID
|
EntityId | True | string |
要为其创建文件夹的记录的唯一标识符。 |
|
表名称
|
Schemaname | True | string |
要为其创建文件夹的记录的表名。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
DocumentLocation ID
|
DocumentLocation | string |
选择要在其中创建文件夹的文档位置。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
创建多部分文档 （同步） （V3） [已弃用]
此作已弃用。 请改用 “创建多部分”文档（同步）（V4 ）。
创建由多个组件组成的文档。 有关详细信息 https://short.mscrm-addons.com/multipart
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
多部分 XML
|
MultiPartXml | True | string |
DocumentJob 的多部分 XML 定义。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
使用外部存储
|
SaveToTempRecord | boolean |
仅保存在备用位置。 |
|
|
保存位置
|
SaveLocation | string |
外部 SharePoint 或 Blob URL。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
创建多部分文档 （同步） （V4）
创建由多个组件组成的文档。 有关详细信息 https://short.mscrm-addons.com/multipart
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
多部分 XML
|
MultiPartXml | True | string |
DocumentJob 的多部分 XML 定义。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
使用外部存储
|
SaveToTempRecord | boolean |
仅保存在备用位置。 |
|
|
保存位置
|
SaveLocation | string |
外部 SharePoint 或 Blob URL。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
创建多部分文档 （异步） （V3） [已弃用]
此作已弃用。 请改用“创建多部分”文档（async）（V4）。
创建由多个组件组成的文档。 该作不会等待结果。 有关详细信息 https://short.mscrm-addons.com/multipart
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
多部分 XML
|
MultiPartXml | True | string |
DocumentJob 的多部分 XML 定义。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
使用外部存储
|
SaveToTempRecord | boolean |
仅保存在备用位置。 |
|
|
保存位置
|
SaveLocation | string |
外部 SharePoint 或 Blob URL。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
创建多部分文档 （异步） （V4）
创建由多个组件组成的文档。 该作不会等待结果。 有关详细信息 https://short.mscrm-addons.com/multipart
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
多部分 XML
|
MultiPartXml | True | string |
DocumentJob 的多部分 XML 定义。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
使用外部存储
|
SaveToTempRecord | boolean |
仅保存在备用位置。 |
|
|
保存位置
|
SaveLocation | string |
外部 SharePoint 或 Blob URL。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
创建文档 （同步） [已弃用]
此作已弃用。 请改用“创建文档”（同步）（V4）。
此函数创建新的 DocumentJob 并等待结果最多 [TimeOut] 秒
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
TemplateId
|
TemplateId | True | uuid |
选择此 DocumentJob 的模板 |
|
实体ID
|
EntityId | True | uuid |
Dynamics 365 源记录 ID |
|
FileType
|
FileType | True | string |
为文档结果选择文件类型 |
|
超时
|
TimeOut | integer |
麦克斯。 等待文档的时间 |
|
|
UserId
|
UserId | string |
可选，提供 Dynamics 365 用户域名或 ID |
|
|
SaveToSharepoint
|
SaveToSharepoint | boolean |
可选，将文档保存到 sharepoint |
|
|
DCPPrinterName
|
DCPPrinterName | string |
可选，为 PrintDocument作选择 DCP 打印机 |
|
|
DeactivateOnTimeout
|
DeactivateOnTimeout | boolean |
在超时时停用工作项，防止生成文档 |
返回
- Body
- DocumentJobResponse
创建文档 （同步） （V2） [已弃用]
此作已弃用。 请改用“创建文档”（同步）（V4）。
此函数创建新的 DocumentJob 并等待结果
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | True | integer |
指定要用于 perUser APIKey 的连接 |
|
Template
|
Template | True | uuid |
选择此 DocumentJob 的模板 |
|
实体ID
|
EntityId | True | uuid |
Dynamics 365 源记录 ID |
|
FileType
|
FileType | True | string |
为文档结果选择文件类型 |
|
用户
|
User | string |
可选，提供 Dynamics 365 用户域名或 ID |
|
|
SaveToSharepoint
|
SaveToSharepoint | boolean |
可选，将文档保存到 sharepoint |
|
|
DCPPrinterName
|
DCPPrinterName | string |
可选，为 PrintDocument作选择 DCP 打印机 |
|
|
AttachToEmail
|
AttachToEmailId | uuid |
指定要将作业附加到的电子邮件 |
|
|
AttachToEntity
|
AttachToEntityId | uuid |
指定要将作业附加到的 entityId |
|
|
AttachToEntity - SchemaName
|
AttachToEntitySchemaName | string |
指定要将 DocumentJob 附加到的实体架构名称 |
返回
创建文档 （同步） （V3） [已弃用]
此作已弃用。 请改用“创建文档”（同步）（V4）。
创建新文档。 有关详细信息 https://short.mscrm-addons.com/createdocumentjob
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Template
|
Template | True | uuid |
为此 DocumentJob 选择模板。 |
|
行 ID
|
EntityId | True | uuid |
要为其运行此模板的记录的唯一标识符。 |
|
文件类型
|
FileType | True | string |
选择文件类型。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
保存到 SharePoint
|
SaveToSharepoint | boolean |
将文档保存到 SharePoint。 |
|
|
附加到电子邮件
|
AttachToEmailId | uuid |
要向其附加文档的电子邮件的唯一标识符。 |
|
|
Printer
|
DCPPrinterName | string |
选择打印机。 |
|
|
附加到 [行 ID]
|
AttachToEntityId | uuid |
要附加到此文档的记录的唯一标识符。 |
|
|
附加到 [表]
|
AttachToEntitySchemaName | string |
选择要将此文档附加到的表。 |
|
|
Name
|
Name | string |
提示的名称/ID。 |
|
|
价值
|
Value | string |
提示的值。 |
|
|
IsValid
|
IsValid | boolean | ||
|
JSON 数据源
|
JSONDataSource | string |
使用此 JSON 数据创建文档。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
创建文档 （同步） （V4）
创建新文档。 有关详细信息 https://short.mscrm-addons.com/createdocumentjob
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Template
|
Template | True | uuid |
为此 DocumentJob 选择模板。 |
|
行 ID
|
EntityId | True | uuid |
要为其运行此模板的记录的唯一标识符。 |
|
文件类型
|
FileType | True | string |
选择文件类型。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
保存到 SharePoint
|
SaveToSharepoint | boolean |
将文档保存到 SharePoint。 |
|
|
附加到电子邮件
|
AttachToEmailId | uuid |
要向其附加文档的电子邮件的唯一标识符。 |
|
|
Printer
|
DCPPrinterName | string |
选择打印机。 |
|
|
附加到 [行 ID]
|
AttachToEntityId | uuid |
要附加到此文档的记录的唯一标识符。 |
|
|
附加到 [表]
|
AttachToEntitySchemaName | string |
选择要将此文档附加到的表。 |
|
|
Name
|
Name | string |
提示的名称/ID。 |
|
|
价值
|
Value | string |
提示的值。 |
|
|
IsValid
|
IsValid | boolean | ||
|
JSON 数据源
|
JSONDataSource | string |
使用此 JSON 数据创建文档。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
发送电子邮件 [已弃用]
此作已弃用。 请改用发送电子邮件（V4）。
发送指定的电子邮件
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
DeactivateOnTimeout
|
DeactivateOnTimeout | boolean |
在超时时停用工作项，防止生成文档 |
|
|
EmailToSend
|
EmailToSend | True | string |
要发送电子邮件的 Guid |
|
用户
|
User | string | ||
|
发件人（userid）
|
Sender (userid) | uuid |
电子邮件发件人的 Guid |
|
|
发送方（架构名称）
|
Sender (Schemaname) | string |
发送方的架构名称，默认值为 systemuser |
|
|
关于 （ID）
|
Regarding (Id) | uuid |
要设置的实体的 Guid |
|
|
关于 （Schemaname）
|
Regarding (Schemaname) | string | ||
|
Id
|
Id | uuid | ||
|
Schemaname
|
Schemaname | string | ||
|
Id
|
Id | uuid | ||
|
Schemaname
|
Schemaname | string | ||
|
Id
|
Id | uuid | ||
|
Schemaname
|
Schemaname | string |
返回
发送电子邮件 （V2） [已弃用]
此作已弃用。 请改用发送电子邮件（V4）。
发送指定的电子邮件
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | True | integer |
为作选择环境 |
|
EmailToSend
|
EmailToSend | True | string |
要发送电子邮件的 Guid |
|
用户
|
User | string | ||
|
发件人（userid）
|
SenderId | uuid |
电子邮件发件人的 Guid |
|
|
发送方（架构名称）
|
SenderLogicalName | string |
发送方的架构名称，默认值为 systemuser |
|
|
关于 （ID）
|
RegardingObjectId | uuid |
要设置的实体的 Guid |
|
|
关于 （Schemaname）
|
RegardingObjectLogicalName | string | ||
|
Id
|
Id | uuid | ||
|
Schemaname
|
Schemaname | string | ||
|
Id
|
Id | uuid | ||
|
Schemaname
|
Schemaname | string | ||
|
Id
|
Id | uuid | ||
|
Schemaname
|
Schemaname | string |
返回
发送电子邮件 （V3） [已弃用]
此作已弃用。 请改用发送电子邮件（V4）。
发送 Dataverse 电子邮件。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
要发送电子邮件
|
EmailToSend | True | string |
要发送电子邮件的唯一标识符。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
发件人（行 ID）
|
SenderId | uuid |
电子邮件发件人的唯一标识符。 |
|
|
发件人（表名称）
|
SenderLogicalName | string |
发件人的表名，默认值为 systemuser。 |
|
|
关于 （行 ID）
|
RegardingObjectId | uuid |
要设置的表的唯一标识符。 |
|
|
关于 （表名）
|
RegardingObjectLogicalName | string |
要设置的表名。 |
|
|
行 ID
|
Id | uuid | ||
|
表名称
|
Schemaname | string | ||
|
行 ID
|
Id | uuid | ||
|
表名称
|
Schemaname | string | ||
|
行 ID
|
Id | uuid | ||
|
表名称
|
Schemaname | string | ||
|
环境
|
Environment | string |
选择此作的环境。 |
返回
发送电子邮件（V4）
发送 Dataverse 电子邮件。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
要发送电子邮件
|
EmailToSend | True | string |
要发送电子邮件的唯一标识符。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
发件人（行 ID）
|
SenderId | uuid |
电子邮件发件人的唯一标识符。 |
|
|
发件人（表名称）
|
SenderLogicalName | string |
发件人的表名，默认值为 systemuser。 |
|
|
关于 （行 ID）
|
RegardingObjectId | uuid |
要设置的表的唯一标识符。 |
|
|
关于 （表名）
|
RegardingObjectLogicalName | string |
要设置的表名。 |
|
|
行 ID
|
Id | uuid | ||
|
表名称
|
Schemaname | string | ||
|
行 ID
|
Id | uuid | ||
|
表名称
|
Schemaname | string | ||
|
行 ID
|
Id | uuid | ||
|
表名称
|
Schemaname | string | ||
|
环境
|
Environment | string |
选择此作的环境。 |
返回
在客户旅程中处理批处理 （同步） （V4）
创建新文档。 有关详细信息 https://short.mscrm-addons.com/createdocumentjob
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
[表]
|
EntitySchemaName | True | string |
选择要为其运行此文档的表。 |
|
行 ID
|
EntityId | True | uuid |
要为其运行此模板的记录的唯一标识符。 |
|
Template
|
Template | True | uuid |
为此 DocumentJob 选择模板。 |
|
旅程
|
Journey | True | uuid |
选择此 DocumentJob 的客户旅程。 |
|
文件类型
|
FileType | True | string |
选择文件类型。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
保存到 SharePoint
|
SaveToSharepoint | boolean |
将文档保存到 SharePoint。 |
|
|
BatchDelay
|
BatchDelay | integer |
文档进程之间的间隔（以小时为单位）。 |
|
|
批量大小
|
BatchSize | integer |
触发文档处理所需的项数。 |
|
|
排序列
|
SortField | string |
为文档中的记录指定排序值。 |
|
|
排序方向
|
SortDirection | integer |
对列顺序进行排序。 |
|
|
保存位置
|
SaveLocationUri | string |
设置自定义保存位置（Blob 或 Sharepoint）。 |
|
|
Printer
|
DCPPrinterName | string |
选择打印机。 |
|
|
打印副本
|
PrintCopies | integer |
文档副本数。 |
|
|
附加到 [行 ID]
|
AttachToEntityId | uuid |
要附加到此文档的记录的唯一标识符。 |
|
|
附加到 [表]
|
AttachToEntitySchemaName | string |
选择要将此文档附加到的表。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
在客户旅程中处理批处理 （异步） （V4）
创建新文档。 有关详细信息 https://short.mscrm-addons.com/createdocumentjob
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
[表]
|
EntitySchemaName | True | string |
选择要为其运行此文档的表。 |
|
行 ID
|
EntityId | True | uuid |
要为其运行此模板的记录的唯一标识符。 |
|
Template
|
Template | True | uuid |
为此 DocumentJob 选择模板。 |
|
旅程
|
Journey | True | uuid |
选择此 DocumentJob 的客户旅程。 |
|
文件类型
|
FileType | True | string |
选择文件类型。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
保存到 SharePoint
|
SaveToSharepoint | boolean |
将文档保存到 SharePoint。 |
|
|
BatchDelay
|
BatchDelay | integer |
文档进程之间的间隔（以小时为单位）。 |
|
|
批量大小
|
BatchSize | integer |
触发文档处理所需的项数。 |
|
|
排序列
|
SortField | string |
为文档中的记录指定排序值。 |
|
|
排序方向
|
SortDirection | integer |
对列顺序进行排序。 |
|
|
保存位置
|
SaveLocationUri | string |
设置自定义保存位置（Blob 或 Sharepoint）。 |
|
|
Printer
|
DCPPrinterName | string |
选择打印机。 |
|
|
打印副本
|
PrintCopies | integer |
文档副本数。 |
|
|
附加到 [行 ID]
|
AttachToEntityId | uuid |
要附加到此文档的记录的唯一标识符。 |
|
|
附加到 [表]
|
AttachToEntitySchemaName | string |
选择要将此文档附加到的表。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
基于 XML 创建 DocumentJob [已弃用]
此作已弃用。 请改用“创建多部分”文档（async）（V4）。
此函数创建新的 DocumentJob。 注意力！ 函数不会等待结果
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
DeactivateOnTimeout
|
DeactivateOnTimeout | boolean |
在超时时停用工作项，防止生成文档 |
|
|
超时
|
TimeOut | integer |
文档创建超时 |
|
|
MultiPartXml
|
MultiPartXml | True | string |
DocumentJob 的多部分 XML 文档 |
|
用户
|
User | string |
返回
基于 XML 创建 DocumentJob （同步） [已弃用]
此作已弃用。 请改用 “创建多部分”文档（同步）（V4 ）。
此函数创建新的 DocumentJob 并等待结果最多 [TimeOut] 秒
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
DeactivateOnTimeout
|
DeactivateOnTimeout | boolean |
在超时时停用工作项，防止生成文档 |
|
|
超时
|
TimeOut | integer |
文档创建超时 |
|
|
MultiPartXml
|
MultiPartXml | True | string |
DocumentJob 的多部分 XML 文档 |
|
用户
|
User | string |
返回
- Body
- DocumentJobResponse
基于 XML （async） （V2） 创建 DocumentJob [已弃用]
此作已弃用。 请改用“创建多部分”文档（async）（V4）。
此函数创建新的 DocumentJob。 注意力！ 函数不会等待结果
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | True | integer |
为作选择环境 |
|
MultiPartXml
|
MultiPartXml | True | string |
DocumentJob 的多部分 XML 文档 |
|
用户
|
User | string |
返回
基于 XML（同步）（V2）创建文档 [已弃用]
此作已弃用。 请改用 “创建多部分”文档（同步）（V4 ）。
此函数创建新的 DocumentJob 并等待结果
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | True | integer |
为作选择环境 |
|
MultiPartXml
|
MultiPartXml | True | string |
DocumentJob 的多部分 XML 文档 |
|
用户
|
User | string |
返回
基于 XML（同步）（V2）对 DocumentJob 进行签名 [已弃用]
此作已弃用。 请改用 Sign DocumentJob （sync） （V4）。
此函数对 DocumentJob 进行数字签名并等待结果
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | True | integer |
为作选择环境 |
|
实体ID
|
EntityId | True | string |
要附加到 eSign 记录的实体 Guid |
|
Schemaname
|
Schemaname | True | string |
要附加到 eSign 记录的实体的 Schemaname |
|
DocumentJob
|
DocumentJob | True | uuid |
包含要签名的文档的 DocumentJobId |
|
用户
|
User | string | ||
|
签名提供程序
|
SignProvider | True | integer |
应用于对此文档进行签名的提供程序 |
|
电子邮件默认主题
|
Subject | string |
签名请求电子邮件中的默认主题 |
|
|
电子邮件默认邮件
|
Message | string |
签名请求电子邮件中的默认消息 |
|
|
Name
|
Name | True | string |
签名人的显示名称。 |
|
Email
|
True | string |
Signee 的电子邮件地址。 |
|
|
InPerson
|
InPerson | True | boolean |
生成用于启动签名过程的链接。 |
|
Subject
|
Subject | string |
签名请求电子邮件中的个性化主题。 |
|
|
Message
|
Message | string |
签名请求电子邮件中的个性化消息。 |
|
|
电话编号
|
TelNr | string |
仅签署短信身份验证的电话号码（仅限 DocuSign）。 |
|
|
DocuSign 主机名
|
HostName | string |
仅对 inPerson 签名的主机名称进行签名（仅限 DocuSign）。 |
|
|
Hostemail
|
Hostemail | string |
签名主机 emailaddress for inPerson 签名（仅限 DocuSign）。 |
返回
将 DocumentJob 附加为注释 （V2） [已弃用]
此作已弃用。 请改用 Attach DocumentJob 作为注释（V4）。
将 DocumentJob 生成的文档内容作为备注附加到 Dynamics 365 实体。 注意力！ documentjob 必须已完成
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | True | integer |
为作选择环境 |
|
DocumentJobId
|
DocumentJobId | True | string |
要附加到笔记的生成的文档的 DocumentJob ID |
|
用户
|
User | string | ||
|
Schemaname
|
Schemaname | True | string | |
|
说明
|
Description | string |
将此文本设置为备注说明 |
|
|
注意主题
|
Subject | string |
将此文本设置为备注主题 |
|
|
实体 ID
|
EntityId | True | string |
要将笔记附加到的实体的 Guid |
返回
将 DocumentJob 附加为注释 （V3） [已弃用]
此作已弃用。 请改用 Attach DocumentJob 作为注释（V4）。
将 DocumentJob 生成的文档作为备注附加到 Dynamics 365 记录。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
DocumentJob ID
|
DocumentJobId | True | string |
要附加到笔记的 DocumentJob 的唯一标识符。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
表名称
|
Schemaname | True | string |
选择要将备注附加到的表。 |
|
注释说明
|
Description | string |
备注的文本。 |
|
|
注意主题
|
Subject | string |
备注的主题。 |
|
|
行 ID
|
EntityId | True | string |
要向其附加笔记的记录的唯一标识符。 |
|
环境
|
Environment | string |
选择此作的环境。 |
返回
将 DocumentJob 附加为注释 （V4）
将 DocumentJob 生成的文档作为备注附加到 Dynamics 365 记录。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
DocumentJob ID
|
DocumentJobId | True | string |
要附加到笔记的 DocumentJob 的唯一标识符。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
表名称
|
Schemaname | True | string |
选择要将备注附加到的表。 |
|
注释说明
|
Description | string |
备注的文本。 |
|
|
注意主题
|
Subject | string |
备注的主题。 |
|
|
行 ID
|
EntityId | True | string |
要向其附加笔记的记录的唯一标识符。 |
|
环境
|
Environment | string |
选择此作的环境。 |
返回
将 DocumentJob 附加到电子邮件 [已弃用]
此作已弃用。 请改用“附加 DocumentJob”发送电子邮件（V4）。
将 DocumentJob 生成的文件作为附件附加到 Dynamics 365 电子邮件
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
DocumentJobId
|
DocumentJobId | True | string |
要附加到电子邮件的生成的文档的 DocumentJob ID |
|
DeactivateOnTimeout
|
DeactivateOnTimeout | boolean |
在超时时停用工作项，防止生成文档 |
|
|
UserId
|
UserId | string | ||
|
EmailId
|
EmailId | True | string |
文档应附加到的电子邮件 |
返回
将 DocumentJob 附加到电子邮件 （V2） [已弃用]
此作已弃用。 请改用“附加 DocumentJob”发送电子邮件（V4）。
将 DocumentJob 生成的文档内容作为附件附加到 Dynamics 365 电子邮件
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | True | integer |
为作选择环境 |
|
DocumentJobId
|
DocumentJobId | True | string |
要附加到电子邮件的生成的文档的 DocumentJob ID |
|
用户
|
User | string | ||
|
EmailId
|
EmailId | True | string |
文档应附加到的电子邮件 |
返回
将 DocumentJob 附加到电子邮件 （V3） [已弃用]
此作已弃用。 请改用“附加 DocumentJob”发送电子邮件（V4）。
将 DocumentJob 生成的文档内容作为附件附加到 Dynamics 365 电子邮件。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
DocumentJob ID
|
DocumentJobId | True | string |
要附加到电子邮件的 DocumentJob 的唯一标识符。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
|
|
电子邮件 ID
|
EmailId | True | string |
文档应附加到的电子邮件的唯一标识符。 |
返回
将 DocumentJob 附加到电子邮件（V4）
将 DocumentJob 生成的文档内容作为附件附加到 Dynamics 365 电子邮件。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
DocumentJob ID
|
DocumentJobId | True | string |
要附加到电子邮件的 DocumentJob 的唯一标识符。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
|
|
电子邮件 ID
|
EmailId | True | string |
文档应附加到的电子邮件的唯一标识符。 |
返回
将文件附加到电子邮件 [已弃用]
此作已弃用。 请改用“附加到电子邮件”文件（V4）。
将 base64 编码的文件作为附件附加到 Dynamics 365 电子邮件
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
文档（base64）
|
Document (base64) | True | string |
表示文件内容的 base64 编码字符串 |
|
Filename
|
Filename | True | string |
用于存储文件的文件名 |
|
Mime-Type
|
Mime-Type | string |
用于处理文件的内容 mime 类型（例如应用程序/文本） |
|
|
DeactivateOnTimeout
|
DeactivateOnTimeout | boolean |
在超时时停用工作项，防止生成文档 |
|
|
UserId
|
UserId | string | ||
|
EmailId
|
EmailId | True | string |
文档应附加到的电子邮件 |
返回
将文件附加到电子邮件 （V2） [已弃用]
此作已弃用。 请改用“附加到电子邮件”文件（V4）。
将文档内容或 base64 编码文件作为附件附加到 Dynamics 365 电子邮件
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | True | integer |
为作选择环境 |
|
文档内容
|
base64 | True | byte |
表示文件内容的内容对象或 base64 编码字符串 |
|
Filename
|
Filename | True | string |
用于存储文件的文件名 |
|
Mime-Type
|
MimeType | string |
用于处理文件的内容 mime 类型（例如应用程序/文本） |
|
|
用户
|
User | string | ||
|
EmailId
|
EmailId | True | string |
文档应附加到的电子邮件 |
返回
将文件附加到电子邮件 （V3） [已弃用]
此作已弃用。 请改用“附加到电子邮件”文件（V4）。
将文档内容或 base64 编码的文件作为附件附加到 Dynamics 365 电子邮件。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
文档内容
|
base64 | True | byte |
表示文件内容的内容对象或 base64 编码字符串。 |
|
文件名
|
Filename | True | string |
附件的文件名。 |
|
MIME 类型
|
MimeType | string |
附件的 MIME 类型（例如应用程序/pdf）。 |
|
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
|
|
电子邮件 ID
|
EmailId | True | string |
文档应附加到的电子邮件的唯一标识符。 |
返回
将文件附加到电子邮件（V4）
将文档内容或 base64 编码的文件作为附件附加到 Dynamics 365 电子邮件。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
文档内容
|
base64 | True | byte |
表示文件内容的内容对象或 base64 编码字符串。 |
|
文件名
|
Filename | True | string |
附件的文件名。 |
|
MIME 类型
|
MimeType | string |
附件的 MIME 类型（例如应用程序/pdf）。 |
|
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
|
|
电子邮件 ID
|
EmailId | True | string |
文档应附加到的电子邮件的唯一标识符。 |
返回
打印 DocumentJob （V2） [已弃用]
此作已弃用。 请改用 Print DocumentJob （V4）。
打印 DocumentJob 生成的文档内容。 注意力！ documentjob 必须已完成
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | True | integer |
指定要用于 perUser APIKey 的连接 |
|
DocumentJobId
|
DocumentJobId | True | uuid |
要打印的 DocumentJob ID 的 Guid |
|
DCPPrinterName
|
DCPPrinterName | True | string |
要使用的打印机的 DCP Printername |
返回
打印 DocumentJob （V3） [已弃用]
此作已弃用。 请改用 Print DocumentJob （V4）。
打印 DocumentJob 生成的文档。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
DocumentJob ID
|
DocumentJobId | True | uuid |
要打印的 DocumentJob 的唯一标识符。 |
|
Printer
|
DCPPrinterName | True | string |
选择打印机。 |
|
环境
|
Environment | string |
选择环境。 |
返回
打印 DocumentJob （V4）
打印 DocumentJob 生成的文档。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
DocumentJob ID
|
DocumentJobId | True | uuid |
要打印的 DocumentJob 的唯一标识符。 |
|
Printer
|
DCPPrinterName | True | string |
选择打印机。 |
|
打印副本
|
Copies | integer |
文档副本数。 |
|
|
环境
|
Environment | string |
选择环境。 |
返回
打印文件 [已弃用]
此作已弃用。 请改用打印文件（V4）。
打印 base64 编码的文件。 支持的文件格式为 PDF 和 DOCX
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
DeactivateOnTimeout
|
DeactivateOnTimeout | boolean |
在超时时停用工作项，防止生成文档 |
|
|
文档（base64）
|
Document (base64) | True | string |
表示文件内容的 base64 编码字符串 |
|
Filename
|
Filename | True | string |
用于存储文件的文件名 |
|
Printer
|
DCPPrinterName | True | string |
返回
打印文件 （V2） [已弃用]
此作已弃用。 请改用打印文件（V4）。
打印文档内容或 base64 编码文件。 支持的文件格式为 PDF 和 DOCX
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | True | integer |
为作选择环境 |
|
文档内容
|
base64 | True | byte |
表示文件内容的内容对象或 base64 编码字符串 |
|
Filename
|
Filename | True | string |
用于存储文件的文件名 |
|
Printer
|
DCPPrinterName | True | string |
返回
打印文件 （V3） [已弃用]
此作已弃用。 请改用打印文件（V4）。
打印文档内容或 base64 编码文件。 支持的文件类型：pdf、docx。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
文档内容
|
base64 | True | byte |
表示文件内容的内容对象或 base64 编码字符串。 |
|
文件名
|
Filename | True | string |
选择文件名。 |
|
Printer
|
DCPPrinterName | True | string |
选择打印机。 |
|
环境
|
Environment | string |
选择此作的环境。 |
返回
打印文件 （V4）
打印文档内容或 base64 编码文件。 支持的文件类型：pdf、docx。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
文档内容
|
base64 | True | byte |
表示文件内容的内容对象或 base64 编码字符串。 |
|
文件名
|
Filename | True | string |
选择文件名。 |
|
Printer
|
DCPPrinterName | True | string |
选择打印机。 |
|
打印副本
|
PrintCopies | integer |
文档副本数。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
按说明附加 DocumentJob [已弃用]
此作已弃用。 请改用 Attach DocumentJob 作为注释（V4）。
将 DocumentJob 生成的文件作为备注附加到 Dynamics 365 实体。 注意力！ documentjob 必须已完成
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
DocumentJobId
|
DocumentJobId | True | string |
要附加到笔记的生成的文档的 DocumentJob ID |
|
DeactivateOnTimeout
|
DeactivateOnTimeout | boolean |
在超时时停用工作项，防止生成文档 |
|
|
UserId
|
UserId | string | ||
|
Schemaname
|
Schemaname | True | string |
要向其附加注释的实体的架构名称 |
|
Description
|
Note description | string |
将此文本设置为备注说明 |
|
|
Subject
|
Note subject | string |
将此文本设置为备注主题 |
|
|
关于 ObjectId
|
Entity Id | True | string |
要将笔记附加到的实体的 Guid |
返回
按说明附加文件 [已弃用]
此作已弃用。 请改用附加文件（V4）。
将作为 base64 字符串提供的文件作为备注附加到 Dynamics 365 实体。 注意力！ documentjob 必须已完成
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
文档（base64）
|
Document (base64) | True | string |
表示文件内容的 base64 编码字符串 |
|
Filename
|
Filename | True | string |
用于存储文件的文件名 |
|
Mime-Type
|
Mime-Type | string |
用于处理文件的内容 mime 类型（例如应用程序/文本） |
|
|
DeactivateOnTimeout
|
DeactivateOnTimeout | boolean |
在超时时停用工作项，防止生成文档 |
|
|
UserId
|
UserId | string | ||
|
Schemaname
|
Schemaname | True | string |
要向其附加注释的实体的架构名称 |
|
Description
|
Note description | string |
将此文本设置为备注说明 |
|
|
Subject
|
Note subject | string |
将此文本设置为备注主题 |
|
|
关于 ObjectId
|
Entity Id | True | string |
要将笔记附加到的实体的 Guid |
返回
按说明附加文件 （V4）
将文档内容或 base64 编码文件作为备注附加到 Dynamics 365 记录。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
文档内容
|
base64 | True | byte |
表示文件内容的内容对象或 base64 编码字符串。 |
|
文件名
|
Filename | True | string |
备注附件的文件名。 |
|
MIME 类型
|
MimeType | string |
用于处理文件的内容 MIME 类型（例如应用程序/pdf）。 |
|
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
表名称
|
Schemaname | True | string |
选择要将备注附加到的表。 |
|
注释说明
|
Description | string |
备注的文本。 |
|
|
注意主题
|
Subject | string |
备注的主题。 |
|
|
行 ID
|
EntityId | True | string |
要向其附加笔记的记录的唯一标识符。 |
|
环境
|
Environment | string |
选择此作的环境。 |
返回
检查 API 可用性 [已弃用]
签名 DocumentJob （sync） （V3） [已弃用]
此作已弃用。 请改用 Sign DocumentJob （sync） （V4）。
发送用于电子签名的文档。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
行 ID
|
EntityId | True | string |
eSign 记录将附加到的记录的唯一标识符。 |
|
表名称
|
Schemaname | True | string |
eSign 记录将附加到的记录的表名。 |
|
DocumentJob ID
|
DocumentJob | True | uuid |
要签名的 DocumentJob 的唯一标识符。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
签名提供程序
|
SignProvider | True | integer |
选择电子签名提供程序。 |
|
电子邮件默认主题
|
Subject | string |
签名请求电子邮件中的默认主题。 |
|
|
电子邮件默认邮件
|
Message | string |
签名请求电子邮件中的默认消息。 |
|
|
Name
|
Name | True | string |
签名人的显示名称。 |
|
Email
|
True | string |
Signee 的电子邮件地址。 |
|
|
InPerson
|
InPerson | True | boolean |
生成用于启动签名过程的链接。 |
|
Subject
|
Subject | string |
签名请求电子邮件中的个性化主题。 |
|
|
Message
|
Message | string |
签名请求电子邮件中的个性化消息。 |
|
|
电话编号
|
TelNr | string |
仅签署短信身份验证的电话号码（仅限 DocuSign）。 |
|
|
DocuSign 主机名
|
HostName | string |
仅对 inPerson 签名的主机名称进行签名（仅限 DocuSign）。 |
|
|
Hostemail
|
Hostemail | string |
签名主机 emailaddress for inPerson 签名（仅限 DocuSign）。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
签名 DocumentJob （同步） （V4）
发送用于电子签名的文档。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
行 ID
|
EntityId | True | string |
eSign 记录将附加到的记录的唯一标识符。 |
|
表名称
|
Schemaname | True | string |
eSign 记录将附加到的记录的表名。 |
|
DocumentJob ID
|
DocumentJob | True | uuid |
要签名的 DocumentJob 的唯一标识符。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
签名提供程序
|
SignProvider | True | integer |
选择电子签名提供程序。 |
|
电子邮件默认主题
|
Subject | string |
签名请求电子邮件中的默认主题。 |
|
|
电子邮件默认邮件
|
Message | string |
签名请求电子邮件中的默认消息。 |
|
|
Name
|
Name | True | string |
签名人的显示名称。 |
|
Email
|
True | string |
Signee 的电子邮件地址。 |
|
|
InPerson
|
InPerson | True | boolean |
生成用于启动签名过程的链接。 |
|
Subject
|
Subject | string |
签名请求电子邮件中的个性化主题。 |
|
|
Message
|
Message | string |
签名请求电子邮件中的个性化消息。 |
|
|
电话编号
|
TelNr | string |
仅签署短信身份验证的电话号码（仅限 DocuSign）。 |
|
|
DocuSign 主机名
|
HostName | string |
仅对 inPerson 签名的主机名称进行签名（仅限 DocuSign）。 |
|
|
Hostemail
|
Hostemail | string |
签名主机 emailaddress for inPerson 签名（仅限 DocuSign）。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
获取 DCP 打印机 [已弃用]
此作已弃用。 请改用 “获取打印机 ”。
检索可用打印机名称，（可选）按用户进行筛选
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
envId
|
envId | True | integer |
指定环境 |
|
用户
|
User | string |
可选，提供 Dynamics 365 用户域名或 ID |
返回
- response
- array of JSONPrinterResponse
获取 DocumentJob 状态 [已弃用]
此作已弃用。 请改用 Get DocumentJob 状态（V4）。
检索 DocumentJob 的状态。 Dynamics 365 状态/状态代码规则适用
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
DocumentJobId
|
DocumentJobId | True | uuid |
要检索其状态的 DocumentJob 的唯一标识符 |
|
DeactivateOnTimeout
|
DeactivateOnTimeout | boolean |
在超时时停用工作项，防止生成文档 |
返回
获取 DocumentJob 状态 （V2） [已弃用]
此作已弃用。 请改用 Get DocumentJob 状态（V4）。
检索 DocumentJob 的状态。 Dynamics 365 状态/状态代码规则适用
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | True | integer |
指定要用于 perUser APIKey 的连接 |
|
DocumentJobId
|
DocumentJobId | True | uuid |
要检索其状态的 DocumentJob ID 的 Guid |
返回
获取 DocumentJob 状态 （V3） [已弃用]
此作已弃用。 请改用 Get DocumentJob 状态（V4）。
检索 DocumentJob 的状态。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
DocumentJob ID
|
DocumentJobId | True | uuid |
要检索其状态的 DocumentJob 的唯一标识符。 |
|
环境
|
Environment | string |
选择此作的环境。 |
返回
获取 DocumentJob 状态 （V4）
检索 DocumentJob 的状态。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
DocumentJob ID
|
DocumentJobId | True | uuid |
要检索其状态的 DocumentJob 的唯一标识符。 |
|
环境
|
Environment | string |
选择此作的环境。 |
返回
获取 DocumentJob 结果 [已弃用]
此作已弃用。 请改用 Get DocumentJob 结果（V4）。
检索 DocumentJobs 状态信息。 如果作业已完成，则结果将包含结果文档
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
DocumentJobId
|
DocumentJobId | True | uuid |
要检索其结果的 DocumentJob 的唯一标识符 |
|
DeactivateOnTimeout
|
DeactivateOnTimeout | boolean |
在超时时停用工作项，防止生成文档 |
返回
- Body
- DocumentJobResponse
获取 DocumentJob 结果 （V2） [已弃用]
此作已弃用。 请改用 Get DocumentJob 结果（V4）。
检索 DocumentJobs 状态信息。 如果作业已完成，则结果将包含结果文档
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | True | integer |
指定要用于 perUser APIKey 的连接 |
|
DocumentJobId
|
DocumentJobId | True | uuid |
用于检索结果的 DocumentJob ID 的 Guid |
返回
获取 DocumentJob 结果 （V3） [已弃用]
此作已弃用。 请改用 Get DocumentJob 结果（V4）。
检索 DocumentJob 的状态信息。 结果将包含生成的文档。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
DocumentJob ID
|
DocumentJobId | True | uuid |
DocumentJob 的唯一标识符。 |
|
环境
|
Environment | string |
选择此作的环境。 |
返回
获取 DocumentJob 结果 （V4）
检索 DocumentJob 的状态信息。 结果将包含生成的文档。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
DocumentJob ID
|
DocumentJobId | True | uuid |
DocumentJob 的唯一标识符。 |
|
环境
|
Environment | string |
选择此作的环境。 |
返回
获取 One-Click-Actions [已弃用]
此作已弃用。 请改用 “获取一键式作 ”。
检索 Dynamics 365 中配置的所有 One-Click-Actions。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
- response
- array of JSONOneClickAction
获取 OneClickActions [已弃用]
此作已弃用。 请改用 “获取一键式作 ”。
此函数返回 Dynamics 365 中的所有 OneClickActions
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
envId
|
envId | True | integer |
指定环境 |
返回
- response
- array of JSONOneClickAction
获取 SignProviders [已弃用]
此函数返回 AutomergeSolution 中已知的所有 SignProviders
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
envId
|
envId | True | integer |
指定环境 |
返回
- response
- array of JSONSignProvider
获取 User APIKey 的配置文件
获取 UserAPIKey 的配置文件 [已弃用]
此作已弃用。 请改 用 User APIKey 的“获取配置文件 ”。
此函数返回 Dynamics 365 中的所有配置文件 ID
返回
- response
- array of JSONEnvironment
获取一Click-Actions
检索 Dynamics 365 中配置的所有 One-Click-Actions。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
- response
- array of JSONOneClickAction
获取打印机
检索可用的打印机。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | string |
选择此作的环境。 |
|
|
用户
|
User | string |
（可选）仅列出此用户可访问的打印机。 |
返回
- response
- array of JSONPrinterResponse
获取打印机 [已弃用]
此作已弃用。 请改用 “获取打印机 ”。
检索可用的打印机。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | string |
选择此作的环境。 |
|
|
用户
|
User | string |
（可选）仅列出此用户可访问的打印机。 |
返回
- response
- array of JSONPrinterResponse
获取文档模板
检索可用 DocumentsCorePack 模板的列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
表名称
|
EntityName | string |
按实体（etc 或 etn）进行筛选。 可选通配符 [etn] |
|
|
模板筛选器
|
TemplateNameFilter | string |
按模板名称进行筛选。 可选通配符 [name] |
|
|
组筛选器
|
GroupFilter | string |
按组名称进行筛选。 可选通配符 [name] |
|
|
用户
|
UserId | string |
仅检索可供此用户访问的模板 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
- response
- array of JSONDCPTemplate
获取文档模板 [已弃用]
此作已弃用。 请改用 “获取文档模板 ”。
检索可用 DocumentsCorePack 模板的列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
表名称
|
EntityName | string |
按实体（etc 或 etn）进行筛选。 可选通配符 [etn] |
|
|
模板筛选器
|
TemplateNameFilter | string |
按模板名称进行筛选。 可选通配符 [name] |
|
|
组筛选器
|
GroupFilter | string |
按组名称进行筛选。 可选通配符 [name] |
|
|
用户
|
UserId | string |
仅检索可供此用户访问的模板 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
- response
- array of JSONDCPTemplate
获取模板 [已弃用]
此作已弃用。 请改用 “获取文档模板 ”。
此函数返回可用 DocumentsCorePack 模板的列表
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
实体名称
|
EntityName | string |
按实体（etc 或 etn）进行筛选。 可选通配符 [etn] |
|
|
TemplateNameFilter
|
TemplateNameFilter | string |
按模板名称进行筛选。 可选通配符 [name] |
|
|
GroupFilter
|
GroupFilter | string |
按组名称进行筛选。 可选通配符 [name] |
|
|
UserId
|
UserId | string |
仅检索可供此用户访问的模板 |
|
|
envId
|
envId | integer |
指定环境 |
返回
- response
- array of JSONDCPTemplate
获取此 ApiKey 的默认环境
获取此 ApiKey 的默认环境 [已弃用]
获取用户 APIKey 的配置文件 [已弃用]
获取电子签名提供程序 [已弃用]
检索 DocumentsCorePack 中提供的所有电子签名提供程序。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
- response
- array of JSONSignProvider
获取电子签名提供程序 [已弃用]
检索 DocumentsCorePack 中提供的所有电子签名提供程序。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | string |
选择此作的环境。 |
返回
- response
- array of JSONSignProvider
获取连接详细信息 [已弃用]
运行 OneClickAction （async） （V2） [已弃用]
此作已弃用。 请改用“运行一Click-Action（异步）（V4）。
此函数运行 OneClickAction。 注意力！ 函数不会等待结果
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | True | integer |
指定要用于 perUser APIKey 的连接 |
|
实体ID
|
EntityId | True | uuid |
Dynamics 365 源记录 ID |
|
OneClickAction
|
OneClickAction | True | uuid |
要应用的 OneClickAction 的 ID |
|
用户
|
User | string |
仅检索可供此用户访问的模板 |
返回
运行 OneClickAction （sync） （V2） [已弃用]
此作已弃用。 请改用“运行一Click-Action（同步）（V4）。
此函数运行 OneClickAction 并等待结果
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | True | integer |
指定要用于 perUser APIKey 的连接 |
|
实体ID
|
EntityId | True | uuid |
Dynamics 365 源记录 ID |
|
OneClickAction
|
OneClickAction | True | uuid |
要应用的 OneClickAction 的 ID |
|
用户
|
User | string |
仅检索可供此用户访问的模板 |
返回
运行一Click-Action（同步）（V3） [已弃用]
此作已弃用。 请改用“运行一Click-Action（同步）（V4）。
运行一Click-Action 并等待结果。 有关详细信息 https://short.mscrm-addons.com/oca
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
行 ID
|
EntityId | True | uuid |
要为其运行 One-Click-Action 的记录的唯一标识符 |
|
一Click-Action ID
|
OneClickAction | True | uuid |
要应用的 One-Click-Action 的唯一标识符。 |
|
环境
|
Environment | string |
选择此作的环境。 |
|
|
用户
|
User | string |
仅检索可供此用户访问的一Click-Actions。 |
返回
运行一Click-Action（同步）（V4）
运行一Click-Action 并等待结果。 有关详细信息 https://short.mscrm-addons.com/oca
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
行 ID
|
EntityId | True | uuid |
要为其运行 One-Click-Action 的记录的唯一标识符 |
|
一Click-Action ID
|
OneClickAction | True | uuid |
要应用的 One-Click-Action 的唯一标识符。 |
|
环境
|
Environment | string |
选择此作的环境。 |
|
|
用户
|
User | string |
仅检索可供此用户访问的一Click-Actions。 |
返回
运行一Click-Action（异步）（V3） [已弃用]
此作已弃用。 请改用“运行一Click-Action（异步）（V4）。
运行一键式作。 该作不会等待结果。 有关详细信息 https://short.mscrm-addons.com/oca
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
行 ID
|
EntityId | True | uuid |
要为其运行 One-Click-Action 的记录的唯一标识符 |
|
一Click-Action ID
|
OneClickAction | True | uuid |
要应用的 One-Click-Action 的唯一标识符。 |
|
环境
|
Environment | string |
选择此作的环境。 |
|
|
用户
|
User | string |
仅检索可供此用户访问的一Click-Actions。 |
返回
运行一Click-Action（异步）（V4）
运行一键式作。 该作不会等待结果。 有关详细信息 https://short.mscrm-addons.com/oca
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
行 ID
|
EntityId | True | uuid |
要为其运行 One-Click-Action 的记录的唯一标识符 |
|
一Click-Action ID
|
OneClickAction | True | uuid |
要应用的 One-Click-Action 的唯一标识符。 |
|
环境
|
Environment | string |
选择此作的环境。 |
|
|
用户
|
User | string |
仅检索可供此用户访问的一Click-Actions。 |
返回
连接两个 DocumentJobs [已弃用]
此作已弃用。 请改用连接两个 DocumentJobs （V4）。
连接两个 DocumentJobs 生成的两个文件（pdf，docx）
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
First DocumentJob
|
First DocumentJob | True | uuid |
ConcatenationJob 的第一个 DocumentJobId |
|
Second DocumentJob
|
Second DocumentJob | True | uuid |
ConcatenationJob 的第二个 DocumentJobId |
|
DeactivateOnTimeout
|
DeactivateOnTimeout | boolean |
在超时时停用工作项，防止生成文档 |
|
|
UserId
|
UserId | string | ||
|
CombineType
|
CombineType | True | integer |
选择如何组合文件 |
|
OutputFileType
|
OutputFileType | True | integer |
为分界结果选择文件类型 |
返回
- Body
- DocumentJobResponse
连接两个 DocumentJobs （V2） [已弃用]
此作已弃用。 请改用连接两个 DocumentJobs （V4）。
连接两个 DocumentJobs 生成的两个文档内容（pdf，docx）
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | True | integer |
为作选择环境 |
|
First DocumentJob
|
DocumentJob1 | True | uuid |
ConcatenationJob 的第一个 DocumentJobId |
|
Second DocumentJob
|
DocumentJob2 | True | uuid |
ConcatenationJob 的第二个 DocumentJobId |
|
用户
|
User | string | ||
|
CombineType
|
CombineType | True | integer |
选择如何组合文件 |
|
OutputFileType
|
OutputFileType | True | integer |
为分界结果选择文件类型 |
返回
连接两个 DocumentJobs （V3） [已弃用]
此作已弃用。 请改用连接两个 DocumentJobs （V4）。
连接两个 DocumentJobs。 支持的文件类型：pdf、docx。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
First DocumentJob ID
|
DocumentJob1 | True | uuid |
第一个 DocumentJob 的唯一标识符。 |
|
Second DocumentJob ID
|
DocumentJob2 | True | uuid |
第二个 DocumentJob 的唯一标识符。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
|
|
CombineType
|
CombineType | True | integer |
选择组合类型。 |
|
输出文件类型
|
OutputFileType | True | integer |
为结果选择文件类型。 |
返回
连接两个 DocumentJobs （V4）
连接两个 DocumentJobs。 支持的文件类型：pdf、docx。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
First DocumentJob ID
|
DocumentJob1 | True | uuid |
第一个 DocumentJob 的唯一标识符。 |
|
Second DocumentJob ID
|
DocumentJob2 | True | uuid |
第二个 DocumentJob 的唯一标识符。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
|
|
CombineType
|
CombineType | True | integer |
选择组合类型。 |
|
输出文件类型
|
OutputFileType | True | integer |
为结果选择文件类型。 |
返回
连接两个文件 （pdf，docx） [已弃用]
此作已弃用。 请使用 连接两个文档。支持的文件类型：pdf、docx 。
连接两个提供的文件（pdf，docx）
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
第一个文件名
|
First Filename | True | string |
第一个文档的文件名 |
|
第一个 Mime-Type
|
First Mime-Type | True | string |
用于处理第一个文档的内容 mime 类型（例如应用程序/pdf） |
|
第一个文档 （base64）
|
First Document (base64) | True | string |
表示第一个文档内容的 base64 编码字符串 |
|
第二个文件名
|
Second Filename | True | string |
第二个文档的文件名 |
|
Second Mime-Type
|
Second Mime-Type | True | string |
用于处理第二个文档的内容 mime 类型（例如应用程序/pdf） |
|
第二个文档 （base64）
|
Second Document (base64) | True | string |
表示第二个文档内容的 base64 编码字符串 |
|
DeactivateOnTimeout
|
DeactivateOnTimeout | boolean |
在超时时停用工作项，防止生成文档 |
|
|
UserId
|
UserId | string | ||
|
CombineType
|
CombineType | True | integer |
选择如何组合文件 |
|
OutputFileType
|
OutputFileType | True | integer |
为分界结果选择文件类型 |
返回
- Body
- DocumentJobResponse
连接两个文档。 支持的文件类型：pdf、docx
连接两个文档内容或 base64 编码文件。 支持的文件类型：pdf、docx。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
第一个文件名
|
FileName_1 | True | string |
第一个文档的文件名。 |
|
第一个 Mime-Type
|
MimeType_1 | True | string |
第一个文档的 MIME 类型（例如 application/pdf）。 |
|
第一个文档内容
|
base64_1 | True | byte |
表示文件内容的内容对象或 base64 编码字符串。 |
|
第二个文件名
|
FileName_2 | True | string |
第二个文档的文件名。 |
|
Second Mime-Type
|
MimeType_2 | True | string |
第二个文档的 MIME 类型（例如 application/pdf）。 |
|
第二个文档内容
|
base64_2 | True | byte |
表示文件内容的内容对象或 base64 编码字符串。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
|
|
CombineType
|
CombineType | True | integer |
选择组合类型。 |
|
输出文件类型
|
OutputFileType | True | integer |
为结果选择文件类型。 |
返回
连接两个文档。 支持的文件类型：pdf、docx [已弃用]
此作已弃用。 请使用 连接两个文档。支持的文件类型：pdf、docx 。
连接两个文档内容或 base64 编码文件。 支持的文件类型：pdf、docx。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
第一个文件名
|
FileName_1 | True | string |
第一个文档的文件名。 |
|
第一个 Mime-Type
|
MimeType_1 | True | string |
第一个文档的 MIME 类型（例如 application/pdf）。 |
|
第一个文档内容
|
base64_1 | True | byte |
表示文件内容的内容对象或 base64 编码字符串。 |
|
第二个文件名
|
FileName_2 | True | string |
第二个文档的文件名。 |
|
Second Mime-Type
|
MimeType_2 | True | string |
第二个文档的 MIME 类型（例如 application/pdf）。 |
|
第二个文档内容
|
base64_2 | True | byte |
表示文件内容的内容对象或 base64 编码字符串。 |
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
环境
|
Environment | string |
选择此作的环境。 |
|
|
CombineType
|
CombineType | True | integer |
选择组合类型。 |
|
输出文件类型
|
OutputFileType | True | integer |
为结果选择文件类型。 |
返回
连接两个文档内容或 base64 编码文件 （pdf，docx） （V2） [已弃用]
此作已弃用。 请使用 连接两个文档。支持的文件类型：pdf、docx 。
连接两个文档内容或 base64 编码文件（pdf，docx）
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | True | integer |
为作选择环境 |
|
第一个文件名
|
FileName_1 | True | string |
第一个文档的文件名 |
|
第一个 Mime-Type
|
MimeType_1 | True | string |
用于处理第一个文档的内容 mime 类型（例如应用程序/pdf） |
|
第一个文档内容
|
base64_1 | True | byte |
表示文件内容的内容对象或 base64 编码字符串 |
|
第二个文件名
|
FileName_2 | True | string |
第二个文档的文件名 |
|
Second Mime-Type
|
MimeType_2 | True | string |
用于处理第二个文档的内容 mime 类型（例如应用程序/pdf） |
|
第二个文档内容
|
base64_2 | True | byte |
表示文件内容的内容对象或 base64 编码字符串 |
|
用户
|
User | string | ||
|
CombineType
|
CombineType | True | integer |
选择如何组合文件 |
|
OutputFileType
|
OutputFileType | True | integer |
为分界结果选择文件类型 |
返回
附加文件（V2） [已弃用]
此作已弃用。 请改用附加文件（V4）。
将文档内容或 base64 编码文件作为备注附加到 Dynamics 365 实体。 注意力！ documentjob 必须已完成
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
环境
|
Environment | True | integer |
为作选择环境 |
|
文档内容
|
base64 | True | byte |
表示文件内容的内容对象或 base64 编码字符串 |
|
Filename
|
Filename | True | string |
用于存储文件的文件名 |
|
Mime-Type
|
MimeType | string |
用于处理文件的内容 mime 类型（例如应用程序/文本） |
|
|
用户
|
User | string | ||
|
Schemaname
|
Schemaname | True | string | |
|
说明
|
Description | string |
将此文本设置为备注说明 |
|
|
注意主题
|
Subject | string |
将此文本设置为备注主题 |
|
|
实体 ID
|
EntityId | True | string |
要将笔记附加到的实体的 Guid |
返回
附加文件（V3） [已弃用]
此作已弃用。 请改用附加文件（V4）。
将文档内容或 base64 编码文件作为备注附加到 Dynamics 365 记录。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
文档内容
|
base64 | True | byte |
表示文件内容的内容对象或 base64 编码字符串。 |
|
文件名
|
Filename | True | string |
备注附件的文件名。 |
|
MIME 类型
|
MimeType | string |
用于处理文件的内容 MIME 类型（例如应用程序/pdf）。 |
|
|
用户
|
User | string |
选择要运行此作的用户。 |
|
|
表名称
|
Schemaname | True | string |
选择要将备注附加到的表。 |
|
注释说明
|
Description | string |
备注的文本。 |
|
|
注意主题
|
Subject | string |
备注的主题。 |
|
|
行 ID
|
EntityId | True | string |
要向其附加笔记的记录的唯一标识符。 |
|
环境
|
Environment | string |
选择此作的环境。 |
返回
定义
DocumentJobStatusResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
成功
|
Success | boolean | |
|
返回值
|
Return value | string | |
|
返回值 2
|
Return value 2 | string | |
|
DocumentJobId
|
DocumentJobId | string |
JSONCreateNoteResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
annotationid
|
annotationid | string | |
|
成功
|
Success | boolean | |
|
返回值
|
Return value | string | |
|
返回值 2
|
Return value 2 | string |
DocumentJobResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
文件名
|
File name | string | |
|
文件大小
|
File size | integer | |
|
文档（Base64 编码）
|
Document (Base64 encoded) | string | |
|
Mime-Type
|
Mime-Type | string | |
|
临时记录 ID
|
Temporary Record Id | string | |
|
成功
|
Success | boolean | |
|
返回值
|
Return value | string | |
|
返回值 2
|
Return value 2 | string | |
|
DocumentJobId
|
DocumentJobId | string |
DocumentJobResponseV2
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
文件名
|
File name | string | |
|
文件大小
|
File size | integer | |
|
文档内容
|
Document content | byte | |
|
Mime-Type
|
Mime-Type | string | |
|
临时记录 ID
|
Temporary Record Id | string | |
|
成功
|
Success | boolean | |
|
返回值
|
Return value | string | |
|
返回值 2
|
Return value 2 | string | |
|
DocumentJobId
|
DocumentJobId | string |
JSONDCPTemplate
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ptm_mscrmaddons_dcptemplatesid
|
ptm_mscrmaddons_dcptemplatesid | string | |
|
ptm_name
|
ptm_name | string | |
|
ptm_entitytype
|
ptm_entitytype | string |
JSONEnvironment
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
EnvironmentName
|
EnvironmentName | string | |
|
EnvironmentId
|
EnvironmentId | integer |
JSONEnvironmentV3
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
EnvironmentName
|
EnvironmentName | string | |
|
EnvironmentId
|
EnvironmentId | string |
JSONOneClickAction
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
显示名称
|
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 | integer | |
|
_createdby_value
|
_createdby_value | string | |
|
ptm_oca
|
ptm_oca | string | |
|
_ownerid_value
|
_ownerid_value | string | |
|
修改在
|
modifiedon | date-time | |
|
_owninguser_value
|
_owninguser_value | string | |
|
_modifiedby_value
|
_modifiedby_value | string | |
|
版本号
|
versionnumber | integer | |
|
创建时间
|
createdon | date-time | |
|
_ptm_groupid_value
|
_ptm_groupid_value | string |
JSONPrinterResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
DCPPrinterName
|
DCPPrinterName | string |
JSONSignProvider
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
SignProviderName
|
SignProviderName | string | |
|
OptionValue
|
OptionValue | integer |
UserMessage
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Message
|
Message | string |
WhoAmi
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ApiKey（应用程序密钥）
|
ApiKey | string | |
|
ApiOwner
|
ApiOwner | string | |
|
环境
|
Environment | integer |