通过

iManage Work

iManage Work 连接器使用户能够在 iManage Work 环境中保护其所有文件时自动执行重复任务和审批过程。

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

服务 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 iManage LLC
URL https://docs.imanage.com
Email cloudsupport@imanage.com
连接器元数据
发布者 iManage Power Platform 连接器
Website https://imanage.com
隐私策略 https://imanage.com/about/privacy-notice/
类别 内容和文件;生产力

iManage Work

iManage 是面向知识工作者的文档和电子邮件管理解决方案行业领先的提供商。 iManage 平台组织和保护文档和电子邮件中的信息，以便专业人员可以搜索所需的内容、对其执行作并更有效地进行协作。 iManage Work 连接器使用户能够在 iManage Work 环境中保护其所有文件时自动执行重复任务和审批流程。

先决条件

连接器适用于所有连接到 cloudimanage.com 的 iManage Work 客户。 首先，iManage Work 环境的管理员需要启用 Power Automate 应用程序。 启用后，需要环境的特定 URL 以及连接器可以执行作的登录帐户和密码。 有关详细信息，请参阅常见问题解答。

如何获取凭据

如果你是现有的 iManage Work 用户，请提供 iManage Work 凭据以登录。 否则，请与系统管理员联系以获取帮助。

iManage Work 连接器入门

执行以下步骤以开始使用 iManage Work 连接器：

  • 创建即时云流，然后选择“ + 新建”步骤。
  • 搜索 iManage Work 以查看所有可用的 iManage Work作。
  • 选择所需的 iManage Work作。
  • 如果尚未登录到 iManage Work，系统会提示你登录。
    • 选择“登录”。
    • 输入用于连接到 iManage Work 的 URL，例如 cloudimanage.com。
    • 输入 iManage Work 用户 ID。
    • 输入所选帐户的密码，然后选择 “登录”。 从此开始，使用 iManage Work作的所有流都使用这些用户凭据进行连接。 可以通过在 “我的连接 ”下添加新连接并切换到该帐户来使用不同的 iManage 用户帐户。

已知问题和限制

有关已知问题和限制的列表，请访问 https://docs.imanage.com/power-automate/index.html。

常见错误和补救措施

有关常见错误和补救措施的列表，请访问 https://docs.imanage.com/power-automate/index.html。

FAQ

有关常见问题解答的列表，请访问 https://docs.imanage.com/power-automate/index.html。

限制

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

操作

上传文档

将文件作为新文档上传到指定文件夹。
下载文档

根据文档 ID 下载特定文档的版本。 如果最新为 true，则下载此文档的最新版本。 下载是流，不会在本地保存。
创建工作区

基于所选模板创建新工作区。 工作区模板是一个预定义的工作区，其结构将复制到新工作区。 创建新工作区时，会自动强制实施对工作区模板的限制。
创建文档关系

在库中的指定文档之间创建关系。
删除文档

删除指定的文档。
删除文档关系

删除库中指定文档之间的关系。
删除文档引用

从指定文件夹中删除文档引用。
在文档中设置核心扩展元数据属性

设置文档的核心扩展元数据属性。
复制文档

将文档复制到指定文件夹。
复制权限

将访问权限以及默认安全性从一个 iManage Work 对象复制到另一个 iManage Work 对象。 “复制类型”提供有关如何处理源和目标权限组合的选项。 “Overwrite”更新目标对象的用户、组和权限级别，以完全匹配源对象的级别。 “Merge”将保留目标对象上的所有用户和组，并将其与源合并，但在单个或组的权限级别冲突时：“Merge（悲观）”采用较低权限，而“Merge（乐观）”对冲突的用户或组具有更高的权限。
提升文档版本

将文档的现有版本提升到最新版本。 新版本是从指定的日记 ID 或版本创建的，然后提升到最新版本。 必须指定日记 ID 或版本，但不能同时指定这两者。
搜索工作区

搜索工作区。
搜索文件夹

搜索文件夹。
搜索核心扩展元数据分类节点值

搜索与指定搜索条件匹配的核心扩展元数据分类节点值。
搜索用户

搜索符合指定搜索条件的 iManage Work 用户。
更新工作区

更新指定工作区的信息。 若要删除字符串字段的现有值，请将字段的值设置为用单引号或双引号包装的空字符串。
更新工作流状态

更新工作流运行的状态。 此作只能在已创建的工作流中使用，以从 iManage 提供的触发器开始。
更新当前或创建新文档版本

更新文档的指定版本，或创建新版本。 此作可以更新文档的配置文件和内容。 如果指定了“更新当前版本”选项，则文档将替换为新文档，并维护上一个文档的配置文件。 如果指定了“创建新版本”，则会创建继承文件夹配置文件的文档的新版本。 成功执行作后，将返回文档配置文件。
更新文档配置文件

对文档配置文件执行更新。 在更新文档配置文件时不得使用文档，并且无法更新签出的文档的配置文件。 返回作后更新的文档配置文件。
更新权限

更新对象的权限。
更新默认安全性

更新文档、文件夹或工作区的默认安全性。
添加文档历史记录条目

将条目添加为文档历史记录中的事件。
添加文档引用

在另一个文件夹中添加文档引用或文档快捷方式。
移动文档

将文档移动到指定文件夹。
编辑名称/值对

创建、更新或删除文档、文件夹或工作区的名称/值对属性。 若要删除名称值对，请将键的值设置为用单引号或双引号包装的空字符串。
获取受托人

获取具有文档、文件夹或工作区特定权限的受托人列表。 受托人可以是用户或组。
获取子类

获取与指定条件匹配的所有库子类。
获取工作区模板

获取库中可用的模板列表。 工作区模板是预定义的工作区，其结构是为新工作区复制的。
获取工作区配置文件

获取工作区配置文件，并根据需要获取工作区的允许作列表。
获取库

获取用户有权访问的库的列表。
获取文档版本

获取当前用户有权访问指定文档的所有版本的配置文件。
获取文档的核心扩展元数据属性

获取文档的核心扩展元数据属性。
获取文档配置文件

获取与特定文档 ID 关联的文档属性。
获取权限

获取文档、文件夹或工作区的用户或组访问权限属性。 响应属性可能因用户或组权限而异。
获取用户详细信息

从指定库获取有关用户的信息。
获取类

获取库中与指定条件匹配的文档类的列表。
获取组成员

获取属于指定组并符合指定条件的用户的详细信息。

上传文档

操作 ID:
UploadDocument

将文件作为新文档上传到指定文件夹。

参数

名称 密钥 必需 类型 说明
库 ID
 libraryId True string

指定目标库的 ID。
文件夹 ID
 folderId True string

指定目标文件夹的文件夹 ID。 例如，“ACTIVE_US！987”。
继承文件夹配置文件
 inherit_profile_from_folder True boolean

指定配置文件数据是否继承自父文件夹。
保持锁定
 keep_locked boolean

指定上传后是否保留文档锁。
注释
 comment string

指定有关更新的其他信息。
作者
 author string

指定创建文档的用户的 iManage 工作 ID。
Operator
 operator string

指定已签出文档或当前正在编辑文档配置文件的用户的 ID。 例如，“JSMITH”。
Class
 class string

指定用于标识和区分文档的类。 文档类按流派、部门、区域等进行分类。
亚纲
 subclass string

指定用于标识和区分文档的子类。 文档子类按流派、部门、区域等分类。
默认安全性
 default_security string

指定默认安全访问级别。 可能的值为“inherit”、“private”、“view”、“public”。
是 HIPAA
 is_hipaa boolean

指定文档是否要加密。
保留天数
 retain_days integer

指定文档在标记为存档之前必须处于非活动状态的天数。
文件内容
 file True file

指定文件的内容。
文件创建日期
 file_create_date date-time

指定文件的日期和时间（采用 ISO 8601 格式）。 该文件可能已在 iManage Work 系统外部创建。 此日期可能与“create_date”不同。 create_date是 iManage Work 系统创建或导入文件的日期。
文件编辑日期
 file_edit_date date-time

指定文件的最新更改的日期和时间（采用 ISO 8601 格式）。 在上传到 iManage Work 系统之前，该文件可能已更改。
Custom1
 custom1 string

指定 custom1 的值。
Custom2
 custom2 string

指定 custom2 的值。 若要为 custom2 指定值，还必须在同一请求中为 custom1 指定一个值，这是因为其父子关系。
Custom3
 custom3 string

指定 custom3 的值。
Custom4
 custom4 string

指定 custom4 的值。
Custom5
 custom5 string

指定 custom5 的值。
Custom6
 custom6 string

指定 custom6 的值。
Custom7
 custom7 string

指定 custom7 的值。
Custom8
 custom8 string

指定 custom8 的值。
Custom9
 custom9 string

指定 custom9 的值。
Custom10
 custom10 string

指定 custom10 的值。
Custom11
 custom11 string

指定 custom11 的值。
Custom12
 custom12 string

指定 custom12 的值。
Custom13
 custom13 string

指定 custom13 的值。
Custom14
 custom14 string

指定 custom14 的值。
Custom15
 custom15 string

指定 custom15 的值。
Custom16
 custom16 string

指定 custom16 的值。
Custom17
 custom17 double

指定 custom17 的值。
Custom18
 custom18 double

指定 custom18 的值。
Custom19
 custom19 double

指定 custom19 的值。
Custom20
 custom20 double

指定 custom20 的值。
Custom21
 custom21 string

以 ISO 8601 日期/时间格式指定 custom21 的值。
Custom22
 custom22 string

以 ISO 8601 日期/时间格式指定 custom22 的值。
Custom23
 custom23 string

以 ISO 8601 日期/时间格式指定 custom23 的值。
Custom24
 custom24 string

以 ISO 8601 日期/时间格式指定 custom24 的值。
Custom25
 custom25 boolean

指定 custom25 的值。
Custom26
 custom26 boolean

指定 custom26 的值。
Custom27
 custom27 boolean

指定 custom27 的值。
Custom28
 custom28 boolean

指定 custom28 的值。
Custom29
 custom29 string

指定 custom29 的值。
Custom30
 custom30 string

指定 custom30 的值。 若要为 custom30 指定值，还必须在同一请求中为 custom29 指定一个值，这是因为其父子关系。

下载文档

操作 ID:
DownloadDocument

根据文档 ID 下载特定文档的版本。 如果最新为 true，则下载此文档的最新版本。 下载是流，不会在本地保存。

参数

名称 密钥 必需 类型 说明
文档 ID
 documentId True string

指定文档的 ID。 例如，“ACTIVE_USE！453.1”。
获取最新版本
 latest boolean

指定下载文档的最新版本。

返回

指示文件的内容。

文件内容
binary

创建工作区

操作 ID:
CreateWorkspace

基于所选模板创建新工作区。 工作区模板是一个预定义的工作区，其结构将复制到新工作区。 创建新工作区时，会自动强制实施对工作区模板的限制。

参数

名称 密钥 必需 类型 说明
库 ID
 libraryId True string

指定目标工作区的库 ID。
Template
 templateId True string

指定要用于创建工作区及其子工作区的工作区模板。
Name
 name True string

指定工作区的名称。
创建子级
 createChildren True string

指定创建所有文件夹（可选和必需）或仅创建所需文件夹。
工作区所有者
 owner string

指定工作区的所有者。 必须是 iManage Work 系统管理员才能设置工作区的所有者。
默认安全性
 default_security string

指定默认访问级别。 如果未指定，则使用所选模板的默认访问级别。
Description
 description string

指定有关工作区的其他信息。
Custom1
 custom1 string

