检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
注意事项 当检验失败时返回的异常需要友好,用户能清楚知道错误原因。 校验功能最好在一个filter中实现,避免所有接口都实现一次检验。 父主题: 实现一个认证API
获取项目ID 操作场景 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。有如下两种获取方式: 从控制台获取项目ID(推荐使用) 调用API获取项目ID 从控制台获取项目ID 在调用接口的时候,部分URL中需要填入项目编号,所以需要获取到项目编号。编号获取步骤如下:
lotSplitSiteConfig.site001 批次拆分数量校验 lotqtycheck 填0时不进行校验,填其他值无效 是 控制调用Open API接口时批次拆分数量是否可以大于工单数量。 参数配置目录:参数配置 > iMES Site端 > 生产过程管理 > 批次拆分工厂配置 > {启用批次拆分的工厂编码}
请求头 使用机机认证调用接口时需传入header:Authorization,其值为机机鉴权token。 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 processInstanceId 否 String 流程实例ID(可通过获取导航树接口返回值中processId获取)
91c7d3a517" } 状态码 状态码 描述 200 接口返参 错误码 请参见错误码。 使用说明 如果需要获得正常的反参,则需在页面上运行一个真实存在的流程,取得该流程对应的获取导航树接口中的query参数。否则接口返回是200,返回信息中会有报错信息。 父主题: 流程定义API
快速开始 本章节以一个被调用API为例,进行检验API中token的合法性。 操作步骤 在一个待集成的应用系统中,找到一个API接口,如/testApi。 在工程中增加配置信息,具体配置获取方式见准备工作中收集信息章节。 jwt.service.publickey.url: 公钥获取地址
查询用户角色 功能介绍 查询用户角色接口。 URI GET /basic/mgmt/public/api/v1/sysmgr/roles 请求参数 表1 路径参数 参数 是否必选 参数类型 描述 tenantId 是 String 租户ID userName 是 String 用户名称
获取账号ID 操作步骤 在调用接口的时候,部分请求中需要填入账号名(domain name)和账号ID(domain_id)。获取步骤如下: 注册并登录管理控制台。 鼠标移动至用户名,在下拉列表中单击“我的凭证”。 在“API凭证”页面的查看“账号名”和“账号ID”。 图1 获取账号ID
使用机机认证调用接口时需传入header:Authorization,其值为机机鉴权token。 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 businessKey 否 String 参数解释: 流程实例申请单key。 可通过我的任务、我发起的流程等接口获取。 约束限制:
查询轻量化任务状态 功能介绍 查询轻量化任务状态 图纸上传完成后,即可调用该接口获取图纸轻量化转换状态,该接口可能需要调用多次,直到返回的数据轻量化状态为SUCCESS或FAILED,即代表轻量化转换结束。 如果轻量化状态为SUCCESS,则代表图纸轻量化转换成功,此时可通过li
380a0ca291a5" } 状态码 状态码 描述 200 接口返参 错误码 请参见错误码。 使用说明 如果需要获得正常的反参,则需在页面上运行一个真实存在的流程,单击保存草稿按钮,从接口中取得相应的入参。否则接口返回是200,返回信息中不会有真实模板的信息。 父主题: 流程定义API
3a1f1820" } 状态码 状态码 描述 200 接口返参 错误码 请参见错误码。 使用说明 如果需要获得正常的反参,则需在页面上运行一个真实存在的流程,在某一个审批节点单击提交按钮,从接口中取得相应的入参。否则接口返回是200,但是返回信息中会有错误提示。 父主题: 流程定义API
e 示例接口地址:{域名(有文根需带文根)}/pdmcore/ipdcworkflowservice/console/servicetask/api/localMethod/start_process/startProcessInstance 请求头 使用机机认证调用接口时需传入
/basic/mgmt/public/api/v1/sysmgr/teamrole/privilege?teamId=681912555060338688&teamName=test0009 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 code String 返回码 message String
完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token接口,返回如图1所示的消息头,其中“X-Subject-Tok
orderId String 请求跟踪流水号 msg String 接口响应信息 code Integer 接口返回码 data Array of HistoricProcessInstanceVO objects 接口响应数据,JSON对象或数组 pageInfo PageVo object
请求头 使用机机认证调用接口时需传入header:Authorization,其值为机机鉴权token。 请求参数 无 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 msg String 接口响应信息 code Integer 接口返回码 data Data
"name": "test001", "roleType": "teamRole", "description_en": "", "name_en": "test001"
响应Body参数 参数 参数类型 描述 code Integer 参数解释: 接口返回码。 取值范围: 不涉及。 默认取值: 不涉及。 data Array of RenderedTaskInfoVO objects 参数解释: 接口响应数据。 取值范围: 不涉及。 默认取值: 不涉及。 orderID
鉴权失败 接口鉴权失败 使用对应接口鉴权 500 IPDC.02010001 参数错误 检查接口入参未符合要求,应按照API文档中描述准确入参 检查接口入参是否符合要求 500 IPDC.02010033 系统内部错误 入参业务校验未通过,例如授权码已经失效,具体错误看接口返回错误信息