通过

内容管理器 Power Connect

内容管理器是基于治理的企业内容管理系统，旨在帮助政府机构、受监管的行业和全球组织管理其业务内容，从创建到处置。 连接到内容管理器以执行作，包括创建或更新记录或位置、上传或下载电子文件、搜索等。 (1.0.4.757)

此连接器在以下产品和区域中可用：

服务 Class 区域
Copilot Studio 高级 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
逻辑应用程序 标准 除以下各项外的所有 逻辑应用区域 ：
     - Azure 政府区域
     - Azure 中国区域
     - 美国国防部（DoD）
Power Apps 高级 除以下各项外的所有 Power Apps 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
Power Automate 高级 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
联系人​​
Name Kapish Services Pty Ltd
URL https://kapish.com.au/products/power_connect/
Email sales@kapish.com.au
连接器元数据
发布者 Kapish Services Pty Ltd
Website https://kapish.com.au/products/power_connect/
隐私策略 https://kapish.com.au/products/privacy-policy/
类别 数据;内容和文件

Content Manager Power Connect by Kapish 是一种连接器，它提供自动化和集成功能到内容管理器，以简化组织满足其信息管理和治理要求的能力。

先决条件

  • 外部可访问的内容管理器 ServiceAPI
  • Kapish Services Pty Ltd 提供的订阅密钥

有关规范和要求的详细列表，或有关如何帮助组织的详细信息，请联系 Kapish Services Pty Ltd

正在创建连接

连接器支持以下身份验证类型：
OAuth （机密客户端流） 使用 OAuth 连接到内容管理器 所有区域 不可共享
系统托管 使用用户名和密码连接到内容管理器 所有区域 不可共享
默认值 [已弃用] 此选项仅适用于没有显式身份验证类型的较旧连接，并且仅用于向后兼容性。 所有区域 不可共享

OAuth （机密客户端流）

身份验证 ID：OAuth

适用：所有区域

使用 OAuth 连接到内容管理器

这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name 类型 Description 必选
KPC 订阅密钥 securestring 用于访问 Kapish Power Connect 的 API 密钥 True
CM ServiceAPI URL（例如 https://myserver/CMServiceAPI/) 字符串 可以访问 CM ServiceAPI 的 URL True
授权服务器 URL（例如 https://myserver/adfs/oauth2/token) 字符串 用于获取访问令牌的 URL True
客户 ID 字符串 用于身份验证的客户端 ID True
客户端密码 securestring 用于身份验证的客户端密码 True

系统托管

身份验证 ID：基本

适用：所有区域

使用用户名和密码连接到内容管理器

这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name 类型 Description 必选
KPC 订阅密钥 securestring 用于访问 Kapish Power Connect 的 API 密钥 True
CM ServiceAPI URL（例如 https://myserver/CMServiceAPI/) 字符串 可以访问 CM ServiceAPI 的 URL True
用户名 字符串 身份验证的用户名 True
密码 securestring 身份验证的密码 True

默认值 [已弃用]

适用：所有区域

此选项仅适用于没有显式身份验证类型的较旧连接，并且仅用于向后兼容性。

这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name 类型 Description 必选
KPC 订阅密钥 securestring 用于访问 Kapish Power Connect 的 API 密钥 True
CM ServiceAPI URL（例如 https://myserver/CMServiceAPI/) 字符串 可以访问 CM ServiceAPI 的 URL True
授权服务器 URL（例如 https://myserver/adfs/oauth2/token) 字符串 用于获取访问令牌的 URL True
客户 ID 字符串 用于身份验证的客户端 ID True
客户端密码 securestring 用于身份验证的客户端密码 True

限制

名称 调用 续订期
每个连接的 API 调用数 100 60 秒

操作

上传电子文件

上传稍后可能附加到记录的电子文件
下载电子文件

下载记录的电子文件
从 URL 获取文件

使用“GetFileFromUrl”CM Service API 插件将文件从 URL 下载到过渡区域
创建位置 （人员）

创建人员位置
创建位置 （其他）

创建任何类型的位置
创建记录（文件夹）

创建记录
创建记录（文档）

创建记录
创建记录（高级）

使用高级字段创建记录
删除记录

删除记录
按 ID 查找位置

按唯一 ID 或名称提取单个位置
按 ID 查找记录

按唯一 ID 或名称提取单个记录
更新位置 （人员）

使用其唯一标识符更新人员位置
更新位置 （其他字段）

更新位置上的其他字段
更新位置 （其他）

更新位置
更新位置 （地址）

使用地址的唯一 ID 创建/更新位置的地址
更新记录 （从访问控制中删除位置）

RemoveAccessControl
更新记录 （关闭）

使用 CloseRecord 函数关闭容器 - 如果希望关闭日期为“now”，请将日期留空。 由于关闭记录可能需要更新许多包含的记录，因此此函数会自动提交更改
更新记录 （其他字段）

更新记录上的其他字段
更新记录 （分类）

更新记录的分类
更新记录 （删除所有作）

删除附加到指定记录的所有作
更新记录 （完成作）

完成特定记录的一项或所有作
更新记录 （属性）

更新记录
更新记录 （撤消签出）

撤消以前签出此记录的电子文档的签出，忽略自签出以来所做的任何更改
更新记录 （替换访问控制）

SetAccessControl
更新记录 （最终）

更新草稿记录
更新记录 （未公开）

还原记录的状态（及其任何内容），使其不再释放
更新记录 （未完成 - 设置为草稿）

将最终记录更新为草稿
更新记录 （添加访问控制）

AddAccessControl
更新记录 （签出）

设置要签出的记录的状态
更新记录 （设置用户标签）

允许在记录上设置用户标签
更新记录 （设置被分配者）

将被分配者设置为特定位置，返回到主页或注册为 Missing
更新记录 （释放）

释放记录
更新记录 （重新分配作）

将指定作重新分配到指定位置
更新记录 （重新打开）

使用 ReopenRecord 函数重新打开关闭的容器。 由于重新打开记录可能需要更新许多包含的记录，因此此函数会自动提交更改
更新记录 （重新计划作）

重新计划附加到此记录的所有作
更新记录 （附加同义词库术语）

将同义词库术语附加到记录
更新记录 （附加电子文件）

将电子文件附加到记录
更新记录 （附加联系人）

将联系人附加到记录
更新记录 （高级）

使用高级属性更新记录
更新记录（设置不受限制的访问或基于容器的访问）

InheritAccessControl
更新记录（请求呈现形式）

允许你为自动呈现引擎创建一个请求来呈现记录
更新记录（附加作或过程）

将作或过程附加到记录
查找 CM 对象

搜索 CM 对象
查找位置

搜索位置（使用搜索字符串提取位置集合）
查找位置地址的唯一 ID

获取位置子地址的唯一 ID
查找记录

搜索记录（使用搜索字符串提取记录集合）
查找记录（高级）

搜索记录（使用搜索字符串提取记录集合）。 返回原始内容管理器 ServiceAPI 响应。
读取事件数据

转换 Kapish Dispatch 事件数据以使用流

上传电子文件

操作 ID:
RecordElecUpload

上传稍后可能附加到记录的电子文件

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
文件名
 RecordFilePath True string
唯一标识符
 Uri True string

下载电子文件

操作 ID:
RecordElecDownload

下载记录的电子文件

参数

名称 密钥 必需 类型 说明
唯一标识符
 uri True string

唯一 ID 或记录编号
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名

返回

response
binary

从 URL 获取文件

