アクションパラメーター

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:3分
  • アクションパラメーターは、JSON オブジェクトパラメーターが HTTP GET または POST 要求の一部である場合に実行するアクションを指定するため、データパラメーターから分離され、異なるものになっています。

    パラメーターは、提供された JSON オブジェクトのフィールドとして指定することもできます。sysparm_action の場合はアクションをトリガーし、sysparm_query の場合は更新またはクエリの結果をフィルタリングする効果があります。

    sysparm_action

    sysparm_action の有効な値と、API によってトリガーされる対応するアクションは次のとおりです。
    表 : 1. データ検索
    メソッドの概要 説明
    getKeys エンコードされたクエリ文字列を使用してターゲットテーブルをクエリし、カンマ区切りの sys_id 値のリストを返します。
    getRecords エンコードされたクエリ文字列を使用してターゲットテーブルをクエリし、一致するすべてのレコードとそのフィールドを返します。
    get sysparm_sys_id URL パラメーターで sys_id を指定してターゲットテーブルの単一のレコードをクエリし、レコードとそのフィールドを返します。
    表 : 2. データ変更
    メソッドの概要 説明
    insert URL でターゲットとなるテーブルの 1 つ以上の新規レコードを作成します。
    insertMultiple URL でターゲットとなるテーブルに複数の新規レコードを作成します。
    update URL 内のターゲットテーブルの、エンコードされたクエリ文字列でフィルタリングされた既存のレコードを更新します。
    deleteRecord sysparm_sys_id URL パラメーターで sys_id を指定して、URL でターゲットとなるテーブルからレコードを削除します。
    deleteMultiple URL でターゲットとなるテーブルから、エンコードされたクエリ文字列でフィルタリングされた複数のレコードを削除します。

    sysparm_query

    get、getRecords、update、または deleteMultiplesysparm_action 値で使用するエンコードされたクエリ文字列を指定します。

    sysparm_view

    get および getRecords 関数呼び出しの戻り値をカスタマイズするためのフォームビューを指定します。ビューを使用すると、クエリは、ビューで定義されたフィールドのみを参照値を含めて返します。ビュー名がない場合、またはビュー名が有効でない場合、クエリはディクショナリーでアクティブとマークされているすべてのフィールド名を返します。

    sysparm_sys_id

    get または delete 関数の呼び出し時にターゲットの sys_id を指定します (sysparm_action の値)。

    sysparm_record_count

    この要求に対して取得されるレコードの数を制限する整数値を指定します。この値は glide.processor.json.row_limit システムプロパティによって制限されることに注意してください。

    displayvalue

    レコードに参照フィールドがある場合は、その表示値を取得します。たとえば、インシデントレコードには、ユーザーレコードへの参照である assigned_to フィールドを含めることができます。ユーザーレコードの sys_id を送信する代わりに、ユーザー名が送信されます。

    displayvalue パラメーターには、truefalse、または all の 3 種類の値を指定できます。
    • true:すべての参照フィールドに sys_id ではなく表示値が表示されます。
    • false (デフォルト):すべての参照フィールドに sys_id が表示されます。
    • all:表示値と sys_id が表示されます。たとえば、インシデントレコードの assignedto フィールドは、assigned_to:1234556、dv_assigned_to:Fred Luddy として返されます。

    displayvariables

    このレコードに添付されているすべての変数を取得するには、get または getRecords 関数の呼び出し時にこのブール値を true に設定します。