# 修改栏目 API
修改栏目,使用 POST
发起请求,请求地址为 /api/v1/channels/{siteId}/{channelId}/actions/update
。
POST /api/v1/channels/{siteId}/{channelId}/actions/update
# 请求 URI
参数名 | 位置 | 类型 | 必填 | 说明 |
---|---|---|---|---|
siteId | path | 整数 | 是 | 站点 Id |
channelId | path | 整数 | 是 | 栏目 Id |
apiKey | query | 字符串 | 否 | API 密钥,请参考身份认证 |
# 请求 Body
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
channelName | 字符串 | 否 | 栏目名称 |
indexName | 字符串 | 否 | 栏目索引 |
filePath | 字符串 | 否 | 生成页面地址 |
channelFilePathRule | 字符串 | 否 | 下级栏目的页面命名规则 |
contentFilePathRule | 字符串 | 否 | 栏目下内容的页面命名规则 |
groupNames | 字符串 | 否 | 栏目组 |
imageUrl | 字符串 | 否 | 栏目图片,存储图片地址 |
content | 字符串 | 否 | 栏目正文,以编辑器提交信息 |
keywords | 字符串 | 否 | 关键字列表,各关键词间用英文逗号“,”分割 |
description | 字符串 | 否 | 页面描述 |
linkUrl | 字符串 | 否 | 外部链接,设置后链接将指向此地址 |
linkType | 字符串 | 否 | 链接类型,设置此栏目的链接与子栏目及内容的关系 |
channelTemplateId | 整数 | 否 | 栏目模板 Id |
contentTemplateId | 整数 | 否 | 内容模板 Id |
# 返回
名称 | 类型 | 说明 |
---|---|---|
200 OK | Channel | 栏目 |
401 Unauthorized | Error | 认证错误 |
404 NotFound | Error | 资源不存在错误 |
400 BadRequest | Error | 参数错误 |
# 示例 1
以下请求将修改栏目名称。
POST /api/v1/channels/1476/1481/actions/update
Content-Type: application/json
X-SS-API-KEY: 7cd22002-27a7-4c5d-ba4d-a1c108a20eaf
{
"channelName": "栏目标题2"
}
# 示例 2
以下请求将修改栏目名称以及栏目索引。
POST /api/v1/channels/1476/1481/actions/update
Content-Type: application/json
X-SS-API-KEY: 7cd22002-27a7-4c5d-ba4d-a1c108a20eaf
{
"channelName": "栏目标题2",
"channelIndex": "栏目索引2"
}