GoFileRoom

GoFileRoom 是基于云的文档管理和工作流解决方案。使用 GoFileRoom 连接器，可以执行文档、用户管理和 FirmFlow作。

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

服务	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	GoFileRoom 支持
URL	https://tax.thomsonreuters.com/us/en/cs-professional-suite/support/contact
Email	CS.Support@ThomsonReuters.com

连接器元数据
发布者	汤姆森路透社
网站	https://www.gofileroom.com/
隐私策略	https://www.thomsonreuters.com/en/privacy-statement.html
类别	数据;业务管理

GoFileRoom 连接器为 Thomson Reuters 客户提供了一种简单的方法来利用 API for GoFileRoom 和 FirmFlow。用户可以创建与用户管理、文档或 FirmFlow 相关的自动化和集成。

先决条件

用户必须具有 GoFileRoom API 密钥才能使用连接器。

如何获取凭据？

可以通过在以下位置 https://developerportal.thomsonreuters.com/注册帐户来获取 API 密钥。此外，还需要有一个有效的 GoFileRoom 帐户。如果你对 GoFileRoom 感兴趣，请在此处与我们联系： https://tax.thomsonreuters.com/us/en/cs-professional-suite/gofileroom#contact

正在创建连接

连接器支持以下身份验证类型：


默认	用于创建连接的参数。	所有区域	不可共享

违约

适用：所有区域

用于创建连接的参数。

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

Name	类型	Description	必选
X-TR-API-APP-ID	securestring	此 API 的 X-TR-API-APP-ID	True

限制

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

操作

Index LookupList Find	此方法旨在用于自动完成字段。
Taxsort 文档	Taxsort PDF 文档
修改用户	修改用户权限
修改组	修改组权限
创建工作流	创建工作流
创建文档	使用索引创建文档记录
创建用户	将 GoFileRoom 和 ClientFlow 用户创建到系统中
创建组	创建权限组
删除主可交付结果	删除主可交付结果
删除工作流	删除工作流
删除文档	删除文档
删除用户	从系统中删除 GoFileRoom 和 ClientFlow 用户
发布文档状态	从 ClientFlow 发布或取消发布文档。
合并 PDF	将 PDF 文件合并在一起
复制文档	复制文档
按可交付结果 V2 跟踪报告	按 DeliverableV2 跟踪报告
按工作流跟踪报表	按工作流跟踪报表
文档搜索	加载用户有权访问的指定抽屉中的所有文档。
文档重新编制索引	重新编制文档索引
注销	注销应用程序
添加主可交付结果	添加主可交付结果
登录	将用户记录到应用程序中
编辑 WorkFlow	编辑 WorkFlow
编辑主可交付结果	编辑主可交付结果
获取 LookupList 值	从 LookupList 中提取值
获取上传位置	提取用户的上传位置
获取主可交付结果	获取主可交付结果
获取子索引	获取基于列表 ID 的子索引值列表，该列表是在选择父列表值时提供的。
获取密码策略	提取公司的密码策略
获取报表列表	提取可用于用户管理的报表
获取抽屉	提取登录用户可访问的抽屉
获取抽屉索引	检索为抽屉设置的文档索引列表
获取文档	下载文档
获取文档历史记录	获取文档的历史记录
获取文档状态	获取文档的状态
获取文档索引	检索文档的索引
获取用户	获取已登录用户的 GFR 用户
获取用户信息	提取 GFR 用户信息
获取用户信息 V2	获取用户输入
获取用户文档安全性	每次登录提取用户文档安全性
获取用户权限	获取用户的权限
获取索引值列表	获取列表类型索引的所有条目
获取索引的动态规则	获取为指定索引配置的动态规则列表
获取组	提取可用于用户和组管理的组
获取组文档安全性	检索组文档安全性
获取组权限	获取组的权限
获取许可证	检索许可计数
设置用户文档安全性	分配用户文档安全权限
设置用户权限	向用户分配权限
设置组文档安全性	将文档安全性分配给组
设置组权限	为组分配权限
路由工作流 V2	路由工作流 V2
通过可交付结果获取 FirmFlow 数据	按可交付结果数据获取跟踪报告
验证令牌	验证令牌状态
验证索引	检查提供的索引是否有效。

Index LookupList Find

操作 ID:: IndexLookupListFind

此方法旨在用于自动完成字段。

参数

名称	密钥	必需	类型	说明
IndexID	indexId	True	string	输入索引 ID
标记	X-Authorization		string	令牌身份验证
操作类型	ActionType		integer	输入作类型
计数	Count		integer	输入计数
IndexValue	IndexValue		string	输入索引值
搜索类型	SearchType		integer	输入搜索类型

名称	路径	类型	说明
		array of object
indexId	index.indexId	string	索引 ID 值
indexValue	index.indexValue	string	索引值
linkedIndexes	linkedIndexes	array of object	linkedIndexes
indexId	linkedIndexes.indexId	string	indexId
indexValue	linkedIndexes.indexValue	string	indexValue

Taxsort 文档

操作 ID:: TaxsortDocument

Taxsort PDF 文档

参数

名称	密钥	必需	类型	说明
标记	X-Authorization		string	令牌身份验证
身体	body		array of string

名称	路径	类型	说明
		array of object
documentId	documentId	string	文档 ID 值
isTaxSorted	isTaxSorted	boolean	文档 TaxSorted
taxsortDocumentException	taxsortDocumentException	string	taxsort 文档异常

修改用户

操作 ID:: ModifyUser

修改用户权限

参数

名称	密钥	类型	说明
用户类型	userType	string	输入用户类型
标记	X-Authorization	string	令牌身份验证
AccountExpiresDate	AccountExpiresDate	string	帐户到期日期
DisabledComments	DisabledComments	string	输入批注
FullName	FullName	string	输入全名
Groups	Groups	array of string	Groups
IsAccountExpires	IsAccountExpires	string	指定 true 或 false
IsAdvanceFlow	IsAdvanceFlow	string	指定 true 或 false
IsAllowAccessToReports	IsAllowAccessToReports	string	指定 true 或 false
IsAllowOffline	IsAllowOffline	string	指定 true 或 false
IsChangeNextLogin	IsChangeNextLogin	string	指定 true 或 false
是否已禁用	IsDisabled	string	指定 true 或 false
IsFirmFlow	IsFirmFlow	string	指定 true 或 false
IsFirmFlowNotificationGroup	IsFirmFlowNotificationGroup	string	指定 true 或 false
IsFirmFlowNotificationUser	IsFirmFlowNotificationUser	string	指定 true 或 false
IsMfa	IsMfa	string	指定 true 或 false
IsUserAdministration	IsUserAdministration	string	指定 true 或 false
IsWorkflowManagerUser	IsWorkflowManagerUser	string	指定 true 或 false
LicenseType	LicenseType	string	输入许可证类型
登录名	LoginName	string	输入登录名
ManagerEmail	ManagerEmail	string	输入管理器电子邮件
密码	Password	string	输入密码
Allow	Allow	array of string	Allow
Deny	Deny	array of string	Deny
IsAllowAll	IsAllowAll	string	指定 true 或 false
IsDenyAll	IsDenyAll	string	指定 true 或 false
ReportType	ReportType	string	指定 true 或 false
UploadLocation	UploadLocation	string	输入上传位置

名称	路径	类型	说明
isModified	isModified	boolean	用户是否已修改
mfaException	mfaException	string	mfa 异常
modifyUserException	modifyUserException	string	修改用户异常
userId	userId	string	用户 ID 值

修改组

操作 ID:: ModifyGroup

