承诺书

承诺书列表: /commitments GET

请求参数

参数名 示列值 类型 必须 说明 默认值
page 1 number 否 当前页数 1
pageSize 10 number 否 每页条数 10
submitStatus 1 number 否 提交状态:(0:未提交,1:已提交)
name 承诺书名称 string 否 承诺书名称
sort -submitAt string 否 排序。多个排序字段用,号隔开。sort=-a,b
expand 'libraryItems' string 否 获取指定子资源数据: 'libraryItems,organization'
attributes ["id", "name"] array 否 本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回参数

参数名 示列值 说明
page 1 当前页数
pageSize 10 每页条数
limit 10 同 pageSize
offset 2 起始条数
total 3231 符合条件的总数量
items [{},{}] 返回数据项(具体字段看承诺书信息)
参数名 示列值 说明
id 1 id
name demo 反馈任务名称
submitStatus 1 提交状态:(0:未提交,1:已提交)
status 1 状态:(0:禁用,1:启用)
guide 导读部分 导读部分
example 书写参考 书写参考
commit ['承诺内容','承诺内容'] 承诺部分
commitStatus 1 承诺状态:(0:禁用,1:启用)
submitAt 1650160322 提交时间
createdAt 1650160322 创建时间
updatedAt 1650160322 更新时间

返回示列

HTTP/1.1 200 OK
{
    "items": [
        {
            "id": 1,
            "name": "反馈任务名称",
            "submitStatus": 1,
            "status": 1,
            "guide": "导读部分",
            "example": "书写参考",
            "commit": ["承诺内容","承诺内容"],
            "commitStatus": 1,
            "submitAt": 1650160322,
            "createdAt": 1650160322,
            "updatedAt": 1650160322,
        },
    ],
    "page": 1,
    "pageSize": 10,
    "limit": 10,
    "offset": 2,
    "total": 15
}

所有承诺书: /listAll/commitments GET

请求参数

参数名 示列值 类型 必须 说明 默认值
name 承诺书名称 string 否 承诺书名称
expand string 否 获取指定子资源数据:
attributes ["id", "name"] array 否 本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回结果: 承诺书信息

返回示列

HTTP/1.1 200 OK
[
    {
        "id": 1,
        "name": "反馈任务名称",
        "submitStatus": 1,
        "status": 1,
        "guide": "导读部分",
        "example": "书写参考",
        "commit": ["承诺内容","承诺内容"],
        "commitStatus": 1,
        "submitAt": 1650160322,
        "createdAt": 1650160322,
        "updatedAt": 1650160322,
    },
]

承诺书详情: /commitments/:id GET

请求参数

参数名 示列值 类型 必须 说明 默认值
id 1 number 是 id
expand string 否 获取指定子资源数据: ''
attributes ["id", "name"] array 否 本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回结果: 承诺书信息

返回示列

HTTP/1.1 200 OK
{
    "id": 1,
    "name": "反馈任务名称",
    "submitStatus": 1,
    "status": 1,
    "guide": "导读部分",
    "example": "书写参考",
    "commit": ["承诺内容","承诺内容"],
    "commitStatus": 1,
    "submitAt": 1650160322,
    "createdAt": 1650160322,
    "updatedAt": 1650160322,
}

新建承诺书: /commitments POST

请求参数

参数名 示列值 类型 必须 说明 默认值
name 承诺书名称 string 是 承诺书名称
submitStatus 0 number 否 提交状态:(0:未提交,1:已提交) 0
status 1 number 否 状态:(0:禁用,1:启用) 1
guide 导读部分 string 是 导读部分
example 书写参考 string 是 书写参考
commit ["承诺内容","承诺内容"] string[] 否 承诺部分
commitStatus 1 number 否 承诺状态:(0:禁用,1:启用) 1

返回结果: 承诺书信息

返回示列

HTTP/1.1 200 OK
{
    "id": 1,
    "name": "反馈任务名称",
    "submitStatus": 1,
    "status": 1,
    "guide": "导读部分",
    "example": "书写参考",
    "commit": ["承诺内容","承诺内容"],
    "commitStatus": 1,
    "submitAt": 1650160322,
    "createdAt": 1650160322,
    "updatedAt": 1650160322,
}

编辑承诺书: /commitments/:id PUT

请求参数

参数名 示列值 类型 必须 说明 默认值
id 1 number 是
name 反馈任务名称 string 否 反馈任务名称
submitStatus 0 number 否 提交状态:(0:未提交,1:已提交)
status 1 number 否 状态:(0:禁用,1:启用)
guide 导读部分 string 否 导读部分
example 书写参考 string 否 书写参考
commit ["承诺内容","承诺内容"] string[] 否 承诺部分
commitStatus 1 number 否 承诺状态:(0:禁用,1:启用)

返回结果: 承诺书信息

返回示列

HTTP/1.1 200 OK
{
    "id": 1,
    "name": "反馈任务名称",
    "submitStatus": 1,
    "status": 1,
    "guide": "导读部分",
    "example": "书写参考",
    "commit": ["承诺内容","承诺内容"],
    "commitStatus": 1,
    "submitAt": 1650160322,
    "createdAt": 1650160322,
    "updatedAt": 1650160322,
}

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

请求参数

参数名 示列值 类型 必须 说明
id 1 number 否 承诺书id(更新时必传)
name 名称 string 是 承诺书名称

返回示列

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

承诺书入库: librarySetting/commitments POST

请求参数

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

返回示列

HTTP/1.1 200