Get a list of issues

GET 
/project/issues

Get a list of issues.

History

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

Request

Query Parameters

teamID stringrequired

The team ID

limit integer

Possible values: <= 500

Default value: 500

The default value for the number of results to return in this request is 500. Values exceeding 500 or ≤0 will be reset to 500

cursor string

The starting location of this request

projectID string

As a filter condition, the list only returns work items that are projectID, used in conjunction with issueTypeID.

issueTypeID string

As a filter condition, the list only returns work items that are issueTypeID, used in conjunction with projectID.

Responses

200

Request is successful.

application/json

Schema

Schema

data

object

list

object[]

Array [

assignee

object

id string

ID of the assignee.

name string

Name of the assignee.

createTime integer

CreateTime of the issue.

dueDate string

Issue due date.

timeEstimatedHour integer

Time estimated,unit is hour.

issueType

object

id string

ID of the issue type.

name string

Name of the issue type.

title string

Title of the issue.

number integer

Number of the issue.

creator

object

id string

ID of the creator.

name string

Name of the creator.

parent

object

id string

Parent issue ID.

name string

Parent issue title.

priority

object

id string

ID of the priority.

name string

Name of the priority.

project

object

id string

Project ID of the issue.

name string

Project name of the issue.

timeRemainingHour integer

Time remaining,unit is hour.

sprint

object

id string

ID of the sprint.

name string

Name of the sprint.

status

object

id string

ID of the status.

name string

Name of the status.

category string

Category of the status.

subIssueType

object

id string

ID of the sub issue type.

name string

Name of the sub issue type.

subIssueCount integer

Total sub issue.

subIssueDoneCount integer

Total completed sub issue.

subIssues

object[]

Array [

id string

ID of the sub issue.

name string

Name of the sub issue.

]

totalTimeEstimatedHour integer

Total time estimated,unit is hour.

timeSpentHour integer

Time spent,unit is hour.

totalTimeRemainingHour integer

Total time remaining,unit is hour.

id string

ID of the issue.

attachments

object[]

Array [

id string

ID of the attachment.

name string

Name of the attachment.

createTime integer

Create time of the attachment.

]

fieldValues

object[]

Only includes custom attributes added to the detail form and a subset of system attributes

Array [

fieldID string

Field identifier

type integer

Field type (common types as examples):

• 1: Single Select
• 2: Text
• 3: Integer
• 4: Float
• 5: Date
• 6: Time
• 16: Multiple Select
• 19: Boolean

value

object

Field value. The data format varies according to the field type. Due to extensible types, please refer to the response data for specific formats

oneOf

MOD1

string

MOD2

integer

MOD3

boolean

MOD4

Array [

]

]

solution

object

id string

ID of the solution

value string

Value of the solution

publishProgress integer

publish progress

publishDate string

publish date

serverUpdateStamp integer

update timestamp

timeProgress integer

time progress

estimateStoryPoint integer

story point

publishVersion

object[]

Array [

id string

ID of the publish version

name string

Name of the publish version

]

watchers

object[]

Array [

id string

ID of watchers

name string

Name of watchers

]

planStartDate string

Plan start date

planEndDate string

Plan end date

solver

object

id string

ID of the solver

name string

Name of the solver

descriptionText string

Description Text

description string

Description Rich-Text

defectType

object

id string

ID of the defect type

value string

value of the defect type

isOnlineDefect

object

id string

ID of the is-online defect

value string

value of the is-online defect

products

object[]

Array [

id string

ID of products

name string

Name of products

]

productModules

object[]

Array [

id string

ID of product modules

name string

Name of product modules

]

projectModules

object[]

Array [

id string

ID of project modules

name string

Name of project modules

]

epic

object

id string

ID of the epic

name string

Name of the epic

severityLevel

object

id string

ID of the severity level

value string

Value of the severity level

estimateVariance integer

Estimated variance

totalTimeProgress integer

Total time progress

totalEstimateVariance integer

Total estimated variance

progress integer

Progress

]

pageInfo

object

Page information.

count integer

The number returned this time.

endCursor string

The last cursor on this page is generally used to turn pages.

hasNextPage boolean

Is there a next page.

startCursor string

The first cursor on this page is generally used to turn pages.

totalCount integer

The total number of items available in the entire collection, including those that are returned in the current response.

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

errorData object

Error meta data for this request.

Example (from schema)

[
  {
    "result": "SUCCESS",
    "data": {
      "list": [
        {
          "assignee": {
            "id": "5f1b8a1b",
            "name": "test"
          },
          "createTime": 1595555555,
          "dueDate": 1595555555,
          "timeEstimatedHour": 1,
          "issueType": {
            "id": "9c6d4c01",
            "name": "test"
          },
          "title": "test",
          "number": 1,
          "creator": {
            "id": "5f1b8a1b",
            "name": "test"
          },
          "parent": {
            "id": "5f1b8a1b",
            "title": "test"
          },
          "priority": {
            "id": "9c6d4c01",
            "name": "test"
          },
          "project": {
            "id": "5f1b8a1b",
            "name": "test"
          },
          "timeRemainingHour": 1,
          "sprint": {
            "id": "5f1b8a1b",
            "name": "test"
          },
          "status": {
            "id": "5f1b8a1b",
            "name": "test",
            "category": "test"
          },
          "subIssueType": {
            "id": "5f1b8a1b",
            "name": "test"
          },
          "subIssueCount": 1,
          "subIssueDoneCount": 1,
          "subIssues": [
            {
              "id": "5f1b8a1b",
              "name": "test"
            }
          ],
          "totalTimeEstimatedHour": 1,
          "timeSpentHour": 1,
          "totalTimeRemainingHour": 1,
          "id": "5f1b8a1b",
          "attachments": [
            {
              "id": "5f1b8a1b",
              "name": "test",
              "createTime": 1595555555
            }
          ]
        }
      ],
      "pageInfo": {
        "count": 1,
        "endCursor": "sample_end_cursor",
        "hasNextPage": false,
        "startCursor": "sample_start_cursor",
        "totalCount": 1
      }
    }
  }
]

401

Returned if the authentication credentials are incorrect or missing.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

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

403

Returns if the scope check fails.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

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

404

Returned if the resource object was not found.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

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

500

Internal Server Error.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

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

Loading...