修改组权限

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
AccessToApproveDocsOnly	AccessToApproveDocsOnly	string	指定 true 或 false
AllowAccessToReports	AllowAccessToReports	string	指定 true 或 false
注释	Comments	string	输入批注
EnableMfa	EnableMfa	string	指定 true 或 false
EnforceMfaForUsers	EnforceMfaForUsers	string	指定 true 或 false
FirmFlowRoutingNotification	FirmFlowRoutingNotification	string	指定 true 或 false
FullAccessToDocTracking	FullAccessToDocTracking	string	指定 true 或 false
GroupName	GroupName	string	输入组名称
MfaRequired	MfaRequired	string	指定 true 或 false
PermissonToApproveDocs	PermissonToApproveDocs	string	指定 true 或 false
RenameGroup	RenameGroup	string	输入新组名称
Allow	Allow	array of string	Allow
Deny	Deny	array of string	Deny
IsAllowAll	IsAllowAll	string	指定 true 或 false
IsDenyAll	IsDenyAll	string	指定 true 或 false
ReportType	ReportType	string	指定 true 或 false
UploadLocation	UploadLocation	string	输入上传位置
用户	Users	array of string	用户

名称	路径	类型	说明
groupId	groupId	string	组 ID 值
isModified	isModified	boolean	组是否进行了修改
mfaException	mfaException	string	mfa 异常
modifyGroupException	modifyGroupException	string	修改组异常

创建工作流

操作 ID:: CreateWorkflow

创建工作流

参数

名称	密钥	必需	类型	说明
标记	X-Authorization		string	令牌身份验证
抽屉名称	Drawer		string	抽屉名称
服务类型	ServiceType		string	服务类型
文件夹 ID	folderId		string	文件夹 ID
客户端名称	ClientName		string	客户端名称
客户端编号	ClientNumber		string	客户端编号
预订类型	EngagementType		string	预订类型
PIC	PIC		string	PIC
年份	Year		string	年份
句点结束	PeriodEnd		string	句点结束
工作流名称	workflowName		string	工作流名称
Description	description	True	string	Description
状态名称	statusName		string	状态名称
可交付结果作	action		string	可交付结果作
当前截止日期	currentduedate		string	当前截止日期
原始截止日期	originalduedate		string	原始截止日期
可交付结果表单	form		string	可交付结果表单
传递方法	Delivery		string	传递方法
目的地	Destination		string	目的地
源文档	sourceDocument		string	源文档
注释作	action		string	注释作
备注类型	noteType		string	备注类型
注意消息	note		string	注意消息
信息字段名称	name		string	信息字段名称
信息字段值	value		string	信息字段值
责任字段	ResponsibleField		string	责任字段
负责任的字段值	value		string	负责任的字段值

名称	路径	类型	说明
归档 ID	filingId	integer	归档 ID
错误注释	errorComment	string	错误注释
状态	status	boolean	状态
errorMessage	errorMessage	array of string	errorMessage

创建文档

操作 ID:: CreateDocument

使用索引创建文档记录

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
DrawerId	DrawerId	string	输入抽屉 ID
IndexId	IndexId	string	输入索引 ID
IndexValue	IndexValue	string	输入索引值

名称	路径	类型	说明
documentId	documentCreate.documentId	string	文档 ID 值
errorMessage	documentCreate.errorMessage	string	错误信息
errorMessage	indexValidation.errorMessage	string	错误信息
错误	indexValidation.errors	array of	错误
isValid	indexValidation.isValid	boolean	文档有效

创建用户

操作 ID:: CreateUsers

将 GoFileRoom 和 ClientFlow 用户创建到系统中

参数

名称	密钥	类型	说明
用户类型	userType	string	输入用户类型
标记	X-Authorization	string	令牌身份验证
AccountExpiresDate	AccountExpiresDate	string	输入帐户过期日期
DisabledComments	DisabledComments	string	输入禁用的批注
FullName	FullName	string	用户全名
Groups	Groups	array of string	Groups
IsAccountExpires	IsAccountExpires	string	指定 true 或 false
IsAdvanceFlow	IsAdvanceFlow	string	指定 true 或 false
IsAllowAccessToReports	IsAllowAccessToReports	string	指定 true 或 false
IsAllowOffline	IsAllowOffline	string	指定 true 或 false
是否已禁用	IsDisabled	string	指定 true 或 false
IsFirmFlow	IsFirmFlow	string	指定 true 或 false
IsFirmFlowNotificationGroup	IsFirmFlowNotificationGroup	string	指定 true 或 false
IsFirmFlowNotificationUser	IsFirmFlowNotificationUser	string	指定 true 或 false
IsMfa	IsMfa	string	指定 true 或 false
IsUserAdministration	IsUserAdministration	string	指定 true 或 false
IsWorkflowManagerUser	IsWorkflowManagerUser	string	指定 true 或 false
LicenseType	LicenseType	string	输入许可证类型
登录名	LoginName	string	输入登录名
ManagerEmail	ManagerEmail	string	输入管理器电子邮件
密码	Password	string	输入密码
Allow	Allow	array of string	Allow
Deny	Deny	array of string	Deny
IsAllowAll	IsAllowAll	string	指定 true 或 false
IsDenyAll	IsDenyAll	string	指定 true 或 false
ReportType	ReportType	string	指定 true 或 false
UploadLocation	UploadLocation	string	输入上传位置

名称	路径	类型	说明
createUserException	createUserException	string	创建用户异常
isCreated	isCreated	boolean	用户是否创建
mfaException	mfaException	string	mfa 异常
userId	userId	string	用户 ID 值

创建组

操作 ID:: CreateGroup

创建权限组

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
AccessToApproveDocsOnly	AccessToApproveDocsOnly	string	指定 true 或 false
AllowAccessToReports	AllowAccessToReports	string	指定 true 或 false
注释	Comments	string	输入批注
EnableMfa	EnableMfa	string	指定 true 或 false
EnforceMfaForUsers	EnforceMfaForUsers	string	指定 true 或 false
FirmFlowRoutingNotification	FirmFlowRoutingNotification	string	指定 true 或 false
FullAccessToDocTracking	FullAccessToDocTracking	string	指定 true 或 false
GroupName	GroupName	string	输入组名称
MfaRequired	MfaRequired	string	指定 true 或 false
PermissonToApproveDocs	PermissonToApproveDocs	string	指定 true 或 false
Allow	Allow	array of string	Allow
Deny	Deny	array of string	Deny
IsAllowAll	IsAllowAll	string	指定 true 或 false
IsDenyAll	IsDenyAll	string	指定 true 或 false
ReportType	ReportType	string	指定 true 或 false
UploadLocation	UploadLocation	string	输入上传位置
用户	Users	array of string	用户

名称	路径	类型	说明
createGroupException	createGroupException	string	创建组异常
groupId	groupId	string	组 ID 值
isCreated	isCreated	boolean	组是否创建
mfaException	mfaException	string	mfa 状态

删除主可交付结果

操作 ID:: DeleteMasterDeliverable

删除主可交付结果

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
服务类型	ServiceType	string	服务类型
抽屉名称	DrawerName	string	抽屉名称
DeliverableNames	DeliverableNames	array of string	DeliverableNames

名称	路径	类型	说明
		array of object
删除状态	isDeleted	boolean	删除状态
响应消息	responseMessage	string	响应消息

删除工作流

操作 ID:: DeleteWorkflows

删除工作流

参数

名称	密钥	必需	类型	说明
标记	X-Authorization		string	令牌身份验证
filingId	filingId		array of integer	filingId

名称	路径	类型	说明
已删除状态	isDeleted	boolean	已删除状态
归档 ID	filingId	string	归档 ID

删除文档

操作 ID:: DocumentDelete

删除文档

参数

名称	密钥	必需	类型	说明
DocumentId	documentId	True	string	输入文档 ID
标记	X-Authorization		string	令牌身份验证

名称	路径	类型	说明
		array of object
deleteDocumentException	deleteDocumentException	string	删除文档异常
documentId	documentId	string	文档 ID 值
isDeleted	isDeleted	boolean	是已删除的文档

删除用户

操作 ID:: DeleteUser

从系统中删除 GoFileRoom 和 ClientFlow 用户

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
LoginId	LoginId	string	输入用户的登录 ID
用户类型	UserType	string	输入用户类型

名称	路径	类型	说明
deleteUserException	deleteUserException	string	删除用户异常
isDeleted	isDeleted	boolean	登录名是否已删除
loginId	loginId	string	登录 ID 值

发布文档状态

