bsm-sdk
/
client
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity
client/docs/cms/pages.md

8.8 KiB
Raw Permalink Blame History

Pages

单页管理

/cms.Pages/Fetch

单页列表

Request

{
    page: "0", // type<int64>, 页码,默认第一页
    size: "0", // type<int64>, 单页显示数量,默认10,最多50
    keyword: "", // type<string>, 根据文章名称模糊查找
    type: 0, // type<int32>, 根据用户自定义文章类型过滤,可选,默认0,全部查找
}

Reply

{
    data: [{
        identity: "", // type<string>, 文章唯一标识
        created_at: "", // type<string>, 创建时间
        updated_at: "", // type<string>, 更新时间
        post_type: 0, // type<int32>, 用户自定义文章类型
        rights: "", // type<string>, 权限
        title: "", // type<string>, <必传>,标题
        key: "", // type<string>, <必传>,文章key
        description: "", // type<string>, 简介
        cover_path: "", // type<string>, 封面
        Cms: "", // type<string>, <必传>,内容
        has_accessory: false, // type<bool>, 是否有附件,默认没有
        accessory_identity_array: [""], // list<string>, 附件Identity 列表
        accessory_data: [{
            identity: "", // type<string>, 唯一标识
            title: "", // type<string>, 附件标题
            file_path: "", // type<string>, 附件文件路径
            created_at: "", // type<string>, 创建时间
        }], // list<AccessoryItem>, 附件数据
        tags_data: [{
            id: "0", // type<int64>
            identity: "", // type<string>, 唯一标识
            title: "", // type<string>, 标题
            cover_path: "", // type<string>, 封面图片
            intro: "", // type<string>, 简介
            created_at: "", // type<string>, 创建时间
        }], // list<TagsItem>, 标签数据
        tags_identity_array: [""], // list<string>, 标签集Identity 列表
        hits: "0", // type<int64>, 点击量
    }], // list<PagesItem>, 数据
    count: "0", // type<int64>, 总数量
}

/cms.Pages/GetByIdentity

获取单页详情 By Identity

Request

{
    identity: "", // type<string>, 必传唯一标识
}

Reply

{
    identity: "", // type<string>, 文章唯一标识
    created_at: "", // type<string>, 创建时间
    updated_at: "", // type<string>, 更新时间
    post_type: 0, // type<int32>, 用户自定义文章类型
    rights: "", // type<string>, 权限
    title: "", // type<string>, <必传>,标题
    key: "", // type<string>, <必传>,文章key
    description: "", // type<string>, 简介
    cover_path: "", // type<string>, 封面
    Cms: "", // type<string>, <必传>,内容
    has_accessory: false, // type<bool>, 是否有附件,默认没有
    accessory_identity_array: [""], // list<string>, 附件Identity 列表
    accessory_data: [{
        identity: "", // type<string>, 唯一标识
        title: "", // type<string>, 附件标题
        file_path: "", // type<string>, 附件文件路径
        created_at: "", // type<string>, 创建时间
    }], // list<AccessoryItem>, 附件数据
    tags_data: [{
        id: "0", // type<int64>
        identity: "", // type<string>, 唯一标识
        title: "", // type<string>, 标题
        cover_path: "", // type<string>, 封面图片
        intro: "", // type<string>, 简介
        created_at: "", // type<string>, 创建时间
    }], // list<TagsItem>, 标签数据
    tags_identity_array: [""], // list<string>, 标签集Identity 列表
    hits: "0", // type<int64>, 点击量
}

/cms.Pages/GetByKey

获取单页详情 By Key

Request

{
    key: "", // type<string>, <必传> 内容页的key
}

Reply

