Leiga

Query Issue List

POST/issue/page

Request

Header Params

Content-Type

string

required

Example:

application/json

accessToken

string

required

Example:

summary

string

optional

Summary

selectFields

object

optional

Optional Field Values

dateFields

object

optional

Date Field Values

pageNumber

integer <int32>

optional

Page Number

showedCustomFieldCodes

array [object]

optional

Showed Custom Field Codes

orderBy

string

optional

Sorted Fields (createTime|updateTime)

pageSize

integer <int32>

optional

Page Size

sort

string

optional

Sort (ASC|DESC)

projectId

integer <int64>

required

Project ID

statusTypes

array [object]

optional

Status Type List (Not Started: 2, In Progress: 3, Done: 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
  ]
}

Request samples

Responses

OK(200)

HTTP Code: 200

Content Type : JSONapplication/json

priorityName

string

optional

Priority Name

issueTypeName

string

optional

Issue Type Name

statusType

integer <int32>

optional

Status Type (Not Started: 2, In Progress: 3, Done: 4)

dueDate

string <date>

optional

Due Date

customFieldData

object

optional

Custom Field Data

priorityId

integer <int64>

optional

Priority ID

issueTypeVO

object

optional

Issue Type

code

string

optional

Issue Type Code

name

string

optional

Issue Type Name

integer <int64>

optional

Issue Type ID

issueTypeId

integer <int64>

optional

Issue Type ID

assigneeName

string

optional

Assignee Name

updateBy

integer <int64>

optional

Last Updater ID

statusName

string

optional

Issue Status Name

sprintName

string

optional

Sprint Name

integer <int64>

optional

Issue ID

summary

string

optional

Issue Summary

updateTime

string <date>

optional

Last Update Time

assigneeId

integer <int64>

optional

Assignee ID

updateByVO

object

optional

Last Updater

profilePicture

string

optional

Profile Picture

userName

string

optional

User Name

userId

integer <int64>

optional

User ID

accountEnabled

string <byte>

optional

Account Enabled (0:No,1:Yes)

<= 4 characters

assigneeVO

object

optional

Assignee

profilePicture

string

optional

Profile Picture

userName

string

optional

User Name

userId

integer <int64>

optional

User ID

accountEnabled

string <byte>

optional

Account Enabled (0:No,1:Yes)

<= 4 characters

tags

array [object]

optional

Tag List

sprintId

integer <int64>

optional

Sprint ID

createBy

integer <int64>

optional

Creator ID

statusId

integer <int64>

optional

Issue Status ID

createTime

string <date>

optional

Creation Time

createByVO

object

optional

Creator

profilePicture

string

optional

Profile Picture

userName

string

optional

User Name

userId

integer <int64>

optional

User ID

accountEnabled

string <byte>

optional

Account Enabled (0:No,1:Yes)

<= 4 characters

startDate

string <date>

optional

Start 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
      }
    ]
  }
}

Last modified: 7 months ago