操作 ID:: PublishDocumentStatus

从 ClientFlow 发布或取消发布文档。

参数

名称	密钥	必需	类型	说明
DocumentId	documentId	True	string	输入文档 ID
标记	X-Authorization		string	令牌身份验证
IsPublished	IsPublished	True	string	指定 true 或 false

名称	路径	类型	说明
		array of object
documentException	documentException	string	文档异常
documentId	documentId	string	文档 ID 值
isPublished	isPublished	boolean	是已发布的文档

合并 PDF

操作 ID:: MergePDF

将 PDF 文件合并在一起

参数

名称	密钥	必需	类型	说明
标记	X-Authorization		string	令牌身份验证
身体	body		array of string

response: string

复制文档

操作 ID:: CopyDocument

复制文档

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
DocumentIds	DocumentIds	array of string	DocumentIds
IndexId	IndexId	string	输入索引 ID
IndexValue	IndexValue	string	输入索引值

名称	路径	类型	说明
		array of object
copyDocumentException	copyDocumentException	string	复制文档异常
documentId	documentId	string	文档 ID 值
isCopied	isCopied	boolean	文档是否复制
newDocumentId	newDocumentId	string	新文档 ID

按可交付结果 V2 跟踪报告

操作 ID:: TrackingReportByDeliverableV2

按 DeliverableV2 跟踪报告

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
抽屉 ID	DrawerId	string	抽屉 ID
服务类型	ServiceType	string	服务类型
预订类型	EngagementType	string	预订类型
Workflow	Workflow	string	Workflow
当前步骤	CurrentStep	string	当前步骤
PIC	PIC	string	PIC
分配到	AssignedTo	string	分配到
已分配 On	AssignedOn	string	已分配 On
工作流说明	WorkflowDescription	string	工作流说明
仅进程内	InProcessOnly	string	仅进程内
状态	Status	string	状态
Priority	Priority	string	Priority
Received On	ReceivedOn	string	Received On
完成时间	CompletedOn	string	完成时间
发送日期	SentOn	string	发送日期
负责	Responsible	string	负责
工作分配历史记录	AssignmentHistory	string	工作分配历史记录
Received From	ReceivedFrom	string	Received From
收件人	SentTo	string	收件人
已完成者	CompletedBy	string	已完成者
有责任	Accountable	string	有责任
当前截止日期	CurrentDueDate	string	当前截止日期
原始截止日期	OriginalDueDate	string	原始截止日期
延长日期	DateExtended	string	延长日期
步骤中天数	DaysAtStep	string	步骤中天数
单步总天数	TotalDaysAtStep	string	单步总天数
路由之间的天数	DaysBetweenRoutings	string	路由之间的天数
处理的总天数	TotalDaysInProcess	string	处理的总天数
路由详细信息	RoutingDetails	string	路由详细信息
上次更新时间	LastUpdated	string	上次更新时间
InformationFields	InformationFields	array of string	InformationFields
Indexes	Indexes	array of string	Indexes
页码	PageNumber	string	页码

名称	路径	类型	说明
记录总数	totalRecords	integer	记录总数
页码	pageNumber	string	页码
页面大小	pageSize	integer	页面大小
总页数	totalPages	integer	总页数
firmFlowReportResponse	firmFlowReportResponse	array of object	firmFlowReportResponse
客户端名称	firmFlowReportResponse.clientName	string	客户端名称
客户端编号	firmFlowReportResponse.clientNumber	string	客户端编号
抽屉 ID	firmFlowReportResponse.drawerId	string	抽屉 ID
服务类型	firmFlowReportResponse.serviceType	string	服务类型
预订类型	firmFlowReportResponse.engagementType	string	预订类型
Workflow	firmFlowReportResponse.workflow	string	Workflow
当前步骤	firmFlowReportResponse.currentStep	string	当前步骤
PIC	firmFlowReportResponse.pic	string	PIC
分配到	firmFlowReportResponse.assignedTo	string	分配到
已分配 On	firmFlowReportResponse.assignedOn	string	已分配 On
年份	firmFlowReportResponse.year	string	年份
句点结束	firmFlowReportResponse.periodEnd	string	句点结束
工作流说明	firmFlowReportResponse.workflowDescription	string	工作流说明
进展	firmFlowReportResponse.progress	string	进展
状态	firmFlowReportResponse.status	string	状态
Priority	firmFlowReportResponse.priority	string	Priority
eFile 是或否	firmFlowReportResponse.eFileYesOrNo	string	eFile 是或否
扩展为“是”或“否”	firmFlowReportResponse.extendedYesOrNo	string	扩展为“是”或“否”
Received On	firmFlowReportResponse.receivedOn	string	Received On
完成时间	firmFlowReportResponse.completedOn	string	完成时间
发送日期	firmFlowReportResponse.sentOn	string	发送日期
可交付内容	firmFlowReportResponse.deliverables	string	可交付内容
负责	firmFlowReportResponse.responsible	string	负责
工作分配历史记录	firmFlowReportResponse.assignmentHistory	string	工作分配历史记录
Received From	firmFlowReportResponse.receivedFrom	string	Received From
收件人	firmFlowReportResponse.sentTo	string	收件人
已完成者	firmFlowReportResponse.completedBy	string	已完成者
有责任	firmFlowReportResponse.accountable	string	有责任
当前截止日期	firmFlowReportResponse.currentDueDate	string	当前截止日期
原始截止日期	firmFlowReportResponse.originalDueDate	string	原始截止日期
路由说明	firmFlowReportResponse.routingNotes	string	路由说明
PIC 是或否	firmFlowReportResponse.picYesOrNo	string	PIC 是或否
分配到“是”或“否”	firmFlowReportResponse.assignedToYesOrNo	string	分配到“是”或“否”
延长日期	firmFlowReportResponse.dateExtended	string	延长日期
步骤中天数	firmFlowReportResponse.daysAtStep	string	步骤中天数
单步总天数	firmFlowReportResponse.totalDaysAtStep	string	单步总天数
路由之间的天数	firmFlowReportResponse.daysBetweenRoutings	string	路由之间的天数
处理的总天数	firmFlowReportResponse.totalDaysInProcess	string	处理的总天数
文件夹 ID	firmFlowReportResponse.folderID	string	文件夹 ID
归档 ID	firmFlowReportResponse.filingID	string	归档 ID
以前的归档 ID	firmFlowReportResponse.priorFilingID	string	以前的归档 ID
上次更新时间	firmFlowReportResponse.lastUpdated	string	上次更新时间
informationFields	firmFlowReportResponse.informationFields	array of object	informationFields
姓名	firmFlowReportResponse.informationFields.name	string	姓名
value	firmFlowReportResponse.informationFields.value	string	value
routingSummary	firmFlowReportResponse.routingSummary	array of	routingSummary
responsibleUserOrGroups	firmFlowReportResponse.responsibleUserOrGroups	array of	responsibleUserOrGroups
获取 FirmFlow 异常	getFirmFlowException	string	获取 FirmFlow 异常

按工作流跟踪报表

操作 ID:: TrackingReportByWorkflow

按工作流跟踪报表

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
抽屉 ID	DrawerId	string	抽屉 ID
服务类型	ServiceType	string	服务类型
预订类型	EngagementType	string	预订类型
Workflow	Workflow	string	Workflow
当前步骤	CurrentStep	string	当前步骤
PIC	PIC	string	PIC
分配到	AssignedTo	string	分配到
已分配 On	AssignedOn	string	已分配 On
工作流说明	WorkflowDescription	string	工作流说明
仅进程内	InProcessOnly	string	仅进程内
状态	Status	string	状态
Priority	Priority	string	Priority
负责	Responsible	string	负责
工作分配历史记录	AssignmentHistory	string	工作分配历史记录
Received From	ReceivedFrom	string	Received From
Received On	ReceivedOn	string	Received On
收件人	SentTo	string	收件人
发送日期	SentOn	string	发送日期
已完成者	CompletedBy	string	已完成者
完成时间	CompletedOn	string	完成时间
当前截止日期	CurrentDueDate	string	当前截止日期
步骤中天数	DaysAtStep	string	步骤中天数
单步总天数	TotalDaysAtStep	string	单步总天数
路由之间的天数	DaysBetweenRoutings	string	路由之间的天数
处理的总天数	TotalDaysInProcess	string	处理的总天数
有责任	Accountable	string	有责任
路由详细信息	RoutingDetails	string	路由详细信息
上次更新时间	LastUpdated	string	上次更新时间
InformationFields	InformationFields	array of string	InformationFields
Indexes	Indexes	array of string	Indexes
页码	PageNumber	string	页码

