自己修復 API

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む7読むのに数分

    • Next Experience の問題を作成または管理するためのエンドポイントを提供します。

    自己修正 API は、カスタムの Scripted REST API として利用できます。この API には、自己修正フレームワーク (self-remediation-framework) プラグインと sn_srf.experience_issue_create ロールが必要です。

    DEX/DEM プロバイダーは、ユーザーのエンドポイントで問題を検出すると、自己修正 API を使用してエクスペリエンスの問題を作成できます。作成されたエクスペリエンスの問題は、ユーザーとのエンゲージメントを促進し、ユーザーが問題を自己解決するのに役立ちます。自己修正 API は、内部または外部の DEM/DEX プロバイダーで使用できます。

    この API を使用するには、次のテーブルにレコードが設定されていることを確認してください。

    • sn_srf_issue_registry_template
    • sn_srf_issue_registry
    • sn_srf_resolution
    • sn_srf_notification_content
    • sn_srf_provider

    自己修正 - CREATE /sn_srf/self_remediation/experience_issue/create

    DEM/DEX プロバイダーがユーザーのエンドポイントで問題を検出したときに、プロバイダーがエクスペリエンスの問題を作成できるようにします。

    URL 形式

    デフォルトの URL:/ api/sn_srf/self_remediation/experience_issue/create

    サポートされている要求パラメーター

    表 : 1. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 2. クエリパラメーター
    名前 説明
    なし
    表 : 3. 要求本文パラメーター (XML または JSON)
    名前 説明
    endpoint 必須です。オブジェクトは endpoint 、ユーザーおよび構成アイテム (CI) 情報を検出するキーを使用して、エクスペリエンスの問題の詳細を指定します。フレームワークがユーザーを識別できるようにするために、少なくとも 1 つのキーを渡します。無効なキーはエラーを返します。

    データタイプ: オブジェクト

    
--data “{
  "endpoint": {
    "CI": "String",
    "user_id": "String",
    "user_name": "String",
    "email": "String"
  },
    endpoint.user_id オプション。問題が検出されたユーザーのSys_id。

    データタイプ：文字列
    endpoint.user_name オプション。問題が検出されたユーザーのユーザー名。

    データタイプ：文字列
    endpoint.email オプション。問題が検出されたユーザーのメール。

    データタイプ：文字列
    endpoint.CI オプション。問題が検出された CI (デバイス) のSys_id。

    データタイプ：文字列
    issue_code 必須です。発生した問題を一意に識別します。問題コードが利用可能であり、顧客のインスタンスに展開されている必要があります。空または無効な問題が提供された場合、パラメーターはエラーを返します。

    データタイプ：文字列
    プロバイダー 必須です。プロバイダーの一意のコード。このコードは、顧客のインスタンスと一致するsn_srf_provider必要がありますprovider_code。

    データタイプ：文字列
    input_parameters オプション。送信された入力パラメーターは、設定された解決 (サブフロー、フローアクション、CI アクションなど) に渡されます。

    データタイプ: オブジェクト

    "input_parameters": {
    "process_id": "Number"
  }
    investigative_details オプション。電力使用効率 (PUE) の解決が失敗した場合に手動調査に役立つ可能性がある詳細を指定します。調査の詳細は、PUE 解決が失敗した場合のフォールバックとして作成されるインシデントにコピーされます。

    データタイプ: オブジェクト

    "investigative_details": {
    "cpu usage": "String",
    "processes running": "String",
    "available memory": "String"
  }
    experience_id オプション。 プロバイダーが (sys_idではなく) 特定のexperience_idでエクスペリエンスの問題を作成する場合は、要求で送信します。これは、エクスペリエンスの問題チェーニングケースをさらに追跡するために使用できます。

    データタイプ：数値

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 4. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 5. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    ステータスコード 説明
    200 エクスペリエンスの問題が正常に作成されました。experience_Idを返します。
    400 無効な要求です。エンドポイントの詳細を指定してください。

    空の endpoint オブジェクトが要求で送信されました。
    400 無効な問題コード。有効な問題コードを入力してください。

    要求で空 issue_code が送信されます。
    400 無効なプロバイダーです。有効なプロバイダーを指定してください。

    空のプロバイダーが要求で送信されます。
    400 無効な問題コードまたはプロバイダー。有効な詳細を入力してください。

    顧客インスタンスで問題を検出できません。provider詳細を確認しますissue_code。
    400 問題コードに適切な解決策がありません。

    特定された問題に対して、PUE フレームワークで有効な解決策が構成されていません。
    400 エンドポイントの詳細からユーザーを解決できませんでした。有効な詳細を入力してください。

    このエラーは、PUE フレームワーク ID が指定されたエンドポイントの詳細からユーザーを識別できない場合に返されます。
    400 指定されたユーザーの指定された問題コードでエクスペリエンスの問題を解決しています。

    指定されたエクスペリエンスの問題は、現在進行中またはオープンステータスです。
    400 指定された experience_id 既存のエクスペリエンスの問題はまだ実行中であるか、クローズされています。

    このエラーは、エクスペリエンスの問題がチェーン シナリオにある場合 (たとえば、既存のexperience_idキーと共に新しいissue_codeキーが送信され、以前のエクスペリエンスの問題がまだ実行中またはクローズ済み状態の場合) に発生します。

    以前のexperience_idで新しいissue_codeを送信するにはaction_waitこのexperience_idのエクスペリエンスの問題が状態である必要があります。
    400 エクスペリエンスの問題の作成中にエラーが発生しました。

    これは技術的なエラーを示しています。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    experienceId 作成されたエクスペリエンスの問題のエクスペリエンス ID 番号。

    cURL 要求

    次の例では、ユーザー Abel Tuter のエクスペリエンスの問題を作成します。

    curl  "http://instance.servicenow.com//api/sn_srf/self_remediation/experience_issue/create" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'
--data “{
  "endpoint": {
    "CI": "d049b28e936aa1106f98f6db5cba10d5",
    "user_id": "62826bf03710200044e0bfc8bcbe5df1",
    "user_name": "abel.tuter",
    "email": ""
  },
  "issue_code": "100",
  "provider": "sn",
  "experience_id": "09ed4830f393739df33",
  "input_parameters": {
    "process_id": "10644"
  },
  "investigative_details": {
    "cpu usage": "78%",
    "processes running": "35",
    "available memory": "23%"
  }
}”\

    応答本文は、問題の作成が成功したことを示すエクスペリエンス ID を返します。

    { 
  "result": { 
    "experience_id": “xxxxxxxxxxxxxx”
  } 
}