issue列表 - LigaAI

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

accessToken

string

必需

示例值:

Body 参数application/json

summary

string

概要

可选

selectFields

object

下拉选项字段集合

可选

dateFields

object

时间选项字段集合

可选

pageNumber

integer <int32>

页码,默认第一页

可选

showedCustomFieldCodes

array [object]

可选

展示的自定义字段列表

orderBy

string

可选

排序字段（createTime|updateTime）

pageSize

integer <int32>

可选

每页条数，默认每页10条

sort

string

可选

排序方式（DESC|ASC）, 默认DESC

projectId

integer <int64>

项目id编号

必需

statusTypes

array [object]

可选

状态类别列表（未开始：2|进行中：3|已完成：4）

示例

{
  "summary": "xxx",
  "selectFields": {
    "createBy": [
      1,
      2,
      3
    ],
    "sprint": [
      1
    ]
  },
  "dateFields": {
    "createTime": [
      1630425600000,
      1632412799000
    ]
  },
  "pageNumber": 1,
  "showedCustomFieldCodes": [
    "customfield_1"
  ],
  "orderBy": "createTime",
  "pageSize": 10,
  "sort": "DESC",
  "projectId": 1,
  "statusTypes": [
    2
  ]
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://ligai.cn/openapi/api/issue/page' \
--header 'accessToken: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "summary": "xxx",
    "selectFields": {
        "createBy": [
            1,
            2,
            3
        ],
        "sprint": [
            1
        ]
    },
    "dateFields": {
        "createTime": [
            1630425600000,
            1632412799000
        ]
    },
    "pageNumber": 1,
    "showedCustomFieldCodes": [
        "customfield_1"
    ],
    "orderBy": "createTime",
    "pageSize": 10,
    "sort": "DESC",
    "projectId": 1,
    "statusTypes": [
        2
    ]
}'

返回响应

🟢200成功

*/*

OK

Body

priorityName

string

优先级名称

可选

issueTypeName

string

事项类型名称

可选

statusType

integer <int32>

可选

状态类别（未开始：2|进行中：3|已完成：4）

dueDate

string <date>

截止时间

可选

customFieldData

object

自定义字段数据

可选

priorityId

integer <int64>

优先级编号

可选

issueTypeVO

object

事项类型信息

可选

code

string

问题类型编码

可选

name

string

问题类型名称

可选

id

integer <int64>

问题类型编号

可选

issueTypeId

integer <int64>

事项类型id

可选

assigneeName

string

执行人

可选

updateBy

integer <int64>

更新人

可选

statusName

string

状态名称

可选

sprintName

string

迭代名称

可选

id

integer <int64>

事项id

可选

summary

string

概要

可选

updateTime

string <date>

更新时间

可选

assigneeId

integer <int64>

执行人id

可选

updateByVO

object

更新人信息

可选

profilePicture

string

用户头像

可选

userName

string

用户名

可选

userId

integer <int64>

用户id

可选

accountEnabled

string <byte>

可选

账户是否启用(0:否,1:是)

<= 4 字符

assigneeVO

object

执行人信息

可选

profilePicture

string

用户头像

可选

userName

string

用户名

可选

userId

integer <int64>

用户id

可选

accountEnabled

string <byte>

可选

账户是否启用(0:否,1:是)

<= 4 字符

tags

array [object]

标签列表

可选

sprintId

integer <int64>

迭代ID

可选

createBy

integer <int64>

创建人

可选

statusId

integer <int64>

状态id

可选

createTime

string <date>

创建时间

可选

createByVO

object

创建人信息

可选

profilePicture

string

用户头像

可选

userName

string

用户名

可选

userId

integer <int64>

用户id

可选

accountEnabled

string <byte>

可选

账户是否启用(0:否,1:是)

<= 4 字符

startDate

string <date>

开始时间

可选

示例

{
  "code": "0",
  "data": {
    "total": 1,
    "list": [
      {
        "priorityName": "xxx",
        "issueTypeName": "xxx",
        "statusType": 1,
        "dueDate": 1646301600000,
        "customFieldData": {
          "customfield_1": 1
        },
        "priorityId": 1,
        "issueTypeVO": {
          "code": "xxx",
          "name": "xxx",
          "id": 1
        },
        "issueTypeId": 1,
        "assigneeName": "xxx",
        "updateBy": 1,
        "statusName": "xxx",
        "sprintName": "xxx",
        "id": 1,
        "summary": "xxx",
        "updateTime": 1646301600000,
        "assigneeId": 1,
        "updateByVO": {
          "profilePicture": "xxx",
          "userName": "xxx",
          "userId": 1,
          "accountEnabled": 1
        },
        "assigneeVO": {
          "profilePicture": "xxx",
          "userName": "xxx",
          "userId": 1,
          "accountEnabled": 1
        },
        "tags": [
          {
            "id": 1,
            "tagName": "xxx"
          }
        ],
        "sprintId": 1,
        "createBy": 1,
        "statusId": 1,
        "createTime": 1646301600000,
        "createByVO": {
          "profilePicture": "xxx",
          "userName": "xxx",
          "userId": 1,
          "accountEnabled": 1
        },
        "startDate": 1646301600000
      }
    ]
  }
}