获取工作项列表

GET 
/project/issues

获取工作项列表

History

Version	Changes
v3.14.117, v3.15.26	Added in: v3.14.117, v3.15.26

Request

Query Parameters

teamID stringrequired

团队ID

limit integer

Possible values: <= 100

Default value: 50

本次请求要返回的数量，默认值为50，超过100会被截断为100

cursor string

本次请求的起始位置

projectID string

作为过滤条件，列表只返回是projectID的工作项，与issueTypeID配合使用

issueTypeID string

作为过滤条件，列表只返回是issueTypeID的工作项，与projectID配合使用

Responses

200

请求成功

application/json

Schema

Schema

data

object

list

object[]

Array [

assignee

object

id string

工作项负责人ID

name string

工作项标题

createTime integer

工作项创建时间

dueDate string

工作项截止日期

timeEstimatedHour integer

工作项预估工时，单位（小时）

issueType

object

id string

工作项类型ID

name string

工作项类型名称

title string

工作项标题

number integer

工作项编号

creator

object

id string

工作项创建者ID

name string

工作项创建者名称

parent

object

id string

父工作项ID

title string

父工作项标题

priority

object

id string

工作项优先级ID

name string

工作项优先级名称

project

object

id string

工作项所属项目ID

name string

工作项所属项目名称

timeRemainingHour integer

工作项剩余工时，单位（小时）

sprint

object

id string

工作项所属迭代ID

name string

工作项所属迭代名称

status

object

id string

工作项状态ID

name string

工作项状态名称

category string

工作项状态类型

subIssueType

object

id string

子工作项类型ID

name string

子工作项类型名称

subIssueCount integer

子工作项总数

subIssueDoneCount integer

子工作项状态为完成的总数

subIssues

object[]

Array [

id string

子工作项ID

title string

子工作项标题

]

totalTimeEstimatedHour integer

工作项总预估工时，单位（小时）

timeSpentHour integer

工作项已登记工时，单位（小时）

totalTimeRemainingHour integer

工作项总剩余工时，单位（小时）

id string

工作项ID

fieldValues

object[]

Array [

fieldID string

属性唯一标识

type integer

属性类型（以下为常见类型示例）:

• 1: 单选
• 2: 文本
• 3: 整数
• 4: 浮点数
• 5: 日期
• 6: 时间
• 16: 多选
• 19: 布尔值

value

object

属性值。根据属性类型的不同，返回相应的数据格式。由于类型可扩展，具体格式需要参考返回数据

oneOf

MOD1

string

MOD2

integer

MOD3

boolean

MOD4

Array [

]

]

attachments

object[]

Array [

id string

工作项附件ID

name string

工作项附件名称

createTime integer

工作项附件创建时间

]

]

PageInfo

object

count integer

本次返回的数量

endCursor string

本页最后一个光标，用于翻页

hasNextPage boolean

是否有下一页

startCursor string

本页第一个光标，用于翻页

totalCount integer

整个集合总数，包括本次响应中返回的

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

errorData object

本次请求错误元数据

Example (from schema)

{
  "data": {
    "list": [
      {
        "assignee": {
          "id": "string",
          "name": "string"
        },
        "createTime": 0,
        "dueDate": "string",
        "timeEstimatedHour": 0,
        "issueType": {
          "id": "string",
          "name": "string"
        },
        "title": "string",
        "number": 0,
        "creator": {
          "id": "string",
          "name": "string"
        },
        "parent": {
          "id": "string",
          "title": "string"
        },
        "priority": {
          "id": "string",
          "name": "string"
        },
        "project": {
          "id": "string",
          "name": "string"
        },
        "timeRemainingHour": 0,
        "sprint": {
          "id": "string",
          "name": "string"
        },
        "status": {
          "id": "string",
          "name": "string",
          "category": "string"
        },
        "subIssueType": {
          "id": "string",
          "name": "string"
        },
        "subIssueCount": 0,
        "subIssueDoneCount": 0,
        "subIssues": [
          {
            "id": "string",
            "title": "string"
          }
        ],
        "totalTimeEstimatedHour": 0,
        "timeSpentHour": 0,
        "totalTimeRemainingHour": 0,
        "id": "string",
        "fieldValues": [
          {
            "fieldID": "string",
            "type": 0,
            "value": "string"
          }
        ],
        "attachments": [
          {
            "id": "string",
            "name": "string",
            "createTime": 0
          }
        ]
      }
    ],
    "PageInfo": {
      "count": 0,
      "endCursor": "string",
      "hasNextPage": true,
      "startCursor": "string",
      "totalCount": 0
    }
  },
  "result": "string",
  "errorCode": "string",
  "errorMsg": "string",
  "errorData": {}
}

401

如果身份验证凭据不正确或丢失，则返回

application/json

Schema

Schema

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Unauthorized",
  "errorMsg": "Access token is invalid"
}

403

如果scope检验不通过，则返回

application/json

Schema

Schema

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Forbidden",
  "errorMsg": "Scope is invalid"
}

404

如果未找到资源对象，则返回

application/json

Schema

Schema

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "NotFound",
  "errorMsg": "Not Found"
}

500

内部服务器错误

application/json

Schema

Schema

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Internal Server Error",
  "errorMsg": "Internal Server Error"
}

Loading...