コンテンツにスキップ

【モバイル Synthetic テスト】ポイント選択テンプレートの削除



POST /api/v1/dialing_task/mobile/templates/{template_uuid}/delete

概要

現在のワークスペースにあるポイント選択テンプレートを 1 つ削除します。

呼び出し前の確認と使用手順

テンプレートスナップショットのみを削除し、Synthetic テスト、リモートノード、保存済みのポイント選択は削除しません。モバイル Synthetic テストのスイッチがオフでも削除できます。規約への再同意は不要です。対象テンプレートが実際に存在している必要があり、API は先に get で名前を読み取ってから削除します。存在しない場合に成功として無視する冪等な操作ではありません。同時削除ではパラメーターエラーが返される可能性があります。

成功後、タスクに既存の nodeSelection がある場合は元のスナップショットが維持され、新規作成フローではこの templateUUID を使用しなくなります。タイムアウトが発生した場合は、まずテンプレートがまだ存在するか確認してから、再試行するか判断してください。

パスパラメーター

パラメーター名 型 必須 説明
template_uuid string Y 削除対象テンプレートの UUID。タスク/ノード ID ではありません。
例: dsel_example
取得または入力方法: このワークスペースのテンプレート一覧から templateUUID を取得します。

リクエストヘッダー

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

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/dialing_task/mobile/templates/dsel_example/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>'

レスポンス

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

フィールド 型 説明
content boolean 削除成功時は true。
{
  "code": 200,
  "content": true,
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

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

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
400 ft.ParamsValidateError 識別子、ポイント選択の構造/範囲、名前、テンプレート数、またはプロトコルパラメーターが現在のコントラクトに適合しない パラメーター検証失敗: {} message と任意の content.reason/field に従って修正し、まずこのワークスペースの一覧から対象を再取得してください。
409 ft.MobileDialingOperationBusy ワークスペースの相互排他ロック待機がタイムアウトし、今回は実行されなかった 現在のワークスペースで別の操作が実行中のため、今回の操作は実行されませんでした。しばらくしてから再試行してください。 operationExecuted=false/retryable=true の場合はバックオフして再試行し、並行して上書きしないでください。
401 ft.WKSPNotExistOrReleased 待機後にワークスペースが存在しない/解放済み ワークスペースが存在しないか、解放されています 再試行を停止し、有効なワークスペースを確認してください。
403 ft.WorkspaceIsLocked 待機後にワークスペースがロック済み ワークスペースがロックされているため、操作できません ロック解除と操作可能な状態を確認してください。
406 ft.NotFoundWorkspace 削除のロック時にワークスペースが存在しない 指定されたワークスペースが見つかりません ワークスペースが有効であることを確認してください。
500 ft.InternalServerError ストレージ読み取り、履歴設定、またはローカル静的マッピングのフォーマット異常 内部エラー 具体的なタスク/テンプレートまたはフィルターに絞り込み、失敗が続く場合は traceId を保持し、読み取り段階を確認してください。

フィードバック

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