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


---

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

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

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

DocumentService 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)」を参照してください。

ドキュメントは、ドキュメントレコードに関する情報の集合です。レコードの作成または更新に使用されるメソッドは、[SystemDocument](https://servicenow-prod.fluidtopics.net/VhrceQ0QXZOrY2vijOLXIg#SystemDocumentBothAPI "SystemDocument API は、ドキュメント [ds_document] テーブルのレコードのフィールドを設定するためのメソッドを提供します。") オブジェクトを使用してフィールドを変更します。  
ドキュメントコンテンツはバージョンを使用して管理されます。次の API を使用すると、ドキュメントのバージョンを定義および管理できます。

* [SystemDocumentVersion](https://servicenow-prod.fluidtopics.net/TpVtwYvllcyjLadFKvBKXg#SystemDocumentVersionBothAPI "SystemDocumentVersion API は、Versions [ds_document_version] テーブルにドキュメントのソースバージョンの値を設定するためのメソッドを提供します。")：ドキュメントのバージョンをドキュメントコンテンツのソースとして定義します。 各バージョンは、ドキュメントコンテンツを含む要素であり、単一の URL または添付ファイルを使用して提供されます。添付ファイルはドキュメントバージョン \[ds_document_version\] テーブルの UI でのみ追加することができ、API を使用して追加することはできません。
* [DocumentVersionService](https://servicenow-prod.fluidtopics.net/NVAyB~FnPidkMgM40~GZCA#DocumentVersionServiceBothAPI "DocumentVersionService API は、ドキュメント バージョンを作成および削除するためのサービスを提供します。 各バージョンは、ドキュメントコンテンツを含む要素であり、単一の URL または添付ファイルを使用して提供されます。添付ファイルはドキュメントバージョン [ds_document_version] テーブルの UI でのみ追加することができ、API を使用して追加することはできません。")：ドキュメントコンテンツはバージョンを使用して管理されます。
{#DocumentServiceBothAPI__ul_krc_vmf_vpb}

[DocumentReferenceService](https://servicenow-prod.fluidtopics.net/eBprRyY9vOupbISuMaM9nA#DocumentReferenceServiceBothAPI "DocumentReferenceService API は、インシデント [incident] テーブルやナレッジ [kb_knowledge] テーブルなどのターゲットテーブル内のドキュメント参照を管理するためのメソッドを提供します。ドキュメント参照を使用して、情報をレコードに関連付けることができます。") API を使用して、インシデント \[incident\] テーブルやナレッジ \[kb_knowledge\] テーブルなどのターゲットテーブルで参照されるドキュメントを管理します。  
ドキュメント管理 プラグインは、ドキュメントに関連付けるドキュメントテンプレートのリストの作成もサポートしています。たとえば、卒業証書、ID、パスポートなどの複数のドキュメントを必要とするジョブアプリケーションなどです。

* [SystemDocumentList](https://servicenow-prod.fluidtopics.net/3XQTJI78G05ln9oFHteRDA#SystemDocumentListBothAPI "SystemDocumentList API は、ドキュメントリスト [ds_document_lists] テーブルのレコードフィールドを設定するためのメソッドを提供します。")：ドキュメントテンプレートのリストを定義します。
* [DocumentListService](https://servicenow-prod.fluidtopics.net/60MUr2gGh3_47C0sfOPlpw#DocumentListServiceBothAPI "DocumentListService API には、ドキュメント リストを作成、削除、および更新するためのメソッドが用意されています。")：ドキュメントテンプレートのリストを追加または削除します。
* [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 は、ドキュメント リスト内のドキュメント テンプレートを管理するためのメソッドを提供します。")：ドキュメントテンプレートのリストエントリを追加または削除します。
{#DocumentServiceBothAPI__ul_asn_gjg_vpb}

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

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

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

{#DocumentService-DocumentService__table_zw5_mcg_tpb}  
次の例は、DocumentService オブジェクトをインスタンス化する方法を示しています。

    var s = new sn_doc_services.DocumentService();

## DocumentService - createDocument(SystemDocument doc) {#ariaid-title3}

ドキュメント \[ds_document\] テーブルにドキュメントレコードを作成します。
{#DocumentService-createDocument_O__table_w4z_2cg_tpb__entry__3}

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

{#DocumentService-createDocument_O__table_w4z_2cg_tpb} {#DocumentService-createDocument_O__table_tj4_p5j_34b__entry__2}{#DocumentService-createDocument_O__row_pdfgen_ret_msgCnv}

| タイプ | 説明 |
|-|-|
| オブジェクト | ドキュメント \[ds_document\] テーブルの新しいレコードの sys_id と成功メッセージです。それ以外の場合はエラーメッセージ。 { "message": "String", "request_id": "String", "status": "String" } |
| \<Object\>.message | 成功またはエラーを確認するメッセージ。 可能な値： * Create document sysId : \<sys_id\> is successful. * Document Name is mandatory and should be valid. * Document Name is mandatory and it should not be null or empty. * \<[SystemDocument](https://servicenow-prod.fluidtopics.net/VhrceQ0QXZOrY2vijOLXIg#SystemDocumentBothAPI "SystemDocument API は、ドキュメント [ds_document] テーブルのレコードのフィールドを設定するためのメソッドを提供します。") property requiring sys_id input\> with SysId: "\<sys_id\>" does not exist {#DocumentService-createDocument_O__ul_hwn_lbh_tpb} データタイプ：文字列 |
| \<Object\>.request_id | ドキュメント \[ds_document\] テーブルのレコードの sys_id。 データタイプ：文字列 |
| \<Object\>.status | 操作が成功したかどうかを示すステータス。 可能な値： * success - 操作は成功しました。 * failure -- 操作は成功しませんでした。message は詳細を示します。 {#DocumentService-createDocument_O__ul_rlv_5cv_j4b} データタイプ：文字列 |
[表 : 3. 返される内容]

{#DocumentService-createDocument_O__table_tj4_p5j_34b}  
次の例は、SystemDocument オブジェクトのプロパティを入力して新しいドキュメントレコードを作成する方法を示しています。

    var d = new sn_doc_services.SystemDocument('My document');

    // Define the document fields
    var reviewers = '62826bf03710200044e0bfc8bcbe5df1,a8f98bb0eb32010045e1a5115206fe3a';
    d.description('description');
    d.classification('restricted');
    d.state('review');
    d.department('93b25282c0a8000b0b55c8ab34e2f1e6');
    d.template(false);
    d.type('policy');
    d.reviewers(reviewers);
    d.audience('external');

    var s = new sn_doc_services.DocumentService();
    gs.info(JSON.stringify(s.createDocument(d), null, 2));

出力：

    {
      "message": "Create document sysId : 1040420224503410f877a6fed1c2b031 is successful.",
      "request_id": "1040420224503410f877a6fed1c2b031",
      "status": "success"
    }

## DocumentService - deleteDocument(文字列 docSysId) {#ariaid-title4}

ドキュメント \[ds_document\] テーブルからドキュメントレコードを削除します。
{#DocumentService-deleteDocument_S__table_w4z_2cg_tpb__entry__3}{#DocumentService-deleteDocument_S__ph_docserv_parm_docID}

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

{#DocumentService-deleteDocument_S__table_w4z_2cg_tpb} {#DocumentService-deleteDocument_S__table_x4z_2cg_tpb__entry__2}{#DocumentService-deleteDocument_S__ph-docserv-ret-obj-basic}

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

{#DocumentService-deleteDocument_S__table_x4z_2cg_tpb}  
次の例は、既存のドキュメントレコードを削除する方法を示しています。

    var docid = "<sys_id>";
    var svc = new sn_doc_services.DocumentService();
    gs.info(JSON.stringify(svc.deleteDocument(docid), null, 2));

出力：

    {
      "message": "Delete document sysId : <sys_id> is successful.",
      "request_id": "<sys_id>",
      "status": "success"
    }

## DocumentService - updateDocument(文字列 docSysId, SystemDocument doc) {#ariaid-title5}

既存のドキュメントレコードのフィールド値を更新します。
{#DocumentService-updateDocument_S_O__table_w4z_2cg_tpb__entry__3}{#DocumentService-updateDocument_S_O__ph_docserv_parm_docID}

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

{#DocumentService-updateDocument_S_O__table_w4z_2cg_tpb} {#DocumentService-updateDocument_S_O__table_x4z_2cg_tpb__entry__2}{#DocumentService-updateDocument_S_O__ph-docserv-ret-obj-basic}

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

{#DocumentService-updateDocument_S_O__table_x4z_2cg_tpb}  
次の例は、ドキュメント名を変更する方法を示しています。「[SystemDocument](https://servicenow-prod.fluidtopics.net/VhrceQ0QXZOrY2vijOLXIg#SystemDocumentBothAPI "SystemDocument API は、ドキュメント [ds_document] テーブルのレコードのフィールドを設定するためのメソッドを提供します。")」も参照してください。

    var dId = "19aab54e24103410f877a6fed1c2b03d";
    var d = new sn_doc_services.SystemDocument();
    d.name("c22.txt");

    var s = new sn_doc_services.DocumentService();
    gs.info(JSON.stringify(s.updateDocument(dId, d), null, 2));

出力：

    {
      "message": "Update document sysId : 19aab54e24103410f877a6fed1c2b03d is successful.",
      "request_id": "19aab54e24103410f877a6fed1c2b03d",
      "status": "success"
    }