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


---

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

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

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

DocumentVersionService API は、ドキュメント バージョンを作成および削除するためのサービスを提供します。 各バージョンは、ドキュメントコンテンツを含む要素であり、単一の URL または添付ファイルを使用して提供されます。添付ファイルはドキュメントバージョン \[ds_document_version\] テーブルの UI でのみ追加することができ、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] テーブルのレコードのフィールドを設定するためのメソッドを提供します。") -- ドキュメントオブジェクトを定義します。
* [DocumentService](https://servicenow-prod.fluidtopics.net/cVXg531rqJmBPmSMZyK63g#DocumentServiceBothAPI "DocumentService API は、ドキュメントを作成、削除、および更新するためのメソッドを提供します。") -- ドキュメントを追加、更新、または削除します。
{#DocumentVersionServiceBothAPI__ul_qyt_tpr_wpb}

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

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

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

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

    var versionSvc = new sn_doc_services.DocumentVersionService();

## DocumentVersionService - createDocumentVersion(SystemDocumentVersion docVersion) {#ariaid-title3}

バージョン \[ds_document_version\] テーブルにドキュメントバージョンレコードを作成します。
{#DocVersSvc-createDocumentVersion_O__table_w4z_2cg_tpb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| docVersion | [SystemDocumentVersion](https://servicenow-prod.fluidtopics.net/TpVtwYvllcyjLadFKvBKXg#SystemDocumentVersionBothAPI "SystemDocumentVersion API は、Versions [ds_document_version] テーブルにドキュメントのソースバージョンの値を設定するためのメソッドを提供します。") | ドキュメントバージョンのフィールドを表す 1 つ以上のプロパティです。 |
[表 : 2. パラメーター]

{#DocVersSvc-createDocumentVersion_O__table_w4z_2cg_tpb} {#DocVersSvc-createDocumentVersion_O__table_tj4_p5j_34b__entry__2}{#DocVersSvc-createDocumentVersion_O__row_pdfgen_ret_msgCnv}

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

{#DocVersSvc-createDocumentVersion_O__table_tj4_p5j_34b}  
次の例は、SystemDocumentVersion オブジェクトのプロパティを入力して新規ドキュメントバージョンを作成する方法を示しています。「[SystemDocumentVersion](https://servicenow-prod.fluidtopics.net/TpVtwYvllcyjLadFKvBKXg#SystemDocumentVersionBothAPI "SystemDocumentVersion API は、Versions [ds_document_version] テーブルにドキュメントのソースバージョンの値を設定するためのメソッドを提供します。")」も参照してください。

    var versionDefinition = new sn_doc_services.SystemDocumentVersion('491efbee24187410f877a6fed1c2b0a9');

    versionDefinition.type('url');
    versionDefinition.url('http://one/1.0');

    var versionSvc = new sn_doc_services.DocumentVersionService();
    gs.info(JSON.stringify(versionSvc.createDocumentVersion(versionDefinition), null, 2));

出力：

    {
      "message": "Adding an entry to DocumentVersion for the given docId : 491efbee24187410f877a6fed1c2b0a9, sysId : d5a340d9242cf810f877a6fed1c2b069 is successful.",
      "request_id": "d5a340d9242cf810f877a6fed1c2b069",
      "status": "success"
    }

## DocumentVersionService - deleteDocumentVersion(文字列 docVersionSysId) {#ariaid-title4}

ドキュメントバージョンを削除します。
{#DocVersSvc-deleteDocumentVersion_S__table_w4z_2cg_tpb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| docVersionSysId | 文字列 | バージョン \[ds_document_version\] テーブル内のドキュメントバージョンの sys_id です。 |
[表 : 4. パラメーター]

{#DocVersSvc-deleteDocumentVersion_S__table_w4z_2cg_tpb} {#DocVersSvc-deleteDocumentVersion_S__table_x4z_2cg_tpb__entry__2}

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

{#DocVersSvc-deleteDocumentVersion_S__table_x4z_2cg_tpb}  
次の例は、既存のドキュメントバージョンを削除する方法を示しています。

    var vId = "<versionSysId>";
    var versionSvc = new sn_doc_services.DocumentVersionService();

    gs.info(JSON.stringify(versionSvc.deleteDocumentVersion(vId), null, 2));

出力：

    {
      "message": "Deleting an entry to DocumentVersion for the given documentVersionSysId : , sysId : <versionSysId> is successful.",
      "status": "success"
    }