操作 ID:
GetFileFromUrl

使用“GetFileFromUrl”CM Service API 插件将文件从 URL 下载到过渡区域

参数

名称 密钥 必需 类型 说明
文件的 URL
 url True string

要下载的文件的未编码 URL
要另存为的文件名
 filename string

用于保存下载的 URL 的文件名（仅带有后缀的文件名，不包括完整目录）
内容类型
 contentType string

大多数 Content-Type 标头（例如 image/png、text/plain、application/pdf）中找到的典型字符串。

返回

来自“GetFileFromUrl”CM 服务 API 插件的响应。

文件
GetFileFromUrlResponse

创建位置 （人员）

操作 ID:
LocationCreatePerson

创建人员位置

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
Title
 LocationHonorific string
姓氏
 LocationSurname string
名字
 LocationGivenNames string
内部
 LocationIsWithin boolean
职务
 LocationJobDescription string
出生日期
 LocationDateOfBirth string
称呼
 LocationSalutation string
唯一名称
 LocationNickName string
ID 号
 LocationIdNumber string
商务电话
 LocationPhoneNumber string
移动电话
 LocationMobileNumber string
传真
 LocationFaxNumber string
住宅电话
 LocationAfterHoursPhoneNumber string
与地址相同
 LocationUseAddressOf integer

位置的唯一 ID
地址类型
 LocationAddressAddressType string

选择地址类型。 每种类型的限制为一个。
街道
 LocationAddressAddressLines string
郊区/城市
 LocationAddressCity string
State
 LocationAddressState string
邮政编码
 LocationAddressPostcode string
国家
 LocationAddressCountry string
设为默认值
 AddRelationshipMakeThisTheDefaultRelationship boolean
相关唯一 ID
 AddRelationshipRelatedLocation integer
类型
 AddRelationshipRelationshipType string
电子邮件地址
 LocationEmailAddress string
性别
 LocationGenderValue string
接受登录名
 LocationCanLogin boolean
网络登录
 LocationLogsInAs string
其他网络登录名
 LocationAdditionalLogin string
登录过期时间
 LocationLoginExpires string
用户配置文件
 LocationUseProfileOf integer

位置的唯一 ID
用户类型
 LocationUserType string
安全字符串
 LocationSecurityString string
来自
 SetActiveDateRangeValidFromDate string

dd/mm/yyyyy
到
 SetActiveDateRangeValidToDate string

dd/mm/yyyyy
注释
 LocationNotes string
说明更新类型
 NotesUpdateType string

返回

Body
CMLocationsResponse

创建位置 （其他）

操作 ID:
LocationCreate

创建任何类型的位置

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
位置类型
 LocationTypeOfLocation string
Name
 LocationSortName True string
唯一名称
 LocationNickName string
ID 号
 LocationIdNumber string
内部
 LocationIsWithin boolean
商务电话
 LocationPhoneNumber string
移动电话
 LocationMobileNumber string
传真
 LocationFaxNumber string
住宅电话
 LocationAfterHoursPhoneNumber string
与地址相同
 LocationUseAddressOf integer

位置的唯一 ID
地址类型
 LocationAddressAddressType string

选择地址类型。 每种类型的限制为一个。
街道
 LocationAddressAddressLines string
郊区/城市
 LocationAddressCity string
State
 LocationAddressState string
邮政编码
 LocationAddressPostcode string
国家
 LocationAddressCountry string
设为默认值
 AddRelationshipMakeThisTheDefaultRelationship boolean
相关唯一 ID
 AddRelationshipRelatedLocation integer
类型
 AddRelationshipRelationshipType string
电子邮件地址
 LocationEmailAddress string
来自
 SetActiveDateRangeValidFromDate string

dd/mm/yyyyy
到
 SetActiveDateRangeValidToDate string

dd/mm/yyyyy
注释
 LocationNotes string
说明更新类型
 NotesUpdateType string

返回

Body
CMLocationsResponse

创建记录（文件夹）

操作 ID:
RecordCreateContainer

创建记录

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
记录类型
 RecordRecordType True string
标题 （自由文本部分）
 RecordTypedTitle True string
Classification
 RecordClassification string

提供分类的唯一标识符
集装箱
 RecordContainer string
属性
 Properties string

要返回的属性的逗号分隔列表
作者
 RecordAuthor string

位置的唯一 ID 或电子邮件地址
收件人
 RecordAddressee string

位置的唯一 ID 或电子邮件地址
备用容器
 RecordAlternativeContainer string
Assignee
 RecordAssignee string

位置的唯一 ID 或电子邮件地址
绕过记录类型访问控制
 RecordBypassRecordTypeAccessControls boolean
客户
 RecordClient string

位置的唯一 ID 或电子邮件地址
Creator
 RecordCreator string

位置的唯一 ID 或电子邮件地址
创建日期
 RecordDateCreated string
截止日期
 RecordDateDue string
发布日期
 RecordDatePublished string
外部参考
 RecordExternalReference string
警告失败？
 FailOnWarnings boolean

如果有任何警告，则不要创建/保存对象。
Uploads 文件夹中的文件名
 RecordFilePath string

“上传”文件夹中显示的文件名。
外国条形码
 RecordForeignBarcode string
GPS 位置
 RecordGpsLocation string
主页位置
 RecordHomeLocation string

位置的唯一 ID
家庭空间
 RecordHomeSpace string
已封闭
 RecordIsEnclosed boolean
Jurisdiction
 RecordJurisdictions string
上次作日期
 RecordLastActionDate string
长数字
 RecordLongNumber string
注释
 RecordNotes string
说明更新类型
 NotesUpdateType string
其他联系人
 RecordOtherContact string

位置的唯一 ID 或电子邮件地址
所有者位置
 RecordOwnerLocation string

位置的唯一 ID 或电子邮件地址
相关记录
 RecordRelatedRecord string
代表
 RecordRepresentative string

位置的唯一 ID 或电子邮件地址
审阅日期
 RecordReviewDate string
查看截止日期
 RecordReviewDueDate string
审阅状态
 RecordReviewState string
安全性
 RecordSecurity string

返回

Body
CMRecordsResponse

创建记录（文档）

操作 ID:
RecordCreate

创建记录

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
记录类型
 RecordRecordType True string
标题 （自由文本部分）
 RecordTypedTitle True string
属性
 Properties string

要返回的属性的逗号分隔列表
作者
 RecordAuthor string

位置的唯一 ID 或电子邮件地址
收件人
 RecordAddressee string

位置的唯一 ID 或电子邮件地址
备用容器
 RecordAlternativeContainer string
Assignee
 RecordAssignee string

位置的唯一 ID 或电子邮件地址
在保存时自动呈现为 PDF
 RecordAutoRenderToPDFOnSave boolean
绕过记录类型访问控制
 RecordBypassRecordTypeAccessControls boolean
签入为
 CheckinAs string

设置电子文档的 Source 属性。
Classification
 RecordClassification string

提供分类的唯一标识符
客户
 RecordClient string

位置的唯一 ID 或电子邮件地址
客户端记录
 RecordClientRecord string
集装箱
 RecordContainer string
从记录复制文档
 CopyDocumentFromRecord string

为要从中复制此记录的电子文档的记录指定唯一 ID。
Creator
 RecordCreator string

位置的唯一 ID 或电子邮件地址
创建日期
 RecordDateCreated string
截止日期
 RecordDateDue string
发布日期
 RecordDatePublished string
接收日期
 RecordDateReceived string
外部参考
 RecordExternalReference string
