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

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む8読むのに数分

    • SystemDocumentVersion API には、バージョン [ds_document_version] テーブル内のドキュメントのソースバージョンの値を設定するためのメソッドが用意されています。

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

    ドキュメントのバージョンを作成するには、DocumentVersionService API を使用します。

    SystemDocumentVersion - SystemDocumentVersion(文字列 docSysId)

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

    表 : 1. パラメーター
    名前 タイプ 説明
    docSysId 文字列 ドキュメント [ds_document] テーブルのドキュメントレコードの sys_id。
    表 : 2. 返される内容
    タイプ 説明
    なし

    次の例では、SystemDocumentVersion オブジェクトをインスタンス化してドキュメントバージョンを作成する方法を示します。「DocumentVersionService」も参照してください。

    var versionDefinition = new sn_doc_services.SystemDocumentVersion('491efbee24187410f877a6fed1c2b0a9');

versionDefinition.type('url');
versionDefinition.url('http://one/1.0');

var versionSvc = new sn_doc_services.DocumentVersionService();
gs.info(JSON.stringify(versionSvc.createDocumentVersion(versionDefinition), null, 2));

    出力：

    {
  "message": "Adding an entry to DocumentVersion for the given docId : 491efbee24187410f877a6fed1c2b0a9, sysId : d5a340d9242cf810f877a6fed1c2b069 is successful.",
  "request_id": "d5a340d9242cf810f877a6fed1c2b069",
  "status": "success"
}

    SystemDocumentVersion - document(文字列 docSysId)

    このバージョンのドキュメントレコードを指定します。

    注:
    または、SystemDocumentVersion() コンストラクターのパラメーターで名前を設定することもできます。
    表 : 3. パラメーター
    名前 タイプ 説明
    docSysId 文字列 ドキュメント [ds_document] テーブルのドキュメントレコードの sys_id。
    表 : 4. 返される内容
    タイプ 説明
    なし

    次の例では、ドキュメントバージョンの [名前] フィールドを設定する方法を示します。「DocumentVersionService」～「createDocumentVersion()」も参照してください。

    var versionDefinition = new sn_doc_services.SystemDocumentVersion();

versionDefinition.document('491efbee24187410f877a6fed1c2b0a9');

var versionSvc = new sn_doc_services.DocumentVersionService();
gs.info(JSON.stringify(versionSvc.createDocumentVersion(versionDefinition), null, 2));
    出力：
    {
  "message": "Adding an entry to DocumentVersion for the given docId : 491efbee24187410f877a6fed1c2b0a9, sysId : 1c504c91242cf810f877a6fed1c2b08b is successful.",
  "request_id": "1c504c91242cf810f877a6fed1c2b08b",
  "status": "success"
}

    SystemDocumentVersion - type(文字列 docType)

    ドキュメントバージョンの [タイプ] フィールドを設定します。

    表 : 5. パラメーター
    名前 タイプ 説明
    docType 文字列 ドキュメントソースのタイプ。
    有効な値：
    • url
    • attachment
    デフォルト：attachment
    注:
    現在、添付ファイルはドキュメントバージョン [ds_document_version] テーブルの UI でのみ追加することができ、API を使用して追加することはできません。
    表 : 6. 返される内容
    タイプ 説明
    なし

    次の例では、 [タイプ] フィールドを設定してドキュメントバージョンを作成する方法を示します。「DocumentVersionService」も参照してください。

    var versionDefinition = new sn_doc_services.SystemDocumentVersion('491efbee24187410f877a6fed1c2b0a9');

versionDefinition.type('url');
versionDefinition.url('http://one/1.0');

var versionSvc = new sn_doc_services.DocumentVersionService();
gs.info(JSON.stringify(versionSvc.createDocumentVersion(versionDefinition), null, 2));
    {
  "message": "Adding an entry to DocumentVersion for the given docId : 491efbee24187410f877a6fed1c2b0a9, sysId : d5a340d9242cf810f877a6fed1c2b069 is successful.",
  "request_id": "d5a340d9242cf810f877a6fed1c2b069",
  "status": "success"
}

    SystemDocumentVersion - url(文字列 url)

    ドキュメントバージョンの URL を設定します。

    表 : 7. パラメーター
    名前 タイプ 説明
    url 文字列 このバージョンのソースドキュメントの URL。
    表 : 8. 返される内容
    タイプ 説明
    なし

    次の例では、[URL] フィールドをドキュメントバージョンのソースとして設定する方法を示します。「DocumentVersionService」も参照してください。

    var versionDefinition = new sn_doc_services.SystemDocumentVersion('491efbee24187410f877a6fed1c2b0a9');

versionDefinition.type('url');
versionDefinition.url('http://one/1.0');

var versionSvc = new sn_doc_services.DocumentVersionService();
gs.info(JSON.stringify(versionSvc.createDocumentVersion(versionDefinition), null, 2));
    {
  "message": "Adding an entry to DocumentVersion for the given docId : 491efbee24187410f877a6fed1c2b0a9, sysId : d5a340d9242cf810f877a6fed1c2b069 is successful.",
  "request_id": "d5a340d9242cf810f877a6fed1c2b069",
  "status": "success"
}

    SystemDocumentVersion - versionNumber(数字 versionNumber)

    ドキュメントバージョンの番号を設定します。

    表 : 9. パラメーター
    名前 タイプ 説明
    versionNumber 数字 このドキュメントのバージョン番号。
    表 : 10. 返される内容
    タイプ 説明
    なし

    次の例では、バージョン番号を設定してドキュメントバージョンを作成する方法を示します。「DocumentVersionService」も参照してください。

    var versionDefinition = new sn_doc_services.SystemDocumentVersion('491efbee24187410f877a6fed1c2b0a9');

versionDefinition.type('url');
versionDefinition.url('http://one/1.0');
versionDefinition.versionNumber(5);

var versionSvc = new sn_doc_services.DocumentVersionService();
gs.info(JSON.stringify(versionSvc.createDocumentVersion(versionDefinition), null, 2));
    出力：
    {
  "message": "Adding an entry to DocumentVersion for the given docId : 491efbee24187410f877a6fed1c2b0a9, sysId : ff47449d242cf810f877a6fed1c2b06c is successful.",
  "request_id": "ff47449d242cf810f877a6fed1c2b06c",
  "status": "success"
}