コメント一覧¶
GET /api/v1/error_track/comment/{issue_id}/list
概要¶
エラーコメント、システムコメント、および添付ファイルの概要をページングして読み取ります。
呼び出し前の準備と使用手順¶
現在の Key には errorCenter.errorTrackQuery が必要で、現在のワークスペースのみが対象です。パスには実際のテレメトリ issue_id を指定します。親エラーの存在は事前に強制検証されません。[] はレコードなしを表す場合があり、これだけではテレメトリやメタデータが存在しないと判断できません。
createAt の降順で、デフォルトは 1 ページ 10 件です。同じ秒のレコードには安定した二次ソートがありません。アクティブなコメントには、手動コメントとシステムのステータス/担当者変更コメントが含まれます。creatorInfo/updatorInfo は実際の主体から取得され、extend から表示アイデンティティを偽装しません。添付ファイルには uuid/fileName/fileSuffix のみが含まれます。
content は {data,declaration} オブジェクトを維持し、pageInfo はレスポンスのトップレベルにあります。data の各項目には共通宣言が自動追加されません。この読み取りはコメントを書き込まず、添付ファイルを紐付けず、通知も送信しません。履歴の extend=null/構造破損は 500 を引き起こす可能性があるため、traceId を保持して履歴レコードを確認してください。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| issue_id | string | Y | エラー集約の業務識別子。そのまま渡します。refData.uuid(isset_)やコメント UUID ではありません。パスは URL エンコードで処理されます。詳細インターフェースでテレメトリの存在を検証しないでください。 null を許可: False 例: err_payment_timeout取得または入力方法: エラー追跡リスト から content.data[].issue_id を取得するか、現在のワークスペースのエラーセンターにあるテレメトリレコードの issue_id を使用します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| pageIndex | integer | 省略可能な整数。省略時は 1 です。現在のこれらの ErrorTrack 入口では正数/最大値の制限が宣言されていないため、クライアントは正の整数のみを使用してください。 null を許可: False 例: 1取得または入力方法: 呼び出し元がページングを制御し、1 から開始します。 |
|
| pageSize | integer | 省略可能な整数。省略時は 10 です。宣言では上限が設けられていないため、小さなページサイズでの読み取りを推奨します。0 や負数を渡して実装の動作に依存しないでください。 null を許可: False 例: 10取得または入力方法: 呼び出し元が表示/バッチ処理の規模に応じて選択します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/error_track/comment/err_payment_timeout/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=10
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | ページングされたコンテンツオブジェクト。 |
| content.data | array<object> |
このページのレコード。一致しない場合は []。 |
| content.data[].id | integer または null | データベースの行 ID。パスの特定には使用しません。送信前のスナップショットでは null になる場合があります。 |
| content.data[].uuid | string | ローカルリソースの UUID。詳細メタデータは isset_、操作レコードは issetoper_、コメントは issetcomment_ です。 |
| content.data[].status | integer | リソースステータス。通常は 0 で、ソフト削除の 3 はクエリから除外されます。 |
| content.data[].creator | string | 作成主体。自動初期化メタデータは sys、Key 書き込み主体は wsak_ です。 |
| content.data[].updator | string | 最終更新主体。更新されていない場合は空になることがあります。 |
| content.data[].createAt | integer | Unix 秒の作成時間。 |
| content.data[].updateAt | integer | Unix 秒の更新時間。未更新の場合は -1 になることがあります。同じ値へのステータス/担当者更新では、必ずしも更新されない場合があります。 |
| content.data[].deleteAt | integer | Unix 秒の削除時間。削除されていない場合は通常 -1 です。 |
| content.data[].workspaceUUID | string | 現在の Key が属するワークスペース。 |
| content.data[].issueUUID | string | ローカルメタデータの isset_ UUID。パスの issue_id としては使用できません。 |
| content.data[].issueID | string | テレメトリ issue_id の業務識別子。 |
| content.data[].comment | string | コメント本文、またはローカライズされたシステム変更文。 |
| content.data[].extend | object または null | システム操作の拡張、または通常コメントの業務拡張。履歴の異常値は読み取り時の 500 を引き起こす可能性があります。 |
| content.data[].extend.operate_type | string | システム操作タイプ: assigner_update または status_update。通常のコメントでは存在しない場合があります。 |
| content.data[].extend.operator | string | システム操作主体の UUID。 |
| content.data[].extend.before | string または array<string> |
status_update では旧ステータスの文字列、assigner_update では旧担当者の配列です。 |
| content.data[].extend.after | string または array<string> |
status_update では新ステータスの文字列、assigner_update では新担当者の配列です。 |
| content.data[].extend.operator_info | object | 省略可能な操作主体の概要。一致しない場合は {}。 |
| content.data[].extend.before_info | array<object> |
assigner_update の旧担当者の解決可能な概要。チームは uuid/name のみです。 |
| content.data[].extend.after_info | array<object> |
assigner_update の新担当者の解決可能な概要。 |
| content.data[].extend.operator_info.uuid | string | 主体 UUID。アカウント、Key、またはシステム識別子の場合があります。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.operator_info.status | integer | 主体ステータス。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.operator_info.wsAccountStatus | integer | 現在のワークスペースにおけるメンバー関係ステータスの概要。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.operator_info.username | string | ログイン名または Key 名。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.operator_info.name | string | 表示名。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.operator_info.iconUrl | string | アバター URL。空の場合があります。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.operator_info.email | string | メールアドレス。Key 主体は自身の UUID になる場合があり、配信可能であることは保証されません。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.operator_info.mobile | string | 携帯電話番号。空の場合があります。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.operator_info.countryCode | string | 電話の国番号。空の場合があります。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.operator_info.acntWsNickname | string | 現在のワークスペースでのニックネーム。空の場合があります。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.before_info[].uuid | string | 主体 UUID。アカウント、Key、またはシステム識別子の場合があります。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.before_info[].status | integer | 主体ステータス。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.before_info[].wsAccountStatus | integer | 現在のワークスペースにおけるメンバー関係ステータスの概要。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.before_info[].username | string | ログイン名または Key 名。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.before_info[].name | string | 表示名。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.before_info[].iconUrl | string | アバター URL。空の場合があります。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.before_info[].email | string | メールアドレス。Key 主体は自身の UUID になる場合があり、配信可能であることは保証されません。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.before_info[].mobile | string | 携帯電話番号。空の場合があります。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.before_info[].countryCode | string | 電話の国番号。空の場合があります。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.before_info[].acntWsNickname | string | 現在のワークスペースでのニックネーム。空の場合があります。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.after_info[].uuid | string | 主体 UUID。アカウント、Key、またはシステム識別子の場合があります。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.after_info[].status | integer | 主体ステータス。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.after_info[].wsAccountStatus | integer | 現在のワークスペースにおけるメンバー関係ステータスの概要。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.after_info[].username | string | ログイン名または Key 名。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.after_info[].name | string | 表示名。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.after_info[].iconUrl | string | アバター URL。空の場合があります。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.after_info[].email | string | メールアドレス。Key 主体は自身の UUID になる場合があり、配信可能であることは保証されません。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.after_info[].mobile | string | 携帯電話番号。空の場合があります。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.after_info[].countryCode | string | 電話の国番号。空の場合があります。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.after_info[].acntWsNickname | string | 現在のワークスペースでのニックネーム。空の場合があります。アカウントのフィールドは省略可能で、チームは uuid/name のみです。 |
| content.data[].extend.members | array<object> |
今回の編集で @ 対象となる省略可能なリスト。常にオブジェクト配列であることを推奨します。 |
| content.data[].extend.members[].uuid | string | @ 対象主体の UUID。現在のワークスペースのメンバー/チームリストから有効な acnt_/group_ を取得することを推奨します。 |
| content.data[].extend.members[].type | string | 値が @ で uuid が空でない項目のみが通知対象になります。 |
| content.data[].extend.自定义键 | JSON | 呼び出し元が保存するその他の JSON 拡張。固定の実行セマンティクスはありません。 |
| content.data[].attachments | array<object> |
このコメントに紐付けられた有効な添付ファイルの概要。ダウンロード URL/ファイル内容は含みません。添付ファイルがない場合は [] です。 |
| content.data[].attachments[].uuid | string | 添付ファイル UUID。権限付きの添付ファイル読み取り/管理に使用します。 |
| content.data[].attachments[].fileName | string | ファイル名。 |
| content.data[].attachments[].fileSuffix | string | 最後のドット以降の拡張子。ドットがない場合は名称全体になることがあります。 |
| content.data[].creatorInfo | object | 主体の概要。一致しない場合は {}。システム主体ではフィールドが少ない場合があります。 |
| content.data[].creatorInfo.uuid | string | 主体 UUID。アカウント、Key、またはシステム識別子の場合があります。 |
| content.data[].creatorInfo.status | integer | 主体ステータス。 |
| content.data[].creatorInfo.wsAccountStatus | integer | 現在のワークスペースにおけるメンバー関係ステータスの概要。 |
| content.data[].creatorInfo.username | string | ログイン名または Key 名。 |
| content.data[].creatorInfo.name | string | 表示名。 |
| content.data[].creatorInfo.iconUrl | string | アバター URL。空の場合があります。 |
| content.data[].creatorInfo.email | string | メールアドレス。Key 主体は自身の UUID になる場合があり、配信可能であることは保証されません。 |
| content.data[].creatorInfo.mobile | string | 携帯電話番号。空の場合があります。 |
| content.data[].creatorInfo.countryCode | string | 電話の国番号。空の場合があります。 |
| content.data[].creatorInfo.acntWsNickname | string | 現在のワークスペースでのニックネーム。空の場合があります。 |
| content.data[].updatorInfo | object | 主体の概要。一致しない場合は {}。システム主体ではフィールドが少ない場合があります。 |
| content.data[].updatorInfo.uuid | string | 主体 UUID。アカウント、Key、またはシステム識別子の場合があります。 |
| content.data[].updatorInfo.status | integer | 主体ステータス。 |
| content.data[].updatorInfo.wsAccountStatus | integer | 現在のワークスペースにおけるメンバー関係ステータスの概要。 |
| content.data[].updatorInfo.username | string | ログイン名または Key 名。 |
| content.data[].updatorInfo.name | string | 表示名。 |
| content.data[].updatorInfo.iconUrl | string | アバター URL。空の場合があります。 |
| content.data[].updatorInfo.email | string | メールアドレス。Key 主体は自身の UUID になる場合があり、配信可能であることは保証されません。 |
| content.data[].updatorInfo.mobile | string | 携帯電話番号。空の場合があります。 |
| content.data[].updatorInfo.countryCode | string | 電話の国番号。空の場合があります。 |
| content.data[].updatorInfo.acntWsNickname | string | 現在のワークスペースでのニックネーム。空の場合があります。 |
| pageInfo | object | ページングのメタ情報。OpenAPI ではトップレベルにあり、content はオブジェクトを維持します。 |
| pageInfo.count | integer | このページの実際の件数。 |
| pageInfo.totalCount | integer | フィルター条件を満たす候補/ローカルレコードの総数。テレメトリリストは候補上限 10000 の影響を受けます。 |
| pageInfo.pageIndex | integer | ページ番号。1 から開始します。 |
| pageInfo.pageSize | integer | 今回の 1 ページあたりのリクエスト件数。 |
| content.declaration | object または null | 現在のワークスペースの共通宣言。content の親オブジェクトにのみ追加され、data の各項目には再帰的に追加されません。 |
{
"code": 200,
"content": {
"data": [
{
"id": 7,
"uuid": "issetcomment_example",
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"workspaceUUID": "wksp_example",
"issueUUID": "isset_example",
"issueID": "err_payment_timeout",
"comment": "タイムアウトの原因を特定しました。対応中です。",
"extend": {
"members": [
{
"uuid": "acnt_example",
"type": "@"
}
]
},
"attachments": [],
"creatorInfo": {},
"updatorInfo": {}
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"count": 1,
"totalCount": 1,
"pageIndex": 1,
"pageSize": 10
}
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータを使用した、またはパラメータがルールに違反している | パラメータ解析失敗 | Query パラメータ表と例を確認してください。 |
| 500 | ft.InternalServerError | データベース読み取り、履歴 JSON 構造、または関連概要の構築で未処理の例外が発生した | 内部エラー | traceId を保持してバックオフしてください。継続的に失敗する場合は、管理者に関連する履歴レコードと設定の確認を依頼してください。 |