返信 変更¶
POST /api/v1/issue/reply/{reply_uuid}/modify
概要¶
現在の API 呼び出し元の識別情報が作成した通常の返信を変更します。
呼び出し前の準備と使用手順¶
返信一覧から返信 uuid を選択し、同時にその issueUUID を送信します。サーバー側では、現在の呼び出し元の識別情報が返信の creator と一致することを要求します。API Key を変更すると作成者の条件を満たさなくなる可能性があります。content を省略すると元の値が保持され、extend は必ず送信する必要があり、オブジェクト単位で置き換えられます。保持し続ける必要がある情報は事前にコピーしてください。元の作成者の表示情報はサーバー側で保持されます。チャンネル参照は引き続き追加マージです。添付ファイルを新規追加する場合は、先にアップロードしてから attachmentUuids に渡してバインドします。省略または [] の場合、既存の添付ファイルは削除されません。無効または利用できなくなった添付ファイルは内部エラーを引き起こす可能性があるため、送信前に識別子が有効であることを確認してください。API の成功は通知の到達を意味しません。通知は非同期で実行され、受信者はチャンネルのサブスクリプション、通知先、通知ポリシー、担当者、および今回の @ メンバーによって決まります。コンソールで通知設定と実際の到達状況を確認してください。書き込みと後続の通知・添付ファイル処理は段階的に実行されます。失敗またはタイムアウトが発生した場合は、まずリソースが作成または更新済みかどうかを問い合わせてから再試行を判断し、記録や通知の重複を避けてください。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| reply_uuid | string | Y | 単一返信の UUID。Issue UUID は使用しないでください。 例: repim_example取得または入力方法: 返信一覧 の content.data[].uuid、または返信を作成 の content.uuid から取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| attachmentUuids[*] | json | アップロード済みの単一添付ファイル UUID。 例: att_example取得または入力方法: 添付ファイルをアップロード の content.attachmentUuid を取得します。 |
|
| extend.text | json | 省略可能なプレーンテキスト。サーバー側の長さチェックに使用し、最大 3000 文字です。 例: 本番インターフェースの遅延を特定。取得または入力方法: 説明のプレーンテキストから抽出し、3000 文字以内に収めます。省略した場合は空テキストとしてチェックされます。 |
|
| extend.channels | array | チャンネル参照の配列。バインド済みチャンネルを追加マージします。[] は既存のバインドをクリアしません。 例: [{"type": "#", "uuid": "chan_example", "name": "本番異常"}]取得または入力方法: チャンネル一覧 から実際のチャンネル UUID を取得し、説明内の # チャンネルを参照します。省略した場合は追加しません。 |
|
| extend.channels[*] | json | チャンネル参照オブジェクト。 例: {"type": "#", "uuid": "chan_example", "name": "本番異常"}取得または入力方法: 各項目に同一ワークスペースの実在するチャンネルを 1 つ指定します。 |
|
| extend.channels[*].uuid | json | チャンネル UUID。 例: chan_example取得または入力方法: チャンネル一覧 の content[].uuid から取得します。 |
|
| extend.channels[*].name | json | クライアント表示名。 例: 本番異常取得または入力方法: チャンネル一覧 から対応する name を取得して表示に使用します。省略可能です。 |
|
| extend.channels[*].type | json | チャンネル参照マーカー。 例: #取得または入力方法: チャンネル参照では固定で # を使用します。サーバーは読み取り結果にこのマーカーを補完します。 |
|
| extend.channels[*].exists | json | 省略可能な表示マーカー。サーバー側のリソース検証の代わりにはなりません。 例: true取得または入力方法: 有効性の証明として渡す必要はありません。問い合わせレスポンスでは現在のリソースの存在性に基づいて再計算されます。 |
|
| extend.members | array | 今回 @ するメンバー参照。1 回限りの通知メールアドレスの収集に使用し、担当者配列ではありません。 例: [{"type": "@", "uuid": "acnt_example", "name": "オンコールエンジニア"}]取得または入力方法: 対象ワークスペースのメンバー管理からアカウント UUID を取得します。省略した場合は今回の @ メンバーを追加しません。 |
|
| extend.members[*] | json | メンバー参照オブジェクト。 例: {"type": "@", "uuid": "acnt_example", "name": "オンコールエンジニア"}取得または入力方法: @ が必要なアカウントごとにオブジェクトを指定します。 |
|
| extend.members[*].uuid | json | メンバーアカウント UUID。 例: acnt_example取得または入力方法: 対象ワークスペースのメンバー管理から acnt_ アカウント UUID を取得します。 |
|
| extend.members[*].name | json | クライアント表示名。 例: オンコールエンジニア取得または入力方法: メンバーの表示名を使用します。省略可能です。 |
|
| extend.members[*].type | json | メンバー参照マーカー。 例: @取得または入力方法: メンバー参照には @ を使用します。 |
|
| extend.members[*].exists | json | 省略可能な表示マーカー。 例: true取得または入力方法: 有効性の証明として渡す必要はなく、問い合わせ時に再計算されます。 |
|
| extend.extra | json | 外部表示情報。API の実際の認証/作成者 ID を置き換えることはありません。 例: {}取得または入力方法: サードパーティ連携で外部の操作者を表示する必要がある場合に入力します。不要な場合は省略するか {} を指定します。 |
|
| extend.extra.creator | json | 作成者の表示オブジェクト。 例: {"name": "外部チケット作成者", "email": "xxx@guance.com"}取得または入力方法: 連携システムの作成者を使用します。変更時、元の creator は通常サーバー側で保持されます。 |
|
| extend.extra.creator.name | json | 表示名。省略可能です。 例: 外部チケット作成者取得または入力方法: 外部システムの表示名を使用します。 |
|
| extend.extra.creator.email | json | 表示メールアドレス。省略可能です。 例: xxx@guance.com取得または入力方法: 外部システムのメールアドレスを使用します。例は架空のアドレスです。 |
|
| extend.extra.updator | json | 更新者の表示オブジェクト。 例: {"name": "外部チケット更新者", "email": "xxx@guance.com"}取得または入力方法: 変更時は連携システムの今回の操作者情報を使用します。 |
|
| extend.extra.updator.name | json | 表示名。省略可能です。 例: 外部チケット更新者取得または入力方法: 外部システムの表示名を使用します。 |
|
| extend.extra.updator.email | json | 表示メールアドレス。省略可能です。 例: xxx@guance.com取得または入力方法: 外部システムのメールアドレスを使用します。 |
|
| attachmentUuids | array | 省略可能なアップロード済み添付ファイル UUID 配列。空でない場合、この返信にバインドまたは再バインドされます。省略または [] の場合、既存の添付ファイルは削除されません。 null 許可: True 例: []取得または入力方法: 先に添付ファイルをアップロード を呼び出して content.attachmentUuid を保存します。このワークスペースで実際にアップロードされ利用可能な添付ファイルのみ使用できます。省略または [] の場合は添付ファイルを追加しません。 |
|
| content | string | 省略可能な新しい返信内容。省略すると元の内容を保持します。空文字列を渡すと内容をクリアします。 空文字列許可: True null 許可: True 例: データベースのスロークエリを特定し、最適化を進めています。取得または入力方法: 対応の進捗を記入します。添付ファイルのみの返信では省略または空文字列を渡します。 |
|
| extend | json | Y | 必須の拡張オブジェクト。null を渡さないでください。渡したオブジェクトは保存済みの拡張内容を置き換えます。作成者の表示情報の一部はサーバー側で保持されます。 null 許可: True 例: {}取得または入力方法: 拡張内容がない場合は {} を渡します。変更前に元の値を読み取り、完全なオブジェクト内で変更が必要なフィールドを調整してください。 |
| issueUUID | string | Y | 返信が属する Issue UUID。必須です。 null 許可: False 例: issue_example取得または入力方法: Issue 一覧 または Issue 詳細 から uuid を取得します。 |
パラメータ補足説明¶
issueUUID は返信が属する Issue と一致している必要があります。外部の extend.extra.updator は表示のみを制御し、作成者の検証を回避することはできません。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/issue/reply/repim_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"issueUUID":"issue_example","content":"スロークエリの最適化が完了しました。引き続き監視します。","extend":{}}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer または null | レコード番号。Issue/返信の作成レスポンスでは、永続化前に構築される場合に null になることがあります。リソースの操作には uuid を使用してください。 |
| content.uuid | string | リソース UUID。 |
| content.workspaceUUID | string | 所属ワークスペース UUID。 |
| content.status | integer | レコードステータス。0 は正常、3 は削除済みです。Issue のビジネスステータス statusType とは区別されます。 |
| content.creator | string | 作成時の呼び出し元の識別情報。API Key の識別子、アカウント、またはシステム ID の場合があります。 |
| content.updator | string | 最近の更新元の識別情報。未設定の場合は空文字列です。 |
| content.createAt | integer | 作成日時(Unix 秒)。 |
| content.updateAt | integer | 最終更新日時(Unix 秒)。未更新の場合は -1 になることがあります。 |
| content.deleteAt | integer | 削除日時(Unix 秒)。未削除の場合は -1 です。 |
| content.issueUUID | string | 所属 Issue UUID。 |
| content.content | string または null | 返信または操作記録の内容。 |
| content.type | string | reply は通常の返信、change は操作記録、eventReply は関連イベントへの返信、autoDiscoveryReply は自動検出の返信です。 |
| content.extend | object | 拡張内容。リクエストでは null ではなくオブジェクト {} を渡してください。メンバー、チャンネル、担当者などの構造はパラメータ表を参照してください。 |
| content.extend.text | string | 長さチェックに使用するプレーンテキスト。最大 3000 文字です。 |
| content.extend.channels | array<object> |
説明内で参照されたチャンネル。uuid、name、type、exists を含みます。返却時、exists は現在のリソースの存在性に基づいて更新されます。 |
| content.extend.channels[].uuid | string | チャンネル UUID。 |
| content.extend.channels[].name | string または null | 表示名。 |
| content.extend.channels[].type | string | チャンネル参照マーカー #。 |
| content.extend.channels[].exists | boolean | 返却時にそのチャンネルが存在するかどうか。 |
| content.extend.members | array<object> |
説明内で @ されたメンバー参照。uuid、name、type、exists を含みます。 |
| content.extend.members[].uuid | string | メンバーアカウント UUID。 |
| content.extend.members[].name | string または null | 表示名。 |
| content.extend.members[].type | string | メンバー参照マーカー @。 |
| content.extend.members[].exists | boolean | 返却時にそのアカウントが存在するかどうか。 |
| content.extend.extra | object | サードパーティ連携の表示情報。API の実際の認証 ID は変更されません。 |
| content.extend.extra.creator | object | サードパーティの作成者表示情報。name、email を含めることができます。 |
| content.extend.extra.creator.name | string | 作成者の表示名。 |
| content.extend.extra.creator.email | string | 作成者の表示メールアドレス。 |
| content.extend.extra.updator | object | サードパーティの更新者表示情報。name、email を含めることができます。 |
| content.extend.extra.updator.name | string | 更新者の表示名。 |
| content.extend.extra.updator.email | string | 更新者の表示メールアドレス。 |
| content.extend.extra.managerInfos | object | 担当者メールアドレスをキーとする表示情報のマップ。Issue のみで使用します。 |
| content.extend.extra.managerInfos.邮箱.name | string | 対応するメールアドレスの担当者の表示名。 |
| content.extend.其他字段 | JSON | クライアントが保存したその他の拡張情報。すべてがビジネス動作をトリガーするわけではありません。 |
| content.declaration | object または null | ワークスペースの共通宣言。content のこの階層にのみ付加されます。 |
{
"code": 200,
"content": {
"id": 301,
"uuid": "repim_example",
"workspaceUUID": "wksp_example",
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785430800,
"updateAt": 1785430860,
"deleteAt": -1,
"issueUUID": "issue_example",
"content": "スロークエリの最適化が完了しました。引き続き監視します。",
"type": "reply",
"extend": {},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対応方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータの解析に失敗 | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトでない | 一部の json ファイルの形式エラー | JSON オブジェクトを送信してください。 |
| 404 | ft.ObjectNotExists | 指定したリソースが現在のワークスペースに存在しない、または問い合わせ条件を満たさない | 指定されたオブジェクトが存在しません | 同一ワークスペースのリソース UUID を再取得し、削除されていないか確認してください。 |
| 400 | ft.IssueReplyNotModify | 現在の呼び出し元の識別情報がその返信の作成者でない | この返信の作成者ではないため、編集は許可されていません | 返信作成時と同じ呼び出し元の識別情報を使用するか、権限を持つ操作者が業務フローに従って処理してください。 |
| 406 | ft.ExceedMaxLengthLimit | extend.text の長さが 3000 文字を超えている | テキストの最大長制限を超えています | プレーンテキストのフィールドを短くしてください。長い診断資料は添付ファイルとしてアップロードしてください。 |
| 500 | ft.InternalServerError | レベルや設定の保存、監査、その他の内部処理に失敗 | 内部エラー | まず現在のレベルまたは設定を読み取って結果を確認してから再試行を判断してください。失敗が続く場合は traceId を提供してください。 |