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

1、scope 检索范围：
对应素材库 -> 全部素材组界面中的各个tab

0：全部

1：我创建的

2：与我协作的

3：我收藏的

2、parentCollectionId 父级素材组id：
如果只需要在某个素材组内检索，则需要该素材组id作为限定条件

3、permalink 是否获取永久链接：
获取素材组封面图时可根据需要是否获取永久链接

4、sort 排序规则说明：

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

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

sort-为空代表默认；默认为创建时间倒序

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

请求参数

Header 参数

Access-token

string

必需

示例值:

ca9adf46-e134-4fbe-b5a7-07ea220278a5

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]

关键词列表

可选

keywordScope

array[string]

关键字检索范围

可选

支持数组 group_name:素材组名检索；group_description：素材描述搜素；不传默认 group_name

scope

integer

检索范围

必需

0：全部；1：我创建的；2：我协作的；3：我收藏的

sort

object

排序规则

必需

{"field":"", "sort":""};
field-排序字段-可选值：

createTime 创建时间

updateTime 更新时间

groupName 名称排序
sort-排序规则-可选值：

desc 降序

asc 升序

parentCollectionId

integer

父级素材组ID

可选

默认顶级素材组：-1

pageNum

integer

页码

必需

默认：1

pageSize

integer

每页的数量

必需

默认：10，最大：100

permalink

boolean

是否获取永久链接

可选

默认取值false，即返回的链接有效期为30天。 - 传true时，返回信息中以下字段为永久可访问链接(前置条件：需要联系管理员在素材库内先为当前素材组开启永久有效链接)：thumbnailSrc、downloadUrl、transformPreviewUrl。

示例

{
    "token": "9b56f87f-06f0-4812-adb0-5df7d9e14bda",
    "param": {
        "keywordList": ["B"],
        "scope": 0,
        "sort": {
            "field": "default",
            "sort": "desc"
        },
        "parentCollectionId": 292630,
        "pageNum": 1,
        "pageSize": 10
    }
}

示例代码

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 {14}]

素材组列表

必需

示例

{
    "code": "0",
    "message": "success",
    "result": {
        "totalCount": 194,
        "list": [
            {
                "id": 292631,
                "collectionName": "B",
                "itemCount": 0,
                "collectionCount": 1,
                "belongId": 1,
                "description": null,
                "parentCollectionId": 292630,
                "rootId": 292630,
                "thunders": null,
                "hasCollected": false,
                "createTime": 1679988188000,
                "createUser": 1,
                "updateTime": 1679988270000,
                "updateUser": 1
            },
            {
                "id": 112828,
                "collectionName": "B37957",
                "itemCount": 0,
                "collectionCount": 0,
                "belongId": 1,
                "description": null,
                "parentCollectionId": 292630,
                "rootId": 292630,
                "thunders": null,
                "hasCollected": false,
                "createTime": 1677150275000,
                "createUser": 1,
                "updateTime": 1680031712000,
                "updateUser": 1
            },
            {
                "id": 112827,
                "collectionName": "BA8775",
                "itemCount": 0,
                "collectionCount": 0,
                "belongId": 1,
                "description": null,
                "parentCollectionId": 292630,
                "rootId": 292630,
                "thunders": null,
                "hasCollected": false,
                "createTime": 1677150275000,
                "createUser": 1,
                "updateTime": 1680031712000,
                "updateUser": 1
            },
            {
                "id": 112826,
                "collectionName": "B37958",
                "itemCount": 0,
                "collectionCount": 0,
                "belongId": 1,
                "description": null,
                "parentCollectionId": 292630,
                "rootId": 292630,
                "thunders": null,
                "hasCollected": false,
                "createTime": 1677150275000,
                "createUser": 1,
                "updateTime": 1680031712000,
                "updateUser": 1
            },
            {
                "id": 112825,
                "collectionName": "B44751",
                "itemCount": 0,
                "collectionCount": 0,
                "belongId": 1,
                "description": null,
                "parentCollectionId": 292630,
                "rootId": 292630,
                "thunders": null,
                "hasCollected": false,
                "createTime": 1677150275000,
                "createUser": 1,
                "updateTime": 1680031712000,
                "updateUser": 1
            },
            {
                "id": 112824,
                "collectionName": "B44750",
                "itemCount": 0,
                "collectionCount": 0,
                "belongId": 1,
                "description": null,
                "parentCollectionId": 292630,
                "rootId": 292630,
                "thunders": null,
                "hasCollected": false,
                "createTime": 1677150275000,
                "createUser": 1,
                "updateTime": 1680031712000,
                "updateUser": 1
            },
            {
                "id": 112823,
                "collectionName": "AB6066",
                "itemCount": 0,
                "collectionCount": 0,
                "belongId": 1,
                "description": null,
                "parentCollectionId": 292630,
                "rootId": 292630,
                "thunders": null,
                "hasCollected": false,
                "createTime": 1677150275000,
                "createUser": 1,
                "updateTime": 1680031712000,
                "updateUser": 1
            },
            {
                "id": 112822,
                "collectionName": "B41765",
                "itemCount": 0,
                "collectionCount": 0,
                "belongId": 1,
                "description": null,
                "parentCollectionId": 292630,
                "rootId": 292630,
                "thunders": null,
                "hasCollected": false,
                "createTime": 1677150275000,
                "createUser": 1,
                "updateTime": 1680031712000,
                "updateUser": 1
            },
            {
                "id": 112821,
                "collectionName": "AI7286",
                "itemCount": 0,
                "collectionCount": 0,
                "belongId": 1,
                "description": null,
                "parentCollectionId": 292630,
                "rootId": 292630,
                "thunders": null,
                "hasCollected": false,
                "createTime": 1677150275000,
                "createUser": 1,
                "updateTime": 1680031712000,
                "updateUser": 1
            },
            {
                "id": 112820,
                "collectionName": "B41766",
                "itemCount": 0,
                "collectionCount": 0,
                "belongId": 1,
                "description": null,
                "parentCollectionId": 292630,
                "rootId": 292630,
                "thunders": null,
                "hasCollected": false,
                "createTime": 1677150275000,
                "createUser": 1,
                "updateTime": 1680031712000,
                "updateUser": 1
            }
        ]
    }
}