# 设备 API

# 创建设备

接口地址:/api/open/v2/machines/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "isDocking": 0,
    "location": "",
    "machineCode": "",
    "machineName": "",
    "patternNum": "",
    "registrationTime": 0,
    "typeName": "",
    "useStatus": 0
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
machineSaveParamRequestParameter	machineSaveParamRequestParameter	body	true	RequestParameter«MachineSaveParams»	RequestParameter«MachineSaveParams»
body			false	MachineSaveParams	MachineSaveParams
isDocking	设备是否联网，0:设备未联网，1:设备有联网		true	integer
location	安装位置		false	string
machineCode	设备编号		true	string
machineName	设备名称		true	string
patternNum	设备型号		false	string
registrationTime	登记日期		false	integer
typeName	设备类型		false	string
useStatus	使用状态		true	integer

响应状态:

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

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 删除设备

接口地址:/api/open/v2/machines/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
requestParameter	删除设备code	body	true	RequestParameter«string»	RequestParameter«string»
body			false	string

响应状态:

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

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 查询设备列表

接口地址:/api/open/v2/machines/query

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "machineFullName": "",
    "machineName": "",
    "pagingParam": {
      "length": 0,
      "start": 0
    }
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
queryParamRequestParameter	queryParamRequestParameter	body	true	RequestParameter«MachineQueryParams»	RequestParameter«MachineQueryParams»
body			false	MachineQueryParams	MachineQueryParams
machineFullName	设备名称-精确		false	string
machineName	设备名称-模糊		false	string
pagingParam			false	PagingParam	PagingParam
length			false	integer
start			false	integer

响应状态:

状态码	说明	schema
200	OK	ListPagingResponse«MachineSimpleDTO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		ListPagingResponseData«MachineSimpleDTO»	ListPagingResponseData«MachineSimpleDTO»
length		integer(int32)
list		array	MachineSimpleDTO
isDocking	设备是否联网,0:无;1:有	integer
machineCode	设备编码	string
machineName	设备名称	string
useStatus	使用状态	integer
recordsTotal		integer(int32)
start		integer(int32)
message		string

响应示例:

{
	"code": 0,
	"data": {
		"length": 0,
		"list": [
			{
				"isDocking": 0,
				"machineCode": "",
				"machineName": "",
				"useStatus": 0
			}
		],
		"recordsTotal": 0,
		"start": 0
	},
	"message": ""
}

# 修改设备详情

接口地址:/api/open/v2/machines/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "id": 0,
    "isDocking": 0,
    "location": "",
    "machineCode": "",
    "machineName": "",
    "patternNum": "",
    "registrationTime": 0,
    "typeName": "",
    "useStatus": 0
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
machineSaveParamRequestParameter	machineSaveParamRequestParameter	body	true	RequestParameter«MachineUpdateParams»	RequestParameter«MachineUpdateParams»
body			false	MachineUpdateParams	MachineUpdateParams
id	id		true	integer
isDocking	设备是否联网，0:设备未联网，1:设备有联网		true	integer
location	安装位置		false	string
machineCode	设备编号		true	string
machineName	设备名称		true	string
patternNum	设备型号		false	string
registrationTime	登记日期		false	integer
typeName	设备类型		false	string
useStatus	使用状态		true	integer

响应状态:

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

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 创建修改设备详情

接口地址:/api/open/v2/machines/upsert

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "isDocking": 0,
    "location": "",
    "machineCode": "",
    "machineName": "",
    "patternNum": "",
    "registrationTime": 0,
    "typeName": "",
    "useStatus": 0
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
machineSaveParamRequestParameter	machineSaveParamRequestParameter	body	true	RequestParameter«MachineSaveParams»	RequestParameter«MachineSaveParams»
body			false	MachineSaveParams	MachineSaveParams
isDocking	设备是否联网，0:设备未联网，1:设备有联网		true	integer
location	安装位置		false	string
machineCode	设备编号		true	string
machineName	设备名称		true	string
patternNum	设备型号		false	string
registrationTime	登记日期		false	integer
typeName	设备类型		false	string
useStatus	使用状态		true	integer

响应状态:

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

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
    "code": 0,
        "message": ""
}

← 库存 API 文件 API →