---
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


---

# DocumentListService - スコープ付き、グローバル

# DocumentListService - スコープ付き、グローバル {#ariaid-title1}

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

DocumentListService API には、ドキュメント リストを作成、削除、および更新するためのメソッドが用意されています。

この API は、ドキュメント管理 プラグイン (com.snc.platform_document_management) を必要とし、`sn_doc_services` 名前空間内で提供されます。詳細については、「 [ドキュメントサービス](https://www.servicenow.com/docs/access?context=document-services-landing-page&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)」を参照してください。  
ドキュメント管理 プラグインは、ドキュメントに関連付けるドキュメントテンプレートのリストの作成もサポートしています。たとえば、卒業証書、ID、パスポートなどの複数のドキュメントを必要とするジョブアプリケーションなどです。ドキュメントリストを追加した後、ドキュメントテンプレートを追加できます。

* [SystemDocumentListEntry](https://servicenow-prod.fluidtopics.net/a2_LL_eYMqwRoRiT~XoM4g#SystemDocumentListEntryBothAPI "SystemDocumentListEntry API は、ドキュメントリストエントリ [ds_document_list_entry] テーブルのレコードフィールドを設定するためのメソッドを提供します。")：ドキュメントテンプレートのリストエントリを定義します。
* [DocumentListEntryService](https://servicenow-prod.fluidtopics.net/n31PAATCbkZSy8P6hdvv7w#DocumentListEntryServiceBothAPI "DocumentListEntryService API は、ドキュメント リスト内のドキュメント テンプレートを管理するためのメソッドを提供します。")：ドキュメントテンプレートのリストエントリを追加または削除します。
{#DocumentListServiceBothAPI__ul_asn_gjg_vpb}  
ドキュメントをテンプレートとして定義するには：

* [SystemDocument -- template()](https://servicenow-prod.fluidtopics.net/VhrceQ0QXZOrY2vijOLXIg#SystemDoc-template_S "ドキュメントレコードがテンプレートかどうかを指定します。") メソッドを true に設定するドキュメントオブジェクトを定義します。[DocumentService](https://servicenow-prod.fluidtopics.net/cVXg531rqJmBPmSMZyK63g#DocumentServiceBothAPI "DocumentService API は、ドキュメントを作成、削除、および更新するためのメソッドを提供します。") API のメソッドを使用して、ドキュメントレコードを作成または更新します。
* ドキュメント \[ds_document\] テーブルのドキュメントの \[テンプレート\] チェックボックスをオンにします。
{#DocumentListServiceBothAPI__ul_b12_5zv_wpb}  
次の API を使用すると、ドキュメントを定義および管理できます。

* [SystemDocument](https://servicenow-prod.fluidtopics.net/VhrceQ0QXZOrY2vijOLXIg#SystemDocumentBothAPI "SystemDocument API は、ドキュメント [ds_document] テーブルのレコードのフィールドを設定するためのメソッドを提供します。") -- ドキュメントオブジェクトを定義します。
* [DocumentService](https://servicenow-prod.fluidtopics.net/cVXg531rqJmBPmSMZyK63g#DocumentServiceBothAPI "DocumentService API は、ドキュメントを作成、削除、および更新するためのメソッドを提供します。") -- ドキュメントを追加、更新、または削除します。
{#DocumentListServiceBothAPI__ul_krc_vmf_vpb}  
ドキュメントをテンプレートとして定義するには：

* [SystemDocument -- template()](https://servicenow-prod.fluidtopics.net/VhrceQ0QXZOrY2vijOLXIg#SystemDoc-template_S "ドキュメントレコードがテンプレートかどうかを指定します。") メソッドを true に設定するドキュメントオブジェクトを定義します。[DocumentService](https://servicenow-prod.fluidtopics.net/cVXg531rqJmBPmSMZyK63g#DocumentServiceBothAPI "DocumentService API は、ドキュメントを作成、削除、および更新するためのメソッドを提供します。") API のメソッドを使用して、ドキュメントレコードを作成または更新します。
* ドキュメント \[ds_document\] テーブルのドキュメントの \[テンプレート\] チェックボックスをオンにします。
{#DocumentListServiceBothAPI__d3455e143}

「[SystemDocumentList](https://servicenow-prod.fluidtopics.net/3XQTJI78G05ln9oFHteRDA#SystemDocumentListBothAPI "SystemDocumentList API は、ドキュメントリスト [ds_document_lists] テーブルのレコードフィールドを設定するためのメソッドを提供します。")」も参照してください。

## DocumentListService - DocumentListService() {#ariaid-title2}

DocumentListService オブジェクトをインスタンス化します。
{#DLS-DocumentListService__table_zw5_mcg_tpb__entry__3}

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

{#DLS-DocumentListService__table_zw5_mcg_tpb}  
次の例は、DocumentListService オブジェクトをインスタンス化する方法を示しています。「[SystemDocumentList](https://servicenow-prod.fluidtopics.net/3XQTJI78G05ln9oFHteRDA#SystemDocumentListBothAPI "SystemDocumentList API は、ドキュメントリスト [ds_document_lists] テーブルのレコードフィールドを設定するためのメソッドを提供します。")」も参照してください。

    var s = new sn_doc_services.DocumentListService();

## DocumentListService - createDocumentList(SystemDocumentList doc) {#ariaid-title3}

ドキュメントリスト \[ds_document_lists\] テーブル内にドキュメントリストを作成します。
ドキュメント管理 プラグインは、ドキュメントに関連付けるドキュメントテンプレートのリストの作成もサポートしています。たとえば、卒業証書、ID、パスポートなどの複数のドキュメントを必要とするジョブアプリケーションなどです。ドキュメントリストを追加した後、ドキュメントテンプレートを追加できます。

* [SystemDocumentListEntry](https://servicenow-prod.fluidtopics.net/a2_LL_eYMqwRoRiT~XoM4g#SystemDocumentListEntryBothAPI "SystemDocumentListEntry API は、ドキュメントリストエントリ [ds_document_list_entry] テーブルのレコードフィールドを設定するためのメソッドを提供します。")：ドキュメントテンプレートのリストエントリを定義します。
* [DocumentListEntryService](https://servicenow-prod.fluidtopics.net/n31PAATCbkZSy8P6hdvv7w#DocumentListEntryServiceBothAPI "DocumentListEntryService API は、ドキュメント リスト内のドキュメント テンプレートを管理するためのメソッドを提供します。")：ドキュメントテンプレートのリストエントリを追加または削除します。
{#DLS-createDocumentList_O__ul_asn_gjg_vpb}

[createDocumentsFromList()](https://servicenow-prod.fluidtopics.net/60MUr2gGh3_47C0sfOPlpw#DLS-createDocumentsFromList_S_S_S "ドキュメントテンプレートのリストからドキュメントを作成します。") メソッドを使用して、ドキュメントテンプレートリストからドキュメントを作成します。
{#DLS-createDocumentList_O__table_w4z_2cg_tpb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| doc | [SystemDocumentList](https://servicenow-prod.fluidtopics.net/3XQTJI78G05ln9oFHteRDA#SystemDocumentListBothAPI "SystemDocumentList API は、ドキュメントリスト [ds_document_lists] テーブルのレコードフィールドを設定するためのメソッドを提供します。") | 新しいレコードのフィールドを表す 1 つ以上のプロパティです。名前プロパティは必須であり、SystemDocumentList コンストラクタまたは name() メソッドを使用して設定できます。 |
[表 : 2. パラメーター]

{#DLS-createDocumentList_O__table_w4z_2cg_tpb} {#DLS-createDocumentList_O__table_tj4_p5j_34b__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | ドキュメントリスト \[ds_document_lists\] テーブルの新しいレコードの sys_id と成功メッセージです。それ以外の場合はエラーメッセージ。 { "message": "String", "request_id": "String", "status": "String" } |
| \<Object\>.message | 成功またはエラーを確認するメッセージ。 データタイプ：文字列 |
| \<Object\>.request_id | ドキュメントリスト \[ds_document_lists\] テーブルのレコードの sys_id。 データタイプ：文字列 |
| \<Object\>.status | 操作が成功したかどうかを示すステータス。 可能な値： * success - 操作は成功しました。 * failure -- 操作は成功しませんでした。message は詳細を示します。 {#DLS-createDocumentList_O__ul_rlv_5cv_j4b} データタイプ：文字列 |
[表 : 3. 返される内容]

{#DLS-createDocumentList_O__table_tj4_p5j_34b}  
次の例は、ドキュメントリストを作成する方法を示しています。「[SystemDocumentList](https://servicenow-prod.fluidtopics.net/3XQTJI78G05ln9oFHteRDA#SystemDocumentListBothAPI "SystemDocumentList API は、ドキュメントリスト [ds_document_lists] テーブルのレコードフィールドを設定するためのメソッドを提供します。")」も参照してください。

    var dL = new sn_doc_services.SystemDocumentList('My document list');

    // Define the document list field
    dL.description('description');

    var docList = new sn_doc_services.DocumentListService();
    gs.info(JSON.stringify(docList.createDocumentList(dL), null, 2));

出力：

    {
      "message": "Create List for the given name : My document list, List sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
      "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
      "status": "success"
    }

## DocumentListService - createDocumentsFromList(文字列 listSysId, 文字列 tableName, 文字列 tableSysId) {#ariaid-title4}

ドキュメントテンプレートのリストからドキュメントを作成します。
注:  
このメソッドを使用する前に、[createDocumentList()](https://servicenow-prod.fluidtopics.net/60MUr2gGh3_47C0sfOPlpw#DLS-createDocumentList_O "ドキュメントリスト [ds_document_lists] テーブル内にドキュメントリストを作成します。") メソッドを使用してドキュメントテンプレートリストを作成します。
{#DLS-createDocumentsFromList_S_S_S__table_w4z_2cg_tpb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| listSysId | 文字列 | ドキュメントリスト \[ds_document_lists\] テーブルのドキュメントリストレコードの sys_id。 |
| tableName | 文字列 | ドキュメントテンプレート参照のリストの追加元のレコードを含むテーブルの名前です。 |
| tableSysId | 文字列 | ドキュメントテンプレート参照のリストを追加するコンテンツを含むレコードの sys_id です。 |
[表 : 4. パラメーター]

{#DLS-createDocumentsFromList_S_S_S__table_w4z_2cg_tpb} {#DLS-createDocumentsFromList_S_S_S__table_tj4_p5j_34b__entry__2}{#DLS-createDocumentsFromList_S_S_S__ph-docserv-ret-obj-basic}{#DLS-createDocumentsFromList_S_S_S__row_pdfgen_ret_msgCnv}

| タイプ | 説明 |
|-|-|
| オブジェクト | 成功またはエラーメッセージ。 { "message": "String", "request_id": "String", "status": "String" } {#DLS-createDocumentsFromList_S_S_S__api_docserv_codeblock_dets} |
| \<Object\>.message | ドキュメントリスト内のドキュメントテンプレートの数を含むメッセージです。 データタイプ：文字列 |
| \<Object\>.request_id | ドキュメントリスト \[ds_document_lists\] テーブルのレコードの sys_id。 データタイプ：文字列 |
| \<Object\>.status | 操作が成功したかどうかを示すステータス。 可能な値： * success - 操作は成功しました。 * failure -- 操作は成功しませんでした。message は詳細を示します。 {#DLS-createDocumentsFromList_S_S_S__ul_rlv_5cv_j4b} データタイプ：文字列 |
[表 : 5. 返される内容]

{#DLS-createDocumentsFromList_S_S_S__table_tj4_p5j_34b}  
次の例は、ドキュメントテンプレート参照のリストをレコードに追加する方法を示しています。ドキュメントは、インシデント \[incident\] テーブルのレコードに追加されます。

    var result = new sn_doc_services.DocumentListService().createDocumentsFromList('21afddea2460fc10f877a6fed1c2b0dd', 'incident', 'd7158da0c0a8016700eef46c8d1f3661');
    gs.info(JSON.stringify(result, null, 2));

出力：

    {
      "message": "Created 1 document references for the given table name: incident, table sysId : d7158da0c0a8016700eef46c8d1f3661 with list SysId 21afddea2460fc10f877a6fed1c2b0dd",
      "request_id": "21afddea2460fc10f877a6fed1c2b0dd",
      "status": "success"
    }

## DocumentListService - deleteDocumentList(文字列 listSysId) {#ariaid-title5}

ドキュメントリスト \[ds_document_lists\] テーブルからドキュメントレコードを削除します。
{#DLS-deleteDocumentList_S__table_w4z_2cg_tpb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| listSysId | 文字列 | ドキュメントリスト \[ds_document_lists\] テーブルのドキュメントリストレコードの sys_id。 |
[表 : 6. パラメーター]

{#DLS-deleteDocumentList_S__table_w4z_2cg_tpb} {#DLS-deleteDocumentList_S__table_x4z_2cg_tpb__entry__2}{#DLS-deleteDocumentList_S__ph-docserv-ret-obj-basic}

| タイプ | 説明 |
|-|-|
| オブジェクト | 成功またはエラーメッセージ。 { "message": "String", "request_id": "String", "status": "String" } {#DLS-deleteDocumentList_S__api_docserv_codeblock_dets} |
| \<Object\>.message | 成功またはエラーを確認するメッセージ。 データタイプ：文字列 |
| \<Object\>.request_id | ドキュメントリスト \[ds_document_lists\] テーブルのレコードの sys_id。 データタイプ：文字列 |
| \<Object\>.status | 操作が成功したかどうかを示すステータス。 可能な値： * success - 操作は成功しました。 * failure -- 操作は成功しませんでした。message は詳細を示します。 {#DLS-deleteDocumentList_S__ul_rlv_5cv_j4b} データタイプ：文字列 |
[表 : 7. 返される内容]

{#DLS-deleteDocumentList_S__table_x4z_2cg_tpb}  
次の例は、ドキュメントリストレコードを削除する方法を示しています。「[SystemDocumentList](https://servicenow-prod.fluidtopics.net/3XQTJI78G05ln9oFHteRDA#SystemDocumentListBothAPI "SystemDocumentList API は、ドキュメントリスト [ds_document_lists] テーブルのレコードフィールドを設定するためのメソッドを提供します。")」も参照してください。

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';

    var docListSvc = new sn_doc_services.DocumentListService();
    gs.info(JSON.stringify(docListSvc.deleteDocumentList(docListID), null, 2));

出力：

    {
      "message": "Delete List for the given sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
      "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
      "status": "success"
    }

## DocumentListService - updateDocumentList(文字列 docSysId, SystemDocumentList doc) {#ariaid-title6}

既存のドキュメントリストのフィールド値を更新します。
{#DLS-updateDocumentList_S_O__table_w4z_2cg_tpb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| listSysId | 文字列 | ドキュメントリスト \[ds_document_lists\] テーブルのドキュメントリストレコードの sys_id。 |
| doc | [SystemDocument](https://servicenow-prod.fluidtopics.net/VhrceQ0QXZOrY2vijOLXIg#SystemDocumentBothAPI "SystemDocument API は、ドキュメント [ds_document] テーブルのレコードのフィールドを設定するためのメソッドを提供します。") | 更新するドキュメントリストのフィールドを表す 1 つ以上のプロパティです。 |
[表 : 8. パラメーター]

{#DLS-updateDocumentList_S_O__table_w4z_2cg_tpb} {#DLS-updateDocumentList_S_O__table_x4z_2cg_tpb__entry__2}{#DLS-updateDocumentList_S_O__ph-docserv-ret-obj-basic}

| タイプ | 説明 |
|-|-|
| オブジェクト | 成功またはエラーメッセージ。 { "message": "String", "request_id": "String", "status": "String" } {#DLS-updateDocumentList_S_O__api_docserv_codeblock_dets} |
| \<Object\>.message | 成功またはエラーを確認するメッセージ。 データタイプ：文字列 |
| \<Object\>.request_id | ドキュメントリスト \[ds_document_lists\] テーブルのレコードの sys_id。 データタイプ：文字列 |
| \<Object\>.status | 操作が成功したかどうかを示すステータス。 可能な値： * success - 操作は成功しました。 * failure -- 操作は成功しませんでした。message は詳細を示します。 {#DLS-updateDocumentList_S_O__ul_rlv_5cv_j4b} データタイプ：文字列 |
[表 : 9. 返される内容]

{#DLS-updateDocumentList_S_O__table_x4z_2cg_tpb}  
次の例は、ドキュメントリストの名前と説明を更新する方法を示しています。「[SystemDocumentList](https://servicenow-prod.fluidtopics.net/3XQTJI78G05ln9oFHteRDA#SystemDocumentListBothAPI "SystemDocumentList API は、ドキュメントリスト [ds_document_lists] テーブルのレコードフィールドを設定するためのメソッドを提供します。")」も参照してください。

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';

    var docListUpdate = new sn_doc_services.SystemDocumentList();
    docListUpdate.name('name change');
    docListUpdate.description('description update');

    var docListSvc = new sn_doc_services.DocumentListService();
    gs.info(JSON.stringify(docListSvc.updateDocumentList(docListID , docListUpdate), null, 2));

出力：

    {
      "message": "Update List for the given sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
      "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
      "status": "success"
    }