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

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

    • DocumentService API は、ドキュメントを作成、削除、更新するためのメソッドを提供します。

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

    ドキュメントは、ドキュメントレコードに関する情報の集合です。レコードの作成または更新に使用されるメソッドは、SystemDocument オブジェクトを使用してフィールドを変更します。

    ドキュメントコンテンツはバージョンを使用して管理されます。次の API を使用すると、ドキュメントのバージョンを定義および管理できます。
    • SystemDocumentVersion：ドキュメントのバージョンをドキュメントコンテンツのソースとして定義します。 各バージョンは、ドキュメントコンテンツを含む要素であり、単一の URL または添付ファイルを使用して提供されます。添付ファイルはドキュメントバージョン [ds_document_version] テーブルの UI でのみ追加することができ、API を使用して追加することはできません。
    • DocumentVersionService：ドキュメントコンテンツはバージョンを使用して管理されます。

    DocumentReferenceService API を使用して、インシデント [incident] テーブルやナレッジ [kb_knowledge] テーブルなどのターゲットテーブルで参照されるドキュメントを管理します。

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

    DocumentService - DocumentService()

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

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

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

    var s = new sn_doc_services.DocumentService();

    DocumentService - createDocument(SystemDocument doc)

    ドキュメント [ds_document] テーブルにドキュメントレコードを作成します。

    表 : 2. パラメーター
    名前 タイプ 説明
    doc SystemDocument 新しいレコードのフィールドを表す 1 つ以上のプロパティです。名前プロパティは必須であり、SystemDocument コンストラクタまたは name() メソッドを使用して設定できます。
    表 : 3. 返される内容
    タイプ 説明
    オブジェクト ドキュメント [ds_document] テーブルの新しいレコードの sys_id と成功メッセージです。それ以外の場合はエラーメッセージ。
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.message 成功またはエラーを確認するメッセージ。
    可能な値：
    • Create document sysId : <sys_id> is successful.
    • Document Name is mandatory and should be valid.
    • Document Name is mandatory and it should not be null or empty.
    • <SystemDocument property requiring sys_id input> with SysId: "<sys_id>" does not exist

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

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

    データタイプ：文字列

    次の例は、SystemDocument オブジェクトのプロパティを入力して新しいドキュメントレコードを作成する方法を示しています。

    var d = new sn_doc_services.SystemDocument('My document');

// Define the document fields
var reviewers = '62826bf03710200044e0bfc8bcbe5df1,a8f98bb0eb32010045e1a5115206fe3a';
d.description('description');
d.classification('restricted');
d.state('review');
d.department('93b25282c0a8000b0b55c8ab34e2f1e6');
d.template(false);
d.type('policy');
d.reviewers(reviewers);
d.audience('external');

var s = new sn_doc_services.DocumentService();
gs.info(JSON.stringify(s.createDocument(d), null, 2));
    出力：
    {
  "message": "Create document sysId : 1040420224503410f877a6fed1c2b031 is successful.",
  "request_id": "1040420224503410f877a6fed1c2b031",
  "status": "success"
}

    DocumentService - deleteDocument(文字列 docSysId)

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

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

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

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

    データタイプ：文字列

    次の例は、既存のドキュメントレコードを削除する方法を示しています。

    var docid = "<sys_id>";
var svc = new sn_doc_services.DocumentService();
gs.info(JSON.stringify(svc.deleteDocument(docid), null, 2));
    出力：
    {
  "message": "Delete document sysId : <sys_id> is successful.",
  "request_id": "<sys_id>",
  "status": "success"
}

    DocumentService - updateDocument(文字列 docSysId, SystemDocument doc)

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

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

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

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

    データタイプ：文字列

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

    var dId = "19aab54e24103410f877a6fed1c2b03d";
var d = new sn_doc_services.SystemDocument();
d.name("c22.txt");

var s = new sn_doc_services.DocumentService();
gs.info(JSON.stringify(s.updateDocument(dId, d), null, 2));
    出力：
    {
  "message": "Update document sysId : 19aab54e24103410f877a6fed1c2b03d is successful.",
  "request_id": "19aab54e24103410f877a6fed1c2b03d",
  "status": "success"
}