SystemDocumentList: Bereichsbezogen, Global

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 1 Minute Lesedauer
  • Die SystemdokumentListe Die API stellt Methoden zum Festlegen der Datensatzfelder in der Tabelle „Dokumentlisten“ [ds_document_lists] bereit.

    Diese API erfordert Dokumentverwaltung Plugin (com.snc.platform_document_management) und wird in bereitgestellt sn_doc_Services Namespace. Informationen finden Sie unter Dokumentservices .

    Verwenden Sie zum Erstellen oder Verwalten einer Dokumentliste DocumentListService-API .

    SystemDocumentList: SystemDocumentList(Zeichenfolge docListName)

    Instanziiert einen SystemdokumentListe Objekt.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    DocListName Zeichenfolge Name der Dokumentliste.
    Tabelle : 2. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie ein instanziiert wird SystemdokumentListe Objekt.

    var docList = new sn_doc_services.SystemDocumentList();

    SystemDocumentList – Beschreibung (Zeichenfolgenbeschreibung)

    Legt das Feld Beschreibung eines neuen Dokumentlistendatensatzes fest.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    description Zeichenfolge Beschreibung der Dokumentliste.
    Tabelle : 4. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie der Dokumentliste eine Beschreibung hinzugefügt wird. Siehe auch DocumentListService-API .

    var dL = new sn_doc_services.SystemDocumentList('My document list');
    
    // Define the document list field
    dL.description('description');
    
    var docList = new sn_doc_services.DocumentListService();
    gs.info(JSON.stringify(docList.createDocumentList(dL), null, 2));
    Ausgabe:
    {
      "message": "Create List for the given name : My document list, List sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
      "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
      "status": "success"
    }

    SystemDocumentList – Name(Zeichenfolge docListName)

    Legt das Feld Name eines Dokumentlistendatensatzes fest.

    Hinweis:
    Sie können den Namen auch als Parameter in festlegen SystemdokumentList() Konstruktor.
    Tabelle : 5. Parameter
    Name Typ Beschreibung
    DocListName Zeichenfolge Name der Dokumentliste.
    Tabelle : 6. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie eine vorhandene Dokumentliste umbenennen. Siehe auch DocumentListService .

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';
    var docListUpdate = new sn_doc_services.SystemDocumentList();
    
    docListUpdate.name('name change');
    
    var docListSvc = new sn_doc_services.DocumentListService();
    gs.info(JSON.stringify(docListSvc.updateDocumentList(docListID , docListUpdate), null, 2));
    Ausgabe:
    {
      "message": "Update List for the given sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
      "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
      "status": "success"
    }