说明

返回符合查询条件的所有模块（分页显示，默认一页30条）

SDK 方法名

nodeJs:

SDK使用方式 (opens new window)

插件中使用SDK

方法名::

getModules

url

https://api.tapd.cn/modules

支持格式

JSON/XML（默认JSON格式）

HTTP请求方式

GET

请求数限制

默认返回 30 条。可通过传 limit 参数设置，最大取 200。也可以传 page 参数翻页

请求参数

字段名	必选	类型及范围	说明	特殊规则
id	否	integer	id	支持多ID查询
name	否	string	标题	支持模糊匹配
description	否	string	详细描述
owner	否	string	负责人
created	否	datetime	创建时间	支持时间查询
workspace_id	是	integer	项目ID
limit	否	integer	设置返回数量限制，默认为30
page	否	integer	返回当前数量限制下第N页的数据，默认为1（第一页）
order	否	string	排序规则，规则：字段名 ASC或者DESC，然后 urlencode	如按创建时间逆序：order=created%20desc
fields	否	string	设置获取的字段，多个字段间以','逗号隔开

调用示例及返回结果

获取项目下的模块信息

curl 使用 Basic Auth 鉴权调用示例

curl -u 'api_user:api_password' 'https://api.tapd.cn/modules?workspace_id=10158231'

curl 'Authorization: Bearer ACCESS_TOKEN' 'https://api.tapd.cn/modules?workspace_id=10158231'

返回结果

{
    "status": 1,
    "data": [
        {
            "Module": {
                "id": "1010158231007549219",
                "name": "模块1",
                "description": "",
                "owner": "anyechen",
                "created": "2017-06-20 16:49:18"
            }
        }
    ],
    "info": "success"
}

模块字段说明

模块重要字段说明

字段	说明
id	id
name	标题
description	详细描述
owner	负责人
created	创建时间
workspace_id	项目ID