新增工序任务场景(API名称:createTaskScene)
功能介绍
该接口用于新增工序任务场景,在新增任务时需要优先新增有效的场景
相关接口
接口名称 |
调用说明 |
---|---|
调用该接口获取到Token,再调用其他接口时,需要在请求消息头中添加“Authorization”,其值即为Token。 |
|
新增时为防止重复可先进行任务场景的查询,也可以在新增后使用确保新增成功 |
|
新增后如需要删除可使用删除任务场景接口 |
|
提前预配置好“问题类别” |
|
扩展属性配置中,需提前配置好,可使用该接口查询 |
|
提前传入“组织单元编码”可使用该接口查询 |
URL
请求方式 |
HTTPS地址 |
服务架构 |
消息体类型 |
---|---|---|---|
POST |
https://isdp+域名/openapi/v1/openTaskScene/createTaskScene |
OpenAPI |
application/json |
调用流程:
因为任务场景的前置依赖数据较多,成功调用此API需要提前预配置如下信息:
1、 任务管理列表,扩展属性配置中,提前配置好“租户的全局扩展属性”。“任务场景”中写入的“扩展属性”,必须是已配置好的全局扩展属性。
2、 ISDP租户管理员设置,扩展属性配置中,预配置:通用检查作业下,配置“业务类型=作业”;
3、 问题类别配置中,提前预配置好“问题类别”,如创建“问题大类=掘锚工艺”下的问题子类;便于采集模板中,每个条目对应预置的问题类别(调“问题类别创建”API,建好问题类别)
4、 入参中的“组织单元”需要传“组织单元编码”。
请求头
KEY |
VALUE |
是否必填 |
描述 |
---|---|---|---|
Content-Type |
application/json |
是 |
无 |
Authorization |
bearer ${access_token} |
是 |
bearer +“ ”+5.2.1中获取的access_token的值 |
请求参数
参数 |
类型 |
是否必填 |
描述 |
---|---|---|---|
sceneName |
String |
是 |
场景名称 |
adminOrganization |
String |
是 |
组织单元编码 |
sceneMode |
Int |
否 |
只支持任务启用工序模式,传3 |
taskSceneExtendFieldList入参
参数 |
类型 |
是否必填 |
描述 |
---|---|---|---|
fieldName |
String |
否 |
场景扩展字段名称 |
fieldDefaultValue |
String |
否 |
扩展字段的默认值,入参有值,则赋值为扩展字段默认值,没有,则取全局扩展属性配置的默认值 |
stage |
Integer |
否 |
扩展属性阶段:1创建阶段 2执行阶段,不填写默认为创建阶段 |
taskSceneModeList入参
参数 |
类型 |
是否必填 |
描述 |
---|---|---|---|
sceneModeName |
String |
否 |
工序名称 |
description |
String |
否 |
工序描述,如果该工序配置了模板,工序描述也是kcp的名称 |
templateName |
String |
否 |
工序关联的模板名称。若工序需要关联模板,则名称要在templateInfoList集合中存在。无需关联则置空(命名规则:“任务场景名称-工序名称”作为检查模板名称) |
templateInfoList入参
参数 |
类型 |
是否必填 |
描述 |
---|---|---|---|
templateName |
String |
否 |
模板名称 |
kcpList入参
参数 |
类型 |
是否必填 |
描述 |
---|---|---|---|
name |
String |
否 |
条目名称 |
operationGuide |
String |
否 |
条目操作指导(500字以内) |
qualityStandard |
String |
否 |
条目质量标准(500字以内) |
issueType |
String |
否 |
条目采集问题类别,系统中存在。大类和小类用#分割,不同大类用英文分号分割。详见样例请求 |
severity |
Int |
否 |
问题严重程度。仅支持数字。0-一般;1-重要;2-严重 |
outputList入参
参数 |
类型 |
是否必填 |
描述 |
---|---|---|---|
outputType |
Int |
否 |
输出项类型,枚举值:文本,图片 |
outputName |
String |
否 |
输出项名称 |
响应参数
参数 |
类型 |
描述 |
---|---|---|
stateCode |
Int |
接口响应码。0代表成功,非0代表失败 |
errorMessage |
String |
接口请求错误原因 |
result |
String |
需要返回给调用者的数据 |
请求示例
{ "sceneName": "掘锚机日常电气检修标准作业流程", "adminOrganization": "1001", "sceneMode": 3, "taskSceneExtendFieldList": [ { "fieldName": "流程编号", "fieldDefaultValue": "SHPM-12-A02020201-0001", "stage": 1 }, { "fieldName": "配件", "fieldDefaultValue": "", "stage": 1 }, { "fieldName": "材料", "fieldDefaultValue": "棉纱(0.2Kg)、防锈油(1桶)、清洗剂(1瓶)。", "stage": 1 }, { "fieldName": "相关事故案例", "fieldDefaultValue": "", "stage": 1 }, { "fieldName": "工具", "fieldDefaultValue": "万用表(1块)、兆欧表(1块)、一字改锥6X200mm(1把)、十字改锥6X200mm(1把),克丝钳(1把)、便携式甲烷检测报警仪(1部)、8寸活动扳手(1把)、公制内六角扳手(1套)、验电器(1部)、放电绳(1根)、接地线(1根)等。", "stage": 1 }, { "fieldName": "重要危险源", "fieldDefaultValue": "1)顶、帮支护不完好,片帮,造成人员伤害。2)未检查瓦斯浓度或瓦斯浓度超限禁止送电。3)未检查瓦斯浓度或瓦斯浓度超限禁止送电。", "stage": 1 }, { "fieldName": "使用频率", "fieldDefaultValue": "高", "stage": 1 } ], "taskSceneModeList": [ { "sceneModeName": "停机、停电", "description": "1)掘锚机停止运行;2)掘锚机控制开关手把打到零位。", "templateName": "测试openApi导入模板" } ], "templateInfoList": [ { "templateName": "测试openApi导入模板", "kcpList": [ { "children": [ { "name": "启动掘锚机", "operationGuide": "【危险源及风险】1)启动前未预警,造成人员伤害;2)启动掘锚机前,未确认周围无人员作业,造成人员伤害。\n【风险值】12\n【风险等级】中等\n【管控措施】设备启动前需发出预警信号,确保设备周边无人时方可启动。", "qualityStandard": "运行正常。", "issueType": "掘锚工艺#工器具不完好或有缺陷,造成事故", "severity": 1, "outputList": [ { "outputType": "文本", "outputName": "备注" }, { "outputType": "图片", "outputName": "图片" } ] } ] } ] } ] }
响应示例
{ "stateCode": "0", "errorMessage": null, "result": null }
状态码
状态码请参见状态码。
错误码
错误码请参见错误码。