名称	路径	类型	说明
记录总数	totalRecords	integer	记录总数
页码	pageNumber	string	页码
页面大小	pageSize	integer	页面大小
总页数	totalPages	integer	总页数
firmFlowReportResponse	firmFlowReportResponse	array of object	firmFlowReportResponse
客户端名称	firmFlowReportResponse.clientName	string	客户端名称
客户端编号	firmFlowReportResponse.clientNumber	string	客户端编号
抽屉 ID	firmFlowReportResponse.drawerId	string	抽屉 ID
服务类型	firmFlowReportResponse.serviceType	string	服务类型
预订类型	firmFlowReportResponse.engagementType	string	预订类型
Workflow	firmFlowReportResponse.workflow	string	Workflow
当前步骤	firmFlowReportResponse.currentStep	string	当前步骤
PIC	firmFlowReportResponse.pic	string	PIC
分配到	firmFlowReportResponse.assignedTo	string	分配到
已分配 On	firmFlowReportResponse.assignedOn	string	已分配 On
年份	firmFlowReportResponse.year	string	年份
句点结束	firmFlowReportResponse.periodEnd	string	句点结束
工作流说明	firmFlowReportResponse.workflowDescription	string	工作流说明
进展	firmFlowReportResponse.progress	string	进展
状态	firmFlowReportResponse.status	string	状态
Priority	firmFlowReportResponse.priority	string	Priority
eFile 是或否	firmFlowReportResponse.eFileYesOrNo	string	eFile 是或否
扩展为“是”或“否”	firmFlowReportResponse.extendedYesOrNo	string	扩展为“是”或“否”
Received On	firmFlowReportResponse.receivedOn	string	Received On
完成时间	firmFlowReportResponse.completedOn	string	完成时间
发送日期	firmFlowReportResponse.sentOn	string	发送日期
可交付内容	firmFlowReportResponse.deliverables	string	可交付内容
负责	firmFlowReportResponse.responsible	string	负责
工作分配历史记录	firmFlowReportResponse.assignmentHistory	string	工作分配历史记录
Received From	firmFlowReportResponse.receivedFrom	string	Received From
收件人	firmFlowReportResponse.sentTo	string	收件人
已完成者	firmFlowReportResponse.completedBy	string	已完成者
有责任	firmFlowReportResponse.accountable	string	有责任
当前截止日期	firmFlowReportResponse.currentDueDate	string	当前截止日期
原始截止日期	firmFlowReportResponse.originalDueDate	string	原始截止日期
路由说明	firmFlowReportResponse.routingNotes	string	路由说明
PIC 是或否	firmFlowReportResponse.picYesOrNo	string	PIC 是或否
分配到“是”或“否”	firmFlowReportResponse.assignedToYesOrNo	string	分配到“是”或“否”
延长日期	firmFlowReportResponse.dateExtended	string	延长日期
步骤中天数	firmFlowReportResponse.daysAtStep	string	步骤中天数
单步总天数	firmFlowReportResponse.totalDaysAtStep	string	单步总天数
路由之间的天数	firmFlowReportResponse.daysBetweenRoutings	string	路由之间的天数
处理的总天数	firmFlowReportResponse.totalDaysInProcess	string	处理的总天数
文件夹 ID	firmFlowReportResponse.folderID	string	文件夹 ID
归档 ID	firmFlowReportResponse.filingID	string	归档 ID
上次更新的工作流	firmFlowReportResponse.workflowLastUpdated	string	上次更新的工作流
informationFields	firmFlowReportResponse.informationFields	array of object	informationFields
姓名	firmFlowReportResponse.informationFields.name	string	姓名
value	firmFlowReportResponse.informationFields.value	string	value
routingSummary	firmFlowReportResponse.routingSummary	array of	routingSummary
responsibleUserOrGroups	firmFlowReportResponse.responsibleUserOrGroups	array of	responsibleUserOrGroups
获取 FirmFlow 异常	getFirmFlowException	string	获取 FirmFlow 异常

文档搜索

操作 ID:: DocumentSearch

加载用户有权访问的指定抽屉中的所有文档。

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
DrawerId	DrawerId	string	输入抽屉 ID
IndexId	IndexId	string	输入索引 ID
IndexValue	IndexValue	string	输入索引值
NumberOfRows	NumberOfRows	integer	输入行数
PageNumber	PageNumber	integer	输入页码
SortField	SortField	string	输入排序字段
SortOrder	SortOrder	string	输入排序顺序

名称	路径	类型	说明
documentIds	documentIds	array of string	documentIds
documentSearchCount	documentSearchCount	integer	文档搜索计数

文档重新编制索引

操作 ID:: DocumentReindex

重新编制文档索引

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
DocumentIds	DocumentIds	array of string	DocumentIds
IndexId	IndexId	string	输入索引 ID
IndexValue	IndexValue	string	输入索引值

名称	路径	类型	说明
		array of object
documentId	documentId	string	文档 ID 值
isReIndexed	isReIndexed	boolean	是文档 ReIndexed
reIndexDocumentException	reIndexDocumentException	string	reIndex 文档异常

注销

操作 ID:: Logout

注销应用程序

参数

名称	密钥	必需	类型	说明
标记	X-Authorization		string	令牌身份验证

名称	路径	类型	说明
isLogoutSuccess	isLogoutSuccess	boolean	注销是否成功

添加主可交付结果

操作 ID:: AddMasterDeliverable

添加主可交付结果

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
可交付结果名称	deliverableName	string	可交付结果名称
截止日期	dueDate	string	截止日期
第一个扩展	firstExtension	string	第一个扩展
第二个扩展	secondExtension	string	第二个扩展
第三个扩展	thirdExtension	string	第三个扩展
日历或会计	calenderOrFiscal	string	日历或会计
Extension	extension	integer	Extension
服务类型	ServiceType	string	服务类型
抽屉名称	DrawerName	string	抽屉名称

名称	路径	类型	说明
已保存	isSaved	boolean	已保存
响应消息	responseMessage	string	响应消息

名称	密钥	必需	类型	说明
登录名	LoginName	True	string	输入登录名
密码	Password	True	password	输入密码

名称	路径	类型	说明
authSuccess	authSuccess	boolean	身份验证成功
authenticationResponse	authenticationResponse	string	身份验证响应值
customerId	customerId	string	客户 ID 值
错误代码	errorCode	string	错误代码值
idleSessionTimeoutMinutes	idleSessionTimeoutMinutes	integer	空闲会话超时分钟数
loneStarFirmId	loneStarFirmId	string	孤星公司 ID
loneStarValidated	loneStarValidated	boolean	单星验证
代币	token	string	token value
userId	userId	string	用户 ID 值
用户名	userName	string	用户名值

编辑 WorkFlow

操作 ID:: EditWorkflow

编辑 WorkFlow

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
归档 ID	filingId	integer	归档 ID
客户端名称	ClientName	string	客户端名称
客户端编号	ClientNumber	string	客户端编号
预订类型	EngagementType	string	预订类型
PIC	PIC	string	PIC
年份	Year	string	年份
句点结束	PeriodEnd	string	句点结束
可交付结果名称	action	string	可交付结果名称
当前截止日期	currentduedate	string	当前截止日期
原始截止日期	originalduedate	string	原始截止日期
附件	form	string	附件
注释作	action	string	注释作
备注类型	noteType	string	备注类型
noteid	noteid	array of string	noteid
注意消息	note	string	注意消息
信息字段名称	name	string	信息字段名称
信息字段值	value	string	信息字段值
传递方法	Delivery	string	传递方法
目的地	Destination	string	目的地
源文档	sourceDocument	string	源文档
责任字段	responsibleField	string	责任字段
分配到	value	string	分配到
重新编制文档索引	reindexDocs	boolean	重新编制文档索引