指定要与新创建的工作区关联的 custom1 的值。 如果存在，此值将替代所选模板工作区的 custom1 值。 如果子文件夹设置了 custom1 值，则不会覆盖这些子文件夹的 custom1 值。
Custom2
 custom2 string

指定要与新创建的工作区关联的 custom2 的值。 若要为 custom2 指定值，还必须在同一请求中为 custom1 指定一个值，这是因为其父子关系。 如果存在，此值将替代所选模板工作区的 custom2 值。 如果子文件夹设置了 custom2 值，则不会覆盖这些子文件夹的 custom2 值。
Custom3
 custom3 string

指定 custom3 的值。
Custom4
 custom4 string

指定 custom4 的值。
Custom5
 custom5 string

指定 custom5 的值。
Custom6
 custom6 string

指定 custom6 的值。
Custom7
 custom7 string

指定 custom7 的值。
Custom8
 custom8 string

指定 custom8 的值。
Custom9
 custom9 string

指定 custom9 的值。
Custom10
 custom10 string

指定 custom10 的值。
Custom11
 custom11 string

指定 custom11 的值。
Custom12
 custom12 string

指定 custom12 的值。
Custom13
 custom13 string

指定 custom13 的值。
Custom14
 custom14 string

指定 custom14 的值。
Custom15
 custom15 string

指定 custom15 的值。
Custom16
 custom16 string

指定 custom16 的值。
Custom17
 custom17 double

指定 custom17 的值。
Custom18
 custom18 double

指定 custom18 的值。
Custom19
 custom19 double

指定 custom19 的值。
Custom20
 custom20 double

指定 custom20 的值。
Custom21
 custom21 string

以 ISO 8601 日期/时间格式指定 custom21 的值。
Custom22
 custom22 string

以 ISO 8601 日期/时间格式指定 custom22 的值。
Custom23
 custom23 string

以 ISO 8601 日期/时间格式指定 custom23 的值。
Custom24
 custom24 string

以 ISO 8601 日期/时间格式指定 custom24 的值。
Custom25
 custom25 boolean

指定 custom25 的值。
Custom26
 custom26 boolean

指定 custom26 的值。
Custom27
 custom27 boolean

指定 custom27 的值。
Custom28
 custom28 boolean

指定 custom28 的值。
Custom29
 custom29 string

指定 custom29 的值。
Custom30
 custom30 string

指定 custom30 的值。 若要为 custom30 指定值，还必须在同一请求中为 custom29 指定一个值，这是因为其父子关系。
外部为正常
 is_external_as_normal boolean

指定可以将工作区视为公共工作区。 如果设置为“true”且“default_security”不是“private”，请将“is_external”设置为“true”。
Project Custom1
 project_custom1 string

指定有关工作区的其他信息。 此字段不同于与内容项（如文档、工作区或文件夹）关联的元数据自定义字段。 这是无需设置格式且未验证的描述性文本。
Project Custom2
 project_custom2 string

指定有关工作区的其他信息。 此字段不同于与内容项（如文档、工作区或文件夹）关联的元数据自定义字段。 这是无需设置格式且未验证的描述性文本。
Project Custom3
 project_custom3 string

指定有关工作区的其他信息。 此字段不同于与内容项（如文档、工作区或文件夹）关联的元数据自定义字段。 这是无需设置格式且未验证的描述性文本。
工作区子类
 subclass string

根据工作区包含的文档的子类指定工作区的子类。

创建文档关系

操作 ID:
CreateDocumentRelation

在库中的指定文档之间创建关系。

参数

名称 密钥 必需 类型 说明
主文档 ID
 primaryDocumentId True string

指定要关联的主文档的 ID。 例如，“ACTIVE_US！453.1”。
相关文档 ID
 relatedDocumentId True string

指定要关联的文档的 ID。 例如，“ACTIVE_US！453.1”。

返回

response
object

删除文档

操作 ID:
DeleteDocument

删除指定的文档。

参数

名称 密钥 必需 类型 说明
文档 ID
 documentId True string

指定文档的 ID。 例如，“ACTIVE_US！453.1”。
删除所有版本
 deleteAllVersions True boolean

指定删除文档的所有版本。

删除文档关系

操作 ID:
DeleteDocumentRelation

删除库中指定文档之间的关系。

参数

名称 密钥 必需 类型 说明
主文档 ID
 primaryDocumentId True string

指定主文档的 ID。 例如，“ACTIVE_US！453.1”。
相关文档 ID
 relatedDocumentId True string

指定相关文档的 ID。 例如，“ACTIVE_US！453.1”。

返回

response
object

删除文档引用

操作 ID:
DeleteDocumentReference

从指定文件夹中删除文档引用。

参数

名称 密钥 必需 类型 说明
文档 ID
 documentId True string

指定文档的 ID。 例如，“ACTIVE_US！453.1”。
文件夹 ID
 folderId True string

指定文件夹的 ID。 例如，“ACTIVE_US！773”。

返回

response
object

在文档中设置核心扩展元数据属性

操作 ID:
SetCoreEMPropertiesForDocument

设置文档的核心扩展元数据属性。

参数

名称 密钥 必需 类型 说明
文档 ID
 documentId True string

指定文档的 ID。 例如，“ACTIVE_US！453.1”。
Name
 key True string

指定核心扩展元数据属性的名称。
价值
 value True string

指定要为核心扩展元数据属性设置的一个或多个值，用分号分隔。 若要取消设置值，请将键的值设置为用单引号或双引号包装的空字符串。

复制文档

操作 ID:
CopyDocument

将文档复制到指定文件夹。

参数

名称 密钥 必需 类型 说明
文档 ID
 documentId True string

指定文档的 ID。 例如，“ACTIVE_US！453.1”。
目标文件夹 ID
 folderId True string

指定要将文档复制到的目标文件夹 ID。 例如，“ACTIVE_US！987”。

返回

名称 路径 类型 说明
文档访问
 data.access string

指示文档或容器的访问级别权限集。 访问级别由作者或具有对项完全访问权限的用户设置。 可能的值为“no_access”、“read”、“read_write”、“full_access”。
别名
 data.alias string

指示本文档的别名。
作者
 data.author string

指示创建文档的用户的 ID。 例如，“JSMITH”。
作者说明
 data.author_description string

指示有关文档作者的其他信息。
Cc
 data.cc string

指示电子邮件被抄送给的收件人。 仅适用于电子邮件。
文档类
 data.class string

指示文档的类。
文档类说明
 data.class_description string

指示有关文档类的其他信息。
内容类型
 data.content_type string

指示文档内容类型。
文档创建日期
 data.create_date string

指示文档已导入到 iManage Work 系统中的日期和时间（采用 ISO 8601 格式）。 此日期可能与“file_create_date”不同。
数据库
 data.database string

指示存储文档的库。
文档默认安全性
 data.default_security string

指示默认安全访问级别。 可能的值为“inherit”、“private”、“view”、“public”。
文档编号
 data.document_number integer

指示文档的文档编号。
文档 URL
 data.document_url string

指示文档的可共享链接。
文档编辑日期
 data.edit_date string

指示文档的最新更改的日期和时间（采用 ISO 8601 格式）。
配置文件编辑日期
 data.edit_profile_date string

指示文档配置文件的最新更改的日期和时间（采用 ISO 8601 格式）。
文档扩展
 data.extension string

指示文档的文件扩展名（也称为应用程序扩展名）。
文件创建日期
 data.file_create_date string

指示文件的创建日期和时间（采用 ISO 8601 格式）。 该文件可能已在 iManage Work 系统之外创建。 此日期可能与“create_date”不同。
文件编辑日期
 data.file_edit_date string

指示文件的最新更改的日期和时间（采用 ISO 8601 格式）。 在上传到 iManage Work 系统之前，该文件可能已更改。
来自
 data.from string

指示电子邮件的发件人。 仅适用于电子邮件。
完整文件名
 data.full_file_name string

指示文档的完整文件名。 包括文件扩展名。
具有附件
 data.has_attachment boolean

指示电子邮件是否具有附件。 仅适用于电子邮件。
基本文档属性
 data.basic_properties string

指示包含基本文档属性的可嵌入的“”元素。
文档 ID
 data.id string

指示文档的 ID。 例如，“ACTIVE_US！453.1”。
可编制索引
 data.indexable boolean

指示文档是否由系统编制索引。
已签出
 data.is_checked_out boolean

指示文档是否已签出。
已声明
 data.is_declared boolean

指示文档是否声明为记录。 声明为记录的文档无法编辑或删除，但 iManage Work 系统管理员除外。
是外部的
 data.is_external boolean

指示文档是否与外部用户共享。
外部为正常
 data.is_external_as_normal boolean

指示文档是否为正常外部文档。
是 HIPAA
 data.is_hipaa boolean

指示文档是否已加密。
正在使用
 data.is_in_use boolean

指示文档是否正在使用。
文档链接
 data.iwl string

指示文档的 iManage 工作链接（iWL）。 iWL 用于由具有“read_write”或“full_access”的用户在受保护的视图模式下打开文档。
最后一个用户
 data.last_user string

指示最近编辑文档的用户的 ID。 例如，“JSMITH”。
上一个用户说明
 data.last_user_description string

指示最近编辑文档的最后一个用户的其他信息。
文档名称
 data.name string

指示文档的文件名。
Operator
 data.operator string

指示已签出文档或当前正在编辑其配置文件的用户的 ID。 例如，“JSMITH”。
运算符说明
 data.operator_description string

指示有关运算符的其他信息。
接收日期
 data.received_date string

指示收到电子邮件的日期和时间（采用 ISO 8601 格式）。 仅适用于电子邮件。
保留天数
 data.retain_days integer

指示文档符合存档条件的天数。 仅适用于非活动文档。
发送日期
 data.sent_date string

指示电子邮件的日期和时间（采用 ISO 8601 格式）。 仅适用于电子邮件。
文档大小
 data.size integer

指示文档的大小（以字节为单位）。
亚纲
 data.subclass string

指示文档的子类。
子类说明
 data.subclass_description string

指示有关文档的子类的其他信息。
到
 data.to string

指示电子邮件的收件人。 仅适用于电子邮件。
类型
 data.type string

指示文档类型。 例如，WORD for Microsoft Word。 有关当前类型的列表，请联系 iManage Work 系统管理员。
类型说明
 data.type_description string

指示有关文档类型的其他信息。
文档版本
 data.version integer

指示文档的版本号。
工作区 ID
 data.workspace_id string

指示文档工作区的 ID。 例如，“ACTIVE_US！427”。
工作区名称
 data.workspace_name string

指示文档工作区的名称。
Wstype
 data.wstype string

指示对象的 iManage Work 类型。 可能的值为“document”、“folder”、“workspace”、“email”、“document_shortcut”、“folder_shortcut”、“workspace_shortcut”、“user”。
Custom13
 data.custom13 string

指示 custom13 的值。
Custom14
 data.custom14 string

指示 custom14 的值。
Custom15
 data.custom15 string

指示 custom15 的值。
Custom16
 data.custom16 string

指示 custom16 的值。
Custom21
 data.custom21 string

指示 ISO 8601 日期/时间格式的 custom21 属性的值。
Custom22
 data.custom22 string

指示 ISO 8601 日期/时间格式的 custom22 属性的值。

复制权限

操作 ID:
CopyPermissions

将访问权限以及默认安全性从一个 iManage Work 对象复制到另一个 iManage Work 对象。 “复制类型”提供有关如何处理源和目标权限组合的选项。 “Overwrite”更新目标对象的用户、组和权限级别，以完全匹配源对象的级别。 “Merge”将保留目标对象上的所有用户和组，并将其与源合并，但在单个或组的权限级别冲突时：“Merge（悲观）”采用较低权限，而“Merge（乐观）”对冲突的用户或组具有更高的权限。

