AssessmentCreation - グローバル

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間：6分

    • AssessmentCreation API は、アドミニストレーターがアセスメントとサーベイを生成するために使用できるメソッドを提供します。

    createAssessments() メソッドを呼び出す方法は複数あります。メトリクスタイプまたはサーベイ定義を識別するには、すべてのケースで typeID パラメーターを設定する必要があります。

    メソッドの動作に影響を与える要因には、次のようなものがあります。
    • ターゲットがアセスメントかサーベイか
    • アセスメントスケジュールタイプがオンデマンドかスケジュール済みか
    • サーベイのスケジュール期間
    • 指定されたパラメーター

    たとえば、 typeID パラメーターのみが設定された状態でメソッドが呼び出されると、招待状を送信するステークホルダーまたはサーベイユーザーが検索されます。対照的に、 typeID パラメーターと userID パラメーターを設定してメソッドが呼び出されると、指定されたユーザーに招待状を送信しようとします。

    AssessmentCreation - createAssessments (文字列 typeID、文字列 sourceRecordID、文字列 userID)

    指定されたメトリクスタイプまたはサーベイ定義に対して 1 つ以上のアセスメントまたはサーベイを作成します。

    表 : 1. パラメーター
    名前 タイプ 説明
    タイプ ID 文字列 アセスメントまたはサーベイを生成するメトリクスタイプまたはサーベイ定義のsys_id。
    ソースレコード ID 文字列 生成されたアセスメントに含める 1 つ以上のカンマ区切りサーベイ定義sys_ids。各ソースレコードには、指定されたメトリクスタイプに関連付けられたアセスメント可能なレコードが必要です。このパラメーターを空白のままにすると、生成されたアセスメントには、指定されたタイプのすべてのアセスメント可能なレコードが含まれます。このパラメーターは、アセスメントでのみ使用します。
    userID 文字列 アセスメントまたはサーベイインスタンスを送信する 1 つ以上のカンマ区切りのユーザー sys_ids。このパラメーターを空白のままにすると、アセスメントのステークホルダーまたはサーベイユーザーはインスタンスを受け取ります。このパラメーターはオンデマンドアセスメントに必要です。
    表 : 2. 返される内容
    タイプ 説明
    文字列 メソッドが成功した場合は、7a2ad2253784200044e0bfc8bcbe5de1, 10, b7e8b5d4c0a80169008b49e468920048 (インスタンス ID、インスタンス数、グループ ID) などのカンマ区切りの文字列を次の値とともに返します。
    • instanceID:作成されたアセスメントまたはサーベイインスタンスのSys_id (1 つしかない場合)。インスタンスが複数ある場合、いずれかのインスタンスをSys_idします。複数のインスタンスがある場合は、グループ ID を使用してデータを取得します。
    • #instances:作成されたアセスメントまたはサーベイのインスタンスの数。
    • groupID:作成されたアセスメントまたはサーベイインスタンスを含むアセスメントグループのSys_id。

    メソッドがアセスメントまたはサーベイを生成できない場合は、エラーコードのいずれかが返されます。

    エラーコード
    • isscheduled - userID または sourceRecordID パラメーターを使用しないことを示します。typeID値が [スケジュール タイプ] フィールドが [スケジュール済み] に設定されたメトリクスタイプを表す場合、typeID パラメーターのみを使用できます。
    • draft_state: typeID 値が公開されていないメトリクスタイプまたはサーベイ定義であることを示します。メトリクスタイプまたはサーベイ定義を公開します。
    • invalidtype: typeID 値に一致する既存のメトリクスタイプがないことを示します。
    • 非アクティブ: typeID 値がアクティブでないメトリクスタイプまたはサーベイ定義であることを示します。メトリクスタイプまたはサーベイ定義に移動し、[ アクティブ] チェックボックスをオンにします。
    • not_available: typeID 値がメトリクスタイプまたはサーベイ定義であり、メトリクスまたはサーベイの質問がないことを示します。メトリクスまたはサーベイの質問を少なくとも 1 つ追加してください。
    • notyet - userID 値内の少なくとも 1 人のユーザーに、指定されたサーベイ定義のサーベイインスタンスが割り当てられており、まだ有効期限が切れていないことを示します。エラーコードは有効期限を返します。
    • wip - userID 値の少なくとも 1 人のユーザーに、サーベイのサーベイインスタンスが既にアサインされていることを示します。
    • not_authorized: userID 値内の少なくとも 1 人のユーザーがサーベイに回答する権限がないことを示します。次のいずれかが正しいことを確認します。
      • 指定されたサーベイ定義のサーベイユーザーはいません。
      • userID 値内のすべてのユーザーは、指定されたサーベイ定義のサーベイユーザーとして保存されます。
    • 完了: typeID 値が [繰り返し期間] フィールドが [1 回のみ] に設定されたサーベイ定義であり、 userID 値内の少なくとも 1 人のユーザーがそのサーベイ定義のサーベイインスタンスを既に完了していることを示します。
    • nousers: userID パラメーターが使用されておらず、次のいずれかが true であることを示します。
      • 指定されたメトリクスタイプに関連付けられたステークホルダーがいません。userIDパラメーターを設定するか、少なくとも 1 人のステークホルダーを作成します。
      • 指定されたサーベイ定義に関連付けられたサーベイユーザーはいません。userIDパラメーターを設定するか、少なくとも 1 人のサーベイユーザーを作成します。
    • nosources: typeID 値が、[スケジュールタイプ] フィールドが [オンデマンド] に設定されたメトリクスタイプであり、 userID パラメーターも sourceRecordID パラメーターも使用されなかったことを示します。これらのパラメーターのうち少なくとも 1 つを設定してください。

    このコード例は、サービスポータルウィジェットでアセスメントのインスタンスを生成する方法を示しています。この例は、[スケジュールタイプ] が [オンデマンド] に設定されている場合には機能しません。

    (function() {
  var gdtSurvey = new GlideDateTime();
  if (gdtSurvey.getDayOfMonthUTC() == 23) {
    (new SNC.AssessmentCreation()).createAssessments('d902e09a075730101263f19d7c1ed03a', // Assessment metric type sys_id
      '4baec2fe07d3f0101263f19d7c1ed0a6', // Assessable record which is the source of the assessment
      gs.getUserID()); // Users ID to send the assessment instances to
  }
})();

    結果を返します:

    bbf0b9b8072330101263f19d7c1ed00b,1,33f0f978072330101263f19d7c1ed05f