コンテンツにスキップ

変更



POST /api/v1/channel/{channel_uuid}/modify

概要

指定したチャンネルの名前、説明、通知先、またはエスカレーション設定を部分的に更新します。

呼び出し前の準備と使用手順

まずチャンネル簡易リストから対象の UUID と現在の設定をコピーします。省略したフィールドは現在の値が保持され、通知配列またはエスカレーションオブジェクトを渡すと、対応するフィールドが全体として置き換えられます。デフォルトチャンネルは元の名前を保持しますが、説明と通知設定は変更できます。エスカレーション通知を無効化する場合は、triggerTime=0、notifyTarget=[] を送信してください。サブフィールドが欠けた空のオブジェクトは使用しないでください。チャンネルとエスカレーショントリガー設定は段階的に保存されます。タイムアウトまたはエラーが発生した場合は、まずチャンネルの状態を確認してから再試行するフィールドを判断し、重複作成を避けてください。エスカレーション通知は、ルールの有効化または更新後に新規作成され、まだ完了しておらず担当者のいない Issue を対象とします。triggerTime を超過した後は定期タスクによってチェックされるため、正確なカウントダウンではありません。現在のタスクは、ワークスペース内で有効な担当者なしエスカレーション通知ポリシーにも依存します。メッセージを受信できない場合は、通知ポリシー、通知先、およびサイトのタスクスイッチを確認してください。

ルートパラメータ

パラメータ名 型 必須 説明
channel_uuid string Y 現在のワークスペースのチャンネル UUID。
例: chan_example
取得・入力方法: チャンネル簡易リストの content[].uuid から取得します。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得・入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Body リクエストパラメータ

パラメータ名 型 必須 説明
notifyTarget[*] string 単一の通知先 UUID。
例: notify_example
取得・入力方法: 通知先リストで同一ワークスペース内に設定済みの通知先を検索し、content.data[].uuid を取得します。
notifyUpgradeCfg.notifyTarget[*] string 単一のエスカレーション通知先 UUID。
例: notify_example
取得・入力方法: 通知先リストで同一ワークスペース内に設定済みの通知先を検索し、content.data[].uuid を取得します。
description string チャンネルの説明。最大 256 文字。
空文字列を許可: True
null を許可: False
最大長: 256
例: 生产异常协作频道
取得・入力方法: チャンネルの用途に応じて入力します。空文字列を渡すとクリアできます。
name string チャンネル名。最大 256 文字。
null を許可: False
最大長: 256
例: 生产异常
取得・入力方法: チャンネル簡易リストで既存の名前を確認し、このワークスペース内で未使用の名前を選択します。
notifyTarget array 通知先 UUID の完全な配列。[] を渡すと設定をクリアします。
null を許可: False
例: ["notify_example"]
取得・入力方法: 通知先リストで同一ワークスペース内に設定済みの通知先を検索し、content.data[].uuid を取得します。
notifyUpgradeCfg json エスカレーション通知の完全な設定。このオブジェクトを渡す場合は、triggerTime と notifyTarget を同時に指定する必要があります。
null を許可: False
例: {"triggerTime": 300, "notifyTarget": ["notify_example"]}
取得・入力方法: 業務の待機時間に応じて秒数を選択し、実際の通知先 UUID を使用します。
notifyUpgradeCfg.notifyTarget array 条件必須 エスカレーション通知先 UUID の完全なリスト。triggerTime=0 と組み合わせて無効化に使用します。
null を許可: False
例: ["notify_example"]
取得・入力方法: 通知先リストで同一ワークスペース内に設定済みの通知先を検索し、content.data[].uuid を取得します。
notifyUpgradeCfg.triggerTime integer 条件必須 エスカレーション通知を待機する秒数。非ゼロの場合は、ルールを有効にするために少なくとも 1 つの通知先も必要です。
null を許可: False
例: 300
取得・入力方法: 正の整数の秒数を入力します。例えば 300 は 5 分間の待機を意味します。無効化する場合は空の notifyTarget 配列とともに 0 を渡します。

パラメータ補足

通知先リストとエスカレーション設定は同時に送信する必要はありません。説明のみを変更する場合は、残りの 2 つのフィールドを省略できます。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/channel/chan_example/modify' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"description":"生产异常处理与升级协作"}'

レスポンス

HTTP 200、application/json。以下の例は、そのまま読み取れる主要フィールドを示しています。

フィールド 型 説明
content.id integer データベースのレコード番号。チャンネルの操作には uuid を使用してください。
content.uuid string チャンネル UUID。変更、削除、または購読に使用します。
content.workspaceUUID string チャンネルが属するワークスペース。
content.name string チャンネル名。default はデフォルトチャンネルを表します。
content.description string チャンネルの説明。
content.notifyTarget array<string> このチャンネルに直接設定された通知先 UUID。
content.notifyTarget[] string 単一の通知先 UUID。
content.notifyUpgradeCfg object エスカレーション通知設定。未設定の場合は空のオブジェクトです。
content.notifyUpgradeCfg.triggerTime integer エスカレーション通知をトリガーするまでの待機時間(秒)。
content.notifyUpgradeCfg.notifyTarget array<string> エスカレーション通知先 UUID のリスト。
content.notifyUpgradeCfg.notifyTarget[] string エスカレーション通知先 UUID。
content.status integer レコードステータス。正常時は 0 です。
content.creator string 作成した呼び出し元の識別情報。
content.updator string 最終更新者の識別情報。未更新の場合は空文字列になることがあります。
content.createAt integer 作成日時(Unix 秒)。
content.updateAt integer 更新日時(Unix 秒)。未更新の場合は -1 です。
content.deleteAt integer 削除日時(Unix 秒)。未削除の場合は -1 です。
content.declaration object または null ワークスペースの共通宣言。
{
  "code": 200,
  "content": {
    "id": 42,
    "uuid": "chan_example",
    "workspaceUUID": "wksp_example",
    "name": "生产异常",
    "description": "生产异常处理与升级协作",
    "notifyTarget": [
      "notify_example"
    ],
    "notifyUpgradeCfg": {
      "triggerTime": 300,
      "notifyTarget": [
        "notify_example"
      ]
    },
    "status": 0,
    "creator": "wsak_example",
    "updator": "wsak_example",
    "createAt": 1785427200,
    "updateAt": 1785427260,
    "deleteAt": -1,
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラー応答

認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたは応答の説明 対処方法
406 ft.ParameterValidationFailed フィールドの型、長さ、列挙、またはフィールド名が宣言に違反している パラメータの解析に失敗しました パラメータ表に従ってリクエストを確認してください。エスカレーション設定では 2 つのサブフィールドを指定してください。
400 ft.RequestJsonFormatError リクエスト JSON の構文が無効 リクエスト JSON の形式エラー content.reason、line、column に従って JSON を修正してください。
400 ft.JsonFormatError JSON のトップレベルがオブジェクトでない 一部の json ファイルの形式エラー 単一の JSON オブジェクトを渡してください。
404 ft.NotFoundChannel 対象のチャンネルが存在しない、削除済み、または現在のワークスペースに属していない 指定されたチャンネルが見つかりません チャンネル簡易リストで有効な UUID を再取得してください。
400 ft.ChannelNameRepeat 対象の名前が他の有効なチャンネルで使用されている チャンネル名が重複しています このワークスペース内で未使用のチャンネル名を選択してください。

フィードバック

このページは役に立ちましたか?