产品 (product)

产品管理，支持获取产品列表、获取项目集的产品列表、创建产品、关闭产品、创建产品的需求模块、创建产品的Bug模块、创建产品的用例模块、获取产品详情、修改产品、删除产品

动作概览

SDK 动作	说明	方法	路径
`list`	获取产品列表	`GET`	`/products`
`programProducts`	获取项目集的产品列表	`GET`	`/programs/{programID}/products`
`create`	创建产品	`POST`	`/products`
`close`	关闭产品	`POST`	`/products/{productID}/close`
`createStoryModule`	创建产品的需求模块	`POST`	`/products/{productID}/story/modules`
`createBugModule`	创建产品的Bug模块	`POST`	`/products/{productID}/bug/modules`
`createTestcaseModule`	创建产品的用例模块	`POST`	`/products/{productID}/testcase/modules`
`get`	获取产品详情	`GET`	`/products/{productID}`
`update`	修改产品	`PUT`	`/products/{productID}`
`delete`	删除产品	`DELETE`	`/products/{productID}`

获取产品列表

SDK 调用：request("product/list", params)
HTTP：GET /products
动作类型：list
最低禅道版本：22.0 / biz13.0 / max8.0 / ipd5.0

路径参数

无路径参数。

查询参数

参数	类型	必填	说明
`browseType`	string	否	浏览类型 `all` 全部 `noclosed` 未关闭 `closed` 已结束
`orderBy`	string	否	排序 `id_asc` ID 升序 `id_desc` ID 降序 `title_asc` 名称升序 `title_desc` 名称降序 `begin_asc` 计划开始升序 `begin_desc` 计划开始降序 `end_asc` 计划结束升序 `end_desc` 计划结束降序
`recPerPage`	number	否	每页数量，不超过1000
`pageID`	number	否	页码，从第1页开始

请求体

无请求体。

返回值

返回形态：list
结果字段：products
分页字段：pager

SDK 示例

import { request } from 'zentao-api';

const result = await request("product/list", {
  "browseType": "all",
  "orderBy": "id_asc",
  "recPerPage": 1,
  "pageID": 1
});

获取项目集的产品列表

SDK 调用：request("product/programProducts", params)
HTTP：GET /programs/{programID}/products
动作类型：list
最低禅道版本：22.5 / biz13.5 / max8.5 / ipd5.5

路径参数

参数	说明
`programID`	项目集ID

查询参数

参数	类型	必填	默认值	说明
`browseType`	string	否	`noclosed`	状态，默认是noclosed `all` 全部 `noclosed` 未关闭 `closed` 已结束
`orderBy`	string	否		排序 `id_asc` ID 升序 `id_desc` ID 降序 `name_asc` 名称升序 `name_desc` 名称降序 `begin_asc` 计划开始升序 `begin_desc` 计划开始降序 `end_asc` 计划结束升序 `end_desc` 计划结束降序
`recPerPage`	number	否		每页数量，不超过1000
`pageID`	number	否		页码，从第1页开始

请求体

无请求体。

返回值

返回形态：list
结果字段：products
分页字段：pager

SDK 示例

import { request } from 'zentao-api';

const result = await request("product/programProducts", {
  "programID": 1,
  "browseType": "noclosed",
  "orderBy": "id_asc",
  "recPerPage": 1,
  "pageID": 1
});

创建产品

SDK 调用：request("product/create", params)
HTTP：POST /products
动作类型：create
最低禅道版本：22.0 / biz13.0 / max8.0 / ipd5.0

路径参数

无路径参数。

查询参数

无查询参数。

请求体

请求体必填：是

Schema:

json

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "产品名称"
    },
    "program": {
      "type": "integer",
      "description": "所属项目集",
      "format": "int32"
    },
    "line": {
      "type": "integer",
      "description": "所属产品线",
      "format": "int32"
    },
    "type": {
      "type": "string",
      "description": "类型(normal 正常 | branch 多分支 | platform 多平台)"
    },
    "PO": {
      "type": "string",
      "description": "产品负责人"
    },
    "reviewer": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "评审人"
    },
    "desc": {
      "type": "string",
      "description": "产品描述"
    },
    "QD": {
      "type": "string",
      "description": "测试负责人"
    },
    "RD": {
      "type": "string",
      "description": "发布负责人"
    },
    "acl": {
      "type": "string",
      "description": "访问控制(open 公开 | private 私有)",
      "defaultValue": "open"
    }
  },
  "required": [
    "name"
  ]
}