警告失败？
 FailOnWarnings boolean

如果有任何警告，则不要创建/保存对象。
Uploads 文件夹中的文件名
 RecordFilePath string

“上传”文件夹中显示的文件名。
在保存时完成
 RecordFinalizeOnSave boolean
外国条形码
 RecordForeignBarcode string
GPS 位置
 RecordGpsLocation string
主页位置
 RecordHomeLocation string

位置的唯一 ID
家庭空间
 RecordHomeSpace string
已封闭
 RecordIsEnclosed boolean
Jurisdiction
 RecordJurisdictions string
保持签出
 keepBookedOut boolean

如此 在上传电子文档后退出记录签出。
上次作日期
 RecordLastActionDate string
长数字
 RecordLongNumber string
介质类型
 RecordMediaType string
注释
 RecordNotes string
说明更新类型
 NotesUpdateType string
其他联系人
 RecordOtherContact string

位置的唯一 ID 或电子邮件地址
所有者位置
 RecordOwnerLocation string

位置的唯一 ID 或电子邮件地址
相关记录
 RecordRelatedRecord string
代表
 RecordRepresentative string

位置的唯一 ID 或电子邮件地址
审阅日期
 RecordReviewDate string
查看截止日期
 RecordReviewDueDate string
审阅状态
 RecordReviewState string
安全性
 RecordSecurity string

返回

Body
CMRecordsResponse

创建记录（高级）

操作 ID:
RecordCreateAdvanced

使用高级字段创建记录

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
记录类型
 RecordRecordType True string
标题 （自由文本部分）
 RecordTypedTitle True string
Classification
 RecordClassification string

提供分类的唯一标识符
作者
 RecordAuthor string

位置的唯一 ID 或电子邮件地址
属性
 Properties string

要返回的属性的逗号分隔列表
入盟编号
 RecordAccessionNumber string
收件人
 RecordAddressee string

位置的唯一 ID 或电子邮件地址
备用容器
 RecordAlternativeContainer string
Assignee
 RecordAssignee string

位置的唯一 ID 或电子邮件地址
自动分类置信度级别
 RecordAutoClassificationConfidenceLevel string
在保存时自动呈现为 PDF
 RecordAutoRenderToPDFOnSave boolean
绕过记录类型访问控制
 RecordBypassRecordTypeAccessControls boolean
绕过保存？
 ByPassSave boolean

如此 不保存对象。 其中一个用途是在记录帖子上设置一个或多个属性，并返回数据输入表单。 然后，数据输入窗体将反映原始记录上设置的各种属性。
更改收藏夹中的位置
 ChangePositionWithinFavorites string

搜索收藏夹时，除非使用其他排序，否则将按此顺序返回它们。
更改用户标签中的位置
 ChangePositionWithinUserLabel string

按 UserLabel 搜索时，除非使用其他排序，否则将按此顺序返回。
签入为
 CheckinAs string

设置电子文档的 Source 属性。
记录类
 RecordClassOfRecord string
客户
 RecordClient string

位置的唯一 ID 或电子邮件地址
客户端记录
 RecordClientRecord string
注释
 comments string

上载文档时要进入“记录笔记”中的批注。
寄售
 RecordConsignment string
寄售对象
 RecordConsignmentObject string
集装箱
 RecordContainer string
从记录复制文档
 CopyDocumentFromRecord string

为要从中复制此记录的电子文档的记录指定唯一 ID。
Creator
 RecordCreator string

位置的唯一 ID 或电子邮件地址
创建日期
 RecordDateCreated string
截止日期
 RecordDateDue string
发布日期
 RecordDatePublished string
接收日期
 RecordDateReceived string
Editor
 RecordEditor string

位置的唯一 ID 或电子邮件地址
外部参考
 RecordExternalReference string
警告失败？
 FailOnWarnings boolean

如果有任何警告，则不要创建/保存对象。
Uploads 文件夹中的文件名
 RecordFilePath string

“上传”文件夹中显示的文件名。
在保存时完成
 RecordFinalizeOnSave boolean
外国条形码
 RecordForeignBarcode string
GPS 位置
 RecordGpsLocation string
主页位置
 RecordHomeLocation string

位置的唯一 ID
家庭空间
 RecordHomeSpace string
启动模板
 RecordInitiateTemplate string
已封闭
 RecordIsEnclosed boolean
Jurisdiction
 RecordJurisdictions string
保持签出
 keepBookedOut boolean

如此 在上传电子文档后退出记录签出。
上次作日期
 RecordLastActionDate string
长数字
 RecordLongNumber string
使活动
 MakeActive string

还原记录的状态（及其任何内容），使其不再处于非活动状态。 处理内容时，可以指定在发生任何故障时任务是否应停止。
使非活动状态
 MakeInactive string

设置此记录及其任何内容的日期非活动。 处理内容时，可以指定在发生任何故障时任务是否应停止。
进行新的修订
 makeNewRevision boolean

如果为 True，请使用此电子文档 false 创建新修订，以替换当前修订。
手动销毁日期
 RecordManualDestructionDate string
物质记录
 RecordMatterRecord string
介质类型
 RecordMediaType string
我的授权注释
 RecordMyAuthorizationComments string
我的授权完成
 RecordMyAuthorizationComplete boolean
我的评论
 RecordMyReviewComments string
我的审阅完成
 RecordMyReviewComplete boolean
需要授权？
 RecordNeedsAuthorization boolean
需要评审？
 RecordNeedsReview boolean
新建部件创建规则
 RecordNewPartCreationRule string

自动部件创建规则的唯一 ID
注释
 RecordNotes string
说明更新类型
 NotesUpdateType string
其他联系人
 RecordOtherContact string

位置的唯一 ID 或电子邮件地址
所有者位置
 RecordOwnerLocation string

位置的唯一 ID 或电子邮件地址
数据条目上的保留者层次结构？
 RecordPreserveHierarchyOnDataEntry boolean
上一部分记录
 RecordPrevPartRecord string
Priority
 RecordPriority string
记录新类型
 RecordNewType string

除非创建新的部件版本或复制，否则保留为默认值。
相关记录
 RecordRelatedRecord string
代表
 RecordRepresentative string
保留计划
 RecordRetentionSchedule string
审阅日期
 RecordReviewDate string
查看截止日期
 RecordReviewDueDate string
审阅状态
 RecordReviewState string
安全性
 RecordSecurity string
系列记录
 RecordSeriesRecord string
属性集
 propertySets string

除了请求要返回的那些属性集之外，还指定属性集。
查询字符串
 q string

在此处指定一个查询，以将更新应用于一组记录，而不是一个（由唯一 ID 指定）。

返回

Body
CMRecordsResponse

删除记录

操作 ID:
DeleteRecord

删除记录

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri True integer

要删除的记录的唯一 ID
删除内容？
 DeleteContents True boolean
新主页内容
 NewHomeForContents string

内容的新主页位置的唯一 ID 或电子邮件地址

返回

Body
CMRecordsResponse

按 ID 查找位置

操作 ID:
LocationSearchByID

按唯一 ID 或名称提取单个位置

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Id True string

对象唯一 ID 或名称
子代属性
 descendantProperties string

以逗号分隔的对象属性列表，仅适用于此属性和较低级别的属性，例如 Surname、GivenNames
包括属性定义
 IncludePropertyDefs boolean

如此 返回此响应中属性使用的属性定义的数组
属性
 properties string

对象属性的逗号分隔列表，例如 Surname、GivenNames
属性集
 propertySets string

