1. 工单字段属性API

API列表

编号 API名称 路径 版本
1 保存/更新工单字段属性-PC端 /v1/workorder/admin/field/save 1.0
2 根据节点及流程实例ID获取节点表单字段信息-PC端 /v1/workorder/admin/field/get/fields 1.0
3 根据工单字段ID查询明细-PC端 /v1/workorder/admin/field/get 1.0
4 根据ID物理删除工单字段-PC端 /v1/workorder/admin/field/remove 1.0

API调用

工单字段属性-PC端

保存/更新工单字段属性-PC端

接口地址:/v1/workorder/admin/field/save

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "id": null,
  "type": "input",
  "fieldName": "挂起原因",
  "extraInfo": "",
  "fieldCode": "gqyy",
  "isDeleted": 0
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
entity 工单实例表 body true Workorder对象
  id 主键（存在即更新，反之新增） false int
  type 类型 true string
  fieldName 字段名称 true string
  extraInfo 扩展属性 false string
  fieldCode 字段编码 true string
  isDeleted 是否逻辑删除[0(默认：未删除)/1(删除)] true string

响应状态:

状态码 说明 schema
200 OK Mono
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

名称 位置 类型 描述
code 顶层 STRING 响应码标识
message 顶层 STRING 响应消息文本
data 顶层 JSONObject 响应数据对象
  id data int 主键

响应示例:

{
  "message": "Ok",
  "code": 200,
  "data": {
    "id": "22"
  }
}

根据节点及流程实例ID获取节点表单字段信息-PC端

接口地址:/v1/workorder/admin/field/get/fields

请求方式:GET

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

暂无

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
nodeId 节点ID param true int

响应状态:

状态码 说明 schema
200 OK Mono
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

名称 位置 类型 描述
code 顶层 STRING 响应码标识
message 顶层 STRING 响应消息文本
data 顶层 JSONObject 响应数据对象
  fields data list 字段属性列表
    nodeFieldRel fields NodeFieldRel 节点字段映射关系
      id fields int 主键
      workorderId fields int 工单ID
      nodeId fields int 节点ID
      fieldId fields int 字段ID
      fieldCode fields string 字段编码
      operateRight fields string 读写权限r只读w只写rw读写
      isHidden fields string 是否隐藏1否2是
      workorderTemplateId fields int 工单模板ID
      sortNo fields int 排序号
    field data Field 字段信息
      id field int 主键
      type field string 类型
      fieldName field string 字段名称
      extraInfo field string 扩展属性
      isDeleted field string 逻辑删除
      fieldCode field string 字段编码

响应示例:

{
  "message": "Ok",
  "code": 200,
  "data": {
    "fields": [
      {
        "nodeFieldRel": {
          "id": 1,
          "workorderId": 2,
          "nodeId": 1,
          "fieldId": 6,
          "fieldCode": "fieldCode",
          "operateRight": "2",
          "isHidden": "0",
          "workorderTemplateId": 3,
          "sortNo": null
        },
        "field": {
          "id": 6,
          "type": "input",
          "fieldName": "备注",
          "extraInfo": "",
          "isDeleted": "0",
          "createBy": "pz0001",
          "createTime": "2021-12-24T10:03:47.000+00:00",
          "updateBy": null,
          "updateTime": null,
          "createById": null,
          "updateById": null,
          "fieldCode": "remark",
          "formId": null
        },
        "fieldValue": null
      }
    ]
  }
}

根据工单字段ID查询明细-PC端

接口地址:/v1/workorder/admin/field/get

请求方式:GET

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

暂无

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
id 字段ID path true int

响应状态:

状态码 说明 schema
200 OK Mono
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

名称 位置 类型 描述
code 顶层 STRING 响应码标识
message 顶层 STRING 响应消息文本
data 顶层 JSONObject 响应数据对象
    id field int 主键
    type field string 类型
    fieldName data string 字段名称
    extraInfo data string 扩展属性
    isDeleted data string 逻辑删除
    fieldCode data string 字段编码

响应示例:

{
  "message": "Ok",
  "code": 200,
  "data": {
    "formId": null,
    "fieldName": "项目名称",
    "fieldCode": "xmmc",
    "updateTime": null,
    "type": "input",
    "updateById": null,
    "createBy": "pz0001",
    "isDeleted": "0",
    "createTime": "2021-12-24T09:04:06.000+00:00",
    "updateBy": null,
    "createById": null,
    "id": 1,
    "extraInfo": ""
  }
}

根据ID物理删除工单字段-PC端

接口地址:/v1/workorder/admin/field/remove

请求方式:DELETE

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

暂无

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
id 字段ID path true int

响应状态:

状态码 说明 schema
200 OK Mono
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

名称 位置 类型 描述
code 顶层 STRING 响应码标识
message 顶层 STRING 响应消息文本
data 顶层 JSONObject 响应数据对象

响应示例:

{
  "message": "Ok",
  "code": 200,
  "data": null
}

results matching ""

    No results matching ""