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

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

    • DocumentListService API には、ドキュメント リストを作成、削除、および更新するためのメソッドが用意されています。

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

    ドキュメント管理 プラグインは、ドキュメントに関連付けるドキュメントテンプレートのリストの作成もサポートしています。たとえば、卒業証書、ID、パスポートなどの複数のドキュメントを必要とするジョブアプリケーションなどです。ドキュメントリストを追加した後、ドキュメントテンプレートを追加できます。
    ドキュメントをテンプレートとして定義するには：
    • SystemDocument – template() メソッドを true に設定するドキュメントオブジェクトを定義します。DocumentService API のメソッドを使用して、ドキュメントレコードを作成または更新します。
    • ドキュメント [ds_document] テーブルのドキュメントの [テンプレート] チェックボックスをオンにします。
    次の API を使用すると、ドキュメントを定義および管理できます。
    • SystemDocument – ドキュメントオブジェクトを定義します。
    • DocumentService – ドキュメントを追加、更新、または削除します。
    ドキュメントをテンプレートとして定義するには：
    • SystemDocument – template() メソッドを true に設定するドキュメントオブジェクトを定義します。DocumentService API のメソッドを使用して、ドキュメントレコードを作成または更新します。
    • ドキュメント [ds_document] テーブルのドキュメントの [テンプレート] チェックボックスをオンにします。

    「SystemDocumentList」も参照してください。

    DocumentListService - DocumentListService()

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

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

    次の例は、DocumentListService オブジェクトをインスタンス化する方法を示しています。「SystemDocumentList」も参照してください。

    var s = new sn_doc_services.DocumentListService();

    DocumentListService - createDocumentList(SystemDocumentList doc)

    ドキュメントリスト [ds_document_lists] テーブル内にドキュメントリストを作成します。

    ドキュメント管理 プラグインは、ドキュメントに関連付けるドキュメントテンプレートのリストの作成もサポートしています。たとえば、卒業証書、ID、パスポートなどの複数のドキュメントを必要とするジョブアプリケーションなどです。ドキュメントリストを追加した後、ドキュメントテンプレートを追加できます。

    createDocumentsFromList() メソッドを使用して、ドキュメントテンプレートリストからドキュメントを作成します。

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

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

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

    データタイプ：文字列

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

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

    DocumentListService - createDocumentsFromList(文字列 listSysId, 文字列 tableName, 文字列 tableSysId)

    ドキュメントテンプレートのリストからドキュメントを作成します。

    注:
    このメソッドを使用する前に、createDocumentList() メソッドを使用してドキュメントテンプレートリストを作成します。
    表 : 4. パラメーター
    名前 タイプ 説明
    listSysId 文字列 ドキュメントリスト [ds_document_lists] テーブルのドキュメントリストレコードの sys_id。
    tableName 文字列 ドキュメントテンプレート参照のリストの追加元のレコードを含むテーブルの名前です。
    tableSysId 文字列 ドキュメントテンプレート参照のリストを追加するコンテンツを含むレコードの sys_id です。
    表 : 5. 返される内容
    タイプ 説明
    オブジェクト 成功またはエラーメッセージ。 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.message

    ドキュメントリスト内のドキュメントテンプレートの数を含むメッセージです。

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

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

    データタイプ：文字列

    次の例は、ドキュメントテンプレート参照のリストをレコードに追加する方法を示しています。ドキュメントは、インシデント [incident] テーブルのレコードに追加されます。

    var result = new sn_doc_services.DocumentListService().createDocumentsFromList('21afddea2460fc10f877a6fed1c2b0dd', 'incident', 'd7158da0c0a8016700eef46c8d1f3661');
gs.info(JSON.stringify(result, null, 2));
    出力：
    {
  "message": "Created 1 document references for the given table name: incident, table sysId : d7158da0c0a8016700eef46c8d1f3661 with list SysId 21afddea2460fc10f877a6fed1c2b0dd",
  "request_id": "21afddea2460fc10f877a6fed1c2b0dd",
  "status": "success"
}

    DocumentListService - deleteDocumentList(文字列 listSysId)

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

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

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

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

    データタイプ：文字列

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

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';

var docListSvc = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docListSvc.deleteDocumentList(docListID), null, 2));
    出力：
    {
  "message": "Delete List for the given sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}

    DocumentListService - updateDocumentList(文字列 docSysId, SystemDocumentList doc)

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

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

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

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

    データタイプ：文字列

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

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';

var docListUpdate = new sn_doc_services.SystemDocumentList();
docListUpdate.name('name change');
docListUpdate.description('description update');

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