Query Task List V2

POST

/issue/v2/page

The Issue List, v2, Is Queried For Issues Whose Conditions Are Met By The Subtasks.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://app.workzappy.com/openapi/api/issue/v2/page' \
--header 'accessToken: {{accessToken}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "summary": "xxx",
    "pageNumber": 1,
    "showedCustomFieldCodes": [
        "customfield_1"
    ],
    "orderBy": "xxx",
    "pageSize": 10,
    "sort": "xxx",
    "selectFilter": [
        {
            "fieldCode": "customfield_1",
            "ids": [
                1,
                2
            ],
            "operator": "contains"
        },
        {
            "fieldCode": "customfield_2",
            "operator": "blank"
        }
    ],
    "numberFilter": [
        {
            "fieldCode": "customfield_1",
            "value": 2,
            "operator": "equals"
        },
        {
            "fieldCode": "customfield_2",
            "range": {
                "min": 0,
                "max": 1
            },
            "value": 2,
            "operator": "inRange"
        },
        {
            "fieldCode": "customfield_3",
            "operator": "blank"
        }
    ],
    "projectId": 1,
    "statusTypes": [
        2
    ]
}'

Response Example

{
    "code": "0",
    "data": {
        "total": 1,
        "fields": {
            "customfield_1": {
                "controlCode": "select",
                "fieldName": "customfield_1",
                "fieldCode": "customfield_1",
                "multipleChoice": true,
                "fieldType": "String"
            }
        },
        "list": [
            {
                "singleFields": {
                    "summary": {
                        "value": "xxx"
                    },
                    "createBy": {
                        "id": 1,
                        "value": "xxx",
                        "url": "https://xxx/1.jpg"
                    }
                },
                "multiFields": {
                    "field1": [
                        {
                            "id": 1,
                            "value": "1"
                        },
                        {
                            "id": 2,
                            "value": "2"
                        }
                    ]
                },
                "id": 1,
                "matchFilter": true
            }
        ]
    }
}

Request

Header Params

Content-Type

string

required

Example:

application/json

accessToken

string

required

Example:

Body Params application/json

summary

string

optional

Summary

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)

selectFilter

array [object {3}]

optional

Optional Field Filter

fieldCode

string

optional

Field Code

ids

array [object]

optional

Option Id List

operator

string

optional

operator(contains|notContains|blank|notBlank), contains By Default

numberFilter

array [object {4}]

optional

number Field Filter

fieldCode

string

optional

Field Code

range

object

optional

Range, Necessarily When The Operator Type Is InRange

value

number

optional

Field Code, Necessarily When The Operator Type Is Not InRange

operator

string

optional

projectId

integer <int64>

required

Project ID

statusTypes

array [object]

optional

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

Examples

Responses

🟢200OK

application/json

Body

singleFields

object

optional

Single-Valued Results Collection, Fields Defining The Collection Where MultipleChoice Is False

multiFields

object

optional

Set Result Collection, Field Defines The Field In The Collection Where MultipleChoice Is True

integer <int64>

optional

Issue ID

matchFilter

boolean

optional

Whether To Match The Filter Conditions, If The Current Issue Does Not Meet The Conditions But The Subtasks Meet The Conditions, Return False.

Modified at 2025-03-21 12:10:47

Query Task List

Get Project Task Filter Fields