{
    identity: "", // type<string>, 文章唯一标识
    created_at: "", // type<string>, 创建时间
    updated_at: "", // type<string>, 更新时间
    post_type: 0, // type<int32>, 用户自定义文章类型
    rights: "", // type<string>, 权限
    title: "", // type<string>, <必传>,标题
    key: "", // type<string>, <必传>,文章key
    description: "", // type<string>, 简介
    cover_path: "", // type<string>, 封面
    Cms: "", // type<string>, <必传>,内容
    has_accessory: false, // type<bool>, 是否有附件,默认没有
    accessory_identity_array: [""], // list<string>, 附件Identity 列表
    accessory_data: [{
        identity: "", // type<string>, 唯一标识
        title: "", // type<string>, 附件标题
        file_path: "", // type<string>, 附件文件路径
        created_at: "", // type<string>, 创建时间
    }], // list<AccessoryItem>, 附件数据
    tags_data: [{
        id: "0", // type<int64>
        identity: "", // type<string>, 唯一标识
        title: "", // type<string>, 标题
        cover_path: "", // type<string>, 封面图片
        intro: "", // type<string>, 简介
        created_at: "", // type<string>, 创建时间
    }], // list<TagsItem>, 标签数据
    tags_identity_array: [""], // list<string>, 标签集Identity 列表
    hits: "0", // type<int64>, 点击量
}

/cms.Pages/Create

发布单页

Request

{
    identity: "", // type<string>, 文章唯一标识
    created_at: "", // type<string>, 创建时间
    updated_at: "", // type<string>, 更新时间
    post_type: 0, // type<int32>, 用户自定义文章类型
    rights: "", // type<string>, 权限
    title: "", // type<string>, <必传>,标题
    key: "", // type<string>, <必传>,文章key
    description: "", // type<string>, 简介
    cover_path: "", // type<string>, 封面
    Cms: "", // type<string>, <必传>,内容
    has_accessory: false, // type<bool>, 是否有附件,默认没有
    accessory_identity_array: [""], // list<string>, 附件Identity 列表
    accessory_data: [{
        identity: "", // type<string>, 唯一标识
        title: "", // type<string>, 附件标题
        file_path: "", // type<string>, 附件文件路径
        created_at: "", // type<string>, 创建时间
    }], // list<AccessoryItem>, 附件数据
    tags_data: [{
        id: "0", // type<int64>
        identity: "", // type<string>, 唯一标识
        title: "", // type<string>, 标题
        cover_path: "", // type<string>, 封面图片
        intro: "", // type<string>, 简介
        created_at: "", // type<string>, 创建时间
    }], // list<TagsItem>, 标签数据
    tags_identity_array: [""], // list<string>, 标签集Identity 列表
    hits: "0", // type<int64>, 点击量
}

Reply

{
    code: 0, // type<int32>, 状态码
    message: "", // type<string>, 状态说明
    details: "", // type<string>, 数据
    timeseq: "0", // type<int64>, 响应时间序列
}

/cms.Pages/Modify

修改单页

Request

{
    identity: "", // type<string>, 文章唯一标识
    created_at: "", // type<string>, 创建时间
    updated_at: "", // type<string>, 更新时间
    post_type: 0, // type<int32>, 用户自定义文章类型
    rights: "", // type<string>, 权限
    title: "", // type<string>, <必传>,标题
    key: "", // type<string>, <必传>,文章key
    description: "", // type<string>, 简介
    cover_path: "", // type<string>, 封面
    Cms: "", // type<string>, <必传>,内容
    has_accessory: false, // type<bool>, 是否有附件,默认没有
    accessory_identity_array: [""], // list<string>, 附件Identity 列表
    accessory_data: [{
        identity: "", // type<string>, 唯一标识
        title: "", // type<string>, 附件标题
        file_path: "", // type<string>, 附件文件路径
        created_at: "", // type<string>, 创建时间
    }], // list<AccessoryItem>, 附件数据
    tags_data: [{
        id: "0", // type<int64>
        identity: "", // type<string>, 唯一标识
        title: "", // type<string>, 标题
        cover_path: "", // type<string>, 封面图片
        intro: "", // type<string>, 简介
        created_at: "", // type<string>, 创建时间
    }], // list<TagsItem>, 标签数据
    tags_identity_array: [""], // list<string>, 标签集Identity 列表
    hits: "0", // type<int64>, 点击量
}

Reply

{
    code: 0, // type<int32>, 状态码
    message: "", // type<string>, 状态说明
    details: "", // type<string>, 数据
    timeseq: "0", // type<int64>, 响应时间序列
}

/cms.Pages/Delete

删除单页

Request

{
    id: "0", // type<int64>, 唯一ID
    identity: "", // type<string>, 唯一标识
}

Reply

{
    code: 0, // type<int32>, 状态码
    message: "", // type<string>, 状态说明
    details: "", // type<string>, 数据
    timeseq: "0", // type<int64>, 响应时间序列
}