---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://www.servicenow.com/docs/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# PSBPublicAPIUtil - スコープ指定、グローバル

# PSBPublicAPIUtil - スコープ指定、グローバル {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：8分

PSBPublicAPIUtil スクリプトインクルードは、サービスブリッジ構成レコードに対して操作を実行できるようにするメソッドを提供します。  
このスクリプトインクルードを使用して操作を実行できる サービスブリッジ 設定レコードには、次の 2 つのタイプがあります。

* リモートレコードプロデューサー (RRP)
* リモートタスク定義 (RTD)

これらの設定レコードに対して、次のいずれかの サービスブリッジ 操作を実行できます。

* チェックアウト:指定された設定レコードのドラフトバージョンを作成します。公開済みのバージョンは引き続き使用できます。
* 公開:指定された設定レコードのドラフトバージョンを公開し、顧客が使用できるようにします。
* アーカイブ:指定された設定レコードの非アクティブなバージョンをアーカイブし、顧客が利用できないようにします。
* 廃止:指定された設定レコードのすべてのバージョンを廃止し、顧客が利用できないようにします。

サービスブリッジ設定レコードの詳細については、「[Create configuration revisions](https://www.servicenow.com/docs/access?context=service-bridge-v2-create-config-rev&version=xanadu&pubname=xanadu-service-exchange&ft:locale=en-US)」を参照してください。

この API にアクセスするには、 サービスブリッジ for Providers アプリケーション (sn_sb_pro) と サービスブリッジ Base (sn_sb) をインスタンスにインストールする必要があります。

この API のメソッドは、 sb スクリプトインクルードを使用して呼び出します。ただし、これらのメソッドのコードは PSBPublicAPIUtil スクリプト インクルードに存在します。  
これらのメソッドをグローバルスコープから呼び出す場合は、次の構文を使用します。

    sb.checkout(glideRecord);
    sb.publish(glideRecord);
    sb.archive(glideRecord);
    sb.retire(glideRecord);

スコープ対象のアプリケーションから呼び出す場合は、次の構文を使用します。

    global.sb.checkout(glideRecord);
    global.sb.publish(glideRecord);
    global.sb.archive(glideRecord);
    global.sb.retire(glideRecord);

## PSBPublicAPIUtil - archive(glideRecord) {#ariaid-title2}

指定された GlideRecord が有効な サービスブリッジ 設定レコードであることを検証し、レコードが「非アクティブ」ステータスであることを確認します。この検証に合格すると、指定された設定レコードがアーカイブされ、同じ設定レコードの他のすべてのバージョンは変更されません。
構成リビジョンとそれに関連する状態の詳細については、「 [Create configuration revisions](https://www.servicenow.com/docs/access?context=service-bridge-v2-create-config-rev&version=xanadu&pubname=xanadu-service-exchange&ft:locale=en-US)」を参照してください。
{#PSBPubUtil-archive_GR__table_wlx_2cn_zbc__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| glideRecord | GlideRecord | アーカイブする設定レコード。 このレコードは次のいずれかになります。 * リモートレコードプロデューサー (RRP):リモートレコードプロデューサー \[sn_sb_pro_remote_record_producer\] テーブルにあるレコード。 * リモートタスク定義 (RTD):リモートタスク定義 \[sn_sb_pro_remote_task_def\] テーブルにあるレコード。 |
[表 : 1. パラメーター]

{#PSBPubUtil-archive_GR__table_wlx_2cn_zbc} {#PSBPubUtil-archive_GR__table_xlx_2cn_zbc__entry__2}

| タイプ | 説明 |
|-|-|
| ブール | 設定レコードがアーカイブされたかどうかを示すフラグ。 可能な値： * true:設定レコードがアーカイブされました。 * false:エラーが発生しました。設定レコードがアーカイブされませんでした。 |
[表 : 2. 返される内容]

{#PSBPubUtil-archive_GR__table_xlx_2cn_zbc}  
次のコード例は、FDS 設定レコードのグローバルスコープからこのメソッドを呼び出す方法を示しています。

    var grConfig = new GlideRecord('sn_sb_pro_remote_record_producer'); // Configuration table that contains the desired record 
    grConfig.get('0ed11101ff6aca10c1befe258c4fd99e'); // Sys_id of the configuration record to publish
    var isExecuted = sb.archive(grConfig);

## PSBPublicAPIUtil - checkout(glideRecord) {#ariaid-title3}

指定された GlideRecord が有効な サービスブリッジ 設定レコードであることを検証し、レコードが「公開済み」ステータスであることを確認します。この検証に合格すると、指定された設定レコードの新しいバージョンが作成され、ステータスフィールドが「ドラフト」に設定されます。
{#PSBPubUtil-checkout_GR__table_x5b_yxm_zbc__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| glideRecord | GlideRecord | チェックアウトする設定レコード。 このレコードは次のいずれかになります。 * リモートレコードプロデューサー (RRP):リモートレコードプロデューサー \[sn_sb_pro_remote_record_producer\] テーブルにあるレコード。 * リモートタスク定義 (RTD):リモートタスク定義 \[sn_sb_pro_remote_task_def\] テーブルにあるレコード。 |
[表 : 3. パラメーター]

{#PSBPubUtil-checkout_GR__table_x5b_yxm_zbc} {#PSBPubUtil-checkout_GR__table_y5b_yxm_zbc__entry__2}

| タイプ | 説明 |
|-|-|
| GlideRecord | 成功した場合、ステータスフィールドが「ドラフト」に設定された、新しく作成された設定レコードを返します。 エラーが発生した場合は、null を返します。 |
[表 : 4. 返される内容]

{#PSBPubUtil-checkout_GR__table_y5b_yxm_zbc}  
次のコード例は、RTD 設定レコードのグローバルスコープからこのメソッドを呼び出す方法を示しています。

    var grConfig = new GlideRecord('sn_sb_pro_remote_task_def'); // Configuration table that contains the desired record 
    grConfig.get('0ed11101ff6aca10c1befe258c4fd99e'); // Sys_id of the configuration record to checkout
    var checkoutGr = sb.checkout(grConfig);

## PSBPublicAPIUtil - publish(glideRecord) {#ariaid-title4}

指定された GlideRecord が有効な サービスブリッジ 設定レコードであることを検証し、レコードが「ドラフト」ステータスであることを確認します。この検証に合格すると、設定レコードのドラフトバージョンを公開します。
{#PSBPubUtil-publish_GR__table_mqz_mbn_zbc__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| glideRecord | GlideRecord | 公開する設定レコード。 このレコードは次のいずれかになります。 * リモートレコードプロデューサー (RRP):リモートレコードプロデューサー \[sn_sb_pro_remote_record_producer\] テーブルにあるレコード。 * リモートタスク定義 (RTD):リモートタスク定義 \[sn_sb_pro_remote_task_def\] テーブルにあるレコード。 |
[表 : 5. パラメーター]

{#PSBPubUtil-publish_GR__table_mqz_mbn_zbc} {#PSBPubUtil-publish_GR__table_nqz_mbn_zbc__entry__2}

| タイプ | 説明 |
|-|-|
| ブール | 設定レコードが公開されたかどうかを示すフラグ。 可能な値： * true:設定レコードが公開されました。 * false:エラーが発生しました。設定レコードは公開されませんでした。 |
[表 : 6. 返される内容]

{#PSBPubUtil-publish_GR__table_nqz_mbn_zbc}  
次のコード例は、RRP 設定レコードのグローバルスコープからこのメソッドを呼び出す方法を示しています。

    var grConfig = new GlideRecord('sn_sb_pro_remote_record_producer''); // Configuration table that contains the desired record 
    grConfig.get('0ed11101ff6aca10c1befe258c4fd99e'); // Sys_id of the configuration record to publish
    var isExecuted = sb.publish(grConfig);

## PSBPublicAPIUtil - retire(glideRecord) {#ariaid-title5}

指定された GlideRecord が有効な サービスブリッジ 設定レコードであることを確認し、レコードが有効なステータスであることを検証します。この検証に合格すると、指定されたバージョンの構成レコードを、同じ構成情報レコードの他のすべてのリビジョンとともに廃止します。
構成リビジョンとそれに関連する状態の詳細については、「 [Create configuration revisions](https://www.servicenow.com/docs/access?context=service-bridge-v2-create-config-rev&version=xanadu&pubname=xanadu-service-exchange&ft:locale=en-US)」を参照してください。
{#PSBPubUtil-retire_GR__table_kqj_hcn_zbc__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| glideRecord | GlideRecord | 廃止する設定レコード。 このレコードは次のいずれかになります。 * リモートレコードプロデューサー (RRP):リモートレコードプロデューサー \[sn_sb_pro_remote_record_producer\] テーブルにあるレコード。 * リモートタスク定義 (RTD):リモートタスク定義 \[sn_sb_pro_remote_task_def\] テーブルにあるレコード。 |
[表 : 7. パラメーター]

{#PSBPubUtil-retire_GR__table_kqj_hcn_zbc} {#PSBPubUtil-retire_GR__table_lqj_hcn_zbc__entry__2}

| タイプ | 説明 |
|-|-|
| ブール | 設定レコードが廃止されたかどうかを示すフラグ。 可能な値： * true:設定レコードは廃止されました。 * false:エラーが発生しました。構成レコードは廃止されませんでした。 |
[表 : 8. 返される内容]

{#PSBPubUtil-retire_GR__table_lqj_hcn_zbc}  
次のコード例は、RTD 設定レコードのグローバルスコープからこのメソッドを呼び出す方法を示しています。

    var grConfig = new GlideRecord('sn_sb_pro_remote_task_def'); // Configuration table that contains the desired record 
    grConfig.get('0ed11101ff6aca10c1befe258c4fd99e'); // Sys_id of the configuration record to checkout
    var isExecuted = sb.retire(grConfig);