名称	路径	类型	说明
归档 ID	filingId	integer	归档 ID
错误注释	errorComment	string	错误注释
状态	status	boolean	状态
errorMessage	errorMessage	array of object	errorMessage
Name	errorMessage.name	string	Name
状态	errorMessage.status	boolean	状态
错误注释	errorMessage.errorComment	string	错误注释

编辑主可交付结果

操作 ID:: EditMasterDeliverable

编辑主可交付结果

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
当前可交付结果名称	currentdeliverableName	string	当前可交付结果名称
更新可交付结果名称	updatedeliverableName	string	更新可交付结果名称
截止日期	dueDate	string	截止日期
第一个扩展	firstExtension	string	第一个扩展
第二个扩展	secondExtension	string	第二个扩展
第三个扩展	thirdExtension	string	第三个扩展
日历或会计	calenderOrFiscal	string	日历或会计
Extension	extension	integer	Extension
服务类型	serviceType	string	服务类型
抽屉名称	drawerName	string	抽屉名称

名称	路径	类型	说明
更新状态	isUpdated	boolean	更新状态
响应消息	responseMessage	string	响应消息

获取 LookupList 值

操作 ID:: GetLookupList

从 LookupList 中提取值

参数

名称	密钥	必需	类型	说明
抽屉 ID。示例客户端抽屉：“0000000001”	drawerId	True	string	输入抽屉 ID
标记	X-Authorization		string	令牌身份验证

名称	路径	类型	说明
		array of object
clientName	clientName	string	客户端名称值
clientNumber	clientNumber	string	客户端编号值

获取上传位置

操作 ID:: GetUploadLocation

提取用户的上传位置

参数

名称	密钥	必需	类型	说明
标记	X-Authorization		string	令牌身份验证

名称	路径	类型	说明
uploadLocations	uploadLocations	array of object	uploadLocations
locationName	uploadLocations.locationName	string	location Name 值
locationPath	uploadLocations.locationPath	string	location Path 值
uploadLocationsException	uploadLocationsException	string	上传位置异常

获取主可交付结果

操作 ID:: GetMasterDeliverable

获取主可交付结果

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
页码	PageNumber	integer	页码
页面大小	pageSize	integer	页面大小
服务类型	ServiceType	string	服务类型
抽屉名称	DrawerName	string	抽屉名称

名称	路径	类型	说明
deliverableList	deliverableList	array of object	deliverableList
可交付结果名称	deliverableList.deliverableName	string	可交付结果名称
扩展类型	deliverableList.extensionType	string	扩展类型
截止日期	deliverableList.dueDate	string	截止日期
第一个扩展	deliverableList.firstExtension	string	第一个扩展
第二个扩展	deliverableList.secondExtension	string	第二个扩展
第三个扩展	deliverableList.thirdExtension	string	第三个扩展
Extension	deliverableList.extension	string	Extension
Action	deliverableList.action	string	Action
义务 ID	deliverableList.obligationId	string	义务 ID
公司托管选项	deliverableList.firmManagedOption	string	公司托管选项
记录总数	totalRecords	string	记录总数
响应消息	responseMessage	string	响应消息

获取子索引

操作 ID:: GetChildIndexes

获取基于列表 ID 的子索引值列表，该列表是在选择父列表值时提供的。

参数

名称	密钥	必需	类型	说明
IndexId	indexId	True	string	输入索引 ID
ListID	listId	True	string	输入列表 ID
标记	X-Authorization		string	令牌身份验证

名称	路径	类型	说明
		array of object
childIndexId	childIndexId	string	子索引 ID 值
childListId	childListId	integer	子列表 ID 值
hasChildren	hasChildren	boolean	索引是否具有子索引
listEntryId	listEntryId	integer	list Entry Id 值
listId	listId	integer	列表 ID 值
value	value	string	value

获取密码策略

操作 ID:: GetPasswordPolicy

提取公司的密码策略

参数

名称	密钥	必需	类型	说明
标记	X-Authorization		string	令牌身份验证

名称	路径	类型	说明
clientId	passwordPolicy.clientId	string	客户端 ID 值
forbidden_pwd_words	passwordPolicy.forbidden_pwd_words	array of string	forbidden_pwd_words
lockout_threshold	passwordPolicy.lockout_threshold	integer	锁定阈值
max_length	passwordPolicy.max_length	integer	密码的最大长度
max_login_similarity	passwordPolicy.max_login_similarity	string	最大登录相似性
max_pwd_age	passwordPolicy.max_pwd_age	integer	密码的最大 pwd 期限
max_repeat_chars	passwordPolicy.max_repeat_chars	string	密码中的 max repeat chars
max_sequential_chars	passwordPolicy.max_sequential_chars	string	最大顺序字符数
mfa	passwordPolicy.mfa	integer	mfa 值
min_length	passwordPolicy.min_length	integer	密码的最小长度
pwd_req_alpha	passwordPolicy.pwd_req_alpha	integer	Alpha 密码要求
pwd_req_lower	passwordPolicy.pwd_req_lower	integer	密码要求较低
pwd_req_number	passwordPolicy.pwd_req_number	integer	密码编号要求
pwd_req_symbol	passwordPolicy.pwd_req_symbol	integer	符号密码要求
pwd_req_upper	passwordPolicy.pwd_req_upper	integer	密码要求上限
passwordPolicyException	passwordPolicyException	string	passwordPolicyException

获取报表列表

操作 ID:: GetListOfReports

提取可用于用户管理的报表

参数

名称	密钥	必需	类型	说明
标记	X-Authorization		string	令牌身份验证

名称	路径	类型	说明
reports	reports	array of object	reports
reportName	reports.reportName	array of string	reportName
报告类型	reports.reportType	string	报表类型值
reportsException	reportsException	string	报告异常值

获取抽屉

操作 ID:: GetDrawers

提取登录用户可访问的抽屉

参数

名称	密钥	必需	类型	说明
标记	X-Authorization		string	令牌身份验证

名称	路径	类型	说明
		array of object
drawerID	drawerID	string	抽屉 ID 值
drawerName	drawerName	string	抽屉名称值
添加	permissions.add	boolean	添加值
删除	permissions.delete	boolean	delete 值
编辑	permissions.edit	boolean	编辑值
lookupManagement	permissions.lookupManagement	boolean	lookupManagement 值
视图	permissions.view	boolean	视图值

获取抽屉索引

操作 ID:: GetDrawerIndexes

检索为抽屉设置的文档索引列表

参数

名称	密钥	必需	类型	说明
DrawerId	drawerId	True	string	输入抽屉 ID
标记	X-Authorization		string	令牌身份验证

名称	路径	类型	说明
		array of object
childIndexId	childIndexId	string	子索引 ID 值
indexId	indexId	string	索引 ID 值
indexName	indexName	string	索引名称值
indexType	indexType	string	索引类型值
length	length	integer	抽屉索引长度
listId	listId	integer	列表 ID 值
lookupAutoUpdate	lookupAutoUpdate	boolean	查找自动更新
required	required	boolean	是否需要索引

获取文档

操作 ID:: GetDocument

下载文档

参数

名称	密钥	必需	类型	说明
DocumentId	documentId	True	string	输入文档 ID
标记	X-Authorization		string	令牌身份验证

获取文档历史记录

操作 ID:: GetDocumentHistory

获取文档的历史记录

参数

名称	密钥	必需	类型	说明
DocumentId	documentId	True	string	输入文档 ID
标记	X-Authorization		string	令牌身份验证

名称	路径	类型	说明
documentAudit	documentAudit	array of	documentAudit
documentHistoryException	documentHistoryException	string	文档历史记录异常
documentId	documentId	string	文档 ID 值
mergeDocHistory	mergeDocHistory	array of	mergeDocHistory

获取文档状态

