api - UI Builder

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：41分

    • api API は、UI Builder でクライアントスクリプトを開発するときに使用できるメソッドを提供します。

    この API は、クライアントスクリプト (ページスクリプトとも呼ばれます) に公開されます。クライアントスクリプトは、次のようにページ上で起こるものに応答して実行されます。
    • ボタンのクリックなどのユーザーインタラクションイベント/アクション。
    • データブローカーの実行の開始などのライフサイクルイベント。
    これらのスクリプトは、フレームワークに何も返す必要がなく、非同期の機能として記述することができます。
    この API は、スクリプトのプロパティ値にも公開されます。これらのスクリプトは、次のようにフレームワークランタイムで値を計算する必要があるときは常に実行されます。
    • コンポーネントプロパティに渡す。
    • コンポーネントの可視化を決定する。
    • ペイロードを持つイベントを発行する。
    これらのスクリプトを非同期の機能として記述することはできません。また、api.emit()、api.setState()、api.data.<data_resource_id>.*() など、api オブジェクトの副作用メソッドを呼び出すこともできません 。

    api オブジェクトには、関連ページまたはコンポーネントのコンテキスト内でアクセスできる構成依存プロパティと構成非依存プロパティの両方が含まれます。このオブジェクト内のプロパティを直接変更することはできません。変更は、利用可能なメソッドを介してのみ行うことができます。

    api - api.context.props.<page_property_name>

    ページのプロパティは UI ビルダー 内で構成できます。構成値は、ページが使用されるコンテキストによって異なります。

    表 : 1. フィールド
    名前 タイプ 説明
    <page_property_name> 任意 使用可能な値は、クライアントスクリプトの実装によって異なります。

    これらのプロパティにアクセスするには、api.context.props.<page_property_name> を使用します。

    例： 
    // A record page with property table could be accessed with
function isActivityStreamVisible({api}) {
  return api.context.props.table === 'incident';
}
    注:
    これらのプロパティ値は読み取り専用です。スクリプトからのネストされたオブジェクト値の変更はサポートされていません。

    api - api.context.session.<session_property>

    現在のユーザーに関連付けられたコンテキストセッションプロパティ。

    表 : 2. 使用可能なセッションプロパティ
    名前 タイプ 説明
    isLoggedIn ブーリアン 現在のユーザーがシステムにログインしているかどうかを示すフラグ。
    可能な値：
    • true：現在のユーザーはログインしています。
    • false：現在のユーザーはログインしていません。
    properties.awaEnabled 文字列 現在のユーザーに対して Advanced Work Assignment (AWA) の作業アイテムの自動アサインが有効になっているかどうかを示すシステムプロパティ glide.awa.enabled。
    可能な値：
    • true：ユーザーに対して AWA が有効になっています。
    • false：ユーザーに対して AWA が無効になっています。

    詳細については、「 高度なワークアサインメントとともにインストールされるコンポーネント」を参照してください。
    properties.forgetMe.value 文字列 ログインページから [記憶する] チェックボックスを削除してログイン情報のキャッシュを防ぐかどうかを示すプロパティ glide.ui.forgetme。
    可能な値：
    • true：[記憶する] チェックボックスを削除します。
    • false：[記憶する] チェックボックスを表示します。

    詳細については、「 記憶する」を削除する を参照してください。
    properties.sessionTimeLeft.value 文字列

    文字列に強制される数値

    		 現在のセッションがタイムアウトするまでの残り時間を決定するシステムプロパティ glide.ui.session_timeleft。このプロパティを使用して、現在のセッションがタイムアウトする前に延長するようにユーザーに指示します。

    単位：分
    properties.sessionTimeout.value 文字列

    文字列に強制される数値

    		 初期セッションタイムアウト値を決定するシステムプロパティ glide.ui.session_timeout。

    単位：分。1440 分を超える値は 1 日として扱われます。

    詳細については、「セッションアクティビティのタイムアウト」を参照してください
    properties.trackingEnabled.value 文字列 UI ビルダー ベースのアプリケーションの Web 分析ライブラリのロードとインスタンス化を有効にするか無効にするかを示すシステムプロパティ glide.uxbuilder.tracking.enabled。
    可能な値：
    • true：ユーザーに対して有効になります。
    • false：ユーザーに対して無効になります。
    user.avatar 文字列 現在のユーザーのアバターの URL。
    user.dateFormat 文字列 デフォルトの日付形式。
    user.domain 文字列 現在のユーザーのドメインパス。
    user.firstName 文字列 現在のユーザーの名。
    user.fullName 文字列 現在のユーザーの名と姓。
    user.initials 文字列 現在のユーザーのイニシャル。
    user.language 文字列 現在のユーザーが使用しているプライマリ言語。
    user_preference オブジェクトのアレイ ユーザー初期設定を記述する名前/値ペア。これらのユーザー初期設定は、ユーザー初期設定 [sys_user_preference] テーブルにレコードとして保存され、ユーザーが設定を変更するたびに更新されます。

    詳細については、「Exploring user administration」を参照してください。
    user_roles アレイ 現在のユーザーに割り当てられているロールのカンマ区切りリスト。
    注:
    ユーザーにロールが割り当てられていない場合、このコンテキストセッションプロパティは空のアレイではなく null を返します。
    user.sys_id 文字列 ユーザー [sys_user] テーブル内のユーザーの sys_id。
    user.timeFormat 文字列 ユーザーに使用するデフォルトの時間形式。
    user.timeZone 文字列 現在のユーザーのタイムゾーン。
    user.timeZoneOffset 文字列 現在のユーザーのタイムゾーンのオフセット。

    api - api.data.<data_resource_id>.lifecycle.lastFetchSucceeded

    指定されたデータリソースインスタンスに対する最後のフェッチの試行が正常に終了したかどうかを示すブールフラグです。

    値が true の場合、データリソースインスタンスに対する最後のフェッチの試行は正常に終了しました。false の場合は、正常に終了しませんでした。

    表 : 3. フィールド
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。

    api - api.data.<data_resource_id>.addErrorMessage(オブジェクト payload)

    指定されたエラーメッセージを現在のフォームの上部に表示します。

    表 : 4. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    payload オブジェクト 表示するエラーメッセージを記述するオブジェクト。
    "payload": {
  "message": "String"
}
    payload.message 文字列 表示するエラー メッセージ。
    表 : 5. 返される内容
    タイプ 説明
    なし 

    api.data.gform.addErrorMessage({message: 'Error message'});

    api -api.data.<data_resource_id>.addInfoMessage(オブジェクト payload)

    指定された情報メッセージを現在のフォームの上部に表示します。

    表 : 6. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    payload オブジェクト 表示する情報メッセージを記述するオブジェクト。
    "payload": {
  "message": "String"
}
    payload.message 文字列 表示する情報メッセージ。
    表 : 7. 返される内容
    タイプ 説明
    なし 

    api.data.gform.addInfoMessage({message: 'Test message'});

    api - api.data.<data_resource_id>.addOption(オブジェクト payload)

    指定された選択肢タイプフィールドにオプションを追加します。

    表 : 8. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    payload オブジェクト 更新するフィールド値を記述するオブジェクト。
    "payload": {
  "choiceIndex": "String",
  "choiceLabel": "String",
  "choiceValue": "String",
  "fieldName": "String"
}
    payload.choiceIndex 文字列 オプション。オプションを挿入する選択リストへのインデックス。

    デフォルト：選択リストの最後。
    payload.choiceLabel 文字列 指定されたフィールドに追加するオプションのラベル。
    payload.choiceValue 文字列 指定されたフィールドに追加するオプションの値。
    payload.fieldName 文字列 指定されたオプションを追加する選択肢タイプのフォームフィールドの名前。
    表 : 9. 返される内容
    タイプ 説明
    なし 

    api.data.gform.addOption({fieldName: 'priority', choiceLabel: 'Extremely High', choiceValue: '10'});

    api - api.data.<data_resource_id>.addWarningMessage(オブジェクト payload)

    指定された警告メッセージを現在のフォームの上部に表示します。

    表 : 10. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    payload オブジェクト 表示する警告メッセージを記述するオブジェクト。
    "payload": {
  "message": "String"
}
    payload.message 文字列 表示する警告メッセージ
    表 : 11. 返される内容
    タイプ 説明
    なし 

    api.data.gform.addWarningMessage({message: 'Test message'});

    api - api.data.<data_resource_id>.clearMessage()

    現在のフォームの上部からすべての情報メッセージとエラーメッセージを削除します。

    表 : 12. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    表 : 13. 返される内容
    タイプ 説明
    なし 

    api.data.gform.clearMessage();

    api - api.data.<data_resource_id>.clearOptions(オブジェクト payload)

    指定された選択肢タイプフィールドからすべてのオプションをクリアします。

    表 : 14. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    payload オブジェクト オプションをクリアする選択肢タイプフィールドを記述するオブジェクト。
    "payload": {
  "fieldName": "String"
}
    payload.fieldName 文字列 オプションをクリアする選択肢タイプフィールドの名前。
    表 : 15. 返される内容
    タイプ 説明
    なし 

    api.data.gform.clearOptions({fieldName: 'priority'});

    api - api.data.<data_resource_id>.executeUiAction(オブジェクト payload)

    指定された UI アクションを実行します。

    表 : 16. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    payload オブジェクト 実行する UI アクションの説明。
    "payload": {
  "actionSysId": "String"
}
    payload.actionSysId 文字列 実行する UI アクションの sys_ID。

    テーブル:UI アクション [sys_ui_action]
    表 : 17. 戻り値
    タイプ 説明
    なし

    次のコード例は、このメソッドを呼び出す方法を示しています。

    api.data.gform.executeUiAction({actionSysId: '60615ff90f730010ac7de6f8c4767e9a'});

    api - api.data.<data_resource_id>.execute(オブジェクト inputValues)

    指定されたデータリソースに対する実行操作をトリガーします。

    このメソッドは、データリソースが次のいずれかのタイプである場合にのみ使用できます。
    • 総合
    • GraphQL
    • REST
    • スクリプトレット
    • 変換
    注:
    このメソッドは、対応するデータリソース (sys_ux_data_broker_* テーブル) レコードの mutates_server_data フィールドが true に設定されている場合にのみ公開されます。api.data.<data_resource_Id>.refresh() でアクセスできます。
    表 : 18. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    inputValues オブジェクト 指定されたデータリソースに渡すオブジェクト。このオブジェクトは、データリソースの入力パラメーターに適合する必要があります。
    表 : 19. 返される内容
    タイプ 説明
    なし

    このコード例は、ページの [送信] ボタンがクリックされたときに呼び出されるページスクリプトを示しています。ページは、新しいレコードを作成するサーバーデータリソースを使用して構成されています。

    function handler({api}) {
  if (api.state.movieYear === 2020) {
    // The data resource used in this case specifies two input parameters: name and year
    api.data.create_movie_record.execute({
      name: api.state.movieName,
      year: api.state.movieYear
    });
  }
}

    api - api.data.<data_resource_id>.hideFieldMessage(オブジェクト payload)

    指定されたフィールドの横にある最も古いメッセージを非表示にするか、フィールドに関連付けられているすべてのメッセージをクリアします。

    表 : 20. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    payload オブジェクト 非表示にするフィールドメッセージを記述するオブジェクト。
    "payload": {
  "clearAll": Boolean,
  "fieldName": "String"
}
    payload.clearAll ブーリアン オプション。指定されたフォームフィールドに関連付けられているすべてのメッセージをクリアするかどうかを示すフラグ。
    有効な値：
    • true：指定されたフィールドに関連付けられているすべてのメッセージをクリアします。
    • false：指定されたフィールドに関連付けられているすべてのメッセージをクリアしません。

    デフォルト値：false
    payload.fieldName 文字列 最も古いメッセージを非表示にする、または関連付けられているすべてのメッセージをクリアする対象のフォームフィールドの名前。
    表 : 21. 返される内容
    タイプ 説明
    なし 

    api.data.gform.hideFieldMessage({fieldName: 'short_description'});

    api - api.data.<data_resource_id>.hideRelatedList(オブジェクト payload)

    現在のフォーム上の指定された関連リストを非表示にします。

    表 : 22. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    payload オブジェクト 非表示にする関連リストを記述するオブジェクト。
    "payload": {
  "listTableName ": "String"
}
    payload.listTableName 文字列 非表示にする関連リストの名前。非表示にするリストが関係を介している場合は、名前の代わりにリストの sys_id を指定します。

    テーブル:関連リスト [sys_ui_related_list]
    表 : 23. 戻り値
    タイプ 説明
    なし

    次のコード例は、このメソッドを呼び出す方法を示しています。

    api.data.gform.hideRelatedList({listTableName:'incident.parent_incident'});

    api - api.data.<data_resource_id>.hideRelatedLists()

    現在のフォーム上のすべての関連リストを非表示にします。

    表 : 24. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    表 : 25. 返される内容
    タイプ 説明
    なし 

    api.data.gform.hideRelatedLists();

    api - api.data.<data_resource_id>.refresh()

    指定された非変更データリソースインスタンスに対するリフレッシュ操作をトリガーします。

    このメソッドは、データリソースによってフェッチされる基のデータが変更された場合に呼び出します。レコードの mutates_server_data フィールドが false に設定されている場合、データリソースは非変更と見なされます。

    このメソッドは非同期です。指定されたデータリソースインスタンスのリフレッシュをトリガーする内部イベントを発行します。UI ビルダー を使用すると、データリソースライフサイクルイベント (DATA_Fetch_SUCCESSED や DATA_Fetch_FAILED など) に応答してクライアントスクリプトをトリガーできます。これらのイベントの詳細については、「 イベントマッピング」を参照してください。

    このメソッドは、データリソースが次のいずれかのタイプである場合にのみ使用できます。
    • 総合
    • GraphQL
    • REST
    • スクリプトレット
    • 変換
    注:
    このメソッドは、対応するデータリソース (sys_ux_data_broker_* テーブル) レコードの mutates_server_data フィールドが false に設定されている場合にのみ公開されます。
    表 : 26. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    表 : 27. 返される内容
    タイプ 説明
    なし

    このコード例は、ページでドロップダウンアイテムが選択されたときに呼び出されるページスクリプトを示しています。このページは、問題テーブルとインシデントテーブルをそれぞれ照会する 2 つのサーバーデータリソースで構成されています。

    function handler({api, event}) {
  const value = event.payload.value[0];
  if (value === 'problem')
    api.data.problem_list_1.refresh();
  else if(value === 'incident')
    api.data.incident_list_1.refresh();
}

    api - api.data.<data_resource_id>.reload()

    同じテーブルと sys_id を使用して現在のフォームを再ロードします。

    表 : 28. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    表 : 29. 返される内容
    タイプ 説明
    なし 

    api.data.gform.reload();

    api - api.data.<data_resource_id>.removeOption(オブジェクト payload)

    指定された選択肢タイプフィールドからオプションを削除します。

    表 : 30. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    payload オブジェクト 更新する選択肢タイプフィールドを記述するオブジェクト。
    "payload": {
  "choiceValue": "String",
  "fieldName": "String"
}
    payload.choiceValue 文字列 指定された選択肢タイプフィールドから削除するオプションの値。
    payload.fieldName 文字列 指定された値を削除する選択肢タイプのフォームフィールドの名前。
    表 : 31. 返される内容
    タイプ 説明
    なし 

    api.data.gform.removeOption({fieldName: 'priority', choiceValue: '1'});

    api - api.data.<data_resource_id>.save()

    Save UI アクションを使用してフォーム送信をトリガーします。

    表 : 32. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    表 : 33. 返される内容
    タイプ 説明
    なし 

    api.data.gform.save();

    api - api.data.<data_resource_id>.setMandatory(オブジェクト payload)

    指定されたフォームフィールドが必須かどうかを設定します。

    表 : 34. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    payload オブジェクト 必須情報を更新するフィールドを記述するオブジェクト。
    "payload": {
  "fieldName": "String",
  "mandatory": Boolean
}
    payload.fieldName 文字列 必須の値を設定するフォームフィールドの名前。
    payload.mandatory ブーリアン 指定されたフォームフィールドが必須であることを示すフラグ。つまり、このフィールドに有効な値が含まれていなければ、フォームは保存できません。
    有効な値：
    • true：フィールドは必須です。
    • false：フィールドはオプションです。
    表 : 35. 返される内容
    タイプ 説明
    なし 

    api.data.gform.setMandatory({fieldName: 'short_description', mandatory: false});

    api - api.data.<data_resource_id>.setReadOnly(オブジェクト payload)

    指定されたフォームフィールドの読み取り/書き込み機能を設定します。

    表 : 36. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    payload オブジェクト 読み取り機能の情報を更新するフィールドを記述するオブジェクト。
    "payload": {
  "fieldName": "String",
  "readonly": Boolean
}
    payload.fieldName 文字列 読み取り機能を設定するフォームフィールドの名前。
    payload.readonly ブーリアン 指定されたフォームフィールドの読み取り/書き込み機能を示すフラグ。
    有効な値：
    • true：フィールドは読み取り専用です。
    • false：フィールドは読み取り/書き込み可能です。
    表 : 37. 返される内容
    タイプ 説明
    なし 

    api.data.gform.setReadOnly({fieldName: 'short_description', readonly: false});

    api -api.data.<データリソース ID>.setValue(オブジェクト payload)

    指定された GlideForm フィールドを指定された値で更新します。必要に応じて、同じ指定値で表示値を更新することもできます。

    フォームの値のみが更新されます。値はデータベースに保存されません。

    表 : 38. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    payload オブジェクト 値を更新するフィールドを記述するオブジェクト。
    "payload": {
  "displayValue": "String",
  "fieldName": "String",
  "value": "String"
}
    payload.displayValue 文字列 オプション。更新する表示値の名前。空白のままにすると、表示値は変更されません。
    payload.fieldName 文字列 更新するフォームフィールドの名前。
    payload.value 文字列 フィールドを更新する値。
    表 : 39. 返される内容
    タイプ 説明
    なし 

    api.data.gform.setValue({fieldName: 'short_description', value: 'short description'});

    api - api.data.<data_resource_id>.setVisible(オブジェクト payload)

    指定されたフォームフィールドの可視化を設定します。

    表 : 40. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    payload オブジェクト 可視化を設定するフィールドを記述するオブジェクト。
    "payload": {
  "fieldName": "String",
  "visibility": Boolean
}
    payload.fieldName 文字列 可視化を設定するフォームフィールドの名前。
    payload.visibility ブーリアン 関連付けられたフィールドが現在のフォームに表示されるかどうかを示すフラグ。
    有効な値：
    • true：フィールドがフォームに表示されます。
    • false：フィールドはフォームに表示されません。
    表 : 41. 返される内容
    タイプ 説明
    なし 

    api.data.gform.setVisible({fieldName: 'short_description', visibility: false});

    api - api.data.<data_resource_id>.showFieldMessage(オブジェクト payload)

    指定されたフィールドの横に、指定されたメッセージを表示します。

    表 : 42. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    payload オブジェクト 表示するフィールドメッセージを記述するオブジェクト。
    "payload": {
  "fieldName": "String",
  "message": "String",
  "type": "String"
    payload.fieldName 文字列 メッセージを横に表示させるフィールドの名前。
    payload.message 文字列 表示するメッセージ。
    payload.type 文字列 オプション。表示するメッセージのタイプ。
    有効な値：
    • error
    • 情報
    • warning

    デフォルト：Info
    表 : 43. 返される内容
    タイプ 説明
    なし 

    api.data.gform.showFieldMessage({fieldName: 'short_description', message: 'Error message', type: 'error'});

    api - api.data.<data_resource_id>.showRelatedList(オブジェクト payload)

    指定された関連リストを現在のフォームに表示します。

    表 : 44. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    payload オブジェクト 表示する関連リストを記述するオブジェクト。
    "payload": {
  "listTableName ": "String"
}
    payload.listTableName 文字列 表示する関連リストの名前。表示するリストが関係を介している場合は、名前の代わりにリストの sys_id を指定します。

    テーブル:関連リスト [sys_ui_related_list]
    表 : 45. 戻り値
    タイプ 説明
    なし

    次のコード例は、このメソッドを呼び出す方法を示しています。

    api.data.gform.showRelatedList({listTableName:'incident.parent_incident'});

    api - api.data.<data_resource_id>.showRelatedLists()

    現在のフォームに関連付けられているすべての関連リストを表示します。

    表 : 46. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    表 : 47. 返される内容
    タイプ 説明
    なし 

    api.data.gform.showRelatedLists();

    api - api.data.<data_resource_id>.submit()

    指定された UI アクションを使用してフォーム送信をトリガーします。

    表 : 48. パラメーター
    名前 タイプ 説明
    data_resource_id 文字列 関連付けられたデータリソースの一意の識別子。

    ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。

    使用可能なデータリソースインスタンスは構成に依存し、UI ビルダー でデータリソースをページに追加するときに定義されます。
    payload オブジェクト 現在のフォームの送信に使用する UI アクションを記述するオブジェクト。
    "payload": {
  "submitActionName": "String"
}
    payload.submitActionName 文字列 現在のフォームの送信を実行する UI アクションの名前。
    表 : 49. 返される内容
    タイプ 説明
    なし 

    api.data.gform.submit({submitActionName:'sysverb_ws_save'});

    api - api.emit(文字列 eventName, オブジェクト payload)

    指定された名前とペイロードを持つイベントを発行します。

    発行されるイベント名は、UX macroponent 定義 [sys_ux_macroponent] テーブルに格納されている、関連するページ定義のディスパッチイベントリストの一部である必要があります。このテーブルで宣言されていないイベントをディスパッチする api.emit 呼び出しは無視されます。

    イベントの詳細については、「 イベントの操作」を参照してください。

    表 : 50. パラメーター
    名前 タイプ 説明
    eventName 文字列 発行するイベントの名前。この名前は、UI フレームワークのアクション命名ガイドラインに従う必要があります。
    • 大文字のスネークケース (ITEM_CHANGED など) にする必要があります。すべての文字を大文字にし、すべてのスペースをアンダースコアに置き換えます。
    • 過去形 (BUTTON_CLICKED、USER_SELECTED など) にする必要があります。

    これらのアクション命名ガイドラインの詳細については、「https://developer.servicenow.com/dev.do#!/reference/now-experience/sandiego/ui-framework/main-concepts/dispatching-actions」を参照してください。
    payload オブジェクト オプション。発行されたイベントとともに送信するデータを含むオブジェクト。このオブジェクトは自由形式です。データを受け取るエンティティが必要とするデータをすべて含めることができます。
    注:
    プリミティブタイプのペイロードは機能しますが、動作に一貫性がなくなる可能性があります。
    表 : 51. 返される内容
    タイプ 説明
    なし

    次のコード例は、関連付けられた items ペイロードとともに NOW_UXF_PAGE#ADD_NOTIFICATIONS というイベントを発行する方法を示しています。

    function handler({api}) { 
  api.emit('NOW_UXF_PAGE#ADD_NOTIFICATIONS', { 
    items: [
      { 
        id: 'alert1', 
        status: 'positive', 
        icon: 'check-circle-outline', 
        content: 'Here is some information!', 
        textLinkProps: { 
          label: 'More info',
          href: 'https://www.servicenow.com' 
        }, 
      action: {type: 'acknowledge'} 
      } 
    ] 
  }); 
}

    api - setState(文字列 stateParam, 任意 value)

    指定されたクライアントステータスパラメーターの値を設定します。

    クライアントステータスパラメーターを使用して、ページ上で共有ステータスを維持します。その後で共有ステータスは、ページで使用されるコンポーネントのプロパティに値として渡すことができます。複数のページスクリプトでクライアントステータスにアクセスして更新することもできます。一般的なユースケースは、ページ上の複数のフォームコントロールでユーザーが入力した値を追跡することです。フォームが送信されると、クライアントスクリプトはクライアントステータスパラメーターに格納されているすべての値を使用して、データブローカーで新しいレコードを作成できます。UI Builder を使用してページに対して宣言できるクライアントステータスパラメーターをページに 1 つ以上含めることができます。その後、クライアントステータスパラメーターを 1 つ以上のコンポーネントにバインドして、クライアントステータスパラメーターを共有または操作できます。

    api.setState() 呼び出しは非同期に実行され、UI がすぐに更新されるとは限りません。設定する値がクライアントステータスパラメーターの currentValue、または api オブジェクトで提供されるプロパティのいずれかに依存する場合は、api.setState() メソッドのこのバリアントを使用して、古い値の使用を避ける必要があります。

    表 : 52. パラメーター
    名前 タイプ 説明
    stateParm 文字列 更新するクライアントステータスパラメーターの名前。この名前は、関連付けられたページのクライアントステータスパラメーターで宣言される必要があります。

    クライアント状態パラメーターの宣言の詳細については、「 クライアント状態パラメーターの操作」を参照してください。
    value 任意ですが、クライアントステータスパラメーター宣言と同じにする必要があります。 指定されたクライアントステータスパラメーターに設定する値。
    表 : 53. 返される内容
    タイプ 説明
    なし

    この例は、now-input コンポーネントに入力値が設定されたときにメールクライアントのステータスパラメーターを更新するために実行できるスクリプトを示しています。

    function handler({api, event}) {
    api.setState('email', event.payload.value);
}

    API - setState(文字列 stateParam, 機能 callbackFn)

    指定されたクライアントステータスパラメーターの値を、指定されたコールバック機能によって返される値に設定します。

    コールバック機能は、currentValue と api の 2 つのプロパティを持つオブジェクトにより呼び出されます。コールバック機能は、currentValue プロパティまたは api オブジェクトを直接変更できません。

    クライアントステータスパラメーターを使用して、ページ上で共有ステータスを維持します。その後で共有ステータスは、ページで使用されるコンポーネントのプロパティに値として渡すことができます。複数のページスクリプトでクライアントステータスにアクセスして更新することもできます。一般的なユースケースは、ページ上の複数のフォームコントロールでユーザーが入力した値を追跡することです。フォームが送信されると、クライアントスクリプトはクライアントステータスパラメーターに格納されているすべての値を使用して、データブローカーで新しいレコードを作成できます。UI Builder を使用してページに対して宣言できるクライアントステータスパラメーターをページに 1 つ以上含めることができます。その後、クライアントステータスパラメーターを 1 つ以上のコンポーネントにバインドして、クライアントステータスパラメーターを共有または操作できます。

    api.setState() 呼び出しは非同期に実行され、UI がすぐに更新されるとは限りません。設定する値がクライアントステータスパラメーターの currentValue、または api オブジェクトで提供されるプロパティのいずれかに依存する場合は、api.setState() メソッドのこのバリアントを使用して、古い値の使用を避ける必要があります。

    表 : 54. パラメーター
    名前 タイプ 説明
    stateParm 文字列 更新するクライアントステータスパラメーターの名前。この名前は、関連付けられたページのクライアントステータスパラメーターで宣言される必要があります。

    クライアント状態パラメーターの宣言の詳細については、「 クライアント状態パラメーターの操作」を参照してください。
    callbackFn 関数 値を取得するために実行するコールバック機能。
    表 : 55. 返される内容
    タイプ 説明
    なし

    この例は、api.setState を使用してユーザーをページにログインさせる方法を示しています。

    function handler({api, event}) {
  const {name, value} = event.payload;
  if (name === 'username' || name === 'password') {
    // Update the loginParameters state object with the username/password value
    api.setState('loginParameters', ({currentValue}) => {
      return {
        ...currentValue,
        [name]: value
      };
    });
  }
}

    api - api.state.<client_state_parameter_name>

    指定されたクライアントステータスパラメーターの現在の値です。

    表 : 56. フィールド
    名前 タイプ 説明
    <client_state_parameter_name> 任意。使用可能なクライアントステータスパラメーターは、ページ構成によって異なります。 クライアントステータスパラメーターの名前。使用可能なクライアントステータスは、クライアントスクリプトの実装によって異なります。

    利用可能なクライアントステータスにアクセスするには、api.state.<client_state_name> を使用します。

    例： 
    function showRelatedLists({api}) { 
  return !api.state.isCustomListSelected; 
}
    注:
    これらのプロパティ値は読み取り専用です。クライアントステータスパラメーターを更新するには、api.setState() を使用します。スクリプトからのネストされたオブジェクト値の変更はサポートされていません。