资产分类接口
1. 获取资产分类列表
【注意】该接口对非管理员账户仅能获取到企业下拥有访问权限的资产分类信息,对于管理员账户则能获取到企业下所有资产分类的信息。
请求地址
text
GET /User/Current/Asset/Type参数说明
资产分类查询接口支持丰富的条件过滤参数,请参见支持的查询参数附录
返回结果
json
{
"offset": 0,
"total": 0,
"results": [
{
"parentTypeCode": "1001",
"id": 418599,
"code": "1002",
"name": "分类二",
"serviceLife": 12,
"disabled": false,
"allowSelfReq": false,
"allowHandOver": false
}
],
"meta": {}
}| 参数 | 说明 |
|---|---|
| offset | 当前结果对于首条结果的偏移量,指定分页查询时不为0 |
| total | 所有符合查询条件的查询结果数量,指定需要结果记录数量时不为0 |
| results | 符合查询条件的资产分类详情集合 |
| meta | 其他信息 |
2. 创建资产分类
【注意】使用该接口创建资产分类将会使创建者自动拥有对其访问的权限。
请求地址
text
POST /Asset/Type请求示例
json
{
"Code":"259669",
"Name":"分类",
"ServiceLife":"16",
"SuperiorAssetTypeCode":"36666"
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| Code | 是 | 资产分类编码 |
| Name | 是 | 资产分类名称 |
| ServiceLife | 是 | 使用期限 |
| SuperiorAssetTypeCode | 否 | 资产分类父级编码 |
返回结果
json
{
"id": 462326
}结果说明
| 属性 | 说明 |
|---|---|
| Id | 资产分类Id |
3. 更新资产分类
【注意】该接口对于非管理员账户仅能更新企业下其拥有访问权限的资产分类信息,对于管理员账户则能更新企业下所有资产分类的信息。
请求地址
text
PUT /Asset/Type
POST /Asset/Type/put对于不支持PUT请求的网络环境,请尝试使用备份的POST请求地址
请求示例
json
{
"Code":"01"
"Name":"分类",
"ServiceLife":"16"
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| Code | 是 | 资产分类编码 |
| Name | 是 | 资产分类名称 |
| ServiceLife | 是 | 使用期限 |
返回结果
json
{}对于成功更新的请求,该接口仅返回HTTP 200 OK
4. 更新资产分类编码
【注意】该接口对于非管理员账户仅能更新企业下其拥有访问权限的资产分类信息,对于管理员账户则能更新企业下所有资产分类的信息。
请求地址
text
PUT /Asset/Type/code
POST /Asset/Type/code/put对于不支持PUT请求的网络环境,请尝试使用备份的POST请求地址
请求示例
json
{
"CurrentCode":"01"
"NewCode":"01_new"
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| CurrentCode | 是 | 当前使用中的资产分类编码 |
| NewCode | 是 | 预更新的资产分类编码 |
返回结果
json
{}对于成功更新的请求,该接口仅返回HTTP 200 OK
5. 删除资产分类
【注意】该接口对于非管理员账户仅能删除企业下其拥有访问权限的资产分类,对于管理员账户则能删除企业下所有资产分类。
请求地址
text
DELETE /Asset/Type
POST /Asset/Type/delete对于不支持DELETE请求的网络环境,请尝试使用备份的POST请求地址
请求示例
json
{
"Code":"01"
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| Code | 是 | 资产分类编码 |
返回结果
json
{}对于成功删除的请求,该接口仅返回HTTP 200 OK
附加信息
下列条件之一成立时,无法对指定的资产分类进行删除操作
该资产分类下存在子资产分类信息
该资产分类下存在资产信息
6. 设置资产分类的可用性状态
【注意】该接口对于非管理员账户仅能更新企业下其拥有访问权限的资产分类信息,对于管理员账户则能更新企业下所有资产分类的信息。
请求地址
text
PUT /Asset/Type/availability
POST /Asset/Type/availability/put对于不支持PUT请求的网络环境,请尝试使用备份的POST请求地址
请求示例
json
{
"Enabled":1,
"Code":"231002"
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| Code | 是 | 资产分类编码 |
| Enabled | 是 | 资产分类的可用性状态,0和1分别表示禁用和启用 |
返回结果
json
{}对于成功更新的请求,该接口仅返回HTTP 200 OK
7. 获取标准资产型号
请求地址
text
GET /Asset/Specification?assetTypeId=xxx参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| assetTypeId | 否 | 资产分类id |
返回结果
json
{
"offset": 0,
"total": 0,
"results": [
{
"assetTypeCode": "1002",
"assetTypeName": "分类二",
"idleAssetQuantity": 0,
"id": 13557,
"assetTypeId": 418599,
"assetTemplateName": "新资产",
"specification": "新型号",
"picturePath": "/MediaResources/4506/AssetSpecs/20200418/d6498fd7ea0d455783cc3177467176ce.jpg",
"thumbnailPath": "/MediaResources/4506/AssetSpecs/20200418/d6498fd7ea0d455783cc3177467176ce.jpg",
"measureUnit": "新单位",
"amount": 80.00,
"disabled": false,
"createdDate": "1587179619",
"updatedBy": 0
}
],
"meta": {}
}| 参数 | 说明 |
|---|---|
| offset | 当前结果对于首条结果的偏移量,指定分页查询时不为0 |
| total | 所有符合查询条件的查询结果数量,指定需要结果记录数量时不为0 |
| results | 符合查询条件的标准资产型号详情集合 |
| meta | 其他信息 |
8. 创建标准资产型号
请求地址
text
POST /Asset/Specification请求示例
json
{
"Specification":"型号",
"Amount":"50",
"AssetTemplateName":"名称",
"AssetTypeCode":"1002",
"MeasureUnit":"单位",
"pictureMediaResourceNo":"",
"thumbnailMediaResourceNo":""
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| Specification | 是 | 规格型号 |
| Amount | 否 | 金额 |
| AssetTemplateName | 是 | 资产名称 |
| AssetTypeCode | 是 | 资产分类编码 |
| MeasureUnit | 否 | 计量单位 |
| pictureMediaResourceNo | 否 | 图片编码 |
| thumbnailMediaResourceNo | 否 | 缩略图编码 |
返回结果
json
{
"id": 462326
}结果说明
| 属性 | 说明 |
|---|---|
| id | 标准资产型号Id |
9. 更新标准资产型号
请求地址
text
PUT /Asset/Specification
POST /Asset/Specification/put对于不支持PUT请求的网络环境,请尝试使用备份的POST请求地址
请求示例
json
{
"OriginalAssetTemplateName":"名称",
"OriginalSpecification":"型号",
"OriginalMeasureUnit":"单位",
"pictureMediaResourceNo":"",
"thumbnailMediaResourceNo":"",
"AssetTemplateName":"名称",
"AssetTypeCode":"1002",
"Specification":"新型号",
"MeasureUnit":"单位",
"Amount":"50"
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| OriginalAssetTemplateName | 是 | 原资产名称 |
| OriginalSpecification | 是 | 原规格型号 |
| OriginalMeasureUnit | 否 | 原计量单位 |
| pictureMediaResourceNo | 否 | 图片编码 |
| thumbnailMediaResourceNo | 否 | 缩略图编码 |
| AssetTemplateName | 是 | 资产名称 |
| AssetTypeCode | 是 | 资产分类编码 |
| Specification | 是 | 规格型号 |
| MeasureUnit | 否 | 计量单位 |
| Amount | 否 | 金额 |
返回结果
json
{
"id": 18619
}结果说明
| 属性 | 说明 |
|---|---|
| id | 标准资产型号Id |
10. 删除标准资产型号
请求地址
text
DELETE /Asset/Specification
POST /Asset/Specification/delete对于不支持DELETE请求的网络环境,请尝试使用备份的POST请求地址
请求示例
json
{
"Specification":"型号",
"MeasureUnit":"单位",
"AssetTemplateName":"名称"
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| Specification | 是 | 规格型号 |
| MeasureUnit | 否 | 计量单位 |
| AssetTemplateName | 是 | 资产名称 |
返回结果
json
{}对于成功删除的请求,该接口仅返回HTTP 200 OK
附加信息
下列条件之一成立时,无法对指定的资产分类进行删除操作 1. 该标准资产型号下存在资产信息
11. 设置标准资产型号的可用性状态
请求地址
text
PUT /Asset/Specification/availability
POST /Asset/Specification/availability/put对于不支持PUT请求的网络环境,请尝试使用备份的POST请求地址
请求示例
json
{
"Enabled":"0",
"MeasureUnit":"新单位",
"AssetTemplateName":"新资产",
"Specification":"新型号"
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| MeasureUnit | 否 | 计量单位 |
| AssetTemplateName | 是 | 资产名称 |
| Specification | 是 | 规格型号 |
| Enabled | 是 | 标准资产型号的可用性状态,0和1分别表示禁用和启用 |
返回结果
json
{}对于成功更新的请求,该接口仅返回HTTP 200 OK
附录
1. 支持的查询参数
如无特别说明,下列操作对于查询实体对象中的任意属性均适用。使用时只需将其追加至请求的querystring中即可。对实体对象中不存在的属性进行操作将会得到不可预期的结果。
分页
skip={数字} 跳过指定条数的记录数
take={数字}取出指定条数的记录数(注:最大值为1500,即单页最多返回1500条数据)
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
2. 数据实体格式
1. 资产分类数据对象格式
| 属性名称 | 说明 |
|---|---|
| parentTypeCode | 上级资产分类编码 |
| id | 资产分类Id |
| code | 资产分类编码 |
| name | 资产分类名称 |
| serviceLife | 使用期限 |
| allowSelfReq | 是否允许自助领用借用 |
| allowHandOver | 是否允许自助交接 |
| disabled | 是否已禁用 |
2. 标准资产型号数据对象格式
| 属性名称 | 说明 |
|---|---|
| assetTypeCode | 资产分类编码 |
| assetTypeName | 资产分类名称 |
| idleAssetQuantity | 闲置资产数量 |
| id | 标准资产型号id |
| assetTypeId | 资产分类id |
| assetTemplateName | 标准资产名称 |
| specification | 规格型号 |
| picturePath | 标准资产图片路径 |
| thumbnailPath | 标准资产缩略图路径 |
| measureUnit | 计量单位 |
| amount | 金额 |
| disabled | 是否已禁用 |
| createdDate | 创建时间 |
| updatedBy | 更新人 |