物模型与物料编码API文档

编制 日期 版本
姜鹏 V1.0

API列表

编号 API名称 路径 版本
3.1 保存ipm和model关联 /tx/platform-biz/remac-tx-ipm-model/ipm/model/rel/save 1.0
3.2 删除ipm和model关联 /tx/platform-biz/remac-tx-ipm-model/ipm/model/rel/delete 1.0
3.3 根据ipm_code和src获取关联数据 /tx/platform-biz/remac-tx-ipm-model/ipm/model/rel/load/{ipm_code}/{src} 1.0
3.4 分页获取ipm和modle的关联数据 /tx/platform-biz/remac-tx-ipm-model/ipm/model/rel/search 1.0
3.5 根据ipm_code集合获取关联数据 /tx/platform-biz/remac-tx-ipm-model/ipm/model/rel/query 1.0
3.6 根据关联id删除关联数据 /tx/platform-biz/remac-tx-ipm-model/ipm/model/rel/deleteByIds 1.0
3.7 初始化中台 ipm_model 数据 (导入ipm_product表数据) /tx/platform-biz/remac-tx-ipm-model/ipm/model/rel/dataInit 1.0

1 相关说明

1.1 相关字典/枚举

1.1.1 物料编码来源枚举

枚举值 说明
remac 睿住自有

2 安全规范

业务访问中台的所有接口均需要使用 bizToken 或 remacToken作为HTTP头部标识。

其中： bizToken 为内部平台的应用使用 client_id和client_secret获取的access_token。

remacToken 为H5 端使用统一登录获取的access_token。

3 接口协议

3.1 保存ipm和model关联

描述： 保存ipm和model关联, 批量保存

URL: /tx/platform-biz/remac-tx-ipm-model/ipm/model/rel/save

HTTP头： bizToken / remacToken

方法：POST

请求参数:

名称 类型 必填 描述
src string Y 物料编码来源枚举,remac: 睿住自有的物料编码
ipm_code string Y ipmCode
model_list array Y model 集合
model_id string Y modelId
model_name string N modelName
device_num int Y 关联设备数量

参数示例

[
  {
    "src": "remac",
    "ipm_code": "test123",
    "model_list": [
      {
        "model_id": "909",
        "model_name": "testModel1",
        "device_num": 3
      },
      {
        "model_id": "908",
        "model_name": "testModel2",
        "device_num": 4
      }
    ]
  },
  {
    "src": "remac",
    "ipm_code": "test234",
    "model_list": [
      {
        "model_id": "4567",
        "model_name": "testModel23",
        "device_num": 1
      }
    ]
  }
]

返回结果示例：

{
  "code": "200",
  "message": "success"
}

3.2 删除ipm和model关联

描述： 删除ipm和model关联, 仅支持相同 src 和 相同 ipm_code 下的批量删除

URL: /tx/platform-biz/remac-tx-ipm-model/ipm/model/rel/delete

HTTP头： bizToken / remacToken

方法： PUT

请求参数:

名称 类型 必填 描述
src string Y 物料编码来源枚举,remac: 睿住自有的物料编码
ipm_code string Y ipmCode
model_ids array Y modelId 集合

参数示例

{
  "src": "remac",
  "ipm_code": "234",
  "model_ids": ["45677", "sd456"]
}

返回结果示例：

{
  "code": "200",
  "message": "success"
}

3.3 根据ipm_code和src获取ipm和model关联数据

描述： 根据ipm_code和src获取ipm和model关联数据

URL: /tx/platform-biz/remac-tx-ipm-model/ipm/model/rel/load/{ipm_code}/{src}

HTTP头： bizToken / remacToken

方法： GET

请求参数:

名称 类型 必填 描述
src string Y 物料编码来源枚举,remac: 睿住自有的物料编码
ipm_code string Y ipmCode

参数示例: /tx/platform-biz/remac-tx-ipm-model/ipm/model/rel/test123/remac

返回结果:

名称 类型 必填 描述
src string Y 物料编码来源枚举,remac: 睿住自有的物料编码
ipm_code string Y ipmCode
model_list array Y
model_name string N
model_id string Y
device_num string Y 关联设备数量

返回结果示例：

{
  "code": "200",
  "data": {
    "model_list": [
      {
        "model_name": "testModel2",
        "device_num": 4,
        "model_id": "908"
      },
      {
        "model_name": "testModel1",
        "device_num": 3,
        "model_id": "909"
      }
    ],
    "src": "remac",
    "ipm_code": "test123"
  },
  "message": "success"
}

3.4 分页获取ipm和model关联数据

描述： 分页获取ipm和model关联数据, 支持搜索

URL: /tx/platform-biz/remac-tx-ipm-model/ipm/model/rel/search

HTTP头： bizToken / remacToken

方法： POST

请求参数:

名称 类型 必填 描述
pageNo int N 页码, 不传则默认为1,
pageSize int N 每页数据量, 不传则默认20, 最大不可超过100
src string Y 必填, 物料编码来源枚举, remac: 睿住自有的物料编码
ipm_code string N 精确搜索
model_id string N 精确搜索
model_name string N 模糊搜索

参数示例: 

{
    "pageNo": 1,
    "pageSize": 20,
    "src": "remac",
    "model_name": "23"
}

返回结果:

名称 类型 必填 描述
pageNo int Y 页码
pageSize int Y 每页数据量, 默认 20, 最大不可超过100
total int Y 当前搜索到的数据量
totalPage int Y 当前搜索到的数据总页数
result array Y 搜索结果集合
id long Y 中台关联关系id
src string Y 物料编码来源枚举,remac: 睿住自有的物料编码
ipm_code string Y ipmCode
model_name string N modelName
model_id string Y modelId
device_num string Y 关联设备数量
update_time date Y 最后更新时间

返回结果示例：

{
  "code": "200",
  "data": {
    "result": [
      {
        "id": 5,
        "ipm_code": "test234",
        "model_name": "testModel23",
        "model_id": "4567",
        "src": "remac",
        "device_num": 1,
        "update_time": "2023-08-29 10:06:25"
      }
    ],
    "pageNo": 1,
    "pageSize": 20,
    "total": 1,
    "totalPage": 1
  },
  "message": "success"
}

3.5 根据ipm_code集合获取关联数据

描述： 根据ipm_code集合获取关联数据, 无分页

URL: /tx/platform-biz/remac-tx-ipm-model/ipm/model/rel/query

HTTP头： bizToken / remacToken

方法： POST

请求参数:

名称 类型 必填 描述
src string Y 必填, 物料编码来源枚举, remac: 睿住自有的物料编码
ipm_code_list array Y ipm_code集合, 集合长度最大不可超过100

参数示例:

{
  "src": "remac",
  "ipm_code_list": ["test123", "test234"]
}

返回结果:

名称 类型 必填 描述
src string Y 物料编码来源枚举,remac: 睿住自有的物料编码
ipm_code string Y ipmCode
model_list array Y
model_name string N
model_id string Y
device_num string Y 关联设备数量

返回结果示例：

{
  "code": "200",
  "data": [
    {
      "model_list": [
        {
          "model_name": "testModel23",
          "device_num": 1,
          "model_id": "4567"
        }
      ],
      "src": "remac",
      "ipm_code": "test234"
    },
    {
      "model_list": [
        {
          "model_name": "testModel1",
          "device_num": 3,
          "model_id": "909"
        },
        {
          "model_name": "testModel2",
          "device_num": 4,
          "model_id": "908"
        }
      ],
      "src": "remac",
      "ipm_code": "test123"
    }
  ],
  "message": "success"
}

3.6 根据关联id删除关联数据

描述： 根据关联id删除关联数据, 支持批量

URL: /tx/platform-biz/remac-tx-ipm-model/ipm/model/rel/deleteByIds

HTTP头： bizToken / remacToken

方法： PUT

请求参数:

名称 类型 必填 描述
ids array Y 中台关联数据id集合

参数示例:

{
  "ids": [7, 8, 9]
}

返回结果示例：

{
  "code": "200",
  "message": "success"
}

3.7 初始化中台 ipm_model 数据 (导入ipm_product表数据)

描述： 以form-data的形式上传csv文件, 初始化中台 ipm_model 表数据

URL: /tx/platform-biz/remac-tx-ipm-model/ipm/model/rel/dataInit

HTTP头： bizToken / remacToken

方法： POST

请求参数:

名称 类型 必填 描述
file Part Y 上传的csv文件, 文件内容格式: "{model_name}@::@{model_id}@::@{ipm_codes}"......

csv文件内容生产sql

SELECT CONCAT(IFNULL(`name`,''), '@::@', IFNULL(model_num,''), '@::@', IFNULL(material_code,'')) as `ipm_data`
FROM `iot_product` WHERE IS_REMOVED = 0;

返回结果示例：

{
  "code": "200",
  "message": "success"
}

3.8 物模型ID查询物料编码

URL: /tx/platform-biz/remac-tx-ipm-model/ipm/model/rel/getIpmCodesKV

HTTP头： bizToken / remacToken

方法： PUT

请求参数(BODY):

名称 类型 必填 描述
modelIds Array Y 物模型集合。最大批量尺寸 100

请求示例：

{"modelIds": [ "0x17","0x9B"] }

返回示例：

{
  "code": "200",
  "data": [
    {
      "modelId": "0x9B",
      "ipmCodes": [
        "5130120100022"
      ]
    },
    {
      "modelId": "0x17",
      "ipmCodes": [
        "5120160205001"
      ]
    }
  ],
  "message": "success"
}
Copyright © www.remacsmart.com/ 2021 all right reserved，powered by Gitbook该文件修订时间： 2023-10-31 10:40:44

results matching ""

    No results matching ""