一个或多个预定义属性集，从 DataGridVisible、Detailed、FromSearch、All 或服务配置中定义的自定义属性集中进行选择
属性值
 PropertyValue string

在结果中包含原始值、字符串值或两者
字符串显示类型
 stringDisplayType string

返回要使用的格式的字符串值

返回

Body
CMLocationsResponse

按 ID 查找记录

操作 ID:
RecordSearchByID

按唯一 ID 或名称提取单个记录

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
ID
 Id True string

对象唯一 ID 或名称
包括属性定义
 IncludePropertyDefs boolean

如此 返回此响应中属性使用的属性定义的数组
子代属性
 descendantProperties string

以逗号分隔的对象属性列表，仅适用于此属性和较低级别的属性，例如 RecordNumber、RecordTitle。
属性
 properties string

以逗号分隔的对象属性列表，例如 RecordNumber、RecordTitle。
属性集
 propertySets string

一个或多个预定义的属性集，从 DataGridVisible、Detailed、FromSearch、All 或服务配置中定义的自定义属性集中进行选择。
属性值
 PropertyValue string

在结果中包含原始值、字符串值或两者
字符串显示类型
 stringDisplayType string

如果返回要使用的格式的字符串值

返回

Body
CMRecordsResponse

更新位置 （人员）

操作 ID:
LocationUpdatePerson

使用其唯一标识符更新人员位置

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri integer
查询字符串
 q string

在此处指定一个查询，以便将更新应用于一组位置，而不是一个（由唯一 ID 指定）。
Title
 LocationHonorific string
姓氏
 LocationSurname string
名字
 LocationGivenNames string
内部
 LocationIsWithin boolean
职务
 LocationJobDescription string
出生日期
 LocationDateOfBirth string
称呼
 LocationSalutation string
唯一名称
 LocationNickName string
ID 号
 LocationIdNumber string
商务电话
 LocationPhoneNumber string
移动电话
 LocationMobileNumber string
传真
 LocationFaxNumber string
住宅电话
 LocationAfterHoursPhoneNumber string
与地址相同
 LocationUseAddressOf integer

位置的唯一 ID
设为默认值
 AddRelationshipMakeThisTheDefaultRelationship boolean
相关唯一 ID
 AddRelationshipRelatedLocation integer
类型
 AddRelationshipRelationshipType string
电子邮件地址
 LocationEmailAddress string
性别
 LocationGenderValue string
接受登录名
 LocationCanLogin boolean
网络登录
 LocationLogsInAs string
其他网络登录名
 LocationAdditionalLogin string
登录过期时间
 LocationLoginExpires string
用户配置文件
 LocationUseProfileOf integer

位置的唯一 ID
用户类型
 LocationUserType string
安全字符串
 LocationSecurityString string
来自
 SetActiveDateRangeValidFromDate string

dd/mm/yyyyy
到
 SetActiveDateRangeValidToDate string

dd/mm/yyyyy
注释
 LocationNotes string
说明更新类型
 NotesUpdateType string
相关唯一 ID
 RemoveRelationshipRelatedLocation integer

返回

Body
CMLocationsResponse

更新位置 （其他字段）

操作 ID:
LocationUpdateAdditionalFields

更新位置上的其他字段

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri integer
Name
 SearchClause string
价值
 Value string

返回

Body
CMLocationsResponse

更新位置 （其他）

操作 ID:
LocationUpdate

更新位置

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri integer
查询字符串
 q string

在此处指定一个查询，以便将更新应用于一组位置，而不是一个（由唯一 ID 指定）。
Name
 LocationSortName string
唯一名称
 LocationNickName string
ID 号
 LocationIdNumber string
商务电话
 LocationPhoneNumber string
移动电话
 LocationMobileNumber string
传真
 LocationFaxNumber string
住宅电话
 LocationAfterHoursPhoneNumber string
与地址相同
 LocationUseAddressOf integer

位置的唯一 ID
设为默认值
 AddRelationshipMakeThisTheDefaultRelationship boolean
相关唯一 ID
 AddRelationshipRelatedLocation integer
类型
 AddRelationshipRelationshipType string
电子邮件地址
 LocationEmailAddress string
来自
 SetActiveDateRangeValidFromDate string

dd/mm/yyyyy
到
 SetActiveDateRangeValidToDate string

dd/mm/yyyyy
注释
 LocationNotes string
说明更新类型
 NotesUpdateType string
相关唯一 ID
 RemoveRelationshipRelatedLocation integer

返回

Body
CMLocationsResponse

更新位置 （地址）

操作 ID:
UpdateLocationAddress

使用地址的唯一 ID 创建/更新位置的地址

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri True integer

要更新的现有位置的 URI
唯一 ID
 Uri integer

要更新的现有街道或邮寄地址的 URI
类型
 LocationAddressAddressType string

选择地址类型。 每种类型的限制为一个。
街道
 LocationAddressAddressLines string
郊区/城市
 LocationAddressCity string
State
 LocationAddressState string
邮政编码
 LocationAddressPostcode string
国家
 LocationAddressCountry string

返回

Body
CMLocationsResponse

更新记录 （从访问控制中删除位置）

操作 ID:
RemoveAccessControl

RemoveAccessControl

参数

名称 密钥 必需 类型 说明
唯一标识符
 Uri True integer
FunctionEnum
 FunctionEnum string
唯一 ID
 Uri integer

位置唯一标识符

返回

Body
CMRecordsResponse

更新记录 （关闭）

操作 ID:
RecordClose

使用 CloseRecord 函数关闭容器 - 如果希望关闭日期为“now”，请将日期留空。 由于关闭记录可能需要更新许多包含的记录，因此此函数会自动提交更改

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri True integer
出错时继续？
 ContinueOnError boolean
包含内容？
 EncloseContents boolean
完成内容？
 FinalizeContents boolean
仅记录错误？
 LogErrorsOnly boolean
日志结果？
 LogResults boolean

返回日志消息属性中关闭的记录的文本日志？
清除内容修订？
 PurgeContentRevisions boolean
特定关闭日期？
 SpecificCloseDate date
属性
 Properties string

要返回的属性的逗号分隔列表

返回

Body
CMLogResponse

更新记录 （其他字段）

操作 ID:
RecordUpdateAdditionalFields

更新记录上的其他字段

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri integer
Name
 SearchClause string
价值
 Value string
属性
 Properties string

要返回的属性的逗号分隔列表

返回

Body
CMRecordsResponse

更新记录 （分类）

操作 ID:
RecordUpdateClassification

更新记录的分类

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri True integer
Classification
 RecordClassification True string

提供分类的唯一标识符
属性
 Properties string

要返回的属性的逗号分隔列表

返回

Body
CMRecordsResponse

更新记录 （删除所有作）

操作 ID:
RecordRemoveAllActions

删除附加到指定记录的所有作

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri True integer
属性
 Properties string

要返回的属性的逗号分隔列表

返回

Body
CMRecordsResponse

更新记录 （完成作）

操作 ID:
RecordCompleteActions

完成特定记录的一项或所有作

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri True integer
完成
 Complete True string

指定要完成的记录作
完成以前的作
 CompletePrevious boolean

在指定的记录作之前完成所有记录作
完成日期
 CompletionDate date

要设置为完成日期的日期
记录作唯一 ID
 RecordActionUri integer

如果选择“唯一标识符”，则要完成的记录作的唯一 ID
属性
 Properties string

要返回的属性的逗号分隔列表

