返信一覧¶
GET /api/v1/issue/reply/{issue_uuid}/list
概要¶
Issue の通常の返信、操作記録、および関連イベント返信をページ単位で読み取ります。
呼び出し前と使用手順¶
Issue 詳細 から Issue uuid を取得します。pageIndex のデフォルトは 1、pageSize のデフォルトは 10 です。ordering には -createAt を指定して作成時間の降順に並べ替えられます。省略した場合は明示的な並べ替えを指定しません。content.data 配列およびトップレベルの pageInfo を読み取ります。記録の type は必ずしも reply ではないため、type に基づいて人による内容とシステム操作を区別してください。添付ファイルは各項目の attachmentsList にあります。操作には現在の API Key が属するワークスペースを使用します。同じワークスペースからリソース識別子を取得してください。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| issue_uuid | string | Y | 現在のワークスペースの Issue UUID。 例: issue_example取得または入力方法: Issue リスト の content.data[].uuid または Issue を作成 のレスポンス content.uuid から取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| ordering | string | 並べ替えフィールド。接頭辞 - は降順、接頭辞なしは昇順です。返信記録の実際のフィールドのみを使用してください。不正なフィールドは内部エラーを引き起こす可能性があります。省略した場合は明示的な並べ替えを指定しません。 null を許可: False 例: -createAt取得または入力方法: createAt または -createAt の使用を推奨します。複数フィールドはカンマで区切ります(例: -createAt,uuid)。 |
|
| pageIndex | integer | ページ番号。デフォルトは 1 で、正の整数を使用します。 null を許可: False 例: 1取得または入力方法: 最初のページは 1 から開始し、ページごとに増やします。 |
|
| pageSize | integer | 1 ページあたりの件数。デフォルトは 10。 null を許可: False 例: 10取得または入力方法: 必要に応じて適切な正の整数を選択します。 |
パラメータ補足説明¶
存在しない、または返信がない Issue は空の配列を返す場合があります。このインターフェースで Issue の存在を検証することはできません。まず Issue 詳細を照会して対象を確認してください。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/issue/reply/issue_example/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode ordering=-createAt \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=10
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.data | array<object> |
現在のページの返信。結果がない場合は []。 |
| content.data[].id | integer または null | レコード番号。Issue 作成/返信のレスポンスでは、永続化前に構築される場合に null になることがあります。操作対象リソースには uuid を使用してください。 |
| content.data[].uuid | string | リソース UUID。 |
| content.data[].workspaceUUID | string | 所属ワークスペース UUID。 |
| content.data[].status | integer | レコード状態。0 は正常、3 は削除済みです。Issue の業務状態 statusType と区別してください。 |
| content.data[].creator | string | 作成呼び出しの身元。API Key 識別子、アカウント、またはシステム身元の場合があります。 |
| content.data[].updator | string | 最終更新の身元。未設定の場合は空文字列です。 |
| content.data[].createAt | integer | 作成時間、Unix 秒。 |
| content.data[].updateAt | integer | 最終更新時間、Unix 秒。未更新の場合は -1 になることがあります。 |
| content.data[].deleteAt | integer | 削除時間、Unix 秒。未削除の場合は -1 です。 |
| content.data[].issueUUID | string | 所属 Issue UUID。 |
| content.data[].content | string または null | 返信または操作記録の内容。 |
| content.data[].type | string | reply は通常の返信、change は操作記録、eventReply は関連イベント返信、autoDiscoveryReply は自動検出返信。 |
| content.data[].extend | object | 拡張内容。リクエストでは null ではなくオブジェクト {} を渡してください。メンバー、チャンネル、担当者などの構造はパラメータ表を参照してください。 |
| content.data[].extend.text | string | 長さチェックに使用するプレーンテキスト。最大 3000 文字。 |
| content.data[].extend.channels | array<object> |
説明内で参照されたチャンネル。uuid、name、type、exists を含みます。返却時は exists が現在のリソース存在性に基づいて更新されます。 |
| content.data[].extend.channels[].uuid | string | チャンネル UUID。 |
| content.data[].extend.channels[].name | string または null | 表示名。 |
| content.data[].extend.channels[].type | string | チャンネル参照マーカー #。 |
| content.data[].extend.channels[].exists | boolean | 返却時にこのチャンネルが存在するかどうか。 |
| content.data[].extend.members | array<object> |
説明内で @ されたメンバー参照。uuid、name、type、exists を含みます。 |
| content.data[].extend.members[].uuid | string | メンバーアカウント UUID。 |
| content.data[].extend.members[].name | string または null | 表示名。 |
| content.data[].extend.members[].type | string | メンバー参照マーカー @。 |
| content.data[].extend.members[].exists | boolean | 返却時にこのアカウントが存在するかどうか。 |
| content.data[].extend.extra | object | サードパーティ連携の表示情報。API の実際の認証身元を変更しません。 |
| content.data[].extend.extra.creator | object | サードパーティ作成者の表示情報。name、email を含む場合があります。 |
| content.data[].extend.extra.creator.name | string | 作成者の表示名。 |
| content.data[].extend.extra.creator.email | string | 作成者の表示メールアドレス。 |
| content.data[].extend.extra.updator | object | サードパーティ更新者の表示情報。name、email を含む場合があります。 |
| content.data[].extend.extra.updator.name | string | 更新者の表示名。 |
| content.data[].extend.extra.updator.email | string | 更新者の表示メールアドレス。 |
| content.data[].extend.extra.managerInfos | object | 担当者のメールアドレスをキーとする表示情報マップ。Issue でのみ使用します。 |
| content.data[].extend.extra.managerInfos.邮箱.name | string | 対応するメールアドレスの担当者の表示名。 |
| content.data[].extend.其他字段 | JSON | クライアントが保存するその他の拡張情報。すべてが業務動作をトリガーするわけではありません。 |
| content.data[].creatorInfo | object | 作成者の表示情報。サードパーティの extend.extra.creator に値がある場合、一部の読み取りインターフェースはこの表示情報を優先して使用します。 |
| content.data[].creatorInfo.name | string | 表示名。省略可能。 |
| content.data[].creatorInfo.email | string | メールアドレス。省略可能。 |
| content.data[].creatorInfo.uuid | string | アカウント UUID。省略可能。 |
| content.data[].updatorInfo | object | 更新者の表示情報。空のオブジェクトの場合があります。 |
| content.data[].updatorInfo.name | string | 表示名。省略可能。 |
| content.data[].updatorInfo.email | string | メールアドレス。省略可能。 |
| content.data[].updatorInfo.uuid | string | アカウント UUID。省略可能。 |
| content.data[].attachmentsList | array<object> |
この返信に紐づく添付ファイル。 |
| content.data[].attachmentsList[].uuid | string | 添付ファイル UUID。 |
| content.data[].attachmentsList[].fileName | string | 元のファイル名。 |
| content.data[].attachmentsList[].fileSuffix | string | 拡張子。 |
| content.data[].is_modify | boolean | createAt と updateAt が異なるかどうかで計算されるマーカー。未更新で updateAt=-1 の場合も true になることがあるため、この値だけで人による編集を判断しないでください。 |
| content.data[].latest_modify_time | integer | updateAt に直接対応します。Unix 秒。未更新の場合は -1 になることがあります。 |
| content.declaration | object または null | ワークスペースの共通宣言。content のこの階層にのみ付加されます。 |
| pageInfo | object | トップレベルのページ情報。 |
| pageInfo.pageIndex | integer | 現在のページ番号。 |
| pageInfo.pageSize | integer | このページの件数上限。 |
| pageInfo.count | integer | このページの実際の件数。 |
| pageInfo.totalCount | integer | 条件に一致する総件数。 |
| content.data[].creatorInfo.status | integer | アカウントレコードの状態。省略可能。 |
| content.data[].creatorInfo.wsAccountStatus | integer | 現在のワークスペースにおけるアカウント状態。省略可能。 |
| content.data[].creatorInfo.username | string | ログイン名。省略可能。 |
| content.data[].creatorInfo.iconUrl | string | アカウントのアバター URL。省略可能。 |
| content.data[].creatorInfo.mobile | string | アカウントの携帯電話番号。空または省略の場合があります。 |
| content.data[].creatorInfo.countryCode | string | 携帯電話番号の国/地域コード。省略可能。 |
| content.data[].creatorInfo.acntWsNickname | string | ワークスペースのニックネーム。省略可能。 |
| content.data[].updatorInfo.status | integer | アカウントレコードの状態。省略可能。 |
| content.data[].updatorInfo.wsAccountStatus | integer | 現在のワークスペースにおけるアカウント状態。省略可能。 |
| content.data[].updatorInfo.username | string | ログイン名。省略可能。 |
| content.data[].updatorInfo.iconUrl | string | アカウントのアバター URL。省略可能。 |
| content.data[].updatorInfo.mobile | string | アカウントの携帯電話番号。空または省略の場合があります。 |
| content.data[].updatorInfo.countryCode | string | 携帯電話番号の国/地域コード。省略可能。 |
| content.data[].updatorInfo.acntWsNickname | string | ワークスペースのニックネーム。省略可能。 |
{
"code": 200,
"content": {
"data": [
{
"id": 301,
"uuid": "repim_example",
"workspaceUUID": "wksp_example",
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785430800,
"updateAt": -1,
"deleteAt": -1,
"issueUUID": "issue_example",
"content": "已定位到数据库慢查询,正在优化。",
"type": "reply",
"extend": {},
"creatorInfo": {},
"updatorInfo": {},
"attachmentsList": [],
"is_modify": true,
"latest_modify_time": -1
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 10,
"count": 1,
"totalCount": 1
}
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 処理方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している場合 | パラメータの解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 500 | ft.InternalServerError | レベルまたは設定の保存、監査、その他の内部処理に失敗した場合 | 内部エラー | まず現在のレベルまたは設定を読み取って結果を確認し、その後リトライを判断してください。継続的に失敗する場合は traceId を提供してください。 |