GET
/
v1
/
projects
/
{project}
/
issues
{
  "issues": [
    {
      "approval": {
        "approvalTemplates": [
          {
            "flow": {
              "steps": [
                {
                  "type": "TYPE_UNSPECIFIED",
                  "nodes": [
                    {
                      "type": "TYPE_UNSPECIFIED",
                      "role": "<string>"
                    }
                  ]
                }
              ]
            },
            "title": "<string>",
            "description": "<string>"
          }
        ],
        "approvers": [
          {
            "status": "STATUS_UNSPECIFIED",
            "principalId": 123
          }
        ],
        "approvalFindingDone": true,
        "approvalFindingError": "<string>",
        "riskLevel": "RISK_LEVEL_UNSPECIFIED"
      },
      "grantRequest": {
        "role": "<string>",
        "user": "<string>",
        "condition": {
          "id": "<string>",
          "constExpr": {
            "nullValue": "NULL_VALUE",
            "boolValue": true,
            "int64Value": "<string>",
            "uint64Value": "<string>",
            "doubleValue": 123,
            "stringValue": "<string>",
            "bytesValue": "<string>",
            "durationValue": "<string>",
            "timestampValue": "2023-11-07T05:31:56Z"
          },
          "identExpr": {
            "name": "<string>"
          },
          "selectExpr": {
            "operand": {},
            "field": "<string>",
            "testOnly": true
          },
          "callExpr": {
            "target": {},
            "function": "<string>",
            "args": [
              {}
            ]
          },
          "listExpr": {
            "elements": [
              {}
            ],
            "optionalIndices": [
              123
            ]
          },
          "structExpr": {
            "messageName": "<string>",
            "entries": [
              {
                "id": "<string>",
                "fieldKey": "<string>",
                "mapKey": {},
                "value": {},
                "optionalEntry": true
              }
            ]
          },
          "comprehensionExpr": {
            "iterVar": "<string>",
            "iterRange": {},
            "accuVar": "<string>",
            "accuInit": {},
            "loopCondition": {},
            "loopStep": {},
            "result": {}
          }
        },
        "expiration": "<string>"
      },
      "labels": [
        "<string>"
      ]
    }
  ],
  "nextPageToken": "<string>"
}

Path Parameters

​
project
string
required

The project id.

Query Parameters

​
pageSize
integer

The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 10 issues will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

​
pageToken
string

A page token, received from a previous ListIssues call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListIssues must match the call that provided the page token.

​
filter
string

Filter is used to filter issues returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec

Supported filters:

  • creator: issue creator full name in "users/{email or id}" format, support "==" operator.
  • status: the issue status, support "==" and "in" operator, check the IssueStatus enum for the values.
  • create_time: issue create time in "2006-01-02T15:04:05Z07:00" format, support ">=" or "<=" operator.
  • type: the issue type, support "==" and "in" operator, check the Type enum in the Issue message for the values.
  • task_type: support "==" operator, the value can be "DDL", "DML" or "DATA_EXPORT"
  • instance: the instance full name in the "instances/{id}" format, support "==" operator.
  • database: the database full name in the "instances/{id}/databases/{name}" format, support "==" operator.
  • labels: the issue labels, support "==" and "in" operator.
  • has_pipeline: the issue has pipeline or not, support "==" operator, the value should be "true" or "false".

For example: creator == "users/ed@bytebase.com" && status in ["OPEN", "DONE"] status == "CANCELED" && type == "DATABASE_CHANGE" instance == "instances/sample" && labels in ["label1", "label2"] has_pipeline == true && create_time >= "2025-01-02T15:04:05Z07:00"

​
query
string

Query is the query statement.

Response

200
application/json

OK

The response is of type object.

GET
/
v1
/
projects
/
{project}
/
issues
{
  "issues": [
    {
      "approval": {
        "approvalTemplates": [
          {
            "flow": {
              "steps": [
                {
                  "type": "TYPE_UNSPECIFIED",
                  "nodes": [
                    {
                      "type": "TYPE_UNSPECIFIED",
                      "role": "<string>"
                    }
                  ]
                }
              ]
            },
            "title": "<string>",
            "description": "<string>"
          }
        ],
        "approvers": [
          {
            "status": "STATUS_UNSPECIFIED",
            "principalId": 123
          }
        ],
        "approvalFindingDone": true,
        "approvalFindingError": "<string>",
        "riskLevel": "RISK_LEVEL_UNSPECIFIED"
      },
      "grantRequest": {
        "role": "<string>",
        "user": "<string>",
        "condition": {
          "id": "<string>",
          "constExpr": {
            "nullValue": "NULL_VALUE",
            "boolValue": true,
            "int64Value": "<string>",
            "uint64Value": "<string>",
            "doubleValue": 123,
            "stringValue": "<string>",
            "bytesValue": "<string>",
            "durationValue": "<string>",
            "timestampValue": "2023-11-07T05:31:56Z"
          },
          "identExpr": {
            "name": "<string>"
          },
          "selectExpr": {
            "operand": {},
            "field": "<string>",
            "testOnly": true
          },
          "callExpr": {
            "target": {},
            "function": "<string>",
            "args": [
              {}
            ]
          },
          "listExpr": {
            "elements": [
              {}
            ],
            "optionalIndices": [
              123
            ]
          },
          "structExpr": {
            "messageName": "<string>",
            "entries": [
              {
                "id": "<string>",
                "fieldKey": "<string>",
                "mapKey": {},
                "value": {},
                "optionalEntry": true
              }
            ]
          },
          "comprehensionExpr": {
            "iterVar": "<string>",
            "iterRange": {},
            "accuVar": "<string>",
            "accuInit": {},
            "loopCondition": {},
            "loopStep": {},
            "result": {}
          }
        },
        "expiration": "<string>"
      },
      "labels": [
        "<string>"
      ]
    }
  ],
  "nextPageToken": "<string>"
}

Path Parameters

​
project
string
required

The project id.

Query Parameters

​
pageSize
integer

The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 10 issues will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

​
pageToken
string

A page token, received from a previous ListIssues call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListIssues must match the call that provided the page token.

​
filter
string

Filter is used to filter issues returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec

Supported filters:

  • creator: issue creator full name in "users/{email or id}" format, support "==" operator.
  • status: the issue status, support "==" and "in" operator, check the IssueStatus enum for the values.
  • create_time: issue create time in "2006-01-02T15:04:05Z07:00" format, support ">=" or "<=" operator.
  • type: the issue type, support "==" and "in" operator, check the Type enum in the Issue message for the values.
  • task_type: support "==" operator, the value can be "DDL", "DML" or "DATA_EXPORT"
  • instance: the instance full name in the "instances/{id}" format, support "==" operator.
  • database: the database full name in the "instances/{id}/databases/{name}" format, support "==" operator.
  • labels: the issue labels, support "==" and "in" operator.
  • has_pipeline: the issue has pipeline or not, support "==" operator, the value should be "true" or "false".

For example: creator == "users/ed@bytebase.com" && status in ["OPEN", "DONE"] status == "CANCELED" && type == "DATABASE_CHANGE" instance == "instances/sample" && labels in ["label1", "label2"] has_pipeline == true && create_time >= "2025-01-02T15:04:05Z07:00"

​
query
string

Query is the query statement.

Response

200
application/json

OK

The response is of type object.