返回

Body
CMRecordsResponse

更新记录 （属性）

操作 ID:
RecordUpdate

更新记录

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri integer
Query
 q string

在此处指定查询以将更新应用到一组记录，而不是仅应用一个（由唯一 ID 指定）
标题 （自由文本部分）
 RecordTypedTitle string
属性
 Properties string

要返回的属性的逗号分隔列表
作者
 RecordAuthor string

位置的唯一 ID 或电子邮件地址
集装箱
 RecordContainer string
Classification
 RecordClassification string

提供分类的唯一标识符
收件人
 RecordAddressee string

位置的唯一 ID 或电子邮件地址
备用容器
 RecordAlternativeContainer string
Assignee
 RecordAssignee string

位置的唯一 ID 或电子邮件地址
在保存时自动呈现为 PDF
 RecordAutoRenderToPDFOnSave boolean
绕过记录类型访问控制
 RecordBypassRecordTypeAccessControls boolean
签入为
 CheckinAs string

设置电子文档的 Source 属性。
客户
 RecordClient string

位置的唯一 ID 或电子邮件地址
客户端记录
 RecordClientRecord string
从记录复制文档
 CopyDocumentFromRecord string

为要从中复制此记录的电子文档的记录指定唯一 ID。
Creator
 RecordCreator string

位置的唯一 ID 或电子邮件地址
创建日期
 RecordDateCreated string
截止日期
 RecordDateDue string
发布日期
 RecordDatePublished string
接收日期
 RecordDateReceived string
外部参考
 RecordExternalReference string
警告失败？
 FailOnWarnings boolean

如果有任何警告，则不要创建/保存对象。
Uploads 文件夹中的文件名
 RecordFilePath string

“上传”文件夹中显示的文件名。
在保存时完成
 RecordFinalizeOnSave boolean
外国条形码
 RecordForeignBarcode string
GPS 位置
 RecordGpsLocation string
主页位置
 RecordHomeLocation string

位置的唯一 ID
家庭空间
 RecordHomeSpace string
已封闭
 RecordIsEnclosed boolean
Jurisdiction
 RecordJurisdictions string
保持签出
 keepBookedOut boolean

如此 在上传电子文档后退出记录签出。
长数字
 RecordLongNumber string
介质类型
 RecordMediaType string
注释
 RecordNotes string
说明更新类型
 NotesUpdateType string
其他联系人
 RecordOtherContact string

位置的唯一 ID 或电子邮件地址
所有者位置
 RecordOwnerLocation string

位置的唯一 ID 或电子邮件地址
相关记录
 RecordRelatedRecord string
代表
 RecordRepresentative string
审阅日期
 RecordReviewDate string
查看截止日期
 RecordReviewDueDate string
审阅状态
 RecordReviewState string
安全性
 RecordSecurity string

返回

Body
CMRecordsResponse

更新记录 （撤消签出）

操作 ID:
RecordUndoCheckout

撤消以前签出此记录的电子文档的签出，忽略自签出以来所做的任何更改

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri True integer
注释
 Comments string
属性
 Properties string

要返回的属性的逗号分隔列表

返回

Body
CMRecordsResponse

更新记录 （替换访问控制）

操作 ID:
SetAccessControl

SetAccessControl

参数

名称 密钥 必需 类型 说明
唯一标识符
 Uri True integer
FunctionEnum
 FunctionEnum string
唯一 ID
 Uri integer

位置唯一标识符

返回

Body
CMRecordsResponse

更新记录 （最终）

操作 ID:
RecordUpdateFinalise

更新草稿记录

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri True integer
删除旧修订
 SetAsFinalRemoveOldRevisions boolean
属性
 Properties string

要返回的属性的逗号分隔列表

返回

Body
CMRecordsResponse

更新记录 （未公开）

操作 ID:
RecordUndispose

还原记录的状态（及其任何内容），使其不再释放

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri True integer
出错时继续？
 ContinueOnError boolean
属性
 Properties string

要返回的属性的逗号分隔列表

返回

Body
CMRecordsResponse

更新记录 （未完成 - 设置为草稿）

操作 ID:
RecordUpdateUnfinalise

将最终记录更新为草稿

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri True integer

返回

Body
CMRecordsResponse

更新记录 （添加访问控制）

操作 ID:
AddAccessControl

AddAccessControl

参数

名称 密钥 必需 类型 说明
唯一标识符
 Uri True integer
FunctionEnum
 FunctionEnum string
唯一 ID
 Uri integer

位置唯一标识符

返回

Body
CMRecordsResponse

更新记录 （签出）

操作 ID:
RecordCheckout

设置要签出的记录的状态

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri True integer
注释
 Comments string
将签出路径另存为
 SaveCheckoutPathAs string
属性
 Properties string

要返回的属性的逗号分隔列表

返回

Body
CMRecordsResponse

更新记录 （设置用户标签）

操作 ID:
RecordSetUserLabel

允许在记录上设置用户标签

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
记录
 Uri True integer

要将用户标签附加到的记录的唯一 ID
用户标签
 UserLabel True string

要应用的用户标签的唯一 ID 或名称
最爱类型
 FavouriteType string
属性
 Properties string

要返回的属性的逗号分隔列表

返回

Body
CMRecordsResponse

更新记录 （设置被分配者）

操作 ID:
RecordSetAssignee

将被分配者设置为特定位置，返回到主页或注册为 Missing

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri True integer
新建被分配者
 NewAssignee string

新被分配者的唯一 ID 或电子邮件地址
被分配者类型
 AssigneeType string
按日期返回的截止日期
 DueForReturnByDate date
发生实际时间更改
 ActualTimeChangeOccurred date-time
属性
 Properties string

要返回的属性的逗号分隔列表

返回

Body
CMRecordsResponse

更新记录 （释放）

操作 ID:
RecordDispose

释放记录

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri True integer
出错时继续？
 ContinueOnError boolean
处置方法
 MethodOfDisposal string
属性
 Properties string

要返回的属性的逗号分隔列表

返回

Body
CMRecordsResponse

更新记录 （重新分配作）

操作 ID:
RecordReassignAction

将指定作重新分配到指定位置

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri True integer
新建被分配者
 NewAssignee True string

新被分配者的唯一 ID 或电子邮件地址
重新分配的作
 RecordActionUri True integer
属性
 Properties string

要返回的属性的逗号分隔列表

返回

Body
CMRecordsResponse

更新记录 （重新打开）

操作 ID:
RecordReopen

使用 ReopenRecord 函数重新打开关闭的容器。 由于重新打开记录可能需要更新许多包含的记录，因此此函数会自动提交更改

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri True integer
出错时继续？
 ContinueOnError boolean
日志结果？
 LogResults boolean

返回日志消息属性中重新打开的记录的文本日志？
取消定义内容？
 UnfinalizeContents boolean
属性
 Properties string

要返回的属性的逗号分隔列表

返回

Body
CMLogResponse

更新记录 （重新计划作）

操作 ID:
RecordRescheduleActions

重新计划附加到此记录的所有作

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri True integer
从基准日期
 FromBaseDate date
使用实际工期
 UseActualDurations boolean
属性
 Properties string

要返回的属性的逗号分隔列表

返回

Body
CMRecordsResponse

更新记录 （附加同义词库术语）

操作 ID:
RecordAttachKeyword

将同义词库术语附加到记录

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
记录
 Uri True integer

要将同义词库术语附加到的记录的唯一 ID
同义词库术语
 Keyword True string

