---
sourceDocument: オーストラリア API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference

 Release :

    - australia

ft:locale :

    - ja-JP

ft:publication_title :

    - オーストラリア API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# api - UI ビルダー

# api - UI ビルダー {#ariaid-title1}

* リリースバージョン: Australia
* 
* 更新日 2026年03月12日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：41分

API API は、UI ビルダーでクライアントスクリプトを開発するときに使用できるメソッドを提供します。  
この API は、クライアントスクリプト (ページスクリプトとも呼ばれます) に公開されます。クライアントスクリプトは、次のようなページで発生することに応じて実行されます。

* ボタンのクリックなどのユーザーインタラクションイベント/アクション。
* データブローカーの実行の開始などのライフサイクルイベント。
これらのスクリプトは、フレームワークに何も返す必要はなく、非同期関数として記述できます。  
この API は、スクリプト化されたプロパティ値にも公開されます。これらのスクリプトは、次のようなフレームワークランタイムで値を計算する必要がある場合は常に実行されます。

* コンポーネントプロパティへの渡し。
* コンポーネントの可視化の決定。
* ペイロードを指定してイベントを発行します。

これらのスクリプトは非同期関数として記述できません。また、api.emit()、api.setState()、api.data.\<data_resource_id\>.\*() などの副作用メソッドを API オブジェクトに対して呼び出すこともできません。

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

## API:api.context.props.\<page_property_name\> {#ariaid-title2}

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

| 名前 | タイプ | 説明 |
|-|-|-|
| \<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'; } ` 注: これらのプロパティ値は読み取り専用です。スクリプトからのネストされたオブジェクト値の変更はサポートされていません。 |
[表 : 1. フィールド]

{#api-context-props__table_pnc_bkb_n4b}

## API - api.context.session.\<session_property\> {#ariaid-title3}

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

| 名前 | タイプ | 説明 |
|-|-|-|
| isLoggedIn | ブーリアン | 現在のユーザーがシステムにログインしているかどうかを示すフラグ。 可能な値： * true:現在のユーザーは次のものにログインしています * false:現在のユーザーはログインしていません。 |
| properties.awaEnabled | 文字列 | 高度なワークアサインメント (AWA) の作業アイテムの自動アサインが現在のユーザーに対して有効になっているかどうかを示すシステムプロパティ glide.awa.enabled。 可能な値： * true:ユーザーに対して AWA が有効になっています。 * false:ユーザーに対して AWA が有効になっていません。 詳細については、「 [高度なワークアサインメントとともにインストールされるコンポーネント](https://www.servicenow.com/docs/access?context=installed-with-awa&version=australia&pubname=australia-conversational-interfaces&ft:locale=en-US)」を参照してください。 |
| properties.forgetMe.value | 文字列 | ログイン情報がキャッシュされないようにするために、ログインページから \[記憶する \] チェックボックスを削除するかどうかを示すプロパティ glide.ui.forgetme。 可能な値： * true: \[記憶する\] チェックボックスを削除します。 * false: \[記憶する\] チェックボックスを表示します。 詳細については、「 [記憶する」の削除](https://www.servicenow.com/docs/access?context=sc-remove-remember-me&version=australia&pubname=australia-platform-security&ft:locale=en-US)を参照してください。 |
| properties.sessionTimeLeft.value | 文字列 文字列に強制される数値 | 現在のセッションがタイムアウトするまでの残り時間を決定するシステムプロパティglide.ui.session_timeleft。このプロパティを使用して、タイムアウトする前に現在のセッションを拡張するようにユーザーに求めます。 単位:分 |
| properties.sessionTimeout.value | 文字列 文字列に強制される数値 | 初期セッションタイムアウト値を決定するシステムプロパティglide.ui.session_timeout。 単位:分:1440 分を超える値は 1 日として扱われます。 詳細については、「[セッションアクティビティのタイムアウト」](https://www.servicenow.com/docs/access?context=sc-session-activity-timeout&version=australia&pubname=australia-platform-security&ft:locale=en-US)を参照してください |
| 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.preferences | オブジェクトのアレイ | ユーザー設定を説明する名前と値のペア。これらのユーザー設定は、ユーザー設定 \[sys_user_preference\] テーブルにレコードとして保存され、ユーザーが設定を変更するたびに更新されます。 詳細については、「[Exploring user administration](https://www.servicenow.com/docs/access?context=exploring-user-administration&version=australia&pubname=australia-platform-administration&ft:locale=en-US)」を参照してください。 |
| user.roles | アレイ | 現在のユーザーにアサインされているロールのカンマ区切りリスト。 注: ユーザーにロールが割り当てられていない場合、このコンテキストセッションプロパティは空のアレイではなく null を返します。 |
| user.sys_id | 文字列 | ユーザー \[sys_user\] テーブル内のユーザーのSys_id。 |
| user.timeFormat | 文字列 | ユーザーが使用するデフォルトの時間形式。 |
| user.timeZone | 文字列 | 現在のユーザーのタイムゾーン。 |
| user.timeZoneOffset | 文字列 | 現在のユーザーのタイムゾーンオフセット。 |
[表 : 2. 利用可能なセッションプロパティ]

{#api-context-session__table_e24_hkc_n4b}

## api:api.data.\<data_resource_id\>.lifecycle.lastFetchSucceeded {#ariaid-title4}

指定されたデータリソースインスタンスの最後のフェッチ試行が正常に終了したかどうかを示すブールフラグ。
値が true の場合、データリソースインスタンスの最後のフェッチ試行は正常に終了しました。それ以外の場合は false です。
{#api-data-resrc_id-lastFetchSuc__table_svj_czb_n4b__entry__3}{#api-data-resrc_id-lastFetchSuc__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| data_resource_id | 文字列 | 関連付けられたデータリソースの一意の識別子。 ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。 使用可能なデータリソースインスタンスは構成に依存し、 UI ビルダーでページにデータリソースを追加するときに定義されます。 |
[表 : 3. フィールド]

{#api-data-resrc_id-lastFetchSuc__table_svj_czb_n4b}

## api:api.data.\<data_resource_id\>.addErrorMessage(オブジェクトペイロード) {#ariaid-title5}

指定されたエラーメッセージを現在のフォームの上部に表示します。
{#api-data-resrc_id-addErrMsg_O__table_pct_ffd_n4b__entry__3}{#api-data-resrc_id-addErrMsg_O__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| data_resource_id | 文字列 | 関連付けられたデータリソースの一意の識別子。 ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。 使用可能なデータリソースインスタンスは構成に依存し、 UI ビルダーでページにデータリソースを追加するときに定義されます。 |
| payload | オブジェクト | 表示するエラーメッセージを説明するオブジェクト。 "payload": { "message": "String" } |
| payload.message | 文字列 | 表示するエラー メッセージ。 |
[表 : 4. パラメーター]

{#api-data-resrc_id-addErrMsg_O__table_pct_ffd_n4b} {#api-data-resrc_id-addErrMsg_O__table_qct_ffd_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 5. 返される内容]

{#api-data-resrc_id-addErrMsg_O__table_qct_ffd_n4b}  
<br />

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

## api -api.data.\<data_resource_id\>.addInfoMessage(オブジェクトペイロード) {#ariaid-title6}

指定された情報メッセージを現在のフォームの上部に表示します。
{#api-data-resrc_id-addInfoMsg_O__table_pqr_wdd_n4b__entry__3}{#api-data-resrc_id-addInfoMsg_O__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| data_resource_id | 文字列 | 関連付けられたデータリソースの一意の識別子。 ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。 使用可能なデータリソースインスタンスは構成に依存し、 UI ビルダーでページにデータリソースを追加するときに定義されます。 |
| payload | オブジェクト | 表示する情報メッセージを説明するオブジェクト。 "payload": { "message": "String" } |
| payload.message | 文字列 | 表示する情報メッセージ。 |
[表 : 6. パラメーター]

{#api-data-resrc_id-addInfoMsg_O__table_pqr_wdd_n4b} {#api-data-resrc_id-addInfoMsg_O__table_qqr_wdd_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 7. 返される内容]

{#api-data-resrc_id-addInfoMsg_O__table_qqr_wdd_n4b}  
<br />

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

## api - api.data.\<data_resource_id\>.addOption(オブジェクトペイロード) {#ariaid-title7}

指定された選択肢タイプフィールドにオプションを追加します。
{#api-data-resrc_id-addOption_O__table_okr_21j_n4b__entry__3}{#api-data-resrc_id-addOption_O__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| 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 | 文字列 | 指定されたオプションを追加する選択肢タイプフォームフィールドの名前。 |
[表 : 8. パラメーター]

{#api-data-resrc_id-addOption_O__table_okr_21j_n4b} {#api-data-resrc_id-addOption_O__table_pkr_21j_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 9. 返される内容]

{#api-data-resrc_id-addOption_O__table_pkr_21j_n4b}  
<br />

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

## api - api.data.\<data_resource_id\>.addWarningMessage (オブジェクトペイロード) {#ariaid-title8}

指定された警告メッセージを現在のフォームの上部に表示します。
{#api-data-resrc_id-addWarnMsg_O__table_mgf_v2d_n4b__entry__3}{#api-data-resrc_id-addWarnMsg_O__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| data_resource_id | 文字列 | 関連付けられたデータリソースの一意の識別子。 ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。 使用可能なデータリソースインスタンスは構成に依存し、 UI ビルダーでページにデータリソースを追加するときに定義されます。 |
| payload | オブジェクト | 表示する警告メッセージを説明するオブジェクト。 "payload": { "message": "String" } |
| payload.message | 文字列 | 表示する警告メッセージ。 |
[表 : 10. パラメーター]

{#api-data-resrc_id-addWarnMsg_O__table_mgf_v2d_n4b} {#api-data-resrc_id-addWarnMsg_O__table_ngf_v2d_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 11. 返される内容]

{#api-data-resrc_id-addWarnMsg_O__table_ngf_v2d_n4b}  
<br />

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

## api:api.data.\<data_resource_id\>.clearMessage() {#ariaid-title9}

現在のフォームの上部からすべての情報メッセージとエラーメッセージを削除します。
{#api-data-resrc_id-clearMsg__table_g4t_qfd_n4b__entry__3}{#api-data-resrc_id-clearMsg__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| data_resource_id | 文字列 | 関連付けられたデータリソースの一意の識別子。 ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。 使用可能なデータリソースインスタンスは構成に依存し、 UI ビルダーでページにデータリソースを追加するときに定義されます。 |
[表 : 12. パラメーター]

{#api-data-resrc_id-clearMsg__table_g4t_qfd_n4b} {#api-data-resrc_id-clearMsg__table_h4t_qfd_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 13. 返される内容]

{#api-data-resrc_id-clearMsg__table_h4t_qfd_n4b}  
<br />

    api.data.gform.clearMessage();

## api:api.data.\<data_resource_id\>.clearOptions(オブジェクトペイロード) {#ariaid-title10}

指定された選択肢タイプフィールドからすべてのオプションをクリアします。
{#api-data-resrc_id-clearOptions_O__table_c3x_4dj_n4b__entry__3}{#api-data-resrc_id-clearOptions_O__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| data_resource_id | 文字列 | 関連付けられたデータリソースの一意の識別子。 ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。 使用可能なデータリソースインスタンスは構成に依存し、 UI ビルダーでページにデータリソースを追加するときに定義されます。 |
| payload | オブジェクト | オプションをクリアする選択肢タイプフィールドを説明するオブジェクト。 "payload": { "fieldName": "String" } |
| payload.fieldName | 文字列 | オプションをクリアする選択肢タイプフィールドの名前。 |
[表 : 14. パラメーター]

{#api-data-resrc_id-clearOptions_O__table_c3x_4dj_n4b} {#api-data-resrc_id-clearOptions_O__table_d3x_4dj_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 15. 返される内容]

{#api-data-resrc_id-clearOptions_O__table_d3x_4dj_n4b}  
<br />

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

## api:api.data.\<data_resource_id\>.executeUiAction(オブジェクトペイロード) {#ariaid-title11}

指定された UI アクションを実行します。
{#api-data-resrc_id-execUIAct_O__table_l41_s2j_n4b__entry__3}{#api-data-resrc_id-execUIAct_O__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| 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\] |
[表 : 16. パラメーター]

{#api-data-resrc_id-execUIAct_O__table_l41_s2j_n4b} {#api-data-resrc_id-execUIAct_O__table_m41_s2j_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 17. 返される内容]

{#api-data-resrc_id-execUIAct_O__table_m41_s2j_n4b}  
次のコード例は、このメソッドを呼び出す方法を示しています。

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

## api:api.data.\<data_resource_id\>.execute(オブジェクト inputValues) {#ariaid-title12}

指定されたデータリソースに対して実行操作をトリガーします。
このメソッドは、データリソースが次のいずれかのタイプである場合にのみ使用できます。

* 総合
* GraphQL
* REST
* スクリプトレット
* 変換
{#api-data-resrc_id-execute__ul_slc_xq1_54b}  
注:  
このメソッドは、対応するデータリソース (sys_ux_data_broker_\* テーブル) レコードで mutates_server_data フィールドが <kbd class="ph userinput">true</kbd> に設定されている場合にのみ公開されます。api.data.\<data_resource_Id\>.refresh() でアクセスできます。 {#api-data-resrc_id-execute__table_m52_lyc_n4b__entry__3}{#api-data-resrc_id-execute__data_resource_id_non_gform-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| data_resource_id | 文字列 | 関連付けられたデータリソースの一意の識別子。使用可能なデータリソースインスタンスは構成に依存し、 UI ビルダーでページにデータリソースを追加するときに定義されます。 |
| inputValues | オブジェクト | 指定されたデータリソースに渡すオブジェクト。このオブジェクトは、データリソースの入力パラメーターに準拠する必要があります。 |
[表 : 18. パラメーター]

{#api-data-resrc_id-execute__table_m52_lyc_n4b} {#api-data-resrc_id-execute__table_n52_lyc_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 19. 返される内容]

{#api-data-resrc_id-execute__table_n52_lyc_n4b}  
このコード例は、ページの \[送信 \] ボタンがクリックされたときに呼び出されるページスクリプトを示しています。ページは、サーバーデータリソースによって構成され、新しいレコードが作成されます。

    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(オブジェクトペイロード) {#ariaid-title13}

指定したフィールドの横にある最も古いメッセージを非表示にするか、フィールドに関連付けられているすべてのメッセージをクリアします。
{#api-data-resrc_id-hideFldMsg__table_jl3_b33_n4b__entry__3}{#api-data-resrc_id-hideFldMsg__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| data_resource_id | 文字列 | 関連付けられたデータリソースの一意の識別子。 ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。 使用可能なデータリソースインスタンスは構成に依存し、 UI ビルダーでページにデータリソースを追加するときに定義されます。 |
| payload | オブジェクト | 非表示にするフィールドメッセージを説明するオブジェクト。 "payload": { "clearAll": Boolean, "fieldName": "String" } |
| payload.clearAll | ブーリアン | オプション。指定されたフォームフィールドに関連付けられているすべてのメッセージをクリアするかどうかを示すフラグ。 有効な値： * true:指定されたフィールドに関連付けられているすべてのメッセージをクリアします。 * false:指定されたフィールドに関連付けられているすべてのメッセージをクリアしません。 デフォルト値：false |
| payload.fieldName | 文字列 | 最も古いメッセージを非表示にするか、関連するすべてのメッセージをクリアするフォームフィールドの名前。 |
[表 : 20. パラメーター]

{#api-data-resrc_id-hideFldMsg__table_jl3_b33_n4b} {#api-data-resrc_id-hideFldMsg__table_kl3_b33_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 21. 返される内容]

{#api-data-resrc_id-hideFldMsg__table_kl3_b33_n4b}  
<br />

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

## api:api.data.\<data_resource_id\>.hideRelatedList(オブジェクトペイロード) {#ariaid-title14}

現在のフォームで指定された関連リストを非表示にします。
{#api-data-resrc_id-hideRelList_O__table_yxg_jq3_n4b__entry__3}{#api-data-resrc_id-hideRelList_O__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| data_resource_id | 文字列 | 関連付けられたデータリソースの一意の識別子。 ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。 使用可能なデータリソースインスタンスは構成に依存し、 UI ビルダーでページにデータリソースを追加するときに定義されます。 |
| payload | オブジェクト | 非表示にする関連リストを説明するオブジェクト。 "payload": { "listTableName ": "String" } |
| payload.listTableName | 文字列 | 非表示にする関連リストの名前。非表示にするリストが関係性によるものである場合は、名前の代わりにリストのsys_idを指定します。 テーブル:関連リスト \[sys_ui_related_list\] |
[表 : 22. パラメーター]

{#api-data-resrc_id-hideRelList_O__table_yxg_jq3_n4b} {#api-data-resrc_id-hideRelList_O__table_zxg_jq3_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 23. 返される内容]

{#api-data-resrc_id-hideRelList_O__table_zxg_jq3_n4b}  
次のコード例は、このメソッドを呼び出す方法を示しています。

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

## api:api.data.\<data_resource_id\>.hideRelatedLists() {#ariaid-title15}

現在のフォームのすべての関連リストを非表示にします。
{#api-data-resrc_id-hideRelLists__table_cy4_cm3_n4b__entry__3}{#api-data-resrc_id-hideRelLists__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| data_resource_id | 文字列 | 関連付けられたデータリソースの一意の識別子。 ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。 使用可能なデータリソースインスタンスは構成に依存し、 UI ビルダーでページにデータリソースを追加するときに定義されます。 |
[表 : 24. パラメーター]

{#api-data-resrc_id-hideRelLists__table_cy4_cm3_n4b} {#api-data-resrc_id-hideRelLists__table_dy4_cm3_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 25. 返される内容]

{#api-data-resrc_id-hideRelLists__table_dy4_cm3_n4b}  
<br />

    api.data.gform.hideRelatedLists();

## API - api.data.\<data_resource_id\>.refresh() {#ariaid-title16}

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

このメソッドは非同期であり、指定されたデータリソースインスタンスのリフレッシュをトリガーする内部イベントを発行します。UI ビルダーを使用すると、DATA_FETCH_SUCCEEDEDやDATA_FETCH_FAILEDなどのデータリソースライフサイクルイベントに応じてクライアントスクリプトをトリガーできます。これらのイベントの詳細については、「 [イベントマッピング](https://www.servicenow.com/docs/access?context=event-mapping&version=australia&pubname=australia-application-development&ft:locale=en-US)」を参照してください。  
このメソッドは、データリソースが次のいずれかのタイプである場合にのみ使用できます。

* 総合
* GraphQL
* REST
* スクリプトレット
* 変換
{#api-data-resrc_id-refresh__ul_slc_xq1_54b}  
注:  
このメソッドは、対応するデータリソース (sys_ux_data_broker_\* テーブル) レコードで mutates_server_data フィールドが <kbd class="ph userinput">false</kbd> に設定されている場合にのみ公開されます。 {#api-data-resrc_id-refresh__table_jrk_spc_n4b__entry__3}{#api-data-resrc_id-refresh__data_resource_id_non_gform-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| data_resource_id | 文字列 | 関連付けられたデータリソースの一意の識別子。使用可能なデータリソースインスタンスは構成に依存し、 UI ビルダーでページにデータリソースを追加するときに定義されます。 |
[表 : 26. パラメーター]

{#api-data-resrc_id-refresh__table_jrk_spc_n4b} {#api-data-resrc_id-refresh__table_krk_spc_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 27. 返される内容]

{#api-data-resrc_id-refresh__table_krk_spc_n4b}  
このコード例は、ページでドロップダウンアイテムが選択されたときに呼び出されるページスクリプトを示しています。このページは、問題テーブルとインシデントテーブルをクエリする 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() {#ariaid-title17}

同じテーブルとsys_idを使用して現在のフォームを再ロードします。
{#api-data-resrc_id-reload__table_cwc_kw3_n4b__entry__3}{#api-data-resrc_id-reload__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| data_resource_id | 文字列 | 関連付けられたデータリソースの一意の識別子。 ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。 使用可能なデータリソースインスタンスは構成に依存し、 UI ビルダーでページにデータリソースを追加するときに定義されます。 |
[表 : 28. パラメーター]

{#api-data-resrc_id-reload__table_cwc_kw3_n4b} {#api-data-resrc_id-reload__table_dwc_kw3_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 29. 返される内容]

{#api-data-resrc_id-reload__table_dwc_kw3_n4b}  
<br />

    api.data.gform.reload();

## api - api.data.\<data_resource_id\>.removeOption(オブジェクトペイロード) {#ariaid-title18}

指定された選択肢タイプフィールドからオプションを削除します。
{#api-data-resrc_id-removeOption_O__table_gky_wcj_n4b__entry__3}{#api-data-resrc_id-removeOption_O__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| data_resource_id | 文字列 | 関連付けられたデータリソースの一意の識別子。 ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。 使用可能なデータリソースインスタンスは構成に依存し、 UI ビルダーでページにデータリソースを追加するときに定義されます。 |
| payload | オブジェクト | 更新する選択肢タイプフィールドを説明するオブジェクト。 "payload": { "choiceValue": "String", "fieldName": "String" } |
| payload.choiceValue | 文字列 | 指定された選択肢タイプフィールドから削除するオプションの値。 |
| payload.fieldName | 文字列 | 指定した値を削除する選択肢タイプフォームフィールドの名前。 |
[表 : 30. パラメーター]

{#api-data-resrc_id-removeOption_O__table_gky_wcj_n4b} {#api-data-resrc_id-removeOption_O__table_hky_wcj_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 31. 返される内容]

{#api-data-resrc_id-removeOption_O__table_hky_wcj_n4b}  
<br />

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

## API:api.data.\<data_resource_id\>.save() {#ariaid-title19}

\[ 保存 \] UI アクションを使用してフォーム送信をトリガーします。
{#api-data-resrc_id-save__table_fn1_vw3_n4b__entry__3}{#api-data-resrc_id-save__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| data_resource_id | 文字列 | 関連付けられたデータリソースの一意の識別子。 ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。 使用可能なデータリソースインスタンスは構成に依存し、 UI ビルダーでページにデータリソースを追加するときに定義されます。 |
[表 : 32. パラメーター]

{#api-data-resrc_id-save__table_fn1_vw3_n4b} {#api-data-resrc_id-save__table_gn1_vw3_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 33. 返される内容]

{#api-data-resrc_id-save__table_gn1_vw3_n4b}  
<br />

    api.data.gform.save();

## api - api.data.\<data_resource_id\>.setMandatory(オブジェクトペイロード) {#ariaid-title20}

指定したフォームフィールドが必須かどうかを設定します。
{#api-data-resrc_id-setMan_O__table_yws_2v3_n4b__entry__3}{#api-data-resrc_id-setMan_O__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| data_resource_id | 文字列 | 関連付けられたデータリソースの一意の識別子。 ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。 使用可能なデータリソースインスタンスは構成に依存し、 UI ビルダーでページにデータリソースを追加するときに定義されます。 |
| payload | オブジェクト | 必須情報を更新するフィールドを説明するオブジェクト。 "payload": { "fieldName": "String", "mandatory": Boolean } |
| payload.fieldName | 文字列 | 必須値が設定されているフォームフィールドの名前。 |
| payload.mandatory | ブーリアン | 指定されたフォームフィールドが必須であることを示すフラグ。つまり、このフィールドに有効な値が含まれていないとフォームを保存できません。 有効な値： * true:フィールドは必須です。 * false:フィールドはオプションです。 |
[表 : 34. パラメーター]

{#api-data-resrc_id-setMan_O__table_yws_2v3_n4b} {#api-data-resrc_id-setMan_O__table_zws_2v3_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 35. 返される内容]

{#api-data-resrc_id-setMan_O__table_zws_2v3_n4b}  
<br />

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

## api:api.data.\<data_resource_id\>.setReadOnly(オブジェクトペイロード) {#ariaid-title21}

指定されたフォームフィールドの読み取り/書き込み機能を設定します。
{#api-data-resrc_id-setReadOnly_O__table_d13_ps3_n4b__entry__3}{#api-data-resrc_id-setReadOnly_O__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| data_resource_id | 文字列 | 関連付けられたデータリソースの一意の識別子。 ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。 使用可能なデータリソースインスタンスは構成に依存し、 UI ビルダーでページにデータリソースを追加するときに定義されます。 |
| payload | オブジェクト | 読みやすさ情報を更新するフィールドを説明するオブジェクト。 "payload": { "fieldName": "String", "readonly": Boolean } |
| payload.fieldName | 文字列 | 読みやすさを設定するフォームフィールドの名前。 |
| payload.readonly | ブーリアン | 指定されたフォームフィールドの読み取り/書き込み機能を示すフラグ。 有効な値： * true:フィールドは読み取り専用です。 * false:フィールドは読み取り/書き込みです。 |
[表 : 36. パラメーター]

{#api-data-resrc_id-setReadOnly_O__table_d13_ps3_n4b} {#api-data-resrc_id-setReadOnly_O__table_e13_ps3_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 37. 返される内容]

{#api-data-resrc_id-setReadOnly_O__table_e13_ps3_n4b}  
<br />

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

## api -api.data.\<data_resource_id\>.setValue(オブジェクトペイロード) {#ariaid-title22}

指定された GlideForm フィールドを指定された値で更新します。必要に応じて、指定した同じ値で表示値を更新することもできます。
フォームの値のみが更新されます。値はデータベースに保存されません。
{#api-data-resrc_id-setValue_O__table_tyh_31d_n4b__entry__3}{#api-data-resrc_id-setValue_O__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| 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 | 文字列 | フィールドを更新する値。 |
[表 : 38. パラメーター]

{#api-data-resrc_id-setValue_O__table_tyh_31d_n4b} {#api-data-resrc_id-setValue_O__table_uyh_31d_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 39. 返される内容]

{#api-data-resrc_id-setValue_O__table_uyh_31d_n4b}  
<br />

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

## api:api.data.\<data_resource_id\>.setVisible(オブジェクトペイロード) {#ariaid-title23}

指定されたフォームフィールドのヴィジビリティを設定します。
{#api-data-resrc_id-setVisible_O__table_j5k_gr3_n4b__entry__3}{#api-data-resrc_id-setVisible_O__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| data_resource_id | 文字列 | 関連付けられたデータリソースの一意の識別子。 ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。 使用可能なデータリソースインスタンスは構成に依存し、 UI ビルダーでページにデータリソースを追加するときに定義されます。 |
| payload | オブジェクト | 可視化を設定するフィールドを説明するオブジェクト。 "payload": { "fieldName": "String", "visibility": Boolean } |
| payload.fieldName | 文字列 | ヴィジビリティを設定するフォームフィールドの名前。 |
| payload.visibility | ブーリアン | 関連付けられたフィールドが現在のフォーム上に表示されているかどうかを示すフラグ。 有効な値： * true:フィールドがフォームに表示されます。 * false:フィールドはフォームに表示されません。 |
[表 : 40. パラメーター]

{#api-data-resrc_id-setVisible_O__table_j5k_gr3_n4b} {#api-data-resrc_id-setVisible_O__table_k5k_gr3_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 41. 返される内容]

{#api-data-resrc_id-setVisible_O__table_k5k_gr3_n4b}  
<br />

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

## api:api.data.\<data_resource_id\>.showFieldMessage(オブジェクトペイロード) {#ariaid-title24}

指定されたフィールドの横に指定されたメッセージを表示します。
{#api-data-resrc_id-showFldMsg_O__table_o35_xgd_n4b__entry__3}{#api-data-resrc_id-showFldMsg_O__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| 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 | 文字列 | オプション。表示するメッセージのタイプ。 有効な値： * エラー * 情報 * 警告 デフォルト：Info |
[表 : 42. パラメーター]

{#api-data-resrc_id-showFldMsg_O__table_o35_xgd_n4b} {#api-data-resrc_id-showFldMsg_O__table_p35_xgd_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 43. 返される内容]

{#api-data-resrc_id-showFldMsg_O__table_p35_xgd_n4b}  
<br />

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

## api:api.data.\<data_resource_id\>.showRelatedList(オブジェクトペイロード) {#ariaid-title25}

現在のフォームに指定された関連リストを表示します。
{#api-data-resrc_id-showRelList_O__table_xc2_tn3_n4b__entry__3}{#api-data-resrc_id-showRelList_O__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| data_resource_id | 文字列 | 関連付けられたデータリソースの一意の識別子。 ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。 使用可能なデータリソースインスタンスは構成に依存し、 UI ビルダーでページにデータリソースを追加するときに定義されます。 |
| payload | オブジェクト | 表示する関連リストを説明するオブジェクト。 "payload": { "listTableName ": "String" } |
| payload.listTableName | 文字列 | 表示する関連リストの名前。表示するリストが関係を介して表示される場合は、名前の代わりにリストのsys_idを指定します。 テーブル:関連リスト \[sys_ui_related_list\] |
[表 : 44. パラメーター]

{#api-data-resrc_id-showRelList_O__table_xc2_tn3_n4b} {#api-data-resrc_id-showRelList_O__table_yc2_tn3_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 45. 返される内容]

{#api-data-resrc_id-showRelList_O__table_yc2_tn3_n4b}  
次のコード例は、このメソッドを呼び出す方法を示しています。

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

## api:api.data.\<data_resource_id\>.showRelatedLists() {#ariaid-title26}

現在のフォームに関連付けられているすべての関連リストを表示します。
{#api-data-resrc_id-showRelLists__table_wzd_sl3_n4b__entry__3}{#api-data-resrc_id-showRelLists__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| data_resource_id | 文字列 | 関連付けられたデータリソースの一意の識別子。 ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。 使用可能なデータリソースインスタンスは構成に依存し、 UI ビルダーでページにデータリソースを追加するときに定義されます。 |
[表 : 46. パラメーター]

{#api-data-resrc_id-showRelLists__table_wzd_sl3_n4b} {#api-data-resrc_id-showRelLists__table_xzd_sl3_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 47. 返される内容]

{#api-data-resrc_id-showRelLists__table_xzd_sl3_n4b}  
<br />

    api.data.gform.showRelatedLists();

## API:api.data.\<data_resource_id\>.submit() {#ariaid-title27}

指定された UI アクションを使用してフォーム送信をトリガーします。
{#api-data-resrc_id-submit_O__table_zc1_hx3_n4b__entry__3}{#api-data-resrc_id-submit_O__data_resource_id-entry-api}

| 名前 | タイプ | 説明 |
|-|-|-|
| data_resource_id | 文字列 | 関連付けられたデータリソースの一意の識別子。 ほとんどの場合、フォームコントローラー CTRL_RECORD#SAVE_FORM アクションを使用できます。レコードページにレコードページタブコンポーネントがある場合、このメソッドのデータリソースは GlideForm (g_form) に基づいている必要があります。 使用可能なデータリソースインスタンスは構成に依存し、 UI ビルダーでページにデータリソースを追加するときに定義されます。 |
| payload | オブジェクト | 現在のフォームの送信に使用する UI アクションを説明するオブジェクト。 "payload": { "submitActionName": "String" } |
| payload.submitActionName | 文字列 | 現在のフォームを送信するために実行する UI アクションの名前。 |
[表 : 48. パラメーター]

{#api-data-resrc_id-submit_O__table_zc1_hx3_n4b} {#api-data-resrc_id-submit_O__table_ad1_hx3_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 49. 返される内容]

{#api-data-resrc_id-submit_O__table_ad1_hx3_n4b}  
<br />

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

## api - api.emit(String eventName, Object payload) {#ariaid-title28}

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

イベントの詳細については、「 [イベントの操作](https://www.servicenow.com/docs/access?context=work-events&version=australia&pubname=australia-application-development&ft:locale=en-US)」を参照してください。
{#api-emit_S_O__table_yyz_njj_n4b__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| eventName | 文字列 | 発行するイベントの名前。この名前は、UI フレームワークのアクション命名ガイドラインに従う必要があります。 * ITEM_CHANGEDなどのアッパースネークケースにする必要があります。すべての文字は大文字で、すべてのスペースはアンダースコアに置き換えられます。 * BUTTON_CLICKED や USER_SELECTED などの過去形にする必要があります。 {#api-emit_S_O__ul_xgx_cgk_n4b} これらのアクション命名ガイドラインの詳細については、「 <https://developer.servicenow.com/dev.do#!/reference/now-experience/sandiego/ui-framework/main-concepts/dispatching-actions>」を参照してください。 |
| payload | オブジェクト | オプション。発行されたイベントとともに送信するデータを含むオブジェクト。このオブジェクトは自由形式であり、データを受け取るエンティティが必要とするすべてのデータを含めることができます。 注: プリミティブタイプのペイロードは機能しますが、一貫性のない動作が発生する可能性があります。 |
[表 : 50. パラメーター]

{#api-emit_S_O__table_yyz_njj_n4b} {#api-emit_S_O__table_zyz_njj_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 51. 返される内容]

{#api-emit_S_O__table_zyz_njj_n4b}  
次のコード例は、関連付けられた 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, 任意の値) {#ariaid-title29}

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

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

| 名前 | タイプ | 説明 |
|-|-|-|
| stateParm | 文字列 | 更新するクライアントステータスパラメーターの名前。この名前は、関連するページのクライアントステータスパラメーターで宣言する必要があります。 クライアント状態パラメーターの宣言の詳細については、「 [クライアント状態パラメーターの操作](https://www.servicenow.com/docs/access?context=state-parameters&version=australia&pubname=australia-application-development&ft:locale=en-US)」を参照してください。 |
| value | 任意:クライアントステータスパラメーターの宣言と同じである必要があります。 | 指定されたクライアントステータスパラメーターを設定する値。 |
[表 : 52. パラメーター]

{#api-setState_S_A__table_lgw_35q_n4b} {#api-setState_S_A__table_mgw_35q_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 53. 返される内容]

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

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

## api - setState(文字列 stateParam, 関数 callbackFn) {#ariaid-title30}

指定されたクライアントステータスパラメーターの値を、指定されたコールバック関数によって返された値に設定します。
コールバック関数は、 currentValue と api の 2 つのプロパティを持つオブジェクトで呼び出されます。この関数は、 currentValue プロパティまたは api オブジェクトを直接変更しないでください。

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

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

| 名前 | タイプ | 説明 |
|-|-|-|
| stateParm | 文字列 | 更新するクライアントステータスパラメーターの名前。この名前は、関連するページのクライアントステータスパラメーターで宣言する必要があります。 クライアント状態パラメーターの宣言の詳細については、「 [クライアント状態パラメーターの操作](https://www.servicenow.com/docs/access?context=state-parameters&version=australia&pubname=australia-application-development&ft:locale=en-US)」を参照してください。 |
| コールバックFn | 関数 | 値を取得するために実行するコールバック関数。 |
[表 : 54. パラメーター]

{#api-setState_S_F__table_vlt_gyq_n4b} {#api-setState_S_F__table_wlt_gyq_n4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 55. 返される内容]

{#api-setState_S_F__table_wlt_gyq_n4b}  
この例では、 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\> {#ariaid-title31}

指定されたクライアントステータスパラメーターの現在の値。
{#api-state__table_yk3_rmb_n4b__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| \<client_state_parameter_name\> | 任意。使用可能なクライアントステータスパラメーターは、ページ構成によって異なります。 | クライアントステータスパラメーターの名前。使用可能なクライアントステータスは、クライアントスクリプトの実装によって異なります。 利用可能なクライアント状況にアクセスするには、 `api.state.<client_state_name>` を使用します。 例： function showRelatedLists({api}) { return !api.state.isCustomListSelected; } 注: これらのプロパティ値は読み取り専用です。クライアントステータスパラメーターを更新するには、 [api.setState()](https://servicenow-prod.fluidtopics.net/ufjpPh~Zf~SM0CrnjqS1Hg#api-setState_S_A "指定されたクライアントステータスパラメーターの値を設定します。") を使用します。スクリプトからのネストされたオブジェクト値の変更はサポートされていません。 |
[表 : 56. フィールド]

{#api-state__table_yk3_rmb_n4b}