智能创作
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 智能创作 > 客户端 API > 项目管理相关接口 > 搜索项目

搜索项目

最近更新时间：2022-03-23 17:13:47

我的收藏

本页目录：

接口描述

接口名称：/Project/SearchProject。
接口功能：搜索项目，支持根据项目类别和项目名称模糊检索项目。

调用方式

具体调用方式参见 客户端 API 调用方式综述，您也可以使用 CME 客户端 API 调试工具 快速进行调试。

输入参数

字段
类型
必填
描述
CategorySet
Array of String
否
分类集合，取值：
Default：普通编辑项目；
Live：直播剪辑项目；
VideoSegmentation：视频拆条项目。
Name
String
否
项目名称，长度限制：15个字符，不能跟CategorySet同时为空。
Sort
否
排序方式。Sort.Field 可选值：CreateTime。指定 Text 搜索时，将根据匹配度排序，该字段无效。
Offset
Integer
否
偏移量。默认值：0。
Limit
Integer
否
返回记录条数，默认值：50。

输出参数

接口输出参数由 公共返回参数 和接口自身返回参数两部分组成。接口自身返回参数详情如下。
字段
类型
描述
TotalCount
Integer
符合条件的记录总数。
ProjectBasicInfoSet
项目基础信息。

示例

示例1：搜索项目成功

搜索 Category 为Default的项目，返回成功。

输入示例

{
    "CategorySet": [
        "Default"
    ],
    "Limit": 1
}

输出示例

{
    "Code": "Success",
    "Message": "成功",
    "EnglishMessage": "success",
    "Data": {
        "TotalCount": 2,
        "ProjectBasicInfoSet": [
            {
                "ProjectId": "cmepid_5fbb72524e70c2000192d4ed",
                "Owner": {
                    "Id": "ce4cdaf6-6039-486b-8f09-a5df23dbe6c9",
                    "Type": "PERSON"
                },
                "Category": "Default",
                "Name": "招生通0821",
                "WHRatio": "16:9",
                "CoverUrl": "https://cme.vod2.myqcloud.com/1810000003/8d388657vodtranscq1810000003/5fdf8be75285890810291911580/coverBySnapshot/coverBySnapshot_10_0.jpg",
                "CreateTime": "2020-11-23T08:26:58Z",
                "UpdateTime": "2020-12-20T07:25:42Z"
            }
        ]
    }
}

示例2：搜索项目失败

搜索 Category 为Default的项目，返回成功。

输入示例

{
    "Limit": 1
}

输出示例

{
    "Code": "InvalidParameterValue",
    "Message": "参数值错误",
    "EnglishMessage": "param lack of CategorySet or Name"
}

中国站