示例:

json

{
  "name": "智能头枕",
  "program": 1,
  "line": 0,
  "type": "normal",
  "PO": "normal",
  "reviewer": [
    "productManager"
  ],
  "desc": "智能健康头枕",
  "QD": "productManager",
  "RD": "productManager",
  "acl": "open"
}

返回值

返回形态：object

SDK 示例

import { request } from 'zentao-api';

const result = await request("product/create", {
  "name": "<string>",
  "program": 1,
  "line": 1,
  "type": "<string>",
  "PO": "<string>",
  "reviewer": [
    "<string>"
  ],
  "desc": "<string>",
  "QD": "<string>",
  "RD": "<string>",
  "acl": "<string>"
});

关闭产品

SDK 调用：request("product/close", params)
HTTP：POST /products/{productID}/close
动作类型：action
最低禅道版本：22.5 / biz13.5 / max8.5 / ipd5.5

路径参数

参数	说明
`productID`	产品ID

查询参数

无查询参数。

请求体

请求体必填：是

Schema:

json

{
  "type": "object",
  "properties": {
    "comment": {
      "type": "string",
      "description": "备注"
    }
  }
}

示例:

json

{
  "comment": "<string>"
}

返回值

返回形态：text

SDK 示例

import { request } from 'zentao-api';

const result = await request("product/close", {
  "productID": 1,
  "comment": "<string>"
});

创建产品的需求模块

SDK 调用：request("product/createStoryModule", params)
HTTP：POST /products/{productID}/story/modules
动作类型：create
最低禅道版本：22.5 / biz13.5 / max8.5 / ipd5.5

路径参数

参数	说明
`productID`	产品ID

查询参数

无查询参数。

请求体

请求体必填：是

Schema:

json

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "模块名称"
    },
    "parentID": {
      "type": "integer",
      "description": "父模块",
      "format": "int32"
    }
  }
}

示例:

json

{
  "name": "需求模块",
  "parentID": "0"
}

返回值

返回形态：object

SDK 示例

import { request } from 'zentao-api';

const result = await request("product/createStoryModule", {
  "productID": 1,
  "name": "<string>",
  "parentID": 1
});

创建产品的Bug模块

SDK 调用：request("product/createBugModule", params)
HTTP：POST /products/{productID}/bug/modules
动作类型：create
最低禅道版本：22.5 / biz13.5 / max8.5 / ipd5.5

路径参数

参数	说明
`productID`	产品ID

查询参数

无查询参数。

请求体

请求体必填：是

Schema:

json

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "模块名称"
    },
    "parentID": {
      "type": "integer",
      "description": "父模块",
      "format": "int32"
    }
  }
}

示例:

json

{
  "name": "Bug模块",
  "parentID": "0"
}

返回值

返回形态：object

SDK 示例

import { request } from 'zentao-api';

const result = await request("product/createBugModule", {
  "productID": 1,
  "name": "<string>",
  "parentID": 1
});

创建产品的用例模块

SDK 调用：request("product/createTestcaseModule", params)
HTTP：POST /products/{productID}/testcase/modules
动作类型：create
最低禅道版本：22.5 / biz13.5 / max8.5 / ipd5.5

路径参数

参数	说明
`productID`	产品ID

查询参数

无查询参数。

请求体

请求体必填：是

Schema:

json

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "模块名称"
    },
    "parentID": {
      "type": "integer",
      "description": "父模块",
      "format": "int32"
    }
  }
}

示例:

json

{
  "name": "用例模块",
  "parentID": "0"
}

返回值

返回形态：object

SDK 示例

import { request } from 'zentao-api';

const result = await request("product/createTestcaseModule", {
  "productID": 1,
  "name": "<string>",
  "parentID": 1
});

获取产品详情

SDK 调用：request("product/get", params)
HTTP：GET /products/{productID}
动作类型：get
最低禅道版本：22.0 / biz13.0 / max8.0 / ipd5.0

路径参数

参数	说明
`productID`	产品ID

查询参数

无查询参数。

请求体

无请求体。

返回值

返回形态：object
结果字段：product

SDK 示例

import { request } from 'zentao-api';

const result = await request("product/get", {
  "productID": 1
});

修改产品

SDK 调用：request("product/update", params)
HTTP：PUT /products/{productID}
动作类型：update
最低禅道版本：22.0 / biz13.0 / max8.0 / ipd5.0

