DocumentReferenceService:スコープ対象、グローバル

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	操作が成功したかどうかを示すステータス。 可能な値： 成功:操作は成功しました。 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	操作が成功したかどうかを示すステータス。 可能な値： 成功:操作は成功しました。 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"
}