新增任务(API名称:createTask)
功能介绍
该接口用于创建工单任务,工单任务可定义任务类型、字段、采集清单、审批流程、作业工序等,创建的任务可用于现场作业的管理。
相关API
| 接口名称 | 调用说明 |
|---|---|
| 调用该接口获取到Token,再调用其他接口时,需要在请求消息头中添加“Authorization”,其值即为Token。 | |
| 调用该接口获取到任务场景的场景名称。 创建任务时,需要输入获取到的场景名称。 | |
| 调用该接口获取执行人。 创建任务时,任务模式为“启用子任务”时,需要输入获取到执行人;其他任务模式“执行人”为空则提交后为“待调度”状态,“执行人”填写后提交为“待执行”或“任务申请待审批”状态。 | |
| 创建任务后,可以调用该接口查询创建的任务。 |
调用流程
URL
| 请求方式 | HTTPS地址 | 服务架构 | 消息体类型 |
|---|---|---|---|
| POST | https://isdp+域名/openapi/v1/openSceneTask/createTask | OpenAPI | application/json |
请求头
| KEY | VALUE | 是否必填 | 描述 |
|---|---|---|---|
| Content-Type | application/json | 是 | 无 |
| Authorization | bearer ${access_token} | 是 | bearer +“ ”+5.2.1中获取的access_token的值 |
请求参数
| 参数 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| taskQueries | List | 是 | 任务集合。 |
| operUserId | Long | 否 | 操作人。 |
| operUserNo | Long | 否 | 操作人账号。 |
| customerTaskId | Long | 否 | 客户任务ID。 |
| resource | String | 否 | 任务来源。 |
| taskName | String | 是 | 任务名称。 |
| sceneName | String | 是 | 任务场景名称。 |
| sceneId | Long | 是 | 任务场景ID。 |
| signSiteId | Long | 否 | 作业对象ID。 |
| signSiteCode | String | 否 | 作业对象编码。 |
| signSiteName | String | 否 | 作业对象名称。 |
| projectNo | String | 否 | 项目编码。 |
| projectName | String | 否 | 项目名称。 |
| supplierName | String | 否 | 供应商。 |
| assignedUserType | String | 否 | 执行人类型。
|
| assignedUser | String | 否 | 执行人账号。 |
| beginTimestamp | Long | 否 | 计划开始时间。 |
| endTimestamp | Long | 否 | 计划完成时间。 |
| requiredStartTime | Long | 否 | 要求开始时间。 |
| requiredEndTime | Long | 否 | 要求完成时间。 |
| projectDuration | String | 否 | 工期。 |
| jobDuration | String | 否 | 标准时长。 |
| adminOrganizationName | String | 是 | 组织单元名称。 |
| adminOrganization | String | 是 | 组织单元编码。 |
| administrativeDivision | String | 否 | 行政区域。 |
| administrativeDivisionName | String | 否 | 行政区域名称。 说明: 支持输入多个值,多个值时用分号隔开。 |
| regionName | String | 否 | 行政区域名称。 |
| regionId | String | 否 | 行政区域ID。 |
| regionPath | String | 否 | 行政区域路径。 |
| skill | String | 否 | 技能。 |
| address | String | 否 | 任务地址(最多1000个字符)。 |
| templateId | Long | 否 | 模板ID。 |
| templateCode | String | 否 | 模板编码。 |
| templateName | String | 否 | 模板名称。 |
| version | String | 否 | 版本。 |
| reviewRuleId | Long | 否 | 任务申请审批流ID。 |
| reviewRuleName | String | 否 | 任务申请审批流名称。 |
| taskRemark | String | 否 | 任务备注。 |
| isAppraisal | String | 否 | 任务是否需要审批。
|
| collectionReviewId | Long | 否 | 采集审批流ID。 |
| collectionReviewName | String | 否 | 采集审批流名称。 |
| collectionProcessType | String | 否 | 采集审批流类型。
|
| priority | String | 否 | 优先级。 |
| schedulingMode | String | 否 | 调度模式。 |
| customerName | String | 否 | 客户名称。 |
| customerId | String | 否 | 客户ID。 |
| operationGuideList | List | 否 | 操作指导。 |
| attachmentList | List | 否 | 附件。 |
| taskMode | String | 是 | 任务模式。
|
| saveDraft | String | 是 | 保持草稿、提交。
|
| taskExtendList | List | 否 | 任务扩展属性。 |
| url | String | 否 | 待办地址。 |
| thirdUrl | String | 否 | 第三方待办地址。 |
| geoType | String | 否 | 经纬度类型(值只能为BD或者为空) |
| longitude | String | 否 | 任务经度信息 |
| latitude | String | 否 | 任务纬度信息 |
| isCustomerTaskIdDuplicate | String | 否 | 是否允许客户任务ID重复,Y:允许,N,不允许重复 为空或默认为N,不允许重复 |
| Toolset | List<TaskToolVO> | 否 | 工具集 |
taskExtendList列表入参:
| 参数 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| fieldName | String | 是 | 拓展属性字段名称 |
| extendValue | String | 是 | 拓展属性值(如果是时间和日期,值必须是时间戳) |
| stage | Integer | 否 | 任务扩展属性阶段:1创建阶段 2:执行阶段 不填或没有该字段时默认为创建阶段 |
toolSet入参
| 参数 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| id | Long | 否 | 主键id |
| parentTaskId | Long | 否 | 父任务id |
| toolNo | String | 是 | 工具编号 |
| toolName | String | 是 | 工具名称 |
| redirectUrl | String | 否 | 第三方工具跳转url |
| extensionType | Integer | 否 | 扩展属性类型(1:表单;2:json) |
| toolLocation | Map<String, Object> | 是 | 工具在画布中的位置json |
| toolAttrList | Object | 否 | 工具扩展属性配置json |
| NextToolList | List<Map<String,Object>> | 否 | 拓展属性值(如果是时间和日期,值必须是时间戳) |
响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| stateCode | String | 响应状态码。
|
| errorMessage | String | 响应描述。 |
| result | Object | 响应结果内容data、分页数据。 |
data出参:
| 参数 | 类型 | 描述 |
|---|---|---|
| customerTaskId | String | 客户任务ID |
| taskId | Long | 创建成功的任务id |
| status | Integer | 返回状态:0-成功;1-失败 |
| message | String | 返回的失败消息。 |
请求示例
{
"taskQueries": [
{
"supplierName": "",
"taskRemark": "",
"beginTimestamp": "",
"collectionReviewName": "",
"sceneName": "openApi-简单任务场景",
"latitude": "23.456",
"signSiteName": "bzh00201",
"customerTaskId": "1255d-104456789123789001026",
"projectNo": "",
"assignedUserType": "1",
"geoType": "BD",
"reviewRuleName": "人员数量",
"taskName": "简单任务012",
"assignedUser": "15080988442",
"endTimestamp": "",
"taskExtendList": "",
"longitude": "123.456",
"toolSet": [
{
"toolNo": "T003",
"toolName": "子任务2-工序1",
"toolLocation": {
"x": 100,
"y": 200
},
"toolAttrList": [
{
"attrName": "显示名称",
"attrCode": "displayName",
"attrValue": "子任务2-工序1"
}
]
}
]
}
]
} 响应示例
{
"stateCode": "0",
"errorMessage": null,
"result": [
{
"status": "0",
"message": "保存成功",
"customerTaskId": null,
"taskId": 2900025
}
]
} 状态码
状态码请参见状态码。
错误码
错误码请参见错误码。