要附加的同义词库术语的唯一 ID 或名称
属性
 Properties string

要返回的属性的逗号分隔列表

返回

Body
CMRecordsResponse

更新记录 （附加电子文件）

操作 ID:
RecordElecAttach

将电子文件附加到记录

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
文件
 File True file

要附加的电子文档的文件内容/正文
唯一标识符
 Uri True string

记录的唯一 ID

返回

Body
CMRecordsResponse

更新记录 （附加联系人）

操作 ID:
RecordAttachContact

将联系人附加到记录

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri True integer
联系人类型
 ContactType True string
联系人位置
 ContactLocation True string

位置的唯一 ID 或电子邮件地址
设置为主要联系人？
 IsPrimary True boolean
属性
 Properties string

要返回的属性的逗号分隔列表

返回

Body
CMRecordsResponse

更新记录 （高级）

操作 ID:
RecordUpdateAdvanced

使用高级属性更新记录

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri True integer
记录类型
 RecordRecordType string
Classification
 RecordClassification string

提供分类的唯一标识符
属性
 Properties string

要返回的属性的逗号分隔列表
作者
 RecordAuthor string

位置的唯一 ID 或电子邮件地址
入盟编号
 RecordAccessionNumber string
收件人
 RecordAddressee string

位置的唯一 ID 或电子邮件地址
备用容器
 RecordAlternativeContainer string
Assignee
 RecordAssignee string

位置的唯一 ID 或电子邮件地址
自动分类置信度级别
 RecordAutoClassificationConfidenceLevel string
在保存时自动呈现为 PDF
 RecordAutoRenderToPDFOnSave boolean
绕过记录类型访问控制
 RecordBypassRecordTypeAccessControls boolean
绕过保存？
 ByPassSave boolean

如此 不保存对象。 其中一个用途是在记录帖子上设置一个或多个属性，并返回数据输入表单。 然后，数据输入窗体将反映原始记录上设置的各种属性。
更改收藏夹中的位置
 ChangePositionWithinFavorites string

搜索收藏夹时，除非使用其他排序，否则将按此顺序返回它们。
更改用户标签中的位置
 ChangePositionWithinUserLabel string

按 UserLabel 搜索时，除非使用其他排序，否则将按此顺序返回。
签入为
 CheckinAs string

设置电子文档的 Source 属性。
记录类
 RecordClassOfRecord string
客户
 RecordClient string

位置的唯一 ID 或电子邮件地址
客户端记录
 RecordClientRecord string
注释
 comments string

上载文档时要进入“记录笔记”中的批注。
寄售
 RecordConsignment string
寄售对象
 RecordConsignmentObject string
集装箱
 RecordContainer string
从记录复制文档
 CopyDocumentFromRecord string

为要从中复制此记录的电子文档的记录指定唯一 ID。
Creator
 RecordCreator string

位置的唯一 ID 或电子邮件地址
创建日期
 RecordDateCreated string
截止日期
 RecordDateDue string
发布日期
 RecordDatePublished string
接收日期
 RecordDateReceived string
Editor
 RecordEditor string

位置的唯一 ID 或电子邮件地址
电子文档存储
 RecordEStore string
外部参考
 RecordExternalReference string
警告失败？
 FailOnWarnings boolean

如果有任何警告，则不要创建/保存对象。
Uploads 文件夹中的文件名
 RecordFilePath string

“上传”文件夹中显示的文件名。
在保存时完成
 RecordFinalizeOnSave boolean
外国条形码
 RecordForeignBarcode string
GPS 位置
 RecordGpsLocation string
主页位置
 RecordHomeLocation string

位置的唯一 ID
家庭空间
 RecordHomeSpace string
已封闭
 RecordIsEnclosed boolean
Jurisdiction
 RecordJurisdictions string
保持签出
 keepBookedOut boolean

如此 在上传电子文档后退出记录签出。
上次作日期
 RecordLastActionDate string
长数字
 RecordLongNumber string
使活动
 MakeActive string

还原记录的状态（及其任何内容），使其不再处于非活动状态。 处理内容时，可以指定在发生任何故障时任务是否应停止。
使非活动状态
 MakeInactive string

设置此记录及其任何内容的日期非活动。 处理内容时，可以指定在发生任何故障时任务是否应停止。
进行新的修订
 makeNewRevision boolean

如果为 True，请使用此电子文档 false 创建新修订，以替换当前修订。
手动销毁日期
 RecordManualDestructionDate string
物质记录
 RecordMatterRecord string
介质类型
 RecordMediaType string
我的授权注释
 RecordMyAuthorizationComments string
我的授权完成
 RecordMyAuthorizationComplete boolean
我的评论
 RecordMyReviewComments string
我的审阅完成
 RecordMyReviewComplete boolean
需要授权？
 RecordNeedsAuthorization boolean
需要评审？
 RecordNeedsReview boolean
新建部件创建规则
 RecordNewPartCreationRule string

自动部件创建规则的唯一 ID
注释
 RecordNotes string
说明更新类型
 NotesUpdateType string
其他联系人
 RecordOtherContact string

位置的唯一 ID 或电子邮件地址
所有者位置
 RecordOwnerLocation string

位置的唯一 ID 或电子邮件地址
数据条目上的保留者层次结构？
 RecordPreserveHierarchyOnDataEntry boolean
上一部分记录
 RecordPrevPartRecord string
Priority
 RecordPriority string
记录新类型
 RecordNewType string

除非创建新的部件版本或复制，否则保留为默认值。
相关记录
 RecordRelatedRecord string
代表
 RecordRepresentative string
保留计划
 RecordRetentionSchedule string
审阅日期
 RecordReviewDate string
查看截止日期
 RecordReviewDueDate string
审阅状态
 RecordReviewState string
安全性
 RecordSecurity string
系列记录
 RecordSeriesRecord string
标题 （自由文本部分）
 RecordTypedTitle string
查询字符串
 q string

在此处指定一个查询，以将更新应用于一组记录，而不是一个（由唯一 ID 指定）。

返回

Body
CMRecordsResponse

更新记录（设置不受限制的访问或基于容器的访问）

操作 ID:
InheritAccessControl

InheritAccessControl

参数

名称 密钥 必需 类型 说明
唯一标识符
 Uri True integer
FunctionEnum
 FunctionEnum string
唯一 ID
 Uri integer

位置唯一标识符

返回

Body
CMRecordsResponse

更新记录（请求呈现形式）

操作 ID:
RecordRequestRendition

允许你为自动呈现引擎创建一个请求来呈现记录

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri True integer
呈现类型
 RenditionType True string
属性
 Properties string

要返回的属性的逗号分隔列表

返回

Body
CMRecordsResponse

更新记录（附加作或过程）

操作 ID:
RecordAttachAction

将作或过程附加到记录

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
唯一标识符
 Uri True integer
要附加的作
 ActionToAttach True integer
被分配者唯一 ID
 NewAssignee integer
Assignee 选项
 AssigneeOption string
计划开始日期
 ScheduleStartDate date
现有作
 RecordAction integer
插入位置
 InsertPos string
属性
 Properties string

要返回的属性的逗号分隔列表

返回

Body
CMRecordsResponse

查找 CM 对象

操作 ID:
CMObjectSearch

搜索 CM 对象

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
搜索内容
 TrimType True string
查询字符串
 q True string

输入搜索查询，例如“all”以获取所有对象。
应用默认值
 ApplyDefaults boolean