路径参数

参数	说明
`productID`	产品ID

查询参数

无查询参数。

请求体

请求体必填：是

Schema:

json

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "产品名称"
    },
    "program": {
      "type": "integer",
      "description": "所属项目集",
      "format": "int32"
    },
    "line": {
      "type": "integer",
      "description": "所属产品线",
      "format": "int32"
    },
    "type": {
      "type": "string",
      "description": "类型(normal 正常 | branch 多分支 | platform 多平台)"
    },
    "PO": {
      "type": "string",
      "description": "产品负责人"
    },
    "reviewer": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "评审人"
    },
    "desc": {
      "type": "string",
      "description": "产品描述"
    },
    "QD": {
      "type": "string",
      "description": "测试负责人"
    },
    "RD": {
      "type": "string",
      "description": "发布负责人"
    },
    "acl": {
      "type": "string",
      "description": "访问控制(open 公开 | private 私有)",
      "defaultValue": "open"
    }
  },
  "required": [
    "name"
  ]
}

示例:

json

{
  "name": "智能照明",
  "program": 1,
  "line": 0,
  "type": "normal",
  "PO": "normal",
  "reviewer": [
    "productManager"
  ],
  "desc": "智能家庭照明",
  "QD": "productManager",
  "RD": "productManager",
  "acl": "open"
}

返回值

返回形态：object

SDK 示例

import { request } from 'zentao-api';

const result = await request("product/update", {
  "productID": 1,
  "name": "<string>",
  "program": 1,
  "line": 1,
  "type": "<string>",
  "PO": "<string>",
  "reviewer": [
    "<string>"
  ],
  "desc": "<string>",
  "QD": "<string>",
  "RD": "<string>",
  "acl": "<string>"
});

删除产品

SDK 调用：request("product/delete", params)
HTTP：DELETE /products/{productID}
动作类型：delete
最低禅道版本：22.0 / biz13.0 / max8.0 / ipd5.0

路径参数

参数	说明
`productID`	产品ID

查询参数

无查询参数。

请求体

无请求体。

返回值

返回形态：text

SDK 示例

import { request } from 'zentao-api';

const result = await request("product/delete", {
  "productID": 1
});

产品 (product) ​

动作概览 ​

获取产品列表 ​

路径参数 ​

查询参数 ​

请求体 ​

返回值 ​

SDK 示例 ​

获取项目集的产品列表 ​

路径参数 ​

查询参数 ​

请求体 ​

返回值 ​

SDK 示例 ​

创建产品 ​

路径参数 ​

查询参数 ​

请求体 ​

返回值 ​

SDK 示例 ​

关闭产品 ​

路径参数 ​

查询参数 ​

请求体 ​

返回值 ​

SDK 示例 ​

创建产品的需求模块 ​

路径参数 ​

查询参数 ​

请求体 ​

返回值 ​

SDK 示例 ​

创建产品的Bug模块 ​

路径参数 ​

查询参数 ​

请求体 ​

返回值 ​

SDK 示例 ​

创建产品的用例模块 ​

路径参数 ​

查询参数 ​

请求体 ​

返回值 ​

SDK 示例 ​

获取产品详情 ​

路径参数 ​

查询参数 ​

请求体 ​

返回值 ​

SDK 示例 ​

修改产品 ​

路径参数 ​

查询参数 ​

请求体 ​

返回值 ​

SDK 示例 ​

删除产品 ​

路径参数 ​

查询参数 ​

请求体 ​

返回值 ​

SDK 示例 ​

产品 (product)

动作概览

获取产品列表

路径参数

查询参数

请求体

返回值

SDK 示例

获取项目集的产品列表

路径参数

查询参数

请求体

返回值

SDK 示例

创建产品

路径参数

查询参数

请求体

返回值

SDK 示例

关闭产品

路径参数

查询参数

请求体

返回值

SDK 示例

创建产品的需求模块

路径参数

查询参数

请求体

返回值

SDK 示例

创建产品的Bug模块

路径参数

查询参数

请求体

返回值

SDK 示例

创建产品的用例模块

路径参数

查询参数

请求体

返回值

SDK 示例

获取产品详情

路径参数

查询参数

请求体

返回值

SDK 示例

修改产品

路径参数

查询参数

请求体

返回值

SDK 示例

删除产品

路径参数

查询参数

请求体

返回值

SDK 示例