参数

名称 密钥 必需 类型 说明
源对象类型
 sourceObjectType True string

指定源对象的类型。
源对象 ID
 sourceObjectId True string

指定从中复制权限的对象 ID。 文档 ID 的示例为“ACTIVE_US！453.1”。 文件夹或工作区 ID 的示例为“ACTIVE_US！123”。
目标对象类型
 targetObjectType True string

指定目标对象的类型。
目标对象 ID
 targetObjectId True string

指定将权限复制到的对象 ID。 文档 ID 的示例为“ACTIVE_US！453.1”。 文件夹或工作区 ID 的示例为“ACTIVE_US！123”。
复制类型
 copyType True string

指定将源对象权限与目标对象权限合并，或使用源权限覆盖目标对象权限。 有关详细信息，请参阅作说明。
复制默认安全性
 copyDefaultSecurity True boolean

指定将源对象的默认安全性复制到目标对象。 如果源对象的默认安全性为“inherit”，则会将继承的默认安全性从源复制到目标对象。

返回

Body
UpdatePermissionsResponse

提升文档版本

操作 ID:
PromoteDocumentVersion

将文档的现有版本提升到最新版本。 新版本是从指定的日记 ID 或版本创建的，然后提升到最新版本。 必须指定日记 ID 或版本，但不能同时指定这两者。

参数

名称 密钥 必需 类型 说明
文档 ID
 documentId True string

指定文档的 ID。 例如，“ACTIVE_US！453.1”。
版本
 version integer

指定要用作新升级版本的基础的版本号。
日记 ID
 journalId string

指定要用作新升级版本的基础的日记 ID。
注释
 comment string

指定有关文档的其他信息。
别名
 alias string

指定此文档的别名。
作者
 author string

指定创建文档的用户的 ID。 例如，“JSMITH”。
文档类
 class string

指定文档类。
文档默认安全性
 default_security string

指定默认安全访问级别。
已声明
 is_declared boolean

指定是否将文档的新版本声明为记录。 声明为记录的文档无法编辑或删除，但 iManage Work 系统管理员除外。
是 HIPAA
 is_hipaa boolean

指定是否要加密文档的新版本。
文档名称
 name string

指定文档的文件名。
Operator
 operator string

指定已签出文档或当前正在编辑文档配置文件的用户的 ID。 例如，“JSMITH”。
保留天数
 retain_days integer

指定非活动文档符合存档条件的天数。
亚纲
 subclass string

指定文档的子类。
Custom1
 custom1 string

指定 custom1 的值。
Custom2
 custom2 string

指定 custom2 的值。 若要为 custom2 指定值，还必须在同一请求中为 custom1 指定一个值，这是因为其父子关系。
Custom3
 custom3 string

指定 custom3 的值。
Custom4
 custom4 string

指定 custom4 的值。
Custom5
 custom5 string

指定 custom5 的值。
Custom6
 custom6 string

指定 custom6 的值。
Custom7
 custom7 string

指定 custom7 的值。
Custom8
 custom8 string

指定 custom8 的值。
Custom9
 custom9 string

指定 custom9 的值。
Custom10
 custom10 string

指定 custom10 的值。
Custom11
 custom11 string

指定 custom11 的值。
Custom12
 custom12 string

指定 custom12 的值。
Custom13
 custom13 string

指定 custom13 的值。
Custom14
 custom14 string

指定 custom14 的值。
Custom15
 custom15 string

指定 custom15 的值。
Custom16
 custom16 string

指定 custom16 的值。
Custom17
 custom17 double

指定 custom17 的值。
Custom18
 custom18 double

指定 custom18 的值。
Custom19
 custom19 double

指定 custom19 的值。
Custom20
 custom20 double

指定 custom20 的值。
Custom21
 custom21 string

指定 ISO 8601 日期/时间格式的 custom21 属性的值。
Custom22
 custom22 string

指定 ISO 8601 日期/时间格式的 custom22 属性的值。
Custom23
 custom23 string

指定 ISO 8601 日期/时间格式的 custom23 属性的值。
Custom24
 custom24 string

指定 ISO 8601 日期/时间格式的 custom24 属性的值。
Custom25
 custom25 boolean

指定 custom25 的值。
Custom26
 custom26 boolean

指定 custom26 的值。
Custom27
 custom27 boolean

指定 custom27 的值。
Custom28
 custom28 boolean

指定 custom28 的值。
Custom29
 custom29 string

指定 custom29 的值。
Custom30
 custom30 string

指定 custom30 的值。 若要为 custom30 指定值，还必须在同一请求中为 custom29 指定一个值，这是因为其父子关系。

搜索工作区

操作 ID:
SearchWorkspaces

搜索工作区。

参数

名称 密钥 必需 类型 说明
库 ID
 libraryId True string

指定目标工作区的库 ID。
Title
 name string

指定要在工作区的名称属性中搜索的字符串。 此搜索不区分大小写。
所有者
 owner string

指定要与与工作区关联的所有者匹配的字符串。 此搜索不区分大小写。
关键字
 anywhere string

指定要在工作区配置文件中的任何位置搜索的文本。 此搜索不区分大小写。
Description
 description string

指定要在工作区的说明属性中搜索的文本。 此搜索不区分大小写。
亚纲
 subclass string

指定要与与工作区关联的子类值匹配的值。 此搜索不区分大小写。
Custom1
 custom1 string

指定要与与工作区关联的 custom1 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom2
 custom2 string

指定要与与工作区关联的 custom2 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom3
 custom3 string

指定要与与工作区关联的 custom3 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom4
 custom4 string

指定要与与工作区关联的 custom4 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom5
 custom5 string

指定要与工作区关联的 custom5 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom6
 custom6 string

指定要与工作区关联的 custom6 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom7
 custom7 string

指定要与与工作区关联的 custom7 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom8
 custom8 string

指定要与与工作区关联的 custom8 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom9
 custom9 string

指定要与与工作区关联的 custom9 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom10
 custom10 string

指定要与与工作区关联的 custom10 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom11
 custom11 string

指定要与与工作区关联的 custom11 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom12
 custom12 string

指定要与与工作区关联的 custom12 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom13
 custom13 string

指定要与与工作区关联的 custom13 值匹配的值。 此搜索不区分大小写。 支持通配符 \ 和部分匹配项。
Custom14
 custom14 string

指定要与与工作区关联的 custom14 值匹配的值。 此搜索不区分大小写。 支持通配符 \ 和部分匹配项。
Custom15
 custom15 string

指定要与与工作区关联的 custom15 值匹配的值。 此搜索不区分大小写。 支持通配符 \ 和部分匹配项。
Custom16
 custom16 string

指定要与与工作区关联的 custom16 值匹配的值。 此搜索不区分大小写。 支持通配符 \ 和部分匹配项。
Custom17
 custom17 string

指定要与与工作区关联的 custom17 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom18
 custom18 string

指定要与与工作区关联的 custom18 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom19
 custom19 string

指定要与与工作区关联的 custom19 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom20
 custom20 string

指定要与与工作区关联的 custom20 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom21 （下限）
 custom21_from string

指定在与工作区关联的 custom21 属性中搜索的下限（采用 ISO 8601 日期/时间格式）。 此搜索不区分大小写。 对于工作区，将针对 iManage Work 安装自定义此属性的使用。
Custom21 （上限）
 custom21_to string

指定在与工作区关联的 custom21 属性中搜索的上限（采用 ISO 8601 日期/时间格式）。 此搜索不区分大小写。 对于工作区，将针对 iManage Work 安装自定义此属性的使用。
Custom22 （下限）
 custom22_from string

指定在与工作区关联的 custom22 属性中搜索的下限（采用 ISO 8601 日期/时间格式）。 此搜索不区分大小写。 对于工作区，将针对 iManage Work 安装自定义此属性的使用。
Custom22 （上限）
 custom22_to string

指定在与工作区关联的 custom22 属性中搜索的上限（采用 ISO 8601 日期/时间格式）。 此搜索不区分大小写。 对于工作区，将针对 iManage Work 安装自定义此属性的使用。
Custom23 （下限）
 custom23_from string

指定在与工作区关联的 custom23 属性中搜索的下限（采用 ISO 8601 日期/时间格式）。 此搜索不区分大小写。 对于工作区，将针对 iManage Work 安装自定义此属性的使用。
Custom23 （上限）
 custom23_to string

指定在与工作区关联的 custom23 属性中搜索的上限（采用 ISO 8601 日期/时间格式）。 此搜索不区分大小写。 对于工作区，将针对 iManage Work 安装自定义此属性的使用。
Custom24 （下限）
 custom24_from string

指定在与工作区关联的 custom24 属性中搜索的下限（采用 ISO 8601 日期/时间格式）。 此搜索不区分大小写。 对于工作区，将针对 iManage Work 安装自定义此属性的使用。
Custom24 （上限）
 custom24_to string

指定在与工作区关联的 custom24 属性中搜索的上限（采用 ISO 8601 日期/时间格式）。 此搜索不区分大小写。 对于工作区，将针对 iManage Work 安装自定义此属性的使用。
Custom25
 custom25 boolean

指定要与与工作区关联的 custom25 值匹配的值。
Custom26
 custom26 boolean

指定要与与工作区关联的 custom26 值匹配的值。
Custom27
 custom27 boolean

指定要与与工作区关联的 custom27 值匹配的值。
Custom28
 custom28 boolean

指定要与与工作区关联的 custom28 值匹配的值。
Custom29
 custom29 string

指定要与与工作区关联的 custom29 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom30
 custom30 string

指定要与与工作区关联的 custom30 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。 若要为 custom30 指定值，还必须在同一请求中为 custom29 指定一个值，这是因为其父子关系。

搜索文件夹

操作 ID:
SearchFolders

搜索文件夹。

参数

名称 密钥 必需 类型 说明
库 ID
 libraryId True string

指定目标文件夹的库 ID。
容器 ID
 container_id string

指定要从中返回文件夹的工作区或文件夹的 ID。 例如，“ACTIVE_US！987”。 如果提供了此参数，则仅从指定的工作区或文件夹中返回文件夹。
文件夹说明
 description string

指定要在文件夹的说明属性中找到的值。 此搜索不区分大小写。 支持部分匹配。
文件夹电子邮件地址
 email string

指定要与文件夹电子邮件地址匹配的电子邮件地址。 例如，“email1234@ajubalaw.com”。
文件夹名称
 name string

指定要在文件夹的名称属性中找到的值。 此搜索不区分大小写。 支持部分匹配。
文件夹所有者
 owner string

指定要与与文件夹关联的所有者匹配的字符串。 此搜索不区分大小写。 支持部分匹配。
工作区名称
 workspace_name string

指定文件夹所属的父工作区的名称。 此搜索不区分大小写。 支持部分匹配。

搜索核心扩展元数据分类节点值

操作 ID:
SearchCoreEMTaxonomyNodeValues

搜索与指定搜索条件匹配的核心扩展元数据分类节点值。

参数

名称 密钥 必需 类型 说明
库 ID
 libraryId True string

指定要对其执行搜索的库的 ID。
分类属性
 taxonomyProperty True string

指定要为其搜索节点值的分类属性。
ID
 id string

指定分类节点值的显示标识符。 此搜索不区分大小写。 不支持部分匹配项。
Query
 query string

使用通配符 \ 搜索指定匹配分类节点值的查询，为显示标识符或说明提供部分匹配项。
节点状态
 enabled_state string

指定仅返回启用或禁用的分类节点值。
包含路径
 include_path boolean