如果为 True，则应用用户的默认筛选器并对此搜索进行排序。
计算结果数
 CountResults boolean

CountResults 返回最可靠且最慢的总搜索结果计数。 生成的计数位于响应 Count 属性中。
子代属性
 DescendantProperties string

以逗号分隔的对象属性列表，仅适用于此属性和较低级别的属性，例如 RecordNumber、RecordTitle。
排除计数
 ExcludeCount boolean

返回 TotalResults 和 SearchTitle 可能会降低性能。 如果不需要 TotalResults 和 SearchTitle，则设置为 true。
过滤器
 Filter string

要作为筛选器应用的搜索子句的空格分隔列表。
从搜索
 FromSearch integer

要从中构造此搜索的已保存搜索的唯一 ID。
Include 属性 Defs
 IncludePropertyDefs boolean

如此 返回此响应中属性使用的属性定义的数组。
选项
 Options string

设置通常仅在“用户选项”中为此搜索设置一个或多个选项。 使用 /PropertyDef 中的 ID？Get=SearchOptions 服务，追加减号设置为 false，否则假定为 true。
页面大小
 pageSize integer

要在每个结果页中返回的项数。 如果为空，则默认为配置中设置的默认值。
属性值
 PropertyValue string

在结果中包含原始值、字符串值或两者。
属性集
 PropertySets string

一个或多个预定义的属性集，从 DataGridVisible、Detailed、FromSearch、All 或服务配置中定义的自定义属性集中进行选择。
目的
 purpose integer

基于对象用途枚举值筛选搜索结果的特殊属性。
用途额外
 purposeExtra integer

作为对某些目的的补充所必需的。 ObjectDef 服务提供有关枚举或 TrimMainObject 类型的信息，特别是 ObjectDef.ExtraPurposeEnums、ObjectDef.ExtraPurposeObjectTypes 和 HaveExtraPurposeParameter。
排序依据
 sortBy string

搜索子句 ID 的逗号分隔列表。 使用 - 指定降序。 例如 Number- ，按数字降序对记录进行排序。
Start
 start integer

结果集中要开始的位置，空（或 1）从开头开始，2 以从第二个对象开始，第三个对象为 3，等等。
StringDisplayType
 StringDisplayType string

如果返回要使用的格式的字符串值。
属性
 properties string

对象属性的逗号分隔列表，例如 Uri、NameString

返回

Body
CMBobResponse

查找位置

操作 ID:
LocationSearch

搜索位置（使用搜索字符串提取位置集合）

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
Query
 q True string

输入搜索查询，例如“all”以获取所有对象。
应用默认值
 ApplyDefaults boolean

如果为 True，则应用用户的默认筛选器并对此搜索进行排序
计算结果数
 CountResults boolean

如果包含结果计数，则为 True
排除计数
 ExcludeCount boolean

如果排除结果计数，则为 True
过滤器
 filter string

要作为筛选器应用的搜索子句的空格分隔列表。
从搜索
 fromSearch string

要从中构造此搜索的已保存搜索的唯一 ID
子代属性
 descendantProperties string

以逗号分隔的对象属性列表，仅适用于此属性和较低级别的属性的对象属性，例如 RecordNumber、RecordTitle
包括属性定义
 IncludePropertyDefs boolean

如此 返回此响应中属性使用的属性定义的数组
选项
 Options string

设置通常仅在“用户选项”中为此搜索设置一个或多个选项。 使用 /PropertyDef 中的 ID？Get=SearchOptions 服务，追加减号设置为 false，否则假定为 true。
属性
 properties string

对象属性的逗号分隔列表，例如 RecordNumber、RecordTitle
属性集
 propertySets string

一个或多个预定义属性集，从 DataGridVisible、Detailed、FromSearch、All 或服务配置中定义的自定义属性集中进行选择
属性值
 PropertyValue string

在结果中包含原始值、字符串值或两者
页面大小
 pageSize string

每页结果中要返回的项数
目的
 purpose string

基于对象目的枚举值筛选搜索结果的特殊属性
用途额外
 purposeExtra string

作为对某些目的的补充所必需的。 ObjectDef 服务提供有关枚举或 TrimMainObject 类型的信息，特别是 ObjectDef.ExtraPurposeEnums、ObjectDef.ExtraPurposeObjectTypes 和 HaveExtraPurposeParameter。
排序依据
 sortBy string

搜索子句 ID 的逗号分隔列表
Start
 start string

结果集中要开始的位置，空（或 1）从开头开始，2 从第二个对象开始，第三个对象为 3，等等
字符串显示类型
 stringDisplayType string

如果返回要使用的格式的字符串值

返回

Body
CMLocationsResponse

查找位置地址的唯一 ID

操作 ID:
FindLocationChildAddressUri

获取位置子地址的唯一 ID

参数

名称 密钥 必需 类型 说明
类型
 type string

选择地址类型
唯一标识符
 LocationUri True string

位置的唯一 ID
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名

返回

子地址
CMLocationAddressUri

查找记录

操作 ID:
RecordSearch

搜索记录（使用搜索字符串提取记录集合）

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
Query
 q True string

搜索查询
属性
 properties True string

要返回的属性的逗号分隔列表

返回

Body
CMRecordsResponse

查找记录（高级）

操作 ID:
RecordSearchAdvanced

搜索记录（使用搜索字符串提取记录集合）。 返回原始内容管理器 ServiceAPI 响应。

参数

名称 密钥 必需 类型 说明
用户模拟
 userToImpersonate string

CM 中要模拟的位置的网络登录名或备用登录名
Query
 q True string

搜索查询
属性
 properties True string

要返回的属性的逗号分隔列表

返回

response
object

读取事件数据

操作 ID:
ReadEventData

转换 Kapish Dispatch 事件数据以使用流

参数

名称 密钥 必需 类型 说明
Content
 Content string

检索 CM 事件数据的服务总线作的内容

返回

Body
CMEventData

定义

CMRecord

名称 路径 类型 说明
文件路径
 RecordFilePath string

上传文件夹中显示的文件名
入盟编号
 RecordAccessionNumber integer
收件人
 RecordAddressee integer
备用容器
 RecordAlternativeContainer integer
Assignee
 RecordAssignee integer
作者
 RecordAuthor integer
授权方法
 RecordAuthorizationMethod string
自动分类置信度级别
 RecordAutoClassificationConfidenceLevel integer
在保存时自动呈现为 PDF
 RecordAutoRenderToPDFOnSave boolean
蓝色打印标题
 RecordBlueprintTitle string
绕过记录类型访问控制
 RecordBypassRecordTypeAccessControls boolean
签入者
 RecordCheckedInBy integer
签出到
 RecordCheckedOutTo integer
Classification
 RecordClassification integer
记录类
 RecordClassOfRecord string
客户
 RecordClient integer
客户端记录
 RecordClientRecord integer
寄售
 RecordConsignment string
寄售对象
 RecordConsignmentObject string
集装箱
 RecordContainer integer
Creator
 RecordCreator integer
当前版本
 RecordCurrentVersion string
日期已关闭
 RecordDateClosed date-time
创建日期
 RecordDateCreated date-time
截止日期
 RecordDateDue date-time
完成日期
 RecordDateFinalized date-time
导入日期
 RecordDateImported date-time
日期非活动
 RecordDateInactive date-time
修改日期
 RecordDateModified date-time
发布日期
 RecordDatePublished date-time
接收日期
 RecordDateReceived date-time
已注册日期
 RecordDateRegistered date-time
