01 素材检索 - 服务端开放接口

通过筛选条件查询素材信息

提示

当检索发生在素材组内时（即 collectionId 不为空时）：
会进行穿透子素材组搜索（能搜到儿子、孙子素材组里的素材）；

素材筛选条件详解：

筛选条件获取：查询筛选模板元数据

2. 筛选条件设置：

筛选类型解释：

标签多选类型：

日期类型：

特殊类型：

素材状态筛选：

📌

素材状态解释:
可使用：素材正常，筛选值为"0"
已失效：素材已失效，筛选值为"1"
即将失效：素材即将失效，筛选值为"3"
未生效：素材未生效，筛选值为"2"
即将生效：素材即将生效，筛选值为"4"

创建人筛选：

素材大小筛选：

素材创建时间筛选：

素材合成任务ID筛选：

审批状态筛选：

合规检测状态筛选：

素材文件类型筛选：

optionalMap筛选“或”类型解释：

请求参数

Header 参数

Access-token

string

必需

访问令牌，获取途径：获取访问令牌

示例值:

db28c148-24c0-452d-80e9-c4797d991a22

Token-type

string

必需

示例值:

bearer

x-open-api-user

string

必需

用户邮箱，邮箱为系统用户邮箱

示例值:

xxx@tezign.com

Content-Type

string

必需

示例值:

application/json

x-asm-prefer-tag

string

可选

默认值:

version-env-07

Body 参数application/json

token

string

必需

param

object

必需

keywordList

array[string]

搜索关键词列表

可选

关键词筛选，填入的关键词会经过分词器进行分词检索

assetIds

array[string]

素材ID列表

可选

素材ID列表，如需根据确定的某几个素材id进行检索可通过此字段进行过滤

collectionId

null

素材组ID

可选

为空时全局搜索，不为空则在这个组范围内的素材进行检索

isSearchPenetration

boolean | null

是否穿透素材组搜素

可选

默认true 穿透素材组搜素，只搜当前素材组下素材传false

filterMap

object

搜索条件

可选

过滤条件只有满足此过滤条件的素材才会被检索出
此过滤条件可在查询筛选模板元数据中选取中选择
条件填充参考上面 2.筛选条件设置
允许传空，eg：{}

sort

object

排序

必需

{"field":"", "sort":""}; field-排序字段，可选值： default,createTime,name.py sort-排序规则，可选值：desc, asc

pageNum

integer

页码

必需

从1开始

pageSize

integer

页数

必需

最大限制：50

needDownLoadAuth

boolean

是否需要下载权限

可选

默认需要：true:header中x-open-api-user用户有下载权限的素材返回下载链接，false：所有素材不返回下载链接

permalink

boolean

是否获取永久链接

可选

默认取值false，即返回的链接有效期为30天。

传ture 则返回的thumbnailSrc、downloadUrl、transformPreviewUrl为永久有效连接
（前置条件：此参数只对某个素材组下的素材设置，需要联系管理员在素材库内先为当前素材组开启永久有效链接设置拿到素材组id后，然后联合collectionId一起使用）

optionalMap

object

“或”搜索条件

可选

内部查询字段之间都是"或"的关系，具体见说明

示例

{
    "token": "9a83bbf6-85ef-4aba-b3c4-d7c6e591c8ed",
    "param": {
        "keywordList": [
            "素材"
        ],
        "assetIds": [],
        "collectionId": null,
        "sort": {
            "field": "default",
            "sort": "desc"
        },
        "filterMap": {
            "format": [
                1,
                26,
                2,
                46,
                44,
                3,
                4,
                27,
                49,
                53
            ]
        },
        "pageNum": 1,
        "pageSize": 20
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

string

必需

message

string

必需

result

object

必需

totalCount

integer

搜索总数

必需

list

array [object {16}]

搜索结果列表

必需

示例

{
    "code": "43",
    "message": "ipsum in",
    "result": {
        "totalCount": 51,
        "list": [
            {
                "id": 65,
                "assetElementId": 87,
                "name": "法已果市转织第",
                "size": 86,
                "createTime": 527291255885,
                "createUserId": 18,
                "extension": "PNG",
                "thumbnailSrc": "consequat",
                "downloadUrl": "http://jpy.cv/zlow",
                "importUrl": "http://pidqq.mobi/vvcxt",
                "baseText": null,
                "downloadPermission": false,
                "extend": {
                    "duration": null,
                    "width": 80,
                    "height": 31
                },
                "assetElementList": null,
                "transformPreviewUrl": "http://lrkjygqdqs.pk/okgp"
            },
            {
                "id": 55,
                "assetElementId": 2,
                "name": "结题动八严",
                "size": 78,
                "createTime": 72113162674,
                "createUserId": 48,
                "extension": "JPG",
                "thumbnailSrc": "reprehenderit Lorem dolore",
                "downloadUrl": "http://bbsjrln.pw/omwwg",
                "importUrl": "http://bjzn.uy/ehrnugb",
                "baseText": null,
                "downloadPermission": true,
                "extend": {
                    "duration": null,
                    "width": 76,
                    "height": 39
                },
                "assetElementList": null,
                "transformPreviewUrl": "http://eqko.an/hjmsrlnjbj"
            }
        ]
    }
}