指定返回匹配节点值的完整路径。 路径是一个有序列表，从分类中的顶级节点开始，然后所有节点都指向匹配节点的直接父节点。
上级节点 SSID
 children_of_ssid string

指定上级分类节点的唯一系统生成的 ID，以限制搜索。
仅即时子级
 immediate_children_only boolean

指定将搜索结果限制为“上级节点 SSID”指定的分类节点的直接后代。 搜索可以限制为分类的根级别，方法是为包装在单引号或双引号中的“上级节点 SSID”指定空字符串。

返回

名称 路径 类型 说明
SSID
 data.topMatchingResult.created_by.ssid string

指示创建最匹配节点值的用户的唯一系统生成的 ID。
创建日期
 data.topMatchingResult.create_date string

指示创建最匹配节点值的日期和时间（采用 ISO 8601 格式）。
Description
 data.topMatchingResult.description string

指示最匹配节点值的说明。
SSID
 data.topMatchingResult.edited_by.ssid string

指示上次编辑顶部匹配节点值的用户的唯一系统生成的 ID。
编辑日期
 data.topMatchingResult.edit_date string

指示上次编辑最匹配的节点值的日期和时间（采用 ISO 8601 格式）。
已启用
 data.topMatchingResult.enabled boolean

指示是否启用了最匹配的节点值。
ID
 data.topMatchingResult.id string

指示顶部匹配节点值的显示标识符。
SSID
 data.topMatchingResult.parent.ssid string

指示最匹配节点值的直接父节点的唯一系统生成的 ID。
SSID
 data.topMatchingResult.ssid string

指示最匹配节点值的唯一系统生成的 ID。
路径
 data.topMatchingResult.path array of object

指示最匹配节点值的完整路径。 路径是一个有序列表，从分类中的顶级节点开始，然后所有节点都指向匹配节点的直接父节点。
每个 ID
 data.topMatchingResult.path.id string

指示顶部匹配节点路径中节点值的显示标识符。
每个 SSID
 data.topMatchingResult.path.ssid string

指示顶部匹配节点路径中节点值的唯一系统生成的 ID。
核心扩展元数据分类搜索结果
 data.results array of TaxonomyNodeValue

指示与搜索匹配的一个或多个核心扩展元数据分类节点值。
所有分类节点 SSID
 data.all_taxonomy_ssids string

指示所有分类节点 SSID 的列表，这些 SSID 串联为字符串，并用分号分隔。

搜索用户

操作 ID:
SearchUsers

搜索符合指定搜索条件的 iManage Work 用户。

参数

名称 密钥 必需 类型 说明
电子邮件 ID
 email string

指定要搜索的电子邮件 ID。 例如，“JSMITH@XYZ.COM”。

返回

名称 路径 类型 说明
允许登录
 data.topMatchingUser.allow_logon boolean

指示是否允许用户登录。
Custom1
 data.topMatchingUser.custom1 string

指示有关用户的其他信息。
Custom2
 data.topMatchingUser.custom2 string

指示有关用户的其他信息。
Custom3
 data.topMatchingUser.custom3 string

指示有关用户的其他信息。
名录 ID
 data.topMatchingUser.directory_id string

指示外部目录（如 ADFS）中的 ID，该 ID 用于用户配置文件同步。
可分辨名称
 data.topMatchingUser.distinguished_name string

指示对象的名称，该对象表示将条目跟踪回 LDAP 树根的名称的完全限定路径。
编辑日期
 data.topMatchingUser.edit_date string

指示最近对用户配置文件所做的更改的日期和时间（采用 ISO 8601 格式）。
Email
 data.topMatchingUser.email string

指示用户的电子邮件 ID。
Exchange 自动发现 URL
 data.topMatchingUser.exch_autodiscover string

指示用户的交换服务器详细信息。
Extension
 data.topMatchingUser.extension string

指示用户的电话号码分机。
失败的登录尝试
 data.topMatchingUser.failed_logins integer

指示用户的当前登录尝试失败次数。
传真
 data.topMatchingUser.fax string

指示用户的传真号。
强制更改密码
 data.topMatchingUser.force_password_change boolean

指示用户在下次登录时必须更改其密码。 仅适用于虚拟用户，由“user_nos”值“2”表示。
完整姓名
 data.topMatchingUser.full_name string

指示用户的全名。
概况
 data.topMatchingUser.general string

指示有关用户的常规信息。
ID
 data.topMatchingUser.id string

指示用户的 ID。 例如，“JSMITH”。
是外部的
 data.topMatchingUser.is_external boolean

指示外部用户。 外部用户具有有限的访问权限，通常用于临时团队成员、顾问或组织外部的成员。
上次同步时间
 data.topMatchingUser.last_sync_ts string

指示用户配置文件的最后一个同步时间（采用 ISO 8601 日期/时间格式），其中包含外部目录，例如 LDAP 或 Microsoft Active Directory （ADFS）。
位置
 data.topMatchingUser.location string

指示用户的地理位置。
密码永不过期
 data.topMatchingUser.password_never_expire boolean

指示用户的密码是否永不过期。
电话号码
 data.topMatchingUser.phone string

指示用户的电话号码。
首选库
 data.topMatchingUser.preferred_library string

指示首选库。 首选库是用户的默认库。 每个用户必须有一个首选库。
密码更改时间
 data.topMatchingUser.pwd_changed_ts string

指示用户上次更改密码的时间（采用 ISO 8601 日期/时间格式）。 这仅适用于虚拟用户（其用户 NOS 为 2）。
SSID
 data.topMatchingUser.ssid string

指示用户的唯一系统生成的 ID。
域名
 data.topMatchingUser.user_domain string

指示用户的目录服务的完全限定域名。
扩展 ID
 data.topMatchingUser.user_id_ex string

指示从外部目录（如 Microsoft Active Directory（ADFS）接收的用户 ID 的原始值。
NOS
 data.topMatchingUser.user_nos integer

指示用户从中同步的作系统的类型。 可能的值为 2（虚拟用户）和 6（企业用户）。 有关详细信息，请联系 iManage Work 系统管理员。
编号
 data.topMatchingUser.user_num integer

指示用户的数值系统 ID。
results
 data.results array of UserProfileInArray

更新工作区

操作 ID:
UpdateWorkspace

更新指定工作区的信息。 若要删除字符串字段的现有值，请将字段的值设置为用单引号或双引号包装的空字符串。

参数

名称 密钥 必需 类型 说明
工作区 ID
 id True string

指定要更新的工作区的 ID。 例如，“ACTIVE_US！427”。
Name
 name string

指定工作区的名称。
工作区所有者
 owner string

指定工作区的所有者。
Custom1
 custom1 string

指定 custom1 的值。
Custom2
 custom2 string

指定 custom2 的值。 若要为 custom2 指定值，还必须在同一请求中为 custom1 指定一个值，这是因为其父子关系。
Custom3
 custom3 string

指定 custom3 的值。
Custom4
 custom4 string

指定 custom4 的值。
Custom5
 custom5 string

指定 custom5 的值。
Custom6
 custom6 string

指定 custom6 的值。
Custom7
 custom7 string

指定 custom7 的值。
Custom8
 custom8 string

指定 custom8 的值。
Custom9
 custom9 string

指定 custom9 的值。
Custom10
 custom10 string

指定 custom10 的值。
Custom11
 custom11 string

指定 custom11 的值。
Custom12
 custom12 string

指定 custom12 的值。
Custom13
 custom13 string

指定 custom13 的值。
Custom14
 custom14 string

指定 custom14 的值。
Custom15
 custom15 string

指定 custom15 的值。
Custom16
 custom16 string

指定 custom16 的值。
Custom17
 custom17 double

指定 custom17 的值。
Custom18
 custom18 double

指定 custom18 的值。
Custom19
 custom19 double

指定 custom19 的值。
Custom20
 custom20 double

指定 custom20 的值。
Custom21
 custom21 string

以 ISO 8601 日期/时间格式指定 custom21 的值。
Custom22
 custom22 string

以 ISO 8601 日期/时间格式指定 custom22 的值。
Custom23
 custom23 string

以 ISO 8601 日期/时间格式指定 custom23 的值。
Custom24
 custom24 string

以 ISO 8601 日期/时间格式指定 custom24 的值。
Custom25
 custom25 boolean

指定 custom25 的值。
Custom26
 custom26 boolean

指定 custom26 的值。
Custom27
 custom27 boolean

指定 custom27 的值。
Custom28
 custom28 boolean

指定 custom28 的值。
Custom29
 custom29 string

指定 custom29 的值。
Custom30
 custom30 string

指定 custom30 的值。 若要为 custom30 指定值，还必须在同一请求中为 custom29 指定一个值，这是因为其父子关系。
默认安全性
 default_security string

指定默认安全访问级别。
Description
 description string

指定有关工作区的其他信息。
外部为正常
 is_external_as_normal boolean

指定是否可以将工作区视为公共工作区。 如果设置为“true”且“default_security”不是“private”，则“is_external”设置为“true”。
Project Custom1
 project_custom1 string

指定有关工作区的其他信息。 此字段不同于与内容项（如文档、工作区或文件夹）关联的元数据自定义字段。 这是无需设置格式且未验证的描述性文本。
Project Custom2
 project_custom2 string

指定有关工作区的其他信息。 此字段不同于与内容项（如文档、工作区或文件夹）关联的元数据自定义字段。 这是无需设置格式且未验证的描述性文本。
Project Custom3
 project_custom3 string

指定有关工作区的其他信息。 此字段不同于与内容项（如文档、工作区或文件夹）关联的元数据自定义字段。 这是无需设置格式且未验证的描述性文本。
工作区子类
 subclass string

根据工作区包含的文档的子类指定工作区的子类。

更新工作流状态

操作 ID:
UpdateWorkflowState

更新工作流运行的状态。 此作只能在已创建的工作流中使用，以从 iManage 提供的触发器开始。

参数

名称 密钥 必需 类型 说明
库 ID
 libraryId True string

指定定义工作流的库的 ID。
State
 state True string

指定工作流运行的当前状态。
状态
 status string

指定工作流运行的当前状态。 最大长度为 128 个字符。
状态消息
 statusMessage string

指定工作流运行的当前状态的自定义消息。 最大长度为 256 个字符。

返回

response
object

更新当前或创建新文档版本

操作 ID:
UpdateOrCreateNewDocVersion

更新文档的指定版本，或创建新版本。 此作可以更新文档的配置文件和内容。 如果指定了“更新当前版本”选项，则文档将替换为新文档，并维护上一个文档的配置文件。 如果指定了“创建新版本”，则会创建继承文件夹配置文件的文档的新版本。 成功执行作后，将返回文档配置文件。

参数

名称 密钥 必需 类型 说明
更新或创建新版本
 updateOrCreate True string

指定更新文档的当前版本或创建新版本。
现有文档 ID
 documentId True string

指定现有文档的 ID。 例如，“ACTIVE_US！556.1”。
保持锁定
 keep_locked boolean

指定上传后是否保留文档锁。
注释
 comment string

指定有关更新的其他信息。
文档名称
 name string

指定文档的名称。
作者
 author string

指定创建文档的用户的 iManage 工作 ID。
Operator
 operator string

指定已签出文档或当前正在编辑文档配置文件的用户的 ID。 例如，“JSMITH”。
Class
 class string

指定用于标识和区分文档的类。 文档类按流派、部门、区域等进行分类。
亚纲
 subclass string

指定用于标识和区分文档的子类。 文档子类按流派、部门、区域等分类。
默认安全性
 default_security string

指定默认安全访问级别。 可能的值为“inherit”、“private”、“view”、“public”。
是 HIPAA
 is_hipaa boolean

指定文档是否要加密。
保留天数
 retain_days integer