操作 ID:: GetDocumentStatus

获取文档的状态

参数

名称	密钥	必需	类型	说明
标记	X-Authorization		string	令牌身份验证
身体	body		array of string

名称	路径	类型	说明
		array of object
documentId	documentId	string	文档 ID 值
documentStatusException	documentStatusException	string	文档状态异常
drawerId	drawerId	string	抽屉 ID 值
文件大小	fileSize	string	文件大小值
isArchived	isArchived	boolean	是已存档的文档
isCheckedOut	isCheckedOut	boolean	是已签出的文档
isEncrypted	isEncrypted	boolean	是文档加密
isFiled	isFiled	boolean	是已提交的文档
isInRedactionQueue	isInRedactionQueue	boolean	是“修订队列”中的文档
isInTaxsortQueue	isInTaxsortQueue	boolean	是 Taxsort 队列中的文档
isLocked	isLocked	boolean	是锁定的文档
isOfficeDocument	isOfficeDocument	boolean	是 Office 文档的文档
isPublished	isPublished	boolean	是已发布的文档
isUndergoingMerging	isUndergoingMerging	boolean	是正在合并的文档
localFile	localFile	string	是本地文件的文档
noEdit	noEdit	boolean	无“编辑”值
页面	pages	integer	文档中的页面
reviewed	reviewed	boolean	审阅状态
taxSort	taxSort	boolean	是文档 taxSorted
类型	type	string	文件类型
版本	version	integer	文档版本

获取文档索引

操作 ID:: GetDocumentIndexes

检索文档的索引

参数

名称	密钥	必需	类型	说明
DocumentId	documentId	True	string	输入文档 ID
标记	X-Authorization		string	令牌身份验证

名称	路径	类型	说明
		array of object
indexId	indexId	string	索引 ID 值
indexValue	indexValue	string	索引值

获取用户

操作 ID:: GetUsers

获取已登录用户的 GFR 用户

参数

名称	密钥	必需	类型	说明
用户类型	userType		string	输入用户类型
标记	X-Authorization		string	令牌身份验证

名称	路径	类型	说明
		array of object
isActive	isActive	boolean	用户是否处于活动状态
loginId	loginId	string	登录 ID 值

获取用户信息

操作 ID:: GetUserInfo

提取 GFR 用户信息

参数

名称	密钥	必需	类型	说明
标记	X-Authorization		string	令牌身份验证
登录名	LoginName	True	string	输入 LoginName
用户类型	UserType	True	string	选择 UserType

名称	路径	类型	说明
创建日期	createDate	string	创建日期
createdBy	createdBy	string	createdBy
描述	description	string	描述
禁用的	disabled	integer	禁用的
disabledByAdmin	disabledByAdmin	boolean	disabledByAdmin
emailNotify	emailNotify	boolean	emailNotify
emailNotifyEventMgmtGroups	emailNotifyEventMgmtGroups	boolean	emailNotifyEventMgmtGroups
emailNotifyEventMgmtUsers	emailNotifyEventMgmtUsers	boolean	emailNotifyEventMgmtUsers
emailNotifyGroup	emailNotifyGroup	boolean	emailNotifyGroup
forcePasswordChange	forcePasswordChange	boolean	forcePasswordChange
fullName	fullName	string	fullName
hasDrawerSetupRights	hasDrawerSetupRights	string	hasDrawerSetupRights
isAdmin	isAdmin	integer	isAdmin
isManager	isManager	integer	isManager
licenseType	licenseType	string	licenseType
locationID	locationID	string	locationID
loginID	loginID	string	loginID
managerFullName	managerFullName	string	managerFullName
managerId	managerId	string	managerId
managerLoginId	managerLoginId	string	managerLoginId
oberonUser	oberonUser	integer	oberonUser
离线	offline	boolean	离线
passwordChangeDate	passwordChangeDate	string	passwordChangeDate
passwordChangeInterval	passwordChangeInterval	integer	passwordChangeInterval
passwordExpireDate	passwordExpireDate	string	passwordExpireDate
reports	reports	boolean	reports
签名	signature	string	签名
systemAdmin	systemAdmin	boolean	systemAdmin
taxFlow	taxFlow	boolean	taxFlow
userAdministration	userAdministration	integer	userAdministration
userID	userID	string	userID
workflowManagerUser	workflowManagerUser	boolean	workflowManagerUser

获取用户信息 V2

操作 ID:: GetUserInfoV2

获取用户输入

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
登录名	LoginName	string	登录名
用户类型	UserType	string	用户类型

名称	路径	类型	说明
用户 ID	userID	string	用户 ID
登录 ID	loginID	string	登录 ID
完整姓名	fullName	string	完整姓名
创建日期	createDate	string	创建日期
创建者	createdBy	string	创建者
Description	description	string	Description
Disabled	disabled	integer	Disabled
由管理员禁用	disabledByAdmin	boolean	由管理员禁用
密码过期日期	passwordExpireDate	string	密码过期日期
强制更改密码	forcePasswordChange	boolean	强制更改密码
密码更改日期	passwordChangeDate	string	密码更改日期
密码更改间隔	passwordChangeInterval	integer	密码更改间隔
许可证类型	licenseType	string	许可证类型
离线	offline	boolean	离线
报表	reports	boolean	报表
系统管理员	systemAdmin	boolean	系统管理员
Signature	signature	string	Signature
位置 ID	locationID	string	位置 ID
具有抽屉设置权限	hasDrawerSetupRights	string	具有抽屉设置权限
税务流	taxFlow	boolean	税务流
电子邮件通知	emailNotify	boolean	电子邮件通知
电子邮件通知组	emailNotifyGroup	boolean	电子邮件通知组
电子邮件通知事件 Mgmt 用户	emailNotifyEventMgmtUsers	boolean	电子邮件通知事件 Mgmt 用户
电子邮件通知事件 Mgmt 组	emailNotifyEventMgmtGroups	boolean	电子邮件通知事件 Mgmt 组
门户用户管理	portalUserAdministration	boolean	门户用户管理
内部用户管理	internalUserAdministration	boolean	内部用户管理
工作流管理器用户	workflowManagerUser	boolean	工作流管理器用户
管理器 ID	managerId	string	管理器 ID
管理器登录 ID	managerLoginId	string	管理器登录 ID
经理全名	managerFullName	string	经理全名
是管理器	isManager	integer	是管理器
Oberon 用户	oberonUser	integer	Oberon 用户
是管理员	isAdmin	integer	是管理员
上次登录	lastLogin	string	上次登录
groups	groups	array of string	groups

获取用户文档安全性

操作 ID:: GetUserDocumentSecurity

每次登录提取用户文档安全性

参数

名称	密钥	必需	类型	说明
LoginId	loginId	True	string	输入登录 ID
CabinetName	cabinetName	True	string	输入内阁名称
DrawerName	drawerName	True	string	输入抽屉名称
标记	X-Authorization		string	令牌身份验证

名称	路径	类型	说明
cabinetName	cabinetName	string	内阁名称
documentSecurity	documentSecurity	string	文档安全值
drawerName	drawerName	string	抽屉名称值
getUserDocSecurityException	getUserDocSecurityException	string	用户文档安全异常
loginId	loginId	string	登录 ID 值

获取用户权限

操作 ID:: GetUserPermission

获取用户的权限

参数

名称	密钥	必需	类型	说明
登录	login	True	string	输入登录名
标记	X-Authorization		string	令牌身份验证

名称	路径	类型	说明
cabinet	cabinet	string	cabinet 名称值
添加	cabinetPermission.add	boolean	添加值
删除	cabinetPermission.delete	boolean	delete 值
拒绝	cabinetPermission.deny	boolean	deny 值
编辑	cabinetPermission.edit	boolean	编辑值
查找	cabinetPermission.lookUp	boolean	lookUp 值
读取	cabinetPermission.read	boolean	读取值
drawerPermissions	drawerPermissions	array of object	drawerPermissions
抽屉	drawerPermissions.drawer	string	抽屉名称值
添加	drawerPermissions.permission.add	boolean	添加值
删除	drawerPermissions.permission.delete	boolean	delete 值
拒绝	drawerPermissions.permission.deny	boolean	deny 值
编辑	drawerPermissions.permission.edit	boolean	编辑值
查找	drawerPermissions.permission.lookUp	boolean	lookUp 值
读取	drawerPermissions.permission.read	boolean	读取值
getUserPermissionException	getUserPermissionException	string	用户权限异常
loginId	loginId	string	登录 ID 值

