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

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：8分

    • DocumentListEntryService API は、ドキュメント リスト内のドキュメント テンプレートを管理するためのメソッドを提供します。

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

    この API のメソッドを使用する前に、ドキュメントテンプレートとそのバージョンを追加し、ドキュメントリストを作成します。 SystemDocumentListEntry API を使用して、ドキュメントをドキュメントリストに追加、またはドキュメントリストから削除します。

    この API のメソッドを使用する前に、デフォルトバージョンのドキュメントを追加し、ドキュメントリストを作成する必要があります。
    ドキュメントをテンプレートとして定義するには：
    • SystemDocument – template() メソッドを true に設定するドキュメントオブジェクトを定義します。DocumentService API のメソッドを使用して、ドキュメントレコードを作成または更新します。
    • ドキュメント [ds_document] テーブルのドキュメントの [テンプレート] チェックボックスをオンにします。

    DocumentListEntryService - DocumentListEntryService()

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

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

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

    var s = new sn_doc_services.DocumentListEntryService();

    DocumentListEntryService - createDocumentListEntry(SystemDocumentListEntry entry)

    ドキュメントリストにドキュメントテンプレートエントリを追加します。

    表 : 2. パラメーター
    名前 タイプ 説明
    エントリ SystemDocumentListEntry ドキュメントリストエントリオブジェクトのフィールドを表す 1 つ以上のプロパティ。
    表 : 3. 返される内容
    タイプ 説明
    オブジェクト ドキュメントリストエントリ [ds_document_list_entry] テーブル内の新しいレコードの sys_id と成功メッセージです。それ以外の場合はエラーメッセージ。
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.message 成功またはエラーを確認するメッセージ。

    データタイプ：文字列
    <Object>.request_id ドキュメントリストエントリ [ds_document_list_entry] テーブルのレコードの sys_id。

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

    データタイプ：文字列

    次の例は、ドキュメントエントリを定義してドキュメントリストに追加する方法を示しています。「SystemDocumentListEntry」も参照してください。

    var docListEntry = new sn_doc_services.SystemDocumentListEntry('21afddea2460fc10f877a6fed1c2b0dd');
docListEntry.document("9acd7fea24587410f877a6fed1c2b060");
docListEntry.description('birth certificate');

var dlEntrySvc = new sn_doc_services.DocumentListEntryService();
gs.info(JSON.stringify(dlEntrySvc.createDocumentListEntry(docListEntry), null, 2));
    出力:
    {
  "message": "Create List Entry , List Entry sysId : d3f0b13624e8fc10f877a6fed1c2b0d9is successful.",
  "request_id": "d3f0b13624e8fc10f877a6fed1c2b0d9",
  "status": "success"
}

    DocumentListEntryService - deleteDocumentListEntry(文字列 listEntryId)

    ドキュメントリストエントリ [ds_document_list_entry] テーブルからドキュメントリストエントリを削除します。

    表 : 4. パラメーター
    名前 タイプ 説明
    listEntryId 文字列 ドキュメントリストエントリ [ds_document_list_entry] テーブルのドキュメントリストレコードの sys_id。
    表 : 5. 返される内容
    タイプ 説明
    オブジェクト 成功またはエラーメッセージ。 
    {
  "message": "String",
  "status": "String"
}
    <Object>.message 成功またはエラーを確認するメッセージ。

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

    データタイプ：文字列

    次の例は、ドキュメントリストレコードを削除する方法を示しています。「SystemDocumentList」も参照してください。

    var listEntryId = 'd3f0b13624e8fc10f877a6fed1c2b0d9';

var dlEntrySvc = new sn_doc_services.DocumentListEntryService();
gs.info(JSON.stringify(dlEntrySvc.deleteDocumentListEntry(listEntryId), null, 2));
    出力：
    {
  "message": "Deleting an entry for the given documentListEntrySysId : d3f0b13624e8fc10f877a6fed1c2b0d9 is successful.",
  "status": "success"
}

    DocumentListEntryService - updateDocumentListEntry(文字列 listEntryId, SystemDocumentListEntry エントリー)

    既存のドキュメントリストエントリのフィールド値を更新します。

    表 : 6. パラメーター
    名前 タイプ 説明
    listEntryId 文字列 ドキュメントリストエントリ [ds_document_list_entry] テーブルのドキュメントリストレコードの sys_id。
    エントリ SystemDocumentListEntry ドキュメントリストエントリオブジェクトのフィールドを表す 1 つ以上のプロパティ。
    表 : 7. 返される内容
    タイプ 説明
    オブジェクト 成功またはエラーメッセージ。 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.message 成功またはエラーを確認するメッセージ。

    データタイプ：文字列
    <Object>.request_id ドキュメントリストエントリ [ds_document_list_entry] テーブルのレコードの sys_id。

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

    データタイプ：文字列

    次の例は、ドキュメントリストエントリの説明を更新する方法を示しています。「SystemDocumentListEntry」も参照してください。

    var listEntryId = 'd3f0b13624e8fc10f877a6fed1c2b0d9';

var entry = new sn_doc_services.SystemDocumentListEntry();
entry.description('description update');

var dlEntrySvc = new sn_doc_services.DocumentListEntryService();
gs.info(JSON.stringify(dlEntrySvc.updateDocumentListEntry(listEntryId, entry), null, 2));
    出力:
    {
  "message": "Updating an entry for the given documentListEntrySysId : d3f0b13624e8fc10f877a6fed1c2b0d9 is successful.",
  "request_id": "d3f0b13624e8fc10f877a6fed1c2b0d9",
  "status": "success"
}