SystemDocumentListEntry - スコープ指定、グローバル

  • リリースバージョン: Zurich
  • 更新日 2025年07月31日
  • 所要時間：7分

    • SystemDocumentListEntry API は、ドキュメントリストエントリ [ds_document_list_entry] テーブルのレコードフィールドを設定するためのメソッドを提供します。

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

    この API のメソッドを使用する前に、ドキュメントとそのバージョンを追加し、ドキュメントリストを作成する必要があります。

    SystemDocumentListEntry - SystemDocumentListEntry(文字列 listID)

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

    表 : 1. パラメーター
    名前 タイプ 説明
    listSysId 文字列 ドキュメントリスト [ds_document_lists] テーブルのドキュメントリストレコードの sys_id。
    表 : 2. 返される内容
    タイプ 説明
    なし

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

    var docList = new sn_doc_services.SystemDocumentListEntry("<docListSysId>");

    SystemDocumentListEntry - description(文字列 description)

    ドキュメントリストエントリーレコードの [説明] フィールドを設定します。

    表 : 3. パラメーター
    名前 タイプ 説明
    説明 文字列 ドキュメントリストエントリーの説明。
    表 : 4. 返される内容
    タイプ 説明
    なし

    次の例は、コンストラクターを使用して提供されたドキュメントリストエントリーに説明を追加する方法を示しています。「DocumentListEntryService API」も参照してください。

    var docListEntry = new sn_doc_services.SystemDocumentListEntry('21afddea2460fc10f877a6fed1c2b0dd');

docListEntry.description('birth');

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

    SystemDocumentListEntry - document(文字列 docSysId)

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

    ドキュメントをテンプレートとして定義するには：
    • SystemDocument – template() メソッドを true に設定するドキュメントオブジェクトを定義します。DocumentService API のメソッドを使用して、ドキュメントレコードを作成または更新します。
    • ドキュメント [ds_document] テーブルのドキュメントの [テンプレート] チェックボックスをオンにします。
    指定されたドキュメントレコードにはバージョンが必要です。ドキュメントのバージョンを定義して追加するには、次の API を使用します。
    表 : 5. パラメーター
    名前 タイプ 説明
    docSysId 文字列 ドキュメント [ds_document] テーブルのドキュメントレコードの sys_id。 指定されるドキュメントはテンプレートであり、バージョンがある必要があります。
    表 : 6. 返される内容
    タイプ 説明
    なし

    次の例は、ドキュメントテンプレートをドキュメントリストエントリーとして追加する方法を示しています。「DocumentListEntryService API」も参照してください。

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

    SystemDocumentListEntry - documentList(文字列 listSysId)

    ドキュメントを追加するドキュメントリストを指定します。

    注:
    または、SystemDocumentListEntry() コンストラクター内のパラメーターでドキュメントリストを設定することもできます。
    ドキュメントリストを定義して作成するには、次の API を使用します。
    表 : 7. パラメーター
    名前 タイプ 説明
    listSysId 文字列 ドキュメントリスト [ds_document_lists] テーブルのドキュメントリストレコードの sys_id。
    表 : 8. 返される内容
    タイプ 説明
    なし

    次の例では、ドキュメントの追加先となるドキュメントリストを設定する方法を示します。「DocumentListEntryService API」も参照してください。

    var docListEntry = new sn_doc_services.SystemDocumentListEntry();

docListEntry.documentList('21afddea2460fc10f877a6fed1c2b0dd');
docListEntry.document('deaef1ce24103410f877a6fed1c2b085');
docListEntry.description('passport');

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