查询人员信息 - getUserInfos
功能介绍
本接口用于根据用户中文名查询流程引擎中的用户信息,适用于获取流程参与者的账户信息、账号状态等场景,以支持流程任务分配和审批人员配置。与启动流程 - startProcessInstance接口配合,可在启动流程时动态配置参与者信息;与完成任务 - completeTask接口配合,可用于任务转审或委托场景的人员选择。
接口约束
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /console/servicetask/api/localMethod/participant/getUserInfos
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: IAM用户的token。 通过调用IAM服务获取用户Token接口获取(即响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| X-Application-Id | 是 | String | 参数解释: 应用ID。 您可以在应用设计态的“应用中心 > 应用发布”页面获取,详情请参见应用发布。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 |
| X-Tenant-Id | 是 | String | 参数解释: 数据建模引擎运行态租户ID。 您可以从访问流程引擎编排服务的浏览器地址栏中获取。 流程编排服务地址:http://{承载流程编排服务的服务器域名或IP地址}:{流程编排服务的端口号}/{流程编排服务文根}/index.html#/processApplicationForm?tenantId={数据建模引擎运行态租户ID}&applicationId={应用ID} 例如tenantId=-1,表示数据建模引擎运行态默认租户“basicTenant”的租户ID为-1。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| X-User-Id | 是 | String | 参数解释: 请求当前接口时上下文中的用户ID,即OrgID的用户ID。 通过调用OrgID服务的获取用户信息接口获取。 约束限制: 仅基础版数据建模引擎-流程引擎需要配置此参数。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| userCn | 是 | String | 参数解释: 用户中文名,用于指定需要查询的用户名称。支持模糊匹配,传入部分名称即可检索包含该字符串的所有用户。 约束限制: 不涉及。 取值范围: 最大长度100字符。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | Integer | 参数解释: 接口返回码,标识接口调用的执行结果。 取值范围:
|
| data | Array of UserInfoVo objects | 参数解释: 接口响应数据,包含查询到的用户信息列表。如未找到匹配用户,返回空数组[]。 取值范围: 不涉及。 |
| orderID | String | 参数解释: 请求跟踪流水号,用于唯一标识本次接口请求,便于问题排查和链路追踪。 遇到问题时,请提供此ID联系技术支持。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| accountStatus | String | 参数解释: 账号状态,标识用户账号的当前可用状态。调用方需根据此字段过滤不可用用户。 取值范围: |
| ucn | String | 参数解释: 用户名中文名(User Chinese Name),用于展示用户的可读名称。与查询参数“userCn”匹配时返回此字段值。 取值范围: 不涉及。 |
| uid | String | 参数解释: 用户标识(User ID),通常与“ucn”值一致,用于系统内部用户标识。 取值范围: 不涉及。 |
| uuid | String | 参数解释: 用户唯一标识(Universally Unique Identifier),用于在分布式系统中唯一标识用户。此字段为启动流程时“participant”区块配置参与者的关键字段。 取值范围: 不涉及。 |
| account | String | 参数解释: 账号名,用于用户登录系统的账户标识。通常与“ucn”值一致。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
| result | String | 结果。 |
| trace_id | String | 追踪ID。 |
请求示例
POST https://dme.cn-north-4.huaweicloud.cn/workflowRuntime/console/servicetask/api/localMethod/participant/getUserInfos
{
"userCN" : "hid_fje4j2nvnue3xwp"
} 响应示例
状态码:200
OK
{
"code" : 0,
"data" : [ {
"accountStatus" : "1",
"ucn" : "hid_fje4j2nvnue3xwp",
"uid" : "hid_fje4j2nvnue3xwp",
"uuid" : "1008600000065234815",
"account" : "hid_fje4j2nvnue3xwp"
} ],
"orderID" : "d7f5caecec33476daf614302f13e67bb"
} 状态码:400
Bad Request
{
"error_code" : "500",
"error_msg" : "origin is not allowed!",
"result" : "FAIL",
"trace_id" : "2509bee60b3e40asdf9f741d9e23466a9"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
错误码
请参见错误码。