文档附加挂起
 RecordDocumentAttachPending boolean
文档大小
 RecordDocumentSize integer
文档类型
 RecordDocumentType string
Editor
 RecordEditor integer
电子文档存储
 RecordEStore integer
文档扩展
 RecordExtension string
外部参考
 RecordExternalReference string
在保存时完成
 RecordFinalizeOnSave boolean
文件夹源
 RecordFolderOrigin integer
外国条形码
 RecordForeignBarcode string
生成的标题
 RecordGeneratedTitle string
GPS 位置
 RecordGpsLocation string
主页位置
 RecordHomeLocation integer
家庭空间
 RecordHomeSpace integer
启动模板
 RecordInitiateTemplate string

工作流模板的唯一 ID
已封闭
 RecordIsEnclosed boolean
Jurisdiction
 RecordJurisdictions string
上次作日期
 RecordLastActionDate date-time
最后一部分记录
 RecordLastPartRecord integer
最新版本
 RecordLatestVersion integer
展开的数字
 RecordLongNumber string
记录编号
 RecordNumber string
手动销毁日期
 RecordManualDestructionDate date-time
物质记录
 RecordMatterRecord integer
介质类型
 RecordMediaType string
会议
 RecordMeeting integer
Mime 类型
 RecordMimeType string
我的授权注释
 RecordMyAuthorizationComments string
我的授权完成
 RecordMyAuthorizationComplete boolean
我的评论
 RecordMyReviewComments string
我的审阅完成
 RecordMyReviewComplete boolean
编号页？
 RecordNbrPages integer
需要授权？
 RecordNeedsAuthorization boolean
需要评审？
 RecordNeedsReview boolean
新建部件创建规则
 RecordNewPartCreationRule string

自动部件创建规则的唯一 ID
下一部分记录
 RecordNextPartRecord integer
说明更新类型
 NotesUpdateType string
注释
 RecordNotes string
源于
 RecordOriginatedFrom string
源自运行
 RecordOriginatedFromRun string
其他联系人
 RecordOtherContact integer
所有者位置
 RecordOwnerLocation integer
数据条目上的保留者层次结构？
 RecordPreserveHierarchyOnDataEntry boolean
上一部分记录
 RecordPrevPartRecord integer
主要联系人
 RecordPrimaryContact integer
Priority
 RecordPriority string
记录类型
 RecordRecordType integer
相关记录
 RecordRelatedRecord integer
代表
 RecordRepresentative integer
保留计划
 RecordRetentionSchedule integer
审阅日期
 RecordReviewDate date-time
查看截止日期
 RecordReviewDueDate date-time
审阅状态
 RecordReviewState string
根部件记录
 RecordRootPartRecord integer
安全性
 RecordSecurity string
系列记录
 RecordSeriesRecord integer
Title
 RecordTitle string
标题 （自由文本部分）
 RecordTypedTitle string
唯一标识符
 Uri integer
其他字段
 Fields object

CMEventData

名称 路径 类型 说明
事件唯一标识符
 OnlineEventUri integer
事件类型 ID
 EventType integer
事件类型
 EventTypeString string
事件日期
 EventDate date-time
对象类型 ID
 ObjectType integer
对象类型
 ObjectTypeString string
对象唯一 ID
 ObjectUri integer
相关对象类型 ID
 RelatedObjectType integer
相关对象类型
 RelatedObjectTypeString string
相关对象唯一 ID
 RelatedObjectUri integer
从计算机
 FromMachine string
连接 IP 地址
 ConnectionIPAddress string
客户端 IP 地址
 ClientIPAddress string
从时区
 FromTimeZone integer
登录名
 LoginName string
登录唯一 ID
 LoginUri integer
额外详细信息
 ExtraDetails string

CMLogMessage

名称 路径 类型 说明
日志消息
 LogMessage string
搜索内容
 TrimType CMTrimType
唯一标识符
 Uri integer

CMRecordsResponse

名称 路径 类型 说明
Results
 Results array of CMRecord
UpdateErrorResults
 UpdateErrorResults array of CMUpdateErrorResponse
结果总数
 TotalResults integer
Count String Ex
 CountStringEx string
最小计数
 MinimumCount integer
计数
 Count integer
包含更多项
 HasMoreItems boolean
搜索标题
 SearchTitle string
命中突出显示字符串
 HitHighlightString string
搜索内容
 TrimType CMTrimType
响应状态
 ResponseStatus CMResponseStatus

响应状态

CMLogResponse

名称 路径 类型 说明
Results
 Results array of CMLogMessage
UpdateErrorResults
 UpdateErrorResults array of CMUpdateErrorResponse
结果总数
 TotalResults integer
Count String Ex
 CountStringEx string
最小计数
 MinimumCount integer
计数
 Count integer
包含更多项
 HasMoreItems boolean
搜索标题
 SearchTitle string
命中突出显示字符串
 HitHighlightString string
搜索内容
 TrimType CMTrimType
响应状态
 ResponseStatus CMResponseStatus

响应状态

CMUpdateErrorResponse

更新错误响应

名称 路径 类型 说明
错误代码
 ErrorCode string
唯一标识符
 Uri integer
Message
 Message string
Name
 Name string
名称（额外）
 NameExtra string

CMResponseStatus

响应状态

名称 路径 类型 说明
错误代码
 ErrorCode string
Message
 Message string
StackTrace
 StackTrace string
Errors
 Errors array of CMResponseError
Meta
 Meta object

<字典字符串，字符串>

CMResponseError

响应错误

名称 路径 类型 说明
错误代码
 ErrorCode string
字段名称
 FieldName string
Message
 Message string
Meta
 Meta object

<字典字符串，字符串>

CMTrimType

搜索内容
string

CMLocation

名称 路径 类型 说明
唯一标识符
 Uri integer
Name
 NameString string
位置格式的完整名称
 LocationFullFormattedName string
位置排序名称
 LocationSortName string

CMBob

名称 路径 类型 说明
唯一标识符
 Uri integer
Name
 NameString string

CMLocationsResponse

名称 路径 类型 说明
Results
 Results array of CMLocation

Results
UpdateErrorResults
 UpdateErrorResults array of CMUpdateErrorResponse
结果总数
 TotalResults integer
Count String Ex
 CountStringEx string
最小计数
 MinimumCount integer
计数
 Count integer
包含更多项
 HasMoreItems boolean
搜索标题
 SearchTitle string
命中突出显示字符串
 HitHighlightString string
搜索内容
 TrimType CMTrimType
响应状态
 ResponseStatus CMResponseStatus

响应状态

CMBobResponse

名称 路径 类型 说明
Results
 Results array of CMBob

Results
UpdateErrorResults
 UpdateErrorResults array of CMUpdateErrorResponse
结果总数
 TotalResults integer
Count String Ex
 CountStringEx string
最小计数
 MinimumCount integer
计数
 Count integer
包含更多项
 HasMoreItems boolean
搜索标题
 SearchTitle string
命中突出显示字符串
 HitHighlightString string
搜索内容
 TrimType CMTrimType
响应状态
 ResponseStatus CMResponseStatus

响应状态

GetFileFromUrlResponse

来自“GetFileFromUrl”CM 服务 API 插件的响应。

名称 路径 类型 说明
Filepath
 Filepath string

从 URL 下载的文件的本地文件路径。
Message
 Message string

CMLocationAddressUri

名称 路径 类型 说明
唯一 ID
 Uri integer

二进制

这是基本数据类型“binary”。

对象

这是类型“object”。