获取索引值列表

操作 ID:: GetListTypeIndexData

获取列表类型索引的所有条目

参数

名称	密钥	必需	类型	说明
IndexId	indexId	True	string	输入索引 ID
标记	X-Authorization		string	令牌身份验证

名称	路径	类型	说明
		array of object
childIndexId	childIndexId	string	子索引 ID 值
childListId	childListId	integer	子列表 ID 值
hasChildren	hasChildren	boolean	索引是否具有子索引
listEntryId	listEntryId	integer	list Entry Id 值
listId	listId	integer	列表 ID 值
value	value	string	value

获取索引的动态规则

操作 ID:: GetDynamicRulesForIndex

获取为指定索引配置的动态规则列表

参数

名称	密钥	必需	类型	说明
IndexId	indexId	True	string	输入索引 ID
标记	X-Authorization		string	令牌身份验证

名称	路径	类型	说明
		array of object
条件	condition	string	条件值
dependentIndexId	dependentIndexId	string	从属索引 ID 值
dynamicRuleId	dynamicRuleId	string	动态规则 ID 值
value	value	string	value

获取组

操作 ID:: GetGroups

提取可用于用户和组管理的组

参数

名称	密钥	必需	类型	说明
标记	X-Authorization		string	令牌身份验证

名称	路径	类型	说明
		array of object
id	id	string	组 ID 值
mfa	mfa	integer	mfa 值
mfaRequired	mfaRequired	integer	mfa 必需值
姓名	name	string	组名称值

获取组文档安全性

操作 ID:: GetGroupDocumentSecurity

检索组文档安全性

参数

名称	密钥	必需	类型	说明
GroupName	groupName	True	string	输入组名称
CabinetName	cabinetName	True	string	输入内阁名称
DrawerName	drawerName	True	string	输入抽屉名称
标记	X-Authorization		string	令牌身份验证

名称	路径	类型	说明
组名称	groupName	string	组名称
内阁名称	cabinetName	string	内阁名称
抽屉名称	drawerName	string	抽屉名称
documentSecurity	documentSecurity	array of object	documentSecurity
索引名称	documentSecurity.indexName	string	索引名称
文档安全类型	documentSecurity.docSecurityType	string	文档安全类型
values	documentSecurity.values	array of string	values
组文档安全异常	getGroupDocSecurityException	string	组文档安全异常

获取组权限

操作 ID:: GetGroupPermissions

获取组的权限

参数

名称	密钥	必需	类型	说明
GroupName	groupName		string	输入组名称
标记	X-Authorization		string	令牌身份验证

名称	路径	类型	说明
cabinet	cabinet	string	内阁名称
添加	cabinetPermissions.add	boolean	添加权限
删除	cabinetPermissions.delete	boolean	删除权限
拒绝	cabinetPermissions.deny	boolean	拒绝权限
编辑	cabinetPermissions.edit	boolean	编辑权限
查找	cabinetPermissions.lookUp	boolean	lookUp 权限
读取	cabinetPermissions.read	boolean	读取权限
drawerPermissions	drawerPermissions	array of object	drawerPermissions
抽屉	drawerPermissions.drawer	string	抽屉名称
添加	drawerPermissions.permission.add	boolean	添加权限
删除	drawerPermissions.permission.delete	boolean	删除权限
拒绝	drawerPermissions.permission.deny	boolean	拒绝权限
编辑	drawerPermissions.permission.edit	boolean	编辑权限
查找	drawerPermissions.permission.lookUp	boolean	lookUp 权限
读取	drawerPermissions.permission.read	boolean	读取权限
groupName	groupName	string	组名称
groupPermissionException	groupPermissionException	string	组权限异常

获取许可证

操作 ID:: GetLicenses

检索许可计数

参数

名称	密钥	必需	类型	说明
LicenseType	license		string	输入许可证类型
标记	X-Authorization		string	令牌身份验证

名称	路径	类型	说明
assignedLicenses	assignedLicenses	string	分配的许可证计数
getLicenseException	getLicenseException	string	获取许可证异常
许可	license	string	许可证名称
消息	message	string	消息
totalLicenses	totalLicenses	string	许可证总数

设置用户文档安全性

操作 ID:: SetUserDocSecurity

分配用户文档安全权限

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
CabinetName	CabinetName	string	输入内阁名称
DocSecurityType	DocSecurityType	string	输入文档安全类型
IndexName	IndexName	string	输入索引名称
操作	Operation	string	输入作
价值观	Values	array of string	价值观
DrawerName	DrawerName	string	输入抽屉名称
LoginId	LoginId	string	输入登录 ID

名称	路径	类型	说明
isSetUserDocSecurity	isSetUserDocSecurity	boolean	应用了用户文档安全性
loginId	loginId	string	登录 ID 值
setUserDocSecurityException	setUserDocSecurityException	string	设置用户文档安全异常

设置用户权限

操作 ID:: SetUserPermissions

向用户分配权限

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
内阁	Cabinet	string	输入内阁名称
添加	Add	string	指定 true 或 false
删除	Delete	string	指定 true 或 false
Deny	Deny	string	指定 true 或 false
Edit	Edit	string	指定 true 或 false
LookUp	LookUp	string	指定 true 或 false
读取	Read	string	指定 true 或 false
银箱	Drawer	string	输入抽屉名称
添加	Add	string	指定 true 或 false
删除	Delete	string	指定 true 或 false
Deny	Deny	string	指定 true 或 false
Edit	Edit	string	指定 true 或 false
LookUp	LookUp	string	指定 true 或 false
读取	Read	string	指定 true 或 false
LoginId	LoginId	string	输入登录 ID

名称	路径	类型	说明
isSetUserPermission	isSetUserPermission	boolean	用户权限更新
loginId	loginId	string	登录 ID 值
setUserPermissionException	setUserPermissionException	string	设置用户权限异常

设置组文档安全性

操作 ID:: SetGroupDocSecurity

将文档安全性分配给组

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
CabinetName	CabinetName	string	输入内阁名称
DocSecurityType	DocSecurityType	string	输入文档安全类型
IndexName	IndexName	string	输入索引名称
操作	Operation	string	输入作类型
价值观	Values	array of string	价值观
DrawerName	DrawerName	string	输入抽屉名称
GroupName	GroupName	string	输入组名称

名称	路径	类型	说明
groupName	groupName	string	组名称值
isSetGroupDocSecurity	isSetGroupDocSecurity	boolean	设置文档安全性
setGroupDocSecurityException	setGroupDocSecurityException	string	组文档安全异常

设置组权限

操作 ID:: SetGroupPermissions

为组分配权限

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
内阁	Cabinet	string	输入内阁名称
添加	Add	string	指定 true 或 false
删除	Delete	string	指定 true 或 false
Deny	Deny	string	指定 true 或 false
Edit	Edit	string	指定 true 或 false
LookUp	LookUp	string	指定 true 或 false
读取	Read	string	指定 true 或 false
银箱	Drawer	string	输入抽屉名称
添加	Add	string	指定 true 或 false
删除	Delete	string	指定 true 或 false
Deny	Deny	string	指定 true 或 false
Edit	Edit	string	指定 true 或 false
LookUp	LookUp	string	指定 true 或 false
读取	Read	string	指定 true 或 false
GroupName	GroupName	string	输入组名称

名称	路径	类型	说明
groupId	groupId	string	组 ID 值
groupPermissionException	groupPermissionException	string	组权限异常
isSet	isSet	boolean	是否应用了权限

路由工作流 V2

操作 ID:: RouteWorkflowV2