指定文档在标记为存档之前必须处于非活动状态的天数。
文件内容
 file True file

指定文件的内容。
文件创建日期
 file_create_date date-time

指定文件的日期和时间（采用 ISO 8601 格式）。 该文件可能已在 iManage Work 系统外部创建。 此日期可能与“create_date”不同。 create_date是 iManage Work 系统创建或导入文件的日期。
文件编辑日期
 file_edit_date date-time

指定文件的最新更改的日期和时间（采用 ISO 8601 格式）。 在上传到 iManage Work 系统之前，该文件可能已更改。
Custom1
 custom1 string

指定 custom1 的值。
Custom2
 custom2 string

指定 custom2 的值。 若要为 custom2 指定值，还必须在同一请求中为 custom1 指定一个值，这是因为其父子关系。
Custom3
 custom3 string

指定 custom3 的值。
Custom4
 custom4 string

指定 custom4 的值。
Custom5
 custom5 string

指定 custom5 的值。
Custom6
 custom6 string

指定 custom6 的值。
Custom7
 custom7 string

指定 custom7 的值。
Custom8
 custom8 string

指定 custom8 的值。
Custom9
 custom9 string

指定 custom9 的值。
Custom10
 custom10 string

指定 custom10 的值。
Custom11
 custom11 string

指定 custom11 的值。
Custom12
 custom12 string

指定 custom12 的值。
Custom13
 custom13 string

指定 custom13 的值。
Custom14
 custom14 string

指定 custom14 的值。
Custom15
 custom15 string

指定 custom15 的值。
Custom16
 custom16 string

指定 custom16 的值。
Custom17
 custom17 double

指定 custom17 的值。
Custom18
 custom18 double

指定 custom18 的值。
Custom19
 custom19 double

指定 custom19 的值。
Custom20
 custom20 double

指定 custom20 的值。
Custom21
 custom21 string

以 ISO 8601 日期/时间格式指定 custom21 的值。
Custom22
 custom22 string

以 ISO 8601 日期/时间格式指定 custom22 的值。
Custom23
 custom23 string

以 ISO 8601 日期/时间格式指定 custom23 的值。
Custom24
 custom24 string

以 ISO 8601 日期/时间格式指定 custom24 的值。
Custom25
 custom25 boolean

指定 custom25 的值。
Custom26
 custom26 boolean

指定 custom26 的值。
Custom27
 custom27 boolean

指定 custom27 的值。
Custom28
 custom28 boolean

指定 custom28 的值。
Custom29
 custom29 string

指定 custom29 的值。
Custom30
 custom30 string

指定 custom30 的值。 若要为 custom30 指定值，还必须在同一请求中为 custom29 指定一个值，这是因为其父子关系。

更新文档配置文件

操作 ID:
UpdateDocumentProfile

对文档配置文件执行更新。 在更新文档配置文件时不得使用文档，并且无法更新签出的文档的配置文件。 返回作后更新的文档配置文件。

参数

名称 密钥 必需 类型 说明
别名
 alias string

指定此文档的别名。
作者
 author string

指定创建文档的用户的 ID。 例如，“JSMITH”。
注释
 comment string

指定有关文档的其他信息。
文档默认安全性
 default_security string

指定默认安全访问级别。
文档 ID
 documentId True string

指定文档的 ID。 例如，“ACTIVE_US！453.1”。
已声明
 is_declared boolean

指定是否将文档声明为记录。 声明为记录的文档无法编辑或删除，但 iManage Work 系统管理员除外。
是 HIPAA
 is_hipaa boolean

指定文档是否要加密。
审核注释
 audit_comment string

指定有关文档配置文件更新的其他信息。
文档类
 class string

指定文档类。
文档名称
 name string

指定文档的文件名。
Operator
 operator string

指定用户的 ID，该文档已签出或当前正在编辑文档的配置文件。 例如，“JSMITH”。
保留天数
 retain_days integer

指定非活动文档符合存档条件的天数。
亚纲
 subclass string

指定文档的子类。
Custom1
 custom1 string

指定 custom1 的值。
Custom2
 custom2 string

指定 custom2 的值。 若要为 custom2 指定值，还必须在同一请求中为 custom1 指定一个值，这是因为其父子关系。
Custom3
 custom3 string

指定 custom3 的值。
Custom4
 custom4 string

指定 custom4 的值。
Custom5
 custom5 string

指定 custom5 的值。
Custom6
 custom6 string

指定 custom6 的值。
Custom7
 custom7 string

指定 custom7 的值。
Custom8
 custom8 string

指定 custom8 的值。
Custom9
 custom9 string

指定 custom9 的值。
Custom10
 custom10 string

指定 custom10 的值。
Custom11
 custom11 string

指定 custom11 的值。
Custom12
 custom12 string

指定 custom12 的值。
Custom13
 custom13 string

指定 custom13 的值。
Custom14
 custom14 string

指定 custom14 的值。
Custom15
 custom15 string

指定 custom15 的值。
Custom16
 custom16 string

指定 custom16 的值。
Custom17
 custom17 double

指定 custom17 的值。
Custom18
 custom18 double

指定 custom18 的值。
Custom19
 custom19 double

指定 custom19 的值。
Custom20
 custom20 double

指定 custom20 的值。
Custom21
 custom21 string

指定 ISO 8601 日期/时间格式的 custom21 属性的值。
Custom22
 custom22 string

指定 ISO 8601 日期/时间格式的 custom22 属性的值。
Custom23
 custom23 string

指定 ISO 8601 日期/时间格式的 custom23 属性的值。
Custom24
 custom24 string

指定 ISO 8601 日期/时间格式的 custom24 属性的值。
Custom25
 custom25 boolean

指定 custom25 的值。
Custom26
 custom26 boolean

指定 custom26 的值。
Custom27
 custom27 boolean

指定 custom27 的值。
Custom28
 custom28 boolean

指定 custom28 的值。
Custom29
 custom29 string

指定 custom29 的值。
Custom30
 custom30 string

指定 custom30 的值。 若要为 custom30 指定值，还必须在同一请求中为 custom29 指定一个值，这是因为其父子关系。

更新权限

操作 ID:
UpdatePermissions

更新对象的权限。

参数

名称 密钥 必需 类型 说明
对象类型
 objectType True string

指定对象的类型。
对象标识符
 objectId True string

指定文档、文件夹或工作区的 ID。 文档 ID 的示例为“ACTIVE_US！453.1”。 文件夹或工作区 ID 的示例为“ACTIVE_US！123”。
访问级别
 access_level True string

指定访问级别。
用户
 users string

指定要设置访问级别的一个或多个用户，以分号分隔。
Groups
 groups string

指定要设置访问级别的一个或多个组，用分号分隔。

返回

Body
UpdatePermissionsResponse

更新默认安全性

操作 ID:
UpdateDefaultSecurity

更新文档、文件夹或工作区的默认安全性。

参数

名称 密钥 必需 类型 说明
对象类型
 objectType True string

指定对象的类型。
对象标识符
 objectId True string

指定文档、文件夹或工作区的 ID。 文档 ID 的示例为“ACTIVE_US！453.1”。 文件夹或工作区 ID 的示例为“ACTIVE_US！123”。
默认安全性
 default_security True string

指定对象的默认安全性。

返回

名称 路径 类型 说明
默认安全性
 data.default_security string

指示对象的默认安全性。 可能的值为“inherit”、“public”、“view”或“private”。
访问权限
 data.acl AccessPermissions

指示一个或多个用户和/或组的访问权限集合。

添加文档历史记录条目

操作 ID:
AddDocumentHistoryEntry

将条目添加为文档历史记录中的事件。

参数

名称 密钥 必需 类型 说明
文档 ID
 documentId True string

指定文档的 ID。 例如，“ACTIVE_US！453.1”。
Activity
 activity_code True integer

指定对文档执行的活动的类型。
注释
 comments string

指定有关活动的任何其他信息。
持续时间
 duration integer

指定用户处理文档所花费的秒数。

返回

名称 路径 类型 说明
数据
 data object

添加文档引用

操作 ID:
AddDocumentReference

在另一个文件夹中添加文档引用或文档快捷方式。

参数

名称 密钥 必需 类型 说明
文档 ID
 documentId True string

指定文档的 ID。 例如，“ACTIVE_US！453.1”。
文件夹 ID
 folderId True string

指定文件夹的 ID。 例如，“ACTIVE_US！773”。

返回

名称 路径 类型 说明
文档参考 ID
 data.id string

指示文档引用和document_shortcut。
Wstype
 data.wstype string

指示对象的 iManage Work 类型。 可能的值为“document”、“document_shortcut”、“email”。

移动文档

操作 ID:
MoveDocument

将文档移动到指定文件夹。

参数

名称 密钥 必需 类型 说明
父文件夹 ID
 folderId True string

指定父文件夹的文件夹 ID。 例如，“ACTIVE_US！987”。
文档 ID
 documentId True string

指定文档的 ID。 例如，“ACTIVE_US！453.1”。
目标文件夹 ID
 destination_folder_id True string

指定要将文档移动到的目标文件夹 ID。 例如，“ACTIVE_US！987”。
应用目标配置文件
 update_profile boolean

指定是否使用目标文件夹配置文件更新文档配置文件。
应用目标安全性
 update_security boolean

指定是否使用目标文件夹安全性更新文档安全性。 仅当更新配置文件设置为 true 时，此参数才适用。
时间线注释
 comments string

指定有关作的其他信息。 这些注释在文档的时间线中可见。

编辑名称/值对

操作 ID:
EditNVP

创建、更新或删除文档、文件夹或工作区的名称/值对属性。 若要删除名称值对，请将键的值设置为用单引号或双引号包装的空字符串。

参数

名称 密钥 必需 类型 说明
对象类型
 objectType True string

指定对象的类型。 可能的值为“document”、“folder”、“workspace”。
对象标识符
 objectId True string

指定文档、文件夹或工作区的 ID。 文档 ID 的示例为“ACTIVE_US！453.1”。 文件夹或工作区 ID 的示例为“ACTIVE_US！123”。
名称值对
 nameValuePairs object

指定本文档的自由格式名称和值对。

获取受托人

操作 ID:
GetTrustees

获取具有文档、文件夹或工作区特定权限的受托人列表。 受托人可以是用户或组。

参数

名称 密钥 必需 类型 说明
对象类型
 objectType True string

指定对象的类型。
对象标识符
 objectId True string

指定文档、文件夹或工作区的 ID。 文档 ID 的示例为“ACTIVE_US！453.1”。 文件夹或工作区 ID 的示例为“ACTIVE_US！123”。

返回

名称 路径 类型 说明
数据
 data array of object

指示具有文档、文件夹或工作区特定权限的受托人列表。 受托人可以是用户或组。
完整姓名
 data.full_name string

指示受托人的完整名称。
ID
 data.id string

指示受托人的 ID。 这可以是组 ID 或用户 ID。 例如，“JSMITH”或“MARKETING”。
SSID
 data.ssid string

指示受托人的唯一系统生成的 ID。
类型
 data.type string

指示返回的实体的类型。 可能的值为“user”或“group”。

获取子类

操作 ID:
GetSubclasses

获取与指定条件匹配的所有库子类。

参数

名称 密钥 必需 类型 说明
库 ID
 libraryId True string

指定目标子类的库 ID。
类 ID
 classId True string

指定类的 ID，该类是此子类的父类。 例如，“PETITION”。
子类 ID
 alias string

指定要搜索的子类的 ID。 可以是逗号分隔的列表。 支持通配符 \ 。 使用通配符时，支持部分匹配项。
默认安全性
 default_security string

