SystemDocumentVersion: Bereichsbezogen, global

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 2 Minuten Lesedauer
  • Die SystemDocumentVersion -API bietet Methoden zum Festlegen der Werte der Quellversion eines Dokuments in der Versionstabelle [ds_document_version].

    Diese API erfordert das Plugin Dokumentverwaltung (com.snc.platform_document_management) und wird im Namespace sn_doc_services bereitgestellt. Weitere Informationen finden Sie unter Dokumentenservices.

    Verwenden Sie zum Erstellen einer Dokumentversion die DocumentVersionService-API.

    SystemDocumentVersion: SystemDocumentVersion(String docSysId)

    Instanziiert ein SystemDocumentVersion -Objekt.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    docSysId Zeichenfolge Sys_id eines Dokumentdatensatzes in der Tabelle „Dokumente“ [ds_document].
    Tabelle : 2. Ausgabe
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie ein SystemDocumentVersion -Objekt instanziieren und eine Dokumentversion erstellen. Siehe auch 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));

    Ausgabe:

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

    SystemDocumentVersion – document(String docSysId)

    Gibt den Dokumentdatensatz für diese Version an.

    Hinweis:
    Alternativ können Sie den Namen als Parameter im Konstruktor SystemDocumentVersion() festlegen.
    Tabelle : 3. Parameter
    Name Typ Beschreibung
    docSysId Zeichenfolge Sys_id eines Dokumentdatensatzes in der Tabelle „Dokumente“ [ds_document].
    Tabelle : 4. Ausgabe
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie das Namensfeld einer Dokumentversion festgelegt wird. Siehe auch DocumentVersionServicecreateDocumentVersion().

    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));
    Ausgabe:
    {
      "message": "Adding an entry to DocumentVersion for the given docId : 491efbee24187410f877a6fed1c2b0a9, sysId : 1c504c91242cf810f877a6fed1c2b08b is successful.",
      "request_id": "1c504c91242cf810f877a6fed1c2b08b",
      "status": "success"
    }

    SystemDocumentVersion – type(String docType)

    Legt das Feld „Typ“ einer Dokumentversion fest.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    docType Zeichenfolge Dokumentquelltyp.
    Gültige Werte:
    • URL
    • Anhang
    Standard: Anhang
    Hinweis:
    Ein Anhang kann derzeit nur in der UI der Tabelle „Dokumentversionen“ [ds_document_version] und nicht mit der API hinzugefügt werden.
    Tabelle : 6. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie das Typfeld festlegen und eine Dokumentversion erstellen. Siehe auch 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(Zeichenfolgen-URL)

    Legt die URL einer Dokumentversion fest.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    URL Zeichenfolge URL des Quelldokuments für diese Version.
    Tabelle : 8. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie das URL-Feld als Quelle einer Dokumentversion festgelegt wird. Siehe auch 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(Nummer versionNumber)

    Legt die Nummer einer Dokumentversion fest.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    versionNummer Nummer Versionsnummer für dieses Dokument.
    Tabelle : 10. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie die Versionsnummer festlegen und eine Dokumentversion erstellen. Siehe auch 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));
    Ausgabe:
    {
      "message": "Adding an entry to DocumentVersion for the given docId : 491efbee24187410f877a6fed1c2b0a9, sysId : ff47449d242cf810f877a6fed1c2b06c is successful.",
      "request_id": "ff47449d242cf810f877a6fed1c2b06c",
      "status": "success"
    }