LigaAI

issue列表v2

POST

/issue/v2/page

事项模块(issue)

issue列表v2，会查询出子任务满足条件的issue

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

accessToken

string

必需

示例值:

Body 参数application/json

summary

string

概要

可选

pageNumber

integer <int32>

页码,默认第一页

可选

showedCustomFieldCodes

array [object]

可选

展示的自定义字段列表

orderBy

string

可选

排序字段（createTime|updateTime）

pageSize

integer <int32>

可选

每页条数，默认每页10条

sort

string

可选

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

selectFilter

array [object {3}]

下拉选项字段集合

可选

fieldCode

string

字段编码

可选

ids

array [object]

选项id列表

可选

operator

string

可选

操作符（包含：contains|不包含：notContains|为空：blank|不为空：notBlank）, 默认contains

numberFilter

array [object {4}]

数字类型字段集合

可选

fieldCode

string

字段编码

可选

range

object

可选

字符值范围，操作符类型为inRange时传入

value

number

可选

字段值，操作符类型不为inRange时传入

operator

string

可选

projectId

integer <int64>

项目id编号

必需

statusTypes

array [object]

可选

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

示例

{
  "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
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://ligai.cn/openapi/api/issue/v2/page' \
--header '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
    ]
}'

返回响应

🟢200成功

*/*

Body

singleFields

object

可选

单值结果集合, 字段定义集合中multipleChoice为false的字段

multiFields

object

可选

集合结果集合, 字段定义集合中multipleChoice为true的字段

integer <int64>

事项id

可选

matchFilter

boolean

可选

是否匹配筛选条件，当前issue不满足条件但子任务满足条件时返回false

示例

{
  "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
      }
    ]
  }
}

修改于 2024-10-15 13:49:36

issue列表

获取项目下所有的筛选条件