指定默认安全访问级别。
Description
 description string

指定要在说明字段中匹配的文本。 支持通配符 \ 。 使用通配符时，支持部分匹配项。
回波
 echo boolean

指定是否可以将子类回显到用户的本地硬盘驱动器。 这是为了方便脱机工作。
HIPAA
 hipaa boolean

指定是否返回符合 HIPAA 的子类。
Query
 query string

指定要与子类 ID 或说明字段匹配的文本。 支持通配符 \ 。 支持部分匹配。

返回

名称 路径 类型 说明
最匹配的子类 ID
 data.topMatchingId string

指示最匹配子类的 ID。
顶部匹配子类说明
 data.topMatchingDescription string

指示顶级匹配子类的说明。
results
 data.results array of object
默认安全性
 data.results.default_security string

指示默认的安全访问级别。 可能的值为“public”、“view”、“private”。
Description
 data.results.description string

指示有关子类的其他信息。 最大长度为 255 个字符。
是 HIPAA
 data.results.hipaa boolean

指示文档是否已加密。
ID
 data.results.id string

指示用于创建或修改文档配置文件信息的子类的 ID。 例如，“GUARDIANSHIP”。
父 ID
 data.results.parent.id string

指示子类的父类 ID。
必填字段
 data.results.required_fields array of string

指示创建或更新此子类的文档时要输入的必需自定义属性。
Retain
 data.results.retain integer

指示将此子类的非活动文档标记为过期之前的天数。
为阴影
 data.results.shadow boolean

指示签入此子类的文档是否在用户的本地计算机上被隐藏（保留）。

获取工作区模板

操作 ID:
GetWorkspaceTemplates

获取库中可用的模板列表。 工作区模板是预定义的工作区，其结构是为新工作区复制的。

参数

名称 密钥 必需 类型 说明
库 ID
 libraryId True string

指定目标工作区的库 ID。
Custom1
 custom1 string

指定要与工作区模板关联的 custom1 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom2
 custom2 string

指定要与工作区模板关联的 custom2 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom3
 custom3 string

指定要与与工作区模板关联的 custom3 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom4
 custom4 string

指定要与工作区模板关联的 custom4 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom5
 custom5 string

指定要与与工作区模板关联的 custom5 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom6
 custom6 string

指定要与与工作区模板关联的 custom6 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom7
 custom7 string

指定要与工作区模板关联的 custom7 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom8
 custom8 string

指定要与与工作区模板关联的 custom8 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom9
 custom9 string

指定要与与工作区模板关联的 custom9 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom10
 custom10 string

指定要与与工作区模板关联的 custom10 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom11
 custom11 string

指定要与与工作区模板关联的 custom11 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom12
 custom12 string

指定要与与工作区模板关联的 custom12 值匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom17
 custom17 double

指定 custom17 的值。
Custom18
 custom18 double

指定 custom18 的值。
Custom19
 custom19 double

指定 custom19 的值。
Custom20
 custom20 double

指定 custom20 的值。
Custom21
 custom21 string

指定要在与工作区模板关联的 custom21 中搜索的值（采用 ISO 8601 日期/时间格式）。 此搜索不区分大小写。 对于工作区，将针对 iManage Work 安装自定义此属性的使用。
Custom22
 custom22 string

指定要在与工作区模板关联的 custom22 中搜索的值（采用 ISO 8601 日期/时间格式）。 此搜索不区分大小写。 对于工作区，将针对 iManage Work 安装自定义此属性的使用。
Custom23
 custom23 string

指定要在与工作区模板关联的 custom23 中搜索的值（采用 ISO 8601 日期/时间格式）。 此搜索不区分大小写。 对于工作区，将针对 iManage Work 安装自定义此属性的使用。
Custom24
 custom24 string

指定要在与工作区模板关联的 custom24 中搜索的值（采用 ISO 8601 日期/时间格式）。 此搜索不区分大小写。 对于工作区，将针对 iManage Work 安装自定义此属性的使用。
Custom21 （下限）
 custom21_from string

指定自定义 21（采用 ISO 8601 日期/时间格式）的下限进行搜索。 此属性不是 iManage Work 保留的，不是已验证的值。 它旨在根据公司的要求进行自定义。
Custom21 （上限）
 custom21_to string

指定自定义 21 的上限（采用 ISO 8601 日期/时间格式）进行搜索。 此属性不是 iManage Work 保留的，不是已验证的值。 它旨在根据公司的要求进行自定义。
Custom21 （相对）
 custom21_relative string

指定要搜索的日期范围，相对于当前日期。 此参数的格式为 [begin]：[end][time units （d， m 或 y）]。 例如，-15：1d 指定日期范围从当前日期之前的 15 天到当前日期之后的一天（将来的一天）。
Custom22 （下限）
 custom22_from string

指定自定义 22（采用 ISO 8601 日期/时间格式）的下限进行搜索。 此属性不是 iManage Work 保留的，不是已验证的值。 它旨在根据公司的要求进行自定义。
Custom22 （上限）
 custom22_to string

指定自定义 22 的上限（采用 ISO 8601 日期/时间格式）进行搜索。 此属性不是 iManage Work 保留的，不是已验证的值。 它旨在根据公司的要求进行自定义。
Custom22 （相对）
 custom22_relative string

指定要搜索的日期范围，相对于当前日期。 此参数的格式为 [begin]：[end][time units （d， m 或 y）]。 例如，-15：1d 指定日期范围从当前日期之前的 15 天到当前日期之后的一天（将来的一天）。
Custom23 （下限）
 custom23_from string

指定自定义 23（采用 ISO 8601 日期/时间格式）的下限进行搜索。 此属性不是 iManage Work 保留的，不是已验证的值。 它旨在根据公司的要求进行自定义。
Custom23 （上限）
 custom23_to string

指定自定义 23 的上限（采用 ISO 8601 日期/时间格式）进行搜索。 此属性不是 iManage Work 保留的，不是已验证的值。 它旨在根据公司的要求进行自定义。
Custom23 （相对）
 custom23_relative string

指定要搜索的日期范围，相对于当前日期。 此参数的格式为 [begin]：[end][time units （d， m 或 y）]。 例如，-15：1d 指定日期范围从当前日期之前的 15 天到当前日期之后的一天（将来的一天）。
Custom24 （下限）
 custom24_from string

指定自定义 24（采用 ISO 8601 日期/时间格式）的下限进行搜索。 此属性不是 iManage Work 保留的，不是已验证的值。 它旨在根据公司的要求进行自定义。
Custom24 （上限）
 custom24_to string

指定自定义 24 的上限（采用 ISO 8601 日期/时间格式）进行搜索。 此属性不是 iManage Work 保留的，不是已验证的值。 它旨在根据公司的要求进行自定义。
Custom24 （相对）
 custom24_relative string

指定要搜索的日期范围，相对于当前日期。 此参数的格式为 [begin]：[end][time units （d， m 或 y）]。 例如，-15：1d 指定日期范围从当前日期之前的 15 天到当前日期之后的一天（将来的一天）。
Custom25
 custom25 boolean

指定要搜索的 custom25 值。
Custom26
 custom26 boolean

指定要搜索的 custom26 值。
Custom27
 custom27 boolean

指定要搜索的 custom27 值。
Custom28
 custom28 boolean

指定要搜索的 custom28 值。
Custom29
 custom29 string

指定要与 custom29 匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。
Custom30
 custom30 string

指定要与 custom30 匹配的值。 此搜索不区分大小写。 不支持通配符 \ 和部分匹配项。

获取工作区配置文件

操作 ID:
GetWorkspaceProfile

获取工作区配置文件，并根据需要获取工作区的允许作列表。

参数

名称 密钥 必需 类型 说明
工作区 ID
 workspaceId True string

指定工作区的 ID。 例如，“ACTIVE_US！427”。

获取库

操作 ID:
GetLibraries

获取用户有权访问的库的列表。

返回

名称 路径 类型 说明
数据
 data array of object

指示用户有权访问的库列表。
ID
 data.id string

指示库的名称。
Name
 data.display_name string

指示库的显示名称。
类型
 data.type string

指示库的类型。 可能的值为“worksite”或“linksite”。
已隐藏
 data.is_hidden boolean

指示库是否处于隐藏状态。

获取文档版本

操作 ID:
GetDocumentVersions

获取当前用户有权访问指定文档的所有版本的配置文件。

参数

名称 密钥 必需 类型 说明
文档 ID
 documentId True string

指定文档的 ID。 例如，“ACTIVE_US！453.1”。

返回

名称 路径 类型 说明
文档配置文件
 data array of MinimalDocumentProfileInArray

获取文档的核心扩展元数据属性

操作 ID:
GetCoreEMPropertiesForDocument

获取文档的核心扩展元数据属性。

参数

名称 密钥 必需 类型 说明
文档 ID
 documentId True string

指定文档的 ID。 例如，“ACTIVE_US！453.1”。
Latest
 latest boolean

指定获取文档的最新版本。

获取文档配置文件

操作 ID:
GetDocumentProfile

获取与特定文档 ID 关联的文档属性。

参数

名称 密钥 必需 类型 说明
文档 ID
 documentId True string

指定文档的 ID。 例如，“ACTIVE_US！453.1”。
获取最新版本
 latest boolean

指定获取文档的最新版本。

获取权限

操作 ID:
GetPermissions

获取文档、文件夹或工作区的用户或组访问权限属性。 响应属性可能因用户或组权限而异。

参数

名称 密钥 必需 类型 说明
对象类型
 objectType True string

指定对象的类型。
对象标识符
 objectId True string

指定文档、文件夹或工作区的 ID。 文档 ID 的示例为“ACTIVE_US！453.1”。 文件夹或工作区 ID 的示例为“ACTIVE_US！123”。

返回

名称 路径 类型 说明
默认安全性
 data.default_security string

指示对象的默认安全性。 可能的值为“inherit”、“public”、“view”或“private”。
继承的默认安全性
 data.inherited_default_security string

指示默认安全性设置为“inherit”时文件夹的继承默认安全性。 可能的值为“public”、“view”或“private”。
访问权限
 data.acl AccessPermissions

指示一个或多个用户和/或组的访问权限集合。
所有用户 ID
 data.all_user_ids string

指示所有用户 ID 的列表，连接为字符串，并用分号分隔。
所有组 ID
 data.all_group_ids string

指示所有组 ID 的列表，连接为字符串，并用分号分隔。

获取用户详细信息

操作 ID:
GetUserDetails

从指定库获取有关用户的信息。

参数

名称 密钥 必需 类型 说明
库 ID
 libraryId True string

指定目标用户的库 ID。
用户 ID
 userId True string

指定要为其获取详细配置文件信息的用户的 ID。 例如，“JSMITH”。

返回

名称 路径 类型 说明
数据
 data UserProfile

指示有关用户的信息。

获取类

操作 ID:
GetClasses

获取库中与指定条件匹配的文档类的列表。

参数

名称 密钥 必需 类型 说明
库 ID
 libraryId True string

指定目标类的库 ID。
类 ID
 alias string

指定要搜索的类或类的 ID。 可以是逗号分隔的列表。 此搜索不区分大小写。 支持通配符 \ 和部分匹配项。
默认安全性
 default_security string

指定默认安全访问级别。
Description
 description string

指定要在说明字段中匹配的文本。 此搜索不区分大小写。 支持通配符 \ 。 不支持部分匹配项。
回波
 echo boolean

指定此类的文档是否可以回显文档。
HIPAA
 hipaa boolean

指定此类的文档是否使用符合 HIPAA 的加密。
可索引
 indexable boolean

指定此类的文档是否由系统的全文索引器编制索引。
Query
 query string

