更新时间:2021-12-17 GMT+08:00
分享

查询模板列表

功能介绍

根据用户信息查看用户的模板列表,结果使用分页展示。

URI

  • URI格式
    GET /softcomai/datalake/dataplan/v1.0/templates?templateType={templateType}&pageNum={pageNum}&pageSize={pageSize}&dirUrl={dirUrl}&searchField={searchField}&searchStr={searchStr}
  • 参数说明

    参数名

    是否必选

    参数类型

    备注

    pageNum

    int

    分页用到的起始页。

    pageSize

    int

    每页数据条数。

    templateType

    String

    模板类型。

    dirUrl

    String

    URL。

    searchField

    String

    当前只支持:ALL、name、description、tag,其他无效。

    searchStr

    String

    搜索内容。

请求

  • 请求样例
    GET https://127.0.0.1:5555/softcomai/datalake/dataplan/v1.0/templates?templateType=PUBLIC&pageNum=1&pageSize=10&dirUrl=1181635994378930758
  • 参数说明

    参数名

    是否必选

    参数类型

    备注

    pageNum

    int

    分页用到的起始页。

    pageSize

    int

    每页数据条数。

    templateType

    String

    模板类型。

    dirUrl

    String

    URL。

    searchField

    String

    当前只支持:ALL、name、description、tag,其他无效。

    searchStr

    String

    搜索内容。

响应

  • 响应样例
    {
    "success": true,
    "returnData": {
    "page": {
    "currentPageNum": 1,
    "lastPageNum": 1,
    "totalPageNum": 1,
    "startRowIndex": 0,
    "gotoPageNum": 0,
    "pageSize": 10,
    "recordCount": 1
    },
    "dataList": [
    {
    "sourceId": "P_20191025164113_369664296",
    "url": "4070886005386612775--1181635994378930758",
    "templateType": "PUBLIC",
    "id": "P_20191104205225_991575645",
    "name": "POSTMAN测试发布公共模板",
    "description": "POSTMAN测试发布公共模板",
    "userId": "PUBLIC",
    "tenantId": "PUBLIC",
    "createTime": "2019-11-04 20:52:27",
    "updateTime": "2019-11-04 20:52:27",
    "tasks": []
    }
    ]
    }
    }
  • 要素说明

    参数名

    参数类型

    备注

    success

    String

    请求是否成功。

    returnData

    JSON

    返回体。

    page

    JSON

    分页信息。

    dataList

    JSON

    模板列表。

    id

    String

    模板ID。

    sourceId

    String

    源ID,即创建模板的项目ID。

    url

    String

    URL。

    templateType

    String

    模板类型。

    name

    String

    模板名称。

    description

    String

    描述。

    userId

    String

    用户信息。

    tenantId

    String

    租户信息。

    tasks

    String

    任务列表。

状态码

具体请参考状态码

分享:

    相关文档

    相关产品

关闭导读