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

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：5分

    • DocumentVersionService API は、ドキュメントバージョンを作成および削除するためのサービスを提供します。 各バージョンは、ドキュメントコンテンツを含む要素であり、単一の URL または添付ファイルを使用して提供されます。添付ファイルはドキュメントバージョン [ds_document_version] テーブルの UI でのみ追加することができ、API を使用して追加することはできません。

    この API は、ドキュメント管理 プラグイン (com.snc.platform_document_management) を必要とし、sn_doc_services 名前空間内で提供されます。詳細については、「 ドキュメントサービス」を参照してください。

    ドキュメントバージョンを作成する前に、まずドキュメントレコードを定義して追加する必要があります。

    • SystemDocument – ドキュメントオブジェクトを定義します。
    • DocumentService – ドキュメントを追加、更新、または削除します。

    DocumentVersionService - DocumentVersionService()

    DocumentVersionService オブジェクトをインスタンス化します。

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

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

    var versionSvc = new sn_doc_services.DocumentVersionService();

    DocumentVersionService - createDocumentVersion(SystemDocumentVersion docVersion)

    バージョン [ds_document_version] テーブルにドキュメントバージョンレコードを作成します。

    表 : 2. パラメーター
    名前 タイプ 説明
    docVersion SystemDocumentVersion ドキュメントバージョンのフィールドを表す 1 つ以上のプロパティです。
    表 : 3. 返される内容
    タイプ 説明
    オブジェクト バージョン [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 は詳細を示します。

    データタイプ：文字列

    次の例は、SystemDocumentVersion オブジェクトのプロパティを入力して新規ドキュメントバージョンを作成する方法を示しています。「SystemDocumentVersion」も参照してください。

    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)

    ドキュメントバージョンを削除します。

    表 : 4. パラメーター
    名前 タイプ 説明
    docVersionSysId 文字列 バージョン [ds_document_version] テーブル内のドキュメントバージョンの sys_id です。
    表 : 5. 返される内容
    タイプ 説明
    オブジェクト 成功メッセージです。それ以外の場合はエラーメッセージ。
    {
  "message": "String",
  "status": "String"
}
    <Object>.message 成功またはエラーを確認するメッセージ。 成功した場合、削除されたドキュメントバージョンの sys_id が含まれます。

    データタイプ：文字列
    <Object>.status 操作が成功したかどうかを示すステータス。
    可能な値：
    • success - 操作は成功しました。
    • failure – 操作は成功しませんでした。message は詳細を示します。

    データタイプ：文字列

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

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