路由工作流 V2

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
filingId	filingId	array of integer	filingId
CurrentStep	CurrentStep	array of string	CurrentStep
完成	Complete	boolean	完成
已完成日期	CompletedDate	string	已完成日期
下一步	NextStep	string	下一步
分配到	AssignedTo	string	分配到
已分配日期	AssignedDate	string	已分配日期
Priority	Priority	string	Priority
状态	Status	string	状态
路由说明	RoutingNote	string	路由说明
电子邮件通知	emailNotify	boolean	电子邮件通知

名称	路径	类型	说明
归档 ID	filingId	string	归档 ID
路由	isRouted	boolean	路由

通过可交付结果获取 FirmFlow 数据

操作 ID:: GetFirmFlowDeliverableReport

按可交付结果数据获取跟踪报告

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
有责任	Accountable	string	输入“责任”值
AssignedOn	AssignedOn	string	输入已分配的日期
分配到	AssignedTo	string	输入“已分配给”值
AssignmentHistory	AssignmentHistory	string	输入工作分配历史记录
CompletedBy	CompletedBy	string	输入“已完成依据”值
CompletedOn	CompletedOn	string	输入已完成日期
CurrentDueDate	CurrentDueDate	string	输入当前截止日期
CurrentStep	CurrentStep	string	输入当前步骤
DateExtended	DateExtended	string	输入延长日期
DaysAtStep	DaysAtStep	string	在步骤中输入天数
DaysBetweenRoutings	DaysBetweenRoutings	string	输入路由之间的天数
DrawerId	DrawerId	string	输入抽屉 ID
EngagementType	EngagementType	string	输入 Engagement 类型
InProcessOnly	InProcessOnly	string	“仅输入进程内”值
Indexes	Indexes	array of string	Indexes
InformationFields	InformationFields	array of string	InformationFields
OriginalDueDate	OriginalDueDate	string	输入原始截止日期
PIC	PIC	string	输入 PIC
PageNumber	PageNumber	string	输入页码
Priority	Priority	string	输入优先级
ReceivedFrom	ReceivedFrom	string	输入 Received From 值
接收时间	ReceivedOn	string	输入接收日期
负责	Responsible	string	输入“负责任的”值
RoutingDetails	RoutingDetails	string	输入路由详细信息
森顿	SentOn	string	输入发送日期
SentTo	SentTo	string	输入“发送到”值
ServiceType	ServiceType	string	输入服务类型
状态	Status	string	输入状态
TotalDaysAtStep	TotalDaysAtStep	string	在步骤中输入总天数
TotalDaysInProcess	TotalDaysInProcess	string	输入处理的总天数
Workflow	Workflow	string	输入工作流名称
WorkflowDescription	WorkflowDescription	string	输入工作流说明

名称	路径	类型	说明
firmFlowReportResponse	firmFlowReportResponse	array of object	firmFlowReportResponse
有责任	firmFlowReportResponse.accountable	string	accountable 值
assignedOn	firmFlowReportResponse.assignedOn	string	分配日期
assignedTo	firmFlowReportResponse.assignedTo	string	分配给值
assignedToYesOrNo	firmFlowReportResponse.assignedToYesOrNo	string	是否分配了工作流
assignmentHistory	firmFlowReportResponse.assignmentHistory	string	工作分配历史记录值
clientName	firmFlowReportResponse.clientName	string	客户端名称值
clientNumber	firmFlowReportResponse.clientNumber	string	客户端编号值
completedBy	firmFlowReportResponse.completedBy	string	completed By value
completedOn	firmFlowReportResponse.completedOn	string	已完成日期
currentDueDate	firmFlowReportResponse.currentDueDate	string	当前截止日期
currentStep	firmFlowReportResponse.currentStep	string	当前步骤值
dateExtended	firmFlowReportResponse.dateExtended	string	date Extended
daysAtStep	firmFlowReportResponse.daysAtStep	string	步骤中的工作流天数
daysBetweenRoutings	firmFlowReportResponse.daysBetweenRoutings	string	路由之间的工作流天数
交付	firmFlowReportResponse.deliverables	string	可交付结果值
drawerId	firmFlowReportResponse.drawerId	string	抽屉 ID 值
eFileYesOrNo	firmFlowReportResponse.eFileYesOrNo	string	是可交付结果，可交付结果为 eFiled
engagementType	firmFlowReportResponse.engagementType	string	engagement 类型值
extendedYesOrNo	firmFlowReportResponse.extendedYesOrNo	string	已扩展可交付结果
informationFields	firmFlowReportResponse.informationFields	array of object	informationFields
姓名	firmFlowReportResponse.informationFields.name	string	姓名
value	firmFlowReportResponse.informationFields.value	string	value
originalDueDate	firmFlowReportResponse.originalDueDate	string	原始截止日期
periodEnd	firmFlowReportResponse.periodEnd	string	工作流结束周期
pic	firmFlowReportResponse.pic	string	工作流的图片
picYesOrNo	firmFlowReportResponse.picYesOrNo	string	已分配图片
priority	firmFlowReportResponse.priority	string	优先级值
进展	firmFlowReportResponse.progress	string	进度值
receivedFrom	firmFlowReportResponse.receivedFrom	string	received From 值
receivedOn	firmFlowReportResponse.receivedOn	string	接收日期
负责	firmFlowReportResponse.responsible	string	责任值
responsibleUserOrGroups	firmFlowReportResponse.responsibleUserOrGroups	array of	responsibleUserOrGroups
routingNotes	firmFlowReportResponse.routingNotes	string	传送工作流说明
routingSummary	firmFlowReportResponse.routingSummary	array of	routingSummary
sentOn	firmFlowReportResponse.sentOn	string	发送日期
sentTo	firmFlowReportResponse.sentTo	string	“发送到”值
serviceType 服务	firmFlowReportResponse.serviceType	string	工作流的服务类型
状态	firmFlowReportResponse.status	string	工作流的状态
totalDaysAtStep	firmFlowReportResponse.totalDaysAtStep	string	工作流总天数（分步）
totalDaysInProcess	firmFlowReportResponse.totalDaysInProcess	string	工作流进程总天数
工作流	firmFlowReportResponse.workflow	string	工作流类型
workflowDescription	firmFlowReportResponse.workflowDescription	string	工作流说明
年	firmFlowReportResponse.year	string	工作流年份
getFirmFlowException	getFirmFlowException	string	get FirmFlow 异常
pageNumber	pageNumber	string	请求的页码
pageSize	pageSize	integer	请求的页面大小
totalPages	totalPages	integer	请求页总数
totalRecords	totalRecords	integer	请求的记录总数

验证令牌

操作 ID:: ValidateToken

验证令牌状态

参数

名称	密钥	必需	类型	说明
标记	X-Authorization		string	令牌身份验证

response: boolean

验证索引

操作 ID:: ValidateIndexes

检查提供的索引是否有效。

参数

名称	密钥	类型	说明
标记	X-Authorization	string	令牌身份验证
DrawerId	DrawerId	string	输入抽屉 ID
IndexId	IndexId	string	输入索引 ID
IndexValue	IndexValue	string	输入索引值

名称	路径	类型	说明
errorMessage	errorMessage	string	错误信息
错误	errors	array of	错误
isValid	isValid	boolean	是索引有效

通过

GoFileRoom

先决条件

如何获取凭据？

正在创建连接

违约

限制

操作

Index LookupList Find

参数

返回

Taxsort 文档

参数

返回

修改用户

参数

返回

修改组

参数

返回

创建工作流

参数

返回

创建文档

参数

返回

创建用户

参数

返回

创建组

参数

返回

删除主可交付结果

参数

返回

删除工作流

参数

返回

删除文档

参数

返回

删除用户

参数

返回

发布文档状态

参数

返回

合并 PDF

参数

返回

复制文档

参数

返回

按可交付结果 V2 跟踪报告

参数

返回

按工作流跟踪报表

参数

返回

文档搜索

参数

返回

文档重新编制索引

参数

返回

注销

参数

返回

添加主可交付结果

参数

返回

登录

参数

返回

编辑 WorkFlow

参数

返回

编辑主可交付结果

参数

返回