01 分页查询内容 - 服务端开放接口

1、extension说明：

jpg/png...：图片

pdf：PPF

ppt：PPT

content_url：网页

content_text：纯文本

content_rtf：文章

res_group：组合内容

psd/psb/ai...：设计源文件

2、fileFormatType说明：

picture：图片

video：视频

audio：音频

document：文档

font：字体

3、asset说明：

文本类（fileFormatType = "content_text" 或 "content_rtf"；即，普通文本｜文章）

{
    "baseText":"文本内容"
}

图片（fileFormatType = "picture" ；即，extension = png | jpg 等）

{
     "url":"图片地址", // 图片地址
     "name":"文件名", // 图片名称     
     "size":1024, // 图片大小，单位b    
     "width":500, // 图片宽度，单位px     
     "height":500 // 图片高度，单位px
}

文档类（fileFormatType = "document" ；即，extension = ppt｜pptx｜pdf｜psd｜psb｜ai等）

{
     "url":"文档地址", // 文档地址
     "name":"文档名", // 文档名称
     "size":1024, // 图片大小，单位b
     "previewUrls":[]// 预览图地址列表
}

音频类（fileFormatType = "audio"，extention = jpg | png等）

视频类（fileFormatType = "video"，extention = mp4等）

4、sortField 排序规则说明：

code-排序字段，可选值：createTime｜updateTime｜ heatValue；依次代表：创建时间｜更新时间｜热度值

type-排序规则，可选值：desc｜asc；依次代表：降序｜升序

sortField-为空代表默认；默认为更新时间倒序

{
    "code":"", 
    "type":""
}

4、filterMap 过滤条件说明：

filterMap目前支持的key有：createTime（创建时间）、updateTime（更新时间）、publishTime(发布时间)

filterMap的key对应的value针对不同的key，传不同的参数，具体联系对应的开发同学

举例：filterMap的key为createTime或updateTime或publishTime时，filterMap参数如下，value为时间戳，目前支持范围查询：

"filterMap": {
   "createTime" : [1689177600, 1689350400]
}

请求参数

Header 参数

x-tenant-id

string

必需

示例值:

t15

Access-token

string

必需

示例值:

b46eda34-bf02-452b-b518-75d68a7159ab

Token-type

string

必需

示例值:

bearer

Content-Type

string

必需

示例值:

application/json

x-asm-prefer-tag

string

可选

默认值:

version-env-07

Body 参数application/json

token

string

必需

param

object

必需

portalId

string

看板ID

可选

不能与blockId,blockId同时为空；有值代表查询当前看板下所有内容

blockId

integer | null

模块ID

可选

blockIds与block不允许同时为空

blockIds

array[integer] | null

模块ID列表

可选

blockIds与block不允许同时为空

keywords

string | null

搜索文本

可选

min = 0 , max = 38；多个关键词以英文逗号或空格隔开

pageNum

integer

第几页

必需

默认1

pageSize

integer

每页的数量

必需

min = 1, max = 20；默认20

filterConditionList

array [object {3}]

筛选条件

可选

参见<查询内容模块基本信息>返回的navigators

showPositionList

array[string]

显示点位列表

可选

参数为点位code，见/blcok/getBlockPosition返回的 positionCode字段；传空默认返回所有点位信息，否则根据需要点位进行对应信息返回

sortField

object

排序条件

可选

见说明

materialCustomList

array [object {2}]

素材标签筛选

可选

根据素材标签搜索内容时使用

publishStatusList

array[string]

内容状态列表

可选

1-草稿;2-已发布;3-待发布;4-下架

filterMap

object

过滤条件

可选

见接口说明

示例

{
    "token": "b46eda34-bf02-452b-b518-75d68a7159ab",
    "param": {
        "portalId": "OTI4", 
        "blockId": 327,
        "blockIds": [327,328],// 有值，代表跨block进行搜索，若blockIds与blockId均有值，以blockIds为准
        "filterConditionList": [],
        "showPositionList": ["text_title","image_detail"]
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

string

必需

message

string

必需

result

object

必需

pageNum

integer

必需

pageSize

integer

必需

totalCount

integer

必需

totalPage

integer

必需

records

array [object {14}]

必需

示例

{
    "code": "0",
    "message": "success",
    "result": {
        "pageNum": 1,
        "pageSize": 10,
        "totalCount": 10,
        "totalPage": 1,
        "records": [
            {
                "id": 3981,
                "portalId": "2A7A83B058B3FEC49E9C39150B860466",
                "blockId": 327,
                "coreId": 1,
                "extContentInfo": {
                    "CUSTOMER_PORTAL_PUBLISH_TIME": 1661841203655
                },
                "positionList": [
                    {
                        "positionCode": "text_title",
                        "assetList": [
                            {
                                "extension": "content_text",
                                "fileFormatType": "content_text",
                                "asset": {
                                    "baseText": "我是标题我是标题我是标题"
                                }
                            }
                        ]
                    },
                    {
                        "positionCode": "image_detail",
                        "assetList": [
                            {
                                "extension": "png",
                                "fileFormatType": "picture",
                                "asset": {
                                    "size": 4340396,
                                    "name": "ZUI内容详情大图.png",
                                    "width": 1920,
                                    "url": "",
                                    "height": 1760
                                }
                            }
                        ]
                    }
                ]
            },
            {
                "id": 3327,
                "portalId": "2A7A83B058B3FEC49E9C39150B860466",
                "blockId": 327,
                "coreId": 2,
                "extContentInfo": {
                    "CUSTOMER_PORTAL_PUBLISH_TIME": 1661331529416
                },
                "positionList": [
                    {
                        "positionCode": "text_title",
                        "assetList": [
                            {
                                "extension": "content_text",
                                "fileFormatType": "content_text",
                                "asset": {
                                    "baseText": "全面开启推送"
                                }
                            }
                        ]
                    },
                    {
                        "positionCode": "image_detail",
                        "assetList": [
                            {
                                "extension": "jpg",
                                "fileFormatType": "picture",
                                "asset": {
                                    "size": 2595815,
                                    "name": "测试图.jpeg.jpg",
                                    "width": 1920,
                                    "url": "",
                                    "height": 1760
                                }
                            }
                        ]
                    }
                ]
            }
        ]
    }
}