指定要与 ID 或说明字段匹配的文本。 此搜索不区分大小写。 支持通配符 \ 和部分匹配项。
需要子类
 subclass_required boolean

指定类是否具有必需的子类。

返回

名称 路径 类型 说明
顶级匹配类 ID
 data.topMatchingId string

指示顶级匹配类的 ID。 例如，“PETITION”。
顶级匹配类说明
 data.topMatchingDescription string

指示顶级匹配类的说明。
results
 data.results array of object

指示库中可用的与指定条件匹配的类的列表。
Description
 data.results.description string

指示有关该类的其他信息。
是 HIPAA
 data.results.hipaa boolean

指示文档是否已加密。
ID
 data.results.id string

指示类的 ID。 例如，“PETITION”。
可编制索引
 data.results.indexable boolean

指示文档是否由系统编制索引。
默认安全性
 data.results.default_security string

指示默认安全访问级别。 可能的值为“public”、“view”、“private”。
Retain
 data.results.retain integer

指示将此类的非活动文档标记为过期之前的天数。
必填字段
 data.results.required_fields array of string

指示在创建或更新此类的文档时要输入的必需自定义属性。
为阴影
 data.results.shadow boolean

指示签入后，此类的文档是否在用户的本地计算机上被隐藏（保留）。
需要子类
 data.results.subclass_required boolean

指示此类是否需要子类。

获取组成员

操作 ID:
GetGroupMembers

获取属于指定组并符合指定条件的用户的详细信息。

参数

名称 密钥 必需 类型 说明
库 ID
 libraryId True string

指定目标组的库 ID。
群组标识符
 groupId True string

指定组的 ID。 例如，“MARKETING”。
登录状态
 logon_status string

根据每个用户的当前“allow_logon”属性值为用户指定筛选器。
限度
 limit integer

指定要返回的最大成员数，而不考虑组中的成员总数。
首选库
 preferred_library string

指定只有首选库与所提供的值匹配的用户才能返回。
位置
 location string

指定用于根据用户的地理位置查找用户的位置。 此搜索不区分大小写。 不支持通配符 \ 。

返回

名称 路径 类型 说明
数据
 data array of UserProfileInArray

指示属于指定组并符合指定条件的用户列表。

触发器

对于多个选定的工作区

此触发器允许你为 iManage Work 中的一个或多个所选工作区启动工作流。 提供将在 iManage Work 应用程序中向用户显示的显示名称。 如果“等待完成”设置为“是”，则必须在工作流中使用“更新工作流状态”作，否则应用程序最终会超时，而不会向用户指示完成状态。
对于多个选定的文档

此触发器允许你在 iManage Work 中启动一个或多个选定文档的工作流。 提供将在 iManage Work 应用程序中向用户显示的显示名称。 如果“等待完成”设置为“是”，则必须在工作流中使用“更新工作流状态”作，否则应用程序最终会超时，而不会向用户指示完成状态。
对于所选工作区

此触发器允许你在 iManage Work 库中启动所选工作区的工作流。 提供将在 iManage Work 应用程序中向用户显示的显示名称。 如果“等待完成”设置为“是”，则必须在工作流中使用“更新工作流状态”作，否则应用程序最终会超时，而不会向用户指示完成状态。
对于所选文档

此触发器允许你在 iManage Work 库中启动所选文档的工作流。 提供将在 iManage Work 应用程序中向用户显示的显示名称。 如果“等待完成”设置为“是”，则必须在工作流中使用“更新工作流状态”作，否则应用程序最终会超时，而不会向用户指示完成状态。

对于多个选定的工作区

操作 ID:
MultipleSelectedWorkspaces

此触发器允许你为 iManage Work 中的一个或多个所选工作区启动工作流。 提供将在 iManage Work 应用程序中向用户显示的显示名称。 如果“等待完成”设置为“是”，则必须在工作流中使用“更新工作流状态”作，否则应用程序最终会超时，而不会向用户指示完成状态。

参数

名称 密钥 必需 类型 说明
工作流显示名称
 workflowName True string

指定对 iManage Work 用户可见的工作流的显示名称。
Description
 description True string

指定工作流的说明。
库 ID
 libraryId True string

指定工作流可用的库的 ID。
表单 ID
 formId True string

指定向用户显示的表单的 ID，以收集工作流使用的输入。
可供用户使用
 users string

指定一个或多个用户 ID，用分号分隔，工作流可供使用。
组可用
 groups string

指定工作流可用的一个或多个组 ID（用分号分隔）。
等待完成
 waitForCompletion boolean

指定应用程序是否等待工作流完成执行。 如果设置为“是”，则必须使用“更新工作流状态”作。

返回

此操作输出是动态内容。

对于多个选定的文档

操作 ID:
MultipleSelectedDocuments

此触发器允许你在 iManage Work 中启动一个或多个选定文档的工作流。 提供将在 iManage Work 应用程序中向用户显示的显示名称。 如果“等待完成”设置为“是”，则必须在工作流中使用“更新工作流状态”作，否则应用程序最终会超时，而不会向用户指示完成状态。

参数

名称 密钥 必需 类型 说明
工作流显示名称
 workflowName True string

指定对 iManage Work 用户可见的工作流的显示名称。
Description
 description True string

指定工作流的说明。
库 ID
 libraryId True string

指定工作流可用的库的 ID。
表单 ID
 formId True string

指定向用户显示的表单的 ID，以收集工作流使用的输入。
返回文件夹 ID
 inferFolderId True boolean

指定工作流是否需要文档的文件夹 ID。
可供用户使用
 users string

指定一个或多个用户 ID，用分号分隔，工作流可供使用。
组可用
 groups string

指定工作流可用的一个或多个组 ID（用分号分隔）。
显示每个文档的窗体
 showFormPerObject boolean

指定窗体是针对每个选定对象单独呈现还是仅针对所有选定对象显示一次。
等待完成
 waitForCompletion boolean

指定应用程序是否等待工作流完成执行。 如果设置为“是”，则必须使用“更新工作流状态”作。

返回

此操作输出是动态内容。

对于所选工作区

操作 ID:
SingleSelectedWorkspace

此触发器允许你在 iManage Work 库中启动所选工作区的工作流。 提供将在 iManage Work 应用程序中向用户显示的显示名称。 如果“等待完成”设置为“是”，则必须在工作流中使用“更新工作流状态”作，否则应用程序最终会超时，而不会向用户指示完成状态。

参数

名称 密钥 必需 类型 说明
工作流显示名称
 workflowName True string

指定对 iManage Work 用户可见的工作流的显示名称。
Description
 description True string

指定工作流的说明。
库 ID
 libraryId True string

指定工作流可用的库的 ID。
表单 ID
 formId True string

指定向用户显示的表单的 ID，以收集工作流使用的输入。
可供用户使用
 users string

指定一个或多个用户 ID，用分号分隔，工作流可供使用。
组可用
 groups string

指定工作流可用的一个或多个组 ID（用分号分隔）。
等待完成
 waitForCompletion boolean

指定应用程序是否等待工作流完成执行。 如果设置为“是”，则必须使用“更新工作流状态”作。

返回

此操作输出是动态内容。

对于所选文档

操作 ID:
SingleSelectedDocument

此触发器允许你在 iManage Work 库中启动所选文档的工作流。 提供将在 iManage Work 应用程序中向用户显示的显示名称。 如果“等待完成”设置为“是”，则必须在工作流中使用“更新工作流状态”作，否则应用程序最终会超时，而不会向用户指示完成状态。

参数

名称 密钥 必需 类型 说明
工作流显示名称
 workflowName True string

指定对 iManage Work 用户可见的工作流的显示名称。
Description
 description True string

指定工作流的说明。
库 ID
 libraryId True string

指定工作流可用的库的 ID。
表单 ID
 formId True string

指定向用户显示的表单的 ID，以收集工作流使用的输入。
返回文件夹 ID
 inferFolderId True boolean

指定工作流是否需要文档的文件夹 ID。
可供用户使用
 users string

指定一个或多个用户 ID，用分号分隔，工作流可供使用。
组可用
 groups string

指定工作流可用的一个或多个组 ID（用分号分隔）。
在工作区中可用
 workspaces string

指定一个或多个工作区 ID，用分号分隔，可在其中使用工作流。
文档类
 classes string

指定一个或多个文档类 ID，用分号分隔，工作流可供使用。
等待完成
 waitForCompletion boolean

指定应用程序是否等待工作流完成执行。 如果设置为“是”，则必须使用“更新工作流状态”作。

返回

此操作输出是动态内容。

定义

MinimalDocumentProfileInArray

指示文档的每个版本的配置文件。

名称 路径 类型 说明
作者
 author string

指示创建文档的用户的 ID。 例如，“JSMITH”。
作者说明
 author_description string

指示有关文档作者的其他信息。
基本文档属性
 basic_properties string

指示包含基本文档属性的可嵌入的“”元素。
文档类
 class string

指示文档的类。
注释
 comment string

指示有关文档的其他信息。
内容类型
 content_type string

指示文档内容类型。
文档创建日期
 create_date string

指示文档已导入到 iManage Work 系统中的日期和时间（采用 ISO 8601 格式）。 此日期可能与“file_create_date”不同。
Custom1
 custom1 string

指示 custom1 的值。
Custom1 说明
 custom1_description string

指示有关 custom1 属性的其他信息。
Custom2
 custom2 string

指示 custom2 的值。
Custom2 说明
 custom2_description string

指示有关 custom2 属性的其他信息。
Custom3
 custom3 string

指示 custom3 的值。
Custom3 说明
 custom3_description string

指示有关 custom3 属性的其他信息。
Custom4
 custom4 string

指示 custom4 的值。
Custom4 Description
 custom4_description string

指示有关 custom4 属性的其他信息。
Custom5
 custom5 string

指示 custom5 的值。
Custom5 Description
 custom5_description string

指示有关 custom5 属性的其他信息。
Custom6
 custom6 string

指示 custom6 的值。
Custom6 Description
 custom6_description string

指示有关 custom6 属性的其他信息。
Custom7
 custom7 string

指示 custom7 的值。
Custom7 说明
 custom7_description string

指示有关 custom7 属性的其他信息。
Custom8
 custom8 string

指示 custom8 的值。
Custom8 Description
 custom8_description string

指示有关 custom8 属性的其他信息。
Custom9
 custom9 string

指示 custom9 的值。
Custom9 说明
 custom9_description string

指示有关 custom9 属性的其他信息。
Custom10
 custom10 string

指示 custom10 的值。
Custom10 Description
 custom10_description string

指示有关 custom10 属性的其他信息。
Custom11
 custom11 string

指示 custom11 的值。
Custom11 说明
 custom11_description string

指示有关 custom11 属性的其他信息。
Custom12
 custom12 string

指示 custom12 的值。
Custom12 说明
 custom12_description string

指示有关 custom12 属性的其他信息。
Custom13
 custom13 string

指示 custom13 的值。
Custom14
 custom14 string

指示 custom14 的值。
Custom15
 custom15 string

指示 custom15 的值。
Custom16
 custom16 string

指示 custom16 的值。
Custom17
 custom17 double

指示 custom17 的值。
Custom18
 custom18 double

指示 custom18 的值。
Custom19
 custom19 double

指示 custom19 的值。
Custom20
 custom20 double

指示 custom20 的值。
Custom21
 custom21 string

指示 ISO 8601 日期/时间格式的 custom21 属性的值。
Custom22
 custom22 string

指示 ISO 8601 日期/时间格式的 custom22 属性的值。
Custom23
 custom23 string

指示 ISO 8601 日期/时间格式的 custom23 属性的值。
Custom24
 custom24 string

指示 ISO 8601 日期/时间格式的 custom24 属性的值。
Custom25
 custom25 boolean

指示 custom25 的值。
Custom26
 custom26 boolean

指示 custom26 的值。
Custom27
 custom27 boolean

指示 custom27 的值。
Custom28
 custom28 boolean

指示 custom28 的值。
Custom29
 custom29 string

指示 custom29 的值。
Custom29 说明
 custom29_description string

指示有关 custom29 属性的其他信息。
Custom30
 custom30 string

指示 custom30 的值。
Custom30 说明
 custom30_description string

指示有关 custom30 属性的其他信息。
数据库
 database string

指示存储文档的库。
文档默认安全性
 default_security string

指示默认安全访问级别。 可能的值为“inherit”、“private”、“view”、“public”。
文档编号
 document_number integer

指示文档的文档编号。
文档 URL
 document_url string

指示文档的可共享链接。
文档编辑日期
 edit_date string

指示文档的最新更改的日期和时间（采用 ISO 8601 格式）。
配置文件编辑日期
 edit_profile_date string

指示文档配置文件的最新更改的日期和时间（采用 ISO 8601 格式）。
文档扩展
 extension string

指示文档的文件扩展名（也称为应用程序扩展名）。
完整文件名
 full_file_name string

指示文档的完整文件名。 包括文件扩展名。
文档 ID
 id string

指示文档的 ID。 例如，“ACTIVE_US！453.1”。
可编制索引
 indexable boolean

指示文档是否由系统编制索引。
已签出
 is_checked_out boolean

指示文档是否已签出。
已声明
 is_declared boolean

指示文档是否声明为记录。 声明为记录的文档无法编辑或删除，但 iManage Work 系统管理员除外。
是外部的
 is_external boolean

指示文档是否与外部用户共享。
是 HIPAA
 is_hipaa boolean

指示文档是否已加密。
正在使用
 is_in_use boolean

指示文档是否正在使用。
文档链接
 iwl string

指示文档的 iManage 工作链接（iWL）。 iWL 用于由具有“read_write”或“full_access”的用户在受保护的视图模式下打开文档。
最后一个用户
 last_user string

指示最近编辑文档的用户的 ID。 例如，“JSMITH”。
上一个用户说明
 last_user_description string

指示最近编辑文档的最后一个用户的其他信息。
文档名称
 name string

指示文档的文件名。
Operator
 operator string

指示已签出文档或当前正在编辑其配置文件的用户的 ID。 例如，“JSMITH”。
运算符说明
 operator_description string

指示有关运算符的其他信息。
是否相关
 is_related boolean

指示文档是否与另一个文档相关。
文档大小
 size integer

指示文档的大小（以字节为单位）。
类型
 type string

指示文档类型。 例如，WORD for Microsoft Word。 有关当前类型的列表，请联系 iManage Work 系统管理员。
文档版本
 version integer

指示文档的版本号。
Wstype
 wstype string

指示对象的 iManage Work 类型。 可能的值为“document”、“folder”、“workspace”、“email”、“document_shortcut”、“folder_shortcut”、“workspace_shortcut”、“user”。

用户资料

指示有关用户的信息。

名称 路径 类型 说明
允许登录
 allow_logon boolean

指示是否允许用户登录。
Custom1
 custom1 string

指示有关用户的其他信息。
Custom2
 custom2 string

指示有关用户的其他信息。
Custom3
 custom3 string

指示有关用户的其他信息。
名录 ID
 directory_id string

指示外部目录（如 ADFS）中的 ID，该 ID 用于用户配置文件同步。
可分辨名称
 distinguished_name string

指示对象的名称，该对象表示将条目跟踪回 LDAP 树根的名称的完全限定路径。
编辑日期
 edit_date string

指示最近对用户配置文件所做的更改的日期和时间（采用 ISO 8601 格式）。
Email
 email string

指示用户的电子邮件 ID。
Exchange 自动发现 URL
 exch_autodiscover string

指示用户的交换服务器详细信息。
Extension
 extension string

指示用户的电话号码分机。
失败的登录尝试
 failed_logins integer

指示用户的当前登录尝试失败次数。
传真
 fax string

指示用户的传真号。
强制更改密码
 force_password_change boolean

指示用户在下次登录时必须更改其密码。 仅适用于虚拟用户，由“user_nos”值“2”表示。
完整姓名
 full_name string

指示用户的全名。
概况
 general string

指示有关用户的常规信息。
用户 ID
 id string

指示用户的 ID。 例如，“JSMITH”。
是外部用户
 is_external boolean

指示外部用户。 外部用户具有有限的访问权限，通常用于临时团队成员、顾问或组织外部的成员。
上次同步时间
 last_sync_ts string

指示用户配置文件的最后一个同步时间（采用 ISO 8601 日期/时间格式），其中包含外部目录，例如 LDAP 或 Microsoft Active Directory （ADFS）。
位置
 location string

指示用户的地理位置。
密码永不过期
 password_never_expire boolean

指示用户的密码是否永不过期。
电话号码
 phone string

指示用户的电话号码。
首选库
 preferred_library string

指示首选库。 首选库是用户的默认库。 每个用户必须有一个首选库。
密码更改时间
 pwd_changed_ts string

指示用户上次更改密码的时间（采用 ISO 8601 日期/时间格式）。 这仅适用于虚拟用户（其用户 NOS 为 2）。
SSID
 ssid string

指示用户的唯一系统生成的 ID。
用户域
 user_domain string

指示用户的目录服务的完全限定域名。
扩展用户 ID
 user_id_ex string

指示从外部目录（如 Microsoft Active Directory（ADFS）接收的用户 ID 的原始值。
用户 NOS
 user_nos integer

指示用户从中同步的作系统的类型。 可能的值为 2（虚拟用户）和 6（企业用户）。 有关详细信息，请联系 iManage Work 系统管理员。
用户编号
 user_num integer

指示用户的数值系统 ID。

UserProfileInArray

名称 路径 类型 说明
允许登录
 allow_logon boolean

指示是否允许用户登录。
Custom1
 custom1 string

指示有关用户的其他信息。
Custom2
 custom2 string

指示有关用户的其他信息。
Custom3
 custom3 string

指示有关用户的其他信息。
名录 ID
 directory_id string

指示外部目录（如 ADFS）中的 ID，该 ID 用于用户配置文件同步。
可分辨名称
 distinguished_name string

指示对象的名称，该对象表示将条目跟踪回 LDAP 树根的名称的完全限定路径。
编辑日期
 edit_date string

指示最近对用户配置文件所做的更改的日期和时间（采用 ISO 8601 格式）。
Email
 email string

指示用户的电子邮件 ID。
Exchange 自动发现 URL
 exch_autodiscover string

指示用户的交换服务器详细信息。
Extension
 extension string

指示用户的电话号码分机。
失败的登录尝试
 failed_logins integer

指示用户的当前登录尝试失败次数。
传真
 fax string

指示用户的传真号。
强制更改密码
 force_password_change boolean

指示用户在下次登录时必须更改其密码。 仅适用于虚拟用户，由“user_nos”值“2”表示。
完整姓名
 full_name string

指示用户的全名。
概况
 general string

指示有关用户的常规信息。
ID
 id string

指示用户的 ID。 例如，“JSMITH”。
是外部用户
 is_external boolean

指示外部用户。 外部用户具有有限的访问权限，通常用于临时团队成员、顾问或组织外部的成员。
上次同步时间
 last_sync_ts string

指示用户配置文件的最后一个同步时间（采用 ISO 8601 日期/时间格式），其中包含外部目录，例如 LDAP 或 Microsoft Active Directory （ADFS）。
位置
 location string

指示用户的地理位置。
密码永不过期
 password_never_expire boolean

指示用户的密码是否永不过期。
电话号码
 phone string

指示用户的电话号码。
首选库
 preferred_library string

指示首选库。 首选库是用户的默认库。 每个用户必须有一个首选库。
密码更改时间
 pwd_changed_ts string

指示用户上次更改密码的时间（采用 ISO 8601 日期/时间格式）。 这仅适用于虚拟用户（其用户 NOS 为 2）。
SSID
 ssid string

指示用户的唯一系统生成的 ID。
域名
 user_domain string

指示用户的目录服务的完全限定域名。
扩展用户 ID
 user_id_ex string

指示从外部目录（如 Microsoft Active Directory（ADFS）接收的用户 ID 的原始值。
NOS
 user_nos integer

指示用户从中同步的作系统的类型。 可能的值为 2（虚拟用户）和 6（企业用户）。 有关详细信息，请联系 iManage Work 系统管理员。
编号
 user_num integer

指示用户的数值系统 ID。

TaxonomyNodeValue

指示每个分类节点值。

名称 路径 类型 说明
SSID
 created_by.ssid string

指示创建节点值的用户的唯一系统生成的 ID。
创建日期
 create_date date-time

指示创建节点值的日期和时间（采用 ISO 8601 格式）。
Description
 description string

指示节点值的说明。
SSID
 edited_by.ssid string

指示上次编辑节点值的用户的唯一系统生成的 ID。
编辑日期
 edit_date date-time

指示上次编辑节点值的日期和时间（采用 ISO 8601 格式）。
已启用
 enabled boolean

指示节点值是否已启用。
ID
 id string

指示节点值的显示标识符。
SSID
 parent.ssid string

指示直接父节点的唯一系统生成的 ID。
SSID
 ssid string

指示节点值的唯一系统生成的 ID。
路径
 path array of object

指示节点值的完整路径。 路径是一个有序列表，从分类中的顶级节点开始，然后所有节点都指向匹配节点的直接父节点。
每个 ID
 path.id string

指示路径中节点值的显示标识符。
每个 SSID
 path.ssid string

指示路径中节点值的唯一系统生成的 ID。

UpdatePermissionsResponse

名称 路径 类型 说明
默认安全性
 data.default_security string

指示对象的默认安全性。 可能的值为“inherit”、“public”、“view”或“private”。
访问权限
 data.acl AccessPermissions

指示一个或多个用户和/或组的访问权限集合。
所有用户 ID
 data.all_user_ids string

指示所有用户 ID 的列表，连接为字符串，并用分号分隔。
所有组 ID
 data.all_group_ids string

指示所有组 ID 的列表，连接为字符串，并用分号分隔。

AccessPermissions

指示一个或多个用户和/或组的访问权限集合。

名称 路径 类型 说明
受托人名称
 name string

指示受托人的名称。
受托人 ID
 id string

指示受托人的 ID。 这可以是用户 ID 或组 ID。
受托人 SID
 sid string

指示用户或组的安全标识符。
受托人类型
 type string

指示返回的受托人类型。 可能的值为“user”或“group”。
访问级别
 access_level string

指示用户或组对该对象具有的访问权限。 可能的值为“no_access”、“read”、“read_write”或“full_access”。
访问级显示名称
 access_level_display_name string

指示分配给此对象的用户或组的用户或组的用户可读访问级别显示名称。 可能的值为“无访问权限”、“只读”、“读/写”或“完全访问”。
Access
 access integer

指示用户或组对该对象具有的访问权限的数值。 可能的值为 0（no_access）、1（读取）、2（read_write）或 3（full_access）。
是外部的
 is_external boolean

指示用户是否为外部用户，或者该组是否限制为外部用户。
允许登录
 allow_logon boolean

指示是否允许用户登录。 不适用于组。
已启用
 enabled boolean

指示组是否已启用。 不适用于用户。
具有受限成员
 has_restricted_member boolean

指示该组是否至少有一个用户有权访问 iManage 安全策略管理器拒绝此对象。

对象

这是类型“object”。

二进制

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