盘点任务

更新时间：2019-9-27

1. 获取用户盘点单列表

请求地址
GET /SelfService/Check/List
参数说明
用户盘点单查询接口支持丰富的条件过滤参数，请参见支持的查询参数附录
返回结果
{
    "offset": 0,
    "total": 0,
    "results": [
        {
            "name": "测试盘点",
            "serialNo": "PD201909190001",
            "createTime": "1568888759",
            "closed": false,
            "total": 2,
            "checked": 1,
            "uncheck": 1
            "uncheck": 0
        }
    ]
}
参数 说明
offset 当前结果对于首条结果的偏移量，指定分页查询时不为0
total 所有符合查询条件的查询结果数量，指定需要结果记录数量时不为0
results 符合查询条件的用户盘点单列表详情集合
meta 其他信息

2. 获取用户盘点单详情

请求地址
GET /SelfService/Check/Detail
参数说明
用户盘点单详情查询接口支持丰富的条件过滤参数，请参见支持的查询参数附录
返回结果
{
    "offset": 0,
    "total": 0,
    "results": [
        {
            "name": "测试盘点",
            "serialNo": "PD201909190001",
            "createTime": "1568888759",
            "closed": false,
            "total": 2,
            "checked": 1,
            "uncheck": 1,
            "assets": [
                {
                    "barcode": "1001101010003",
                    "name": "测试资产",
                    "thumbnailPath": "/UploadImage/2f2e3623-fc09-4a5e-aa75-70ede15306d5.jpg",
                    "assetTypeName": "测试分类",
                    "checkState": 0,
                    "checklists": [
                        {
                            "serialNo": "PD201909190001",
                            "name": "11111",
                            "supportManualCheck": true
                        }
                    ]
                },
                {
                    "barcode": "02010001",
                    "name": "通用测试",
                    "thumbnailPath": "",
                    "assetTypeName": "通用设备",
                    "checkState": 1,
                    "checklists": [
                        {
                            "serialNo": "PD201909190001",
                            "name": "11111",
                            "supportManualCheck": true
                        }
                    ]
                }
            ]
        }
    ]
}
参数 说明
offset 当前结果对于首条结果的偏移量，指定分页查询时不为0
total 所有符合查询条件的查询结果数量，指定需要结果记录数量时不为0
results 符合查询条件的用户盘点单详情
meta 其他信息

3. 获取用户盘点单资产列表

请求地址
GET /SelfService/Check/Asset
参数说明
参数 是否必须 说明
hasChecked 是 已盘/未盘，1：已盘、0：未盘
Keyword 否 模糊查询关键字
用户盘点单资产查询接口支持丰富的条件过滤参数，请参见支持的查询参数附录
返回结果
{
    "offset": 0,
    "total": 0,
    "results": [
        {
            "barcode": "1001101010003",
            "name": "测试资产",
            "thumbnailPath": "/UploadImage/2f2e3623-fc09-4a5e-aa75-70ede15306d5.jpg",
            "assetTypeName": "测试分类",
            "checkState": 0,
            "checklists": [
                {
                    "serialNo": "PD201909190001",
                    "name": "11111",
                    "supportManualCheck": true
                }
            ]
        }
    ]
}
参数 说明
offset 当前结果对于首条结果的偏移量，指定分页查询时不为0
total 所有符合查询条件的查询结果数量，指定需要结果记录数量时不为0
results 符合查询条件的资产详情集合
meta 其他信息

4. 资产盘点

请求地址
PUT /SelfService/Check
POST /SelfService/Check/put

对于不支持PUT请求的网络环境，请尝试使用备份的POST请求地址

请求示例
{
    "barcode":"1001101010003",
    "checkState":1,
    "comment":"已盘点无误",
    "MediaResourceNo":""
}
参数说明
参数 是否必须 说明
barcode 是 被盘点资产条码
checkState 是 盘点状态，1：已盘、2：盘亏、3：盘盈
comment 否 备注
MediaResourceNo 否 微信图片serverId，多图片以逗号分隔
返回结果
{}

对于成功更新的请求，该接口仅返回HTTP 200 OK

附录

1. 支持的查询参数

如无特别说明，下列操作对于查询实体对象中的任意属性均适用。使用时只需将其追加至请求的querystring中即可。对实体对象中不存在的属性进行操作将会得到不可预期的结果。

  • 分页
    • skip={数字} 跳过指定条数的记录数
    • take={数字} 取出指定条数的记录数
    • include=total 需要返回记录总数
  • 排序
    • orderBy=[-]{属性名称},[-]{属性名称} 返回结果按指定属性排序，在名称前加”-“表示按倒序排序。多个属性的排序可使用逗号分隔。如：orderBy=-Id,Name,-Age
  • 条件过滤
    • 不等于
      • {属性名称}!={值} 如：Id!=1
    • 大于等于
      • >{属性名称}={值} 如：>Id=1
    • 大于
      • {属性名称}>={值} 如：Id>=1
    • 小于
      • <{属性名称}={值} 如：<Id=1
    • 小于等于
      • {属性名称}<={值} 如：Id<=1
    • In
      • {属性名称}In={值，值，值} 属性的值需包含在指定的集合中，如：IdIn=1,2,3
    • Between
      • {属性名称}Between={值，值} 属性的值需处于指定的区间之间，仅支持数字，如： IdBetween=1,3
    • 字符串包含指定字符
      • {属性名称}Contains={值} 如：nameContains=abc
    • 字符串以指定字符开头
      • {属性名称}StartsWith={值} 如：nameStartsWith=abc
    • 字符串以指定字符结尾
      • {属性名称}EndsWith={值} 如：nameEndsWith=abc
  • 自定义返回结果
    • 使用Fields参数来指定返回结果中需要的属性或字段名称 如：对于员工查询接口使用Fields=Id,employeeName，返回的员工集合结果中将仅包含此2个属性。

2. 数据实体格式

1. 用户盘点单列表数据对象格式
属性名称 说明
name 盘点单名称
serialNo 盘点单据号
createTime 创建时间
CompleteTime 完成时间
closed 是否已完成，true：已完成、false：未完成
total 包含盘点资产总数
checked 包含已盘点资产数量
uncheck 包含未盘点资产数量
2. 用户盘点单数据对象格式
属性名称 说明
name 盘点单名称
serialNo 盘点单据号，获取盘点单详情时该参数为必填
createTime 创建时间
CompleteTime 完成时间
closed 是否已完成，true：已完成、false：未完成
total 包含盘点资产总数
checked 包含已盘点资产数量
uncheck 包含未盘点资产数量
assets 盘点单包含的资产详情集合
盘点单包含的资产详情
属性名称 说明
barcode 资产编码
name 资产名称
thumbnailPath 资产图片的缩略图路径
assetTypeName 资产类别名称
checkState 盘点状态，0：未盘点、1：已盘点、2：盘亏、3：盘盈
checklists 相关盘点单详情集合
相关盘点单详情
属性名称 说明
name 盘点单名称
serialNo 盘点单据号
supportManualCheck 是否支持手工盘点，true：支持、false：不支持