---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# CatCategory - スコープ対象

# CatCategory - スコープ対象 {#ariaid-title1}

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

CatCategory API は、スクリプトを使用してサービスカタログカテゴリを作成および変更できるメソッドを提供します。

この API は `sn_sc` 名前空間で実行されます。  
重要:  
この API はアクセス可能です。ただし、推奨される実装は [サービスカタログ REST API](https://servicenow-prod.fluidtopics.net/i~jwK2RKaw9780fWq3gs8w#c_ServiceCatalogAPI "サービスカタログ API は、サービスポータル内からサービスカタログ設定とアクションにアクセスするエンドポイントを提供します。") です。

## CatCategory - availableForUserCriteria(文字列 action, アレイ criteriaIDs) {#ariaid-title2}

Available For ユーザー基準を現在のカタログカテゴリに追加します。
{#r_CCS-availableForUserCriteria_S_A__table_oz2_pln_vz__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| action | 文字列 | 実行するアクション。 * <kbd class="ph userinput">add</kbd>：ユーザー基準を \[利用可能\] リストに追加します。 * <kbd class="ph userinput">delete</kbd>：ユーザー基準を \[利用可能\] リストから削除します。 {#r_CCS-availableForUserCriteria_S_A__ul_gc4_bs4_kpb} |
| criteriaIDs | アレイ | ユーザー基準 sys_id のアレイ |
[表 : 1. パラメーター]

{#r_CCS-availableForUserCriteria_S_A__table_oz2_pln_vz} {#r_CCS-availableForUserCriteria_S_A__table_pz2_pln_vz__entry__2}

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

{#r_CCS-availableForUserCriteria_S_A__table_pz2_pln_vz}  

    var item = new sn_sc.CatCategory("31bea3d53790200044e0bfc8bcbe5dec");
    item.availableForUserCriteria("add", ["0c441abbc6112275000025157c651c89"]);

## CatCategory - canView(ブール isMobile, 文字列 userSysId) {#ariaid-title3}

指定されたユーザーが指定されたカテゴリをモバイルデバイスまたはデスクトップで表示できるかどうかを決定します。
{#CCS-canView_B_S__table_j5n_smk_chb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| isMobile | ブーリアン | モバイルデバイスまたはデスクトップでユーザーのアクセスを検証するかどうかを示すフラグ。 * true：モバイルで検証します。 * false：デスクトップで検証します。 |
| userSysId | 文字列 | 検証するユーザーの sys_id。 |
[表 : 3. パラメーター]

{#CCS-canView_B_S__table_j5n_smk_chb} {#CCS-canView_B_S__table_k5n_smk_chb__entry__2}

| タイプ | 説明 |
|-|-|
| ブーリアン | ユーザーが関連するカテゴリを表示できるかどうかを示すフラグ。 * true：ユーザーはカテゴリを表示できます。 * false：ユーザーはカテゴリを表示できません。 {#CCS-canView_B_S__ul_iwk_ynk_chb} |
[表 : 4. 返される内容]

{#CCS-canView_B_S__table_k5n_smk_chb}  

    var scopedCategoryObj = new sn_sc.CatCategory('7b1262b9530033007444ddeeff7b12ae');
    scopedCategoryObj.canView(false, '62826bf03710200044e0bfc8bcbe5df1');

## CatCategory - create(ブール standardUpdate) {#ariaid-title4}

定義されたカテゴリを挿入します。
{#r_CatCategory-create_Boolean__table_afn_1b2_ns__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| standardUpdate | ブーリアン | エンジンとワークフローの実行を有効にするかどうかを示すフラグです。 有効な値： * true：エンジンとワークフローを有効にします。 * false：エンジンとワークフローを有効にしません。 {#r_CatCategory-create_Boolean__ul_nnx_xwn_kpb} |
[表 : 5. パラメーター]

{#r_CatCategory-create_Boolean__table_afn_1b2_ns} {#r_CatCategory-create_Boolean__table_bfn_1b2_ns__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | 挿入された変数レコードの sys_id です。 |
[表 : 6. 返される内容]

{#r_CatCategory-create_Boolean__table_bfn_1b2_ns}  

    var categoryCreate = new sn_sc.CatCategory();
    categoryCreate.setAttributes({"title" : "test a scoped category", "sc_catalog" : "e0d08b13c3330100c8b837659bba8fb4"});
    var categorySysId = categoryCreate.create();
    var isValidSysId = categorySysId.match(/^[0-9a-fA-F]{32}$/) == null ? false : true;
    global.Assert.assertEquals(true, isValidSysId,"CategorySysId: ["+ categorySysId +"] is not valid", true, isValidSysId);

## CatCategory - deleteRecord(ブール standardUpdate) {#ariaid-title5}

CatCategory クラスが最初にインスタンス化されたカテゴリレコードを削除します。
{#r_CatCategory-deleteRecord_Boolean__table_xzp_4b2_ns__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| standardUpdate | ブーリアン | エンジンとワークフローの実行を有効にするかどうかを示すフラグです。 有効な値： * true：エンジンとワークフローを有効にします。 * false：エンジンとワークフローを有効にしません。 {#r_CatCategory-deleteRecord_Boolean__ul_nnx_xwn_kpb} |
[表 : 7. パラメーター]

{#r_CatCategory-deleteRecord_Boolean__table_xzp_4b2_ns} {#r_CatCategory-deleteRecord_Boolean__table_yzp_4b2_ns__entry__2}

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

{#r_CatCategory-deleteRecord_Boolean__table_yzp_4b2_ns}  

    var categoryDelete = new sn_sc.CatCategory(categorySysId);
    categoryDelete.deleteRecord();
    var category = new sn_sc.CatCategory(categorySysId);
    values = category.read({"title" : "", "sc_catalog":""}, false);
    global.Assert.assertEquals("", values.title,"Category should title");

## CatCategory - getID() {#ariaid-title6}

現在のカテゴリの sys_id を返します。
{#CCS-getID__table_db4_h4d_sbb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 9. パラメーター]

{#CCS-getID__table_db4_h4d_sbb} {#CCS-getID__table_eb4_h4d_sbb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | 現在のカテゴリの sys_id。 |
[表 : 10. 返される内容]

{#CCS-getID__table_eb4_h4d_sbb}  
例：

    var cart = new sn_sc.CatCategory("2809952237b1300054b6a3549dbe5dd4");
    var categoryID = cart.getID();
    gs.info(categoryID);

出力：

    2809952237b1300054b6a3549dbe5dd4

## CatCategory - notAvailableForUserCriteria(文字列 action, アレイ\[\] criteriaIDs) {#ariaid-title7}

Not Available For ユーザー基準を現在のカタログカテゴリに追加します。
{#r_CCS-notAvailableForUserCriteria_S_A__table_yxb_1mn_vz__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| action | 文字列 | 実行するアクション。 * <kbd class="ph userinput">add</kbd>：ユーザー基準を \[利用不可\] リストに追加します。 * <kbd class="ph userinput">delete</kbd>：ユーザー基準を \[利用不可\] リストから削除します。 {#r_CCS-notAvailableForUserCriteria_S_A__ul_gc4_bs4_kpb} |
[表 : 11. パラメーター]

{#r_CCS-notAvailableForUserCriteria_S_A__table_yxb_1mn_vz} {#r_CCS-notAvailableForUserCriteria_S_A__table_zxb_1mn_vz__entry__2}

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

{#r_CCS-notAvailableForUserCriteria_S_A__table_zxb_1mn_vz}  

    var item = new sn_sc.CatCategory("31bea3d53790200044e0bfc8bcbe5dec");
    item. notAvailableForUserCriteria("add", ["0c441abbc6112275000025157c651c89"]);

## CatCategory - read(オブジェクト columns, ブール standardUpdate) {#ariaid-title8}

カテゴリのマッピングを返します。
{#r_CatCategory-read_Object_Boolean__table_p2h_5b2_ns__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| 列 | オブジェクト | 値を希望する列のセットです。 |
| standardUpdate | ブーリアン | エンジンとワークフローの実行を有効にするかどうかを示すフラグです。 有効な値： * true：エンジンとワークフローを有効にします。 * false：エンジンとワークフローを有効にしません。 {#r_CatCategory-read_Object_Boolean__ul_nnx_xwn_kpb} |
[表 : 13. パラメーター]

{#r_CatCategory-read_Object_Boolean__table_p2h_5b2_ns} {#r_CatCategory-read_Object_Boolean__table_q2h_5b2_ns__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | 列名と値のマッピング。 |
[表 : 14. 返される内容]

{#r_CatCategory-read_Object_Boolean__table_q2h_5b2_ns}  

    var category = new sn_sc.CatCategory("a96277509f300200b407b89a442e704e");
    var values = category.read({"title" : ""}, true);
    gs.log(values.title);

## CatCategory - setAttributes(オブジェクト attributes) {#ariaid-title9}

このカテゴリの属性値を定義します。
{#r_CatCategory-setAttributes_Object__table_psn_512_ns__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| 属性 | オブジェクト | 新しいフィールドと値のペアの属性。 |
[表 : 15. パラメーター]

{#r_CatCategory-setAttributes_Object__table_psn_512_ns} {#r_CatCategory-setAttributes_Object__table_qsn_512_ns__entry__2}

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

{#r_CatCategory-setAttributes_Object__table_qsn_512_ns}  

    var categoryCreate = new sn_sc.CatCategory();
    categoryCreate.setAttributes({"title" : "test a scoped category", "sc_catalog" : "e0d08b13c3330100c8b837659bba8fb4"});
    var categorySysId = categoryCreate.create();
    var isValidSysId = categorySysId.match(/^[0-9a-fA-F]{32}$/) == null ? false : true;
    global.Assert.assertEquals(true, isValidSysId,"CategorySysId: ["+ categorySysId +"] is not valid", true, isValidSysId);

## CatCategory - setTableName(文字列 tableName) {#ariaid-title10}

このカテゴリのテーブル名を定義します。
{#r_CatCategory-setTableName_String__table_vh4_3dl_qs__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| tableName | 文字列 | sc_category を拡張するテーブルの名前。 |
[表 : 17. パラメーター]

{#r_CatCategory-setTableName_String__table_vh4_3dl_qs} {#r_CatCategory-setTableName_String__table_wh4_3dl_qs__entry__2}

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

{#r_CatCategory-setTableName_String__table_wh4_3dl_qs}  

    var categoryRead = new sn_sc.CatCategory(categorySysId);
    categoryRead.setTableName("test_category");
    var values = categoryRead.read({"title" : "", "sc_catalog":"", "test": ""}, false);
    gs.info(categorySysId);
    gs.info(values.title);
    gs.info(values.test);
    global.Assert.assertEquals("testValue", values.test,"Category extends sc_category and stores its extended value");

## CatCategory - update(オブジェクト columnValues, ブール standardUpdate) {#ariaid-title11}

現在のカテゴリを指定された名前/値ペアで更新します。
{#r_CatCategory-update_Object_Boolean__table_dfz_fb2_ns__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| columnValues | オブジェクト | 列名と値のマッピング。 |
| standardUpdate | ブーリアン | エンジンとワークフローの実行を有効にするかどうかを示すフラグです。 有効な値： * true：エンジンとワークフローを有効にします。 * false：エンジンとワークフローを有効にしません。 {#r_CatCategory-update_Object_Boolean__ul_nnx_xwn_kpb} |
[表 : 19. パラメーター]

{#r_CatCategory-update_Object_Boolean__table_dfz_fb2_ns} {#r_CatCategory-update_Object_Boolean__table_efz_fb2_ns__entry__2}

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

{#r_CatCategory-update_Object_Boolean__table_efz_fb2_ns}  

    var categoryUpdate = new sn_sc.CatCategory(categorySysId);
    categoryUpdate.update({"title" : "test changed scoped category"}, true);
    values = categoryUpdate.read({"title" : "", "sc_catalog":""}, false);
    global.Assert.assertEquals("test changed scoped category", values.title,"Category should title");