卡片墙

卡片墙列表: /cardWalls GET

请求参数

参数名 示列值 类型 必须 说明 默认值
page 1 number 当前页数 1
pageSize 10 number 每页条数 10
name 卡片名称 string 卡片名称
organizationId 1 number 组织id
status 1 number 卡片状态。0: 禁用 1: 启用
sort -submitAt string 排序。多个排序字段用,号隔开。sort=-a,b
expand '' string 获取指定子资源数据: 'libraryItems'
attributes ["id", "name"] array 本资源的字段。不定义该字段时返回所有字段;空数组不返回字段

返回参数

参数名 示列值 说明
page 1 当前页数
pageSize 10 每页条数
limit 10 同 pageSize
offset 2 起始条数
total 3231 符合条件的总数量
items [{},{}] 返回数据项(具体字段看卡片信息)
参数名 示列值 说明
id 1 id
organizationId 1 组织id(云医为0)
name demo 卡片名称
picUrl demo.png 卡片图片url
content demo 卡片内容
status 1 卡片状态。0: 禁用 1: 启用
creatorId 3 创建人id
creator {id: 1, name: "xxx"} 扩展字段: 创建人信息
organization {id: 1, name: "xxx"} 扩展字段: 数据来源信息
libraryItems [{id: 1, itemId: 1, organization: {id: 1, name: "xx"}}] 扩展字段: 入库组织信息
createdAt 1650160322 创建时间
updatedAt 1650160322 更新时间

返回示列

HTTP/1.1 200 OK
{
    "items": [
        {
            "id": 1,
            "name": "卡片名称",
            "organizationId": 1,
            "picUrl": "demo.png",
            "content": "卡片内容",
            "status": 1,
            "creatorId": 1,
            "createdAt": 1650160322,
            "updatedAt": 1650160322,
        }
    ],
}

新建卡片: /cardWalls POST

请求参数

参数名 示列值 类型 必须 说明 默认值
name 主题名称 string 卡片名称
picUrl demo.png string 卡片图片url
content demo string 卡片内容
organizationId 3 number 组织id
creatorId 1 number 创建人id

返回结果: 卡片信息

返回示列

HTTP/1.1 200 OK
{
    "id": 1,
  "name": "卡片名称",
    "organizationId": 1,
    "picUrl": "demo.png",
    "content": "卡片内容",  
    "status": 1,
    "creatorId": 1,
    "createdAt": 1650160322,
    "updatedAt": 1650160322,
}

编辑卡片: /cardWalls/:id PUT

请求参数

参数名 示列值 类型 必须 说明 默认值
id 1 number id
name 主题名称 string 卡片名称
picUrl demo.png string 卡片图片url
content demo string 卡片内容
organizationId 3 number 组织id
creatorId 1 number 创建人id

返回结果: 卡片信息

返回示列

HTTP/1.1 200 OK
{
    "id": 1,
  "name": "卡片名称",
    "organizationId": 1,
    "picUrl": "demo.png",
    "content": "卡片内容",
    "status": 1,    
    "creatorId": 1,
    "createdAt": 1650160322,
    "updatedAt": 1650160322,
}

名称是否重复: /isExist/cardWalls GET

请求参数

参数名 示列值 类型 必须 说明
id 1 number 卡片id
name 卡片名称 string 卡片名称

返回示列

HTTP/1.1 200 OK
{
  "isExist": true,
}

修改单个卡片状态: /cardWalls/:id/status PUT

请求参数

参数名 示列值 类型 必须 说明
id 1 number 卡片 id
status 1 number 状态:(0:禁用,1:启用)

返回结果: 卡片信息

返回示例

HTTP/1.1 200

批量启用禁用卡片: batchUpdateStatus/cardWalls POST

请求参数

参数名 示列值 类型 必须 说明
ids [1] array Y 卡片id 数组
status 0 int Y 状态, 0=禁用, 1=启用

返回示列

HTTP/1.1 200

删除卡片: /cardWalls/:id DELETE

请求参数

参数名 示列值 类型 必须 说明
id 1 number 资源id

返回示列

HTTP/1.1 204 NO CONTENT

批量删除卡片: batchDestroy/cardWalls POST

请求参数

参数名 示列值 类型 必须 说明
ids [1,2] array 资源id数组

返回示列

HTTP/1.1 204 NO CONTENT

卡片入库: librarySetting/cardWalls POST

请求参数

参数名 示列值 类型 必须 说明
ids [1] array Y 卡片 id 数组
orgIds [1,2] array Y 组织 id 数组
bulk true boolean 是否是批量入库(true:是)

返回示例

HTTP/1.1 200