--- 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 --- # DocumentService:スコープ指定、グローバル # DocumentService:スコープ指定、グローバル {#ariaid-title1} * リリースバージョン: Australia * * 更新日 2026年03月12日 * * ![](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=australia&pubname=australia-servicenow-platform&ft:locale=en-US)を参照してください。 ドキュメントは、ドキュメントレコードに関する情報の集合です。レコードの作成または更新に使用されるメソッドは、 [SystemDocument](https://servicenow-prod.fluidtopics.net/9ce9i4EAQs4raWb40gESaQ#SystemDocumentBothAPI "SystemDocument API は、ドキュメント [ds_document] テーブルのレコードのフィールドを設定するためのメソッドを提供します。") オブジェクトを使用してフィールドを変更します。 ドキュメントコンテンツはバージョンを使用して管理されます。次の API を使用すると、ドキュメントバージョンを定義および管理できます。 * [SystemDocumentVersion](https://servicenow-prod.fluidtopics.net/xAg~2nYvJYAK76OK19y8YQ#SystemDocumentVersionBothAPI "SystemDocumentVersion API は、バージョン [ds_document_version] テーブルでドキュメントのソースバージョンの値を設定するためのメソッドを提供します。") -- ドキュメントコンテンツのソースとしてドキュメントバージョンを定義します。 各バージョンはドキュメントコンテンツを含む要素であり、単一の URL または添付ファイルを使用して提供されます。添付ファイルはドキュメントバージョン \[ds_document_version\] テーブルの UI でのみ追加でき、API では追加できません。 * [DocumentVersionService](https://servicenow-prod.fluidtopics.net/fOMJr2dSrcQpkk1wBb25tQ#DocumentVersionServiceBothAPI "DocumentVersionService API は、ドキュメントバージョンを作成および削除するためのサービスを提供します。 各バージョンはドキュメントコンテンツを含む要素であり、単一の URL または添付ファイルを使用して提供されます。添付ファイルはドキュメントバージョン [ds_document_version] テーブルの UI でのみ追加でき、API では追加できません。") -- ドキュメントコンテンツはバージョンを使用して管理されます。 {#DocumentServiceBothAPI__ul_krc_vmf_vpb} [DocumentReferenceService](https://servicenow-prod.fluidtopics.net/EIDW4s_Edtp7FT1Nn3~FCw#DocumentReferenceServiceBothAPI "DocumentReferenceService API は、インシデント [incident] テーブルやナレッジ [kb_knowledge] テーブルなどのターゲットテーブル内のドキュメント参照を管理するためのメソッドを提供します。ドキュメント参照を使用して、情報をレコードに関連付けることができます。") API を使用して、インシデント \[incident\] テーブルやナレッジ \[kb_knowledge\] テーブルなどのターゲットテーブルで参照されるドキュメントを管理します。 ドキュメント管理 プラグインは、ドキュメントに関連付けるドキュメントテンプレートのリストの作成もサポートしています。たとえば、卒業証書、ID、パスポートなどの複数の書類を必要とする求人応募などです。 * [SystemDocumentList](https://servicenow-prod.fluidtopics.net/VdyRApWs47JpRgMaH7XIkw#SystemDocumentListBothAPI "SystemDocumentList API は、ドキュメントリスト [ds_document_lists] テーブルのレコードフィールドを設定するためのメソッドを提供します。") -- ドキュメントテンプレートのリストを定義します。 * [DocumentListService](https://servicenow-prod.fluidtopics.net/ZbUpbnE7cY5TIa~smNZ6lA#DocumentListServiceBothAPI "DocumentListService API は、ドキュメントリストを作成、削除、および更新するためのメソッドを提供します。") -- ドキュメントテンプレートリストを追加または削除します。 * [SystemDocumentListEntry](https://servicenow-prod.fluidtopics.net/eAgps~ZfEcBMDWCGonNb7Q#SystemDocumentListEntryBothAPI "SystemDocumentListEntry API は、ドキュメントリストエントリ [ds_document_list_entry] テーブルのレコードフィールドを設定するためのメソッドを提供します。") -- ドキュメントテンプレートリストエントリを定義します。 * [DocumentListEntryService](https://servicenow-prod.fluidtopics.net/1kBP57E1T_SZv8_gAlJdtw#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 ドキュメント) {#ariaid-title3} ドキュメント \[ds_document\] テーブルにドキュメントレコードを作成します。 {#DocumentService-createDocument_O__table_w4z_2cg_tpb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | doc | [システムドキュメント](https://servicenow-prod.fluidtopics.net/9ce9i4EAQs4raWb40gESaQ#SystemDocumentBothAPI "SystemDocument API は、ドキュメント [ds_document] テーブルのレコードのフィールドを設定するためのメソッドを提供します。") | 新しいレコードのフィールドを表す 1 つ以上のプロパティ。name プロパティは必須であり、 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" } | | \.message | 成功またはエラーを確認するメッセージ。 可能な値： * ドキュメント sysId を作成:\に成功しました。 * ドキュメント名は必須であり、有効である必要があります。 * ドキュメント名は必須であり、null または空にすることはできません。 * SysID「\」の \は存在しません {#DocumentService-createDocument_O__ul_hwn_lbh_tpb} データタイプ：文字列 | | \.request_id | ドキュメント \[ds_document\] テーブル内のレコードのSys_id。 データタイプ：文字列 | | \.status | 操作が成功したかどうかを示すステータス。 可能な値： * 成功:操作は成功しました。 * 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(String 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} | | \.message | 成功またはエラーを確認するメッセージ。 データタイプ：文字列 | | \.request_id | ドキュメント \[ds_document\] テーブル内のレコードのSys_id。 データタイプ：文字列 | | \.status | 操作が成功したかどうかを示すステータス。 可能な値： * 成功:操作は成功しました。 * failure:操作は成功しませんでした。messageに詳細が表示されます。 {#DocumentService-deleteDocument_S__ul_rlv_5cv_j4b} データタイプ：文字列 | [表 : 5. 返される内容] {#DocumentService-deleteDocument_S__table_x4z_2cg_tpb} 次の例は、既存のドキュメントレコードを削除する方法を示しています。 var docid = ""; var svc = new sn_doc_services.DocumentService(); gs.info(JSON.stringify(svc.deleteDocument(docid), null, 2)); 出力: { "message": "Delete document sysId : is successful.", "request_id": "", "status": "success" } ## DocumentService - updateDocument(String 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 | [システムドキュメント](https://servicenow-prod.fluidtopics.net/9ce9i4EAQs4raWb40gESaQ#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} | | \.message | 成功またはエラーを確認するメッセージ。 データタイプ：文字列 | | \.request_id | ドキュメント \[ds_document\] テーブル内のレコードのSys_id。 データタイプ：文字列 | | \.status | 操作が成功したかどうかを示すステータス。 可能な値： * 成功:操作は成功しました。 * 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/9ce9i4EAQs4raWb40gESaQ#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" }