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

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

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

ドキュメントリストを作成または管理するには、DocumentListService API を使用します。

SystemDocumentList - SystemDocumentList(文字列 docListName)

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

表 : 1. パラメーター

名前	タイプ	説明
docListName	文字列	ドキュメントリストの名前。

表 : 2. 返される内容

タイプ	説明
なし

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

var docList = new sn_doc_services.SystemDocumentList();

SystemDocumentList - description(文字列 description)

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

表 : 3. パラメーター

名前	タイプ	説明
説明	文字列	ドキュメントリストの説明。

表 : 4. 返される内容

タイプ	説明
なし

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

var dL = new sn_doc_services.SystemDocumentList('My document list');

// Define the document list field
dL.description('description');

var docList = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docList.createDocumentList(dL), null, 2));

出力：

{
  "message": "Create List for the given name : My document list, List sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}

SystemDocumentList - name(文字列 docListName)

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

注:

SystemDocumentList() コンストラクターのパラメーターで名前を設定することもできます。

表 : 5. パラメーター

名前	タイプ	説明
docListName	文字列	ドキュメントリストの名前。

表 : 6. 返される内容

タイプ	説明
なし

次の例は、既存のドキュメントリストの名前を変更する方法を示しています。「DocumentListService」も参照してください。

var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';
var docListUpdate = new sn_doc_services.SystemDocumentList();

docListUpdate.name('name change');

var docListSvc = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docListSvc.updateDocumentList(docListID , docListUpdate), null, 2));

出力：

{
  "message": "Update List for the given sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}