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

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

    • DocumentReferenceService API は、インシデント [incident] テーブルやナレッジ [kb_knowledge] テーブルなどのターゲットテーブル内のドキュメント参照を管理するためのメソッドを提供します。ドキュメント参照を使用して、情報をレコードに関連付けることができます。

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

    次の API を使用すると、ドキュメントを定義および管理できます。
    • SystemDocument – ドキュメントオブジェクトを定義します。
    • DocumentService – ドキュメントを追加、更新、または削除します。

    DocumentReferenceService - DocumentReferenceService()

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

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

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

    var result = new sn_doc_services.DocumentReferenceService();

    DocumentReferenceService - addDocumentReference(文字列 docSysId, 文字列 targetTable, 文字列 tableSysId)

    ターゲットテーブルレコードにドキュメント参照を追加します。

    表 : 2. パラメーター
    名前 タイプ 説明
    docSysId 文字列 ドキュメント [ds_document] テーブルのドキュメントレコードの sys_id。
    targetTable 文字列 ドキュメント参照を提供するターゲットテーブルの名前です。
    tableSysId 文字列 ドキュメント参照を追加するターゲットテーブルレコードの sys_id です。
    表 : 3. 返される内容
    タイプ 説明
    オブジェクト ドキュメント参照 [ds_document_reference] テーブルの新しいレコードの sys_id と成功メッセージです。それ以外の場合はエラーメッセージ。
    {
  "message": "String",
  "status": "String"
}
    <Object>.message 成功またはエラーを確認するメッセージ。 成功した場合、ドキュメント参照が追加されたレコードの sys_id が含まれます。

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

    データタイプ：文字列

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

    var docReference = new sn_doc_services.DocumentReferenceService();

var result = docReference.addDocumentReference("<docSysId>", "incident", "<tableSysId>");

gs.info(JSON.stringify(result, null, 2));
    出力：
    {
  "message": "Adding an entry to DocumentReference for the given docId to target table : incident, sysId : <tableSysId> is successful.",
  "status": "success"
}

    DocumentReferenceService - removeDocumentReference(文字列 docSysId, 文字列 targetTable, 文字列 tableSysId)

    ドキュメント参照 [ds_document_reference] テーブルからドキュメント参照を削除します。

    表 : 4. パラメーター
    名前 タイプ 説明
    docSysId 文字列 ドキュメント [ds_document] テーブルのドキュメントレコードの sys_id。
    targetTable 文字列 ドキュメント参照を含むテーブルの名前です。この情報は、ドキュメント参照 [ds_document_reference] テーブルのドキュメントとともに一覧表示されます。
    tableSysId 文字列 ドキュメントの参照元レコードの sys_id です。関連情報がドキュメント参照 [ds_document_reference] テーブルのドキュメントとともに一覧表示されます。
    表 : 5. 返される内容
    タイプ 説明
    オブジェクト 成功メッセージです。それ以外の場合はエラーメッセージ。
    {
  "message": "String",
  "status": "String"
}
    <Object>.message 成功またはエラーを確認するメッセージ。 成功した場合、ドキュメント参照が削除されたレコードの sys_id が含まれます。

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

    データタイプ：文字列

    次の例は、インシデント [incident] テーブルのレコードからドキュメント参照を削除する方法を示しています。

    var docReference = new sn_doc_services.DocumentReferenceService();

var result = docReference.removeDocumentReference("<docSysId>", "incident", "<tableSysId>");

gs.info(JSON.stringify(result, null, 2));
    出力：
    {
  "message": "Deleting an entry to DocumentReference for the given docId to target table : incident, sysId : <tableSysId> is successful.",
  "status": "success"
}