DocumentListService: Bereichsbezogen, Global

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 4 Minuten Lesedauer

    • Die DocumentListService Die API bietet Methoden zum Erstellen, Löschen und Aktualisieren einer Dokumentliste.

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

    Die Dokumentverwaltung Das Plugin unterstützt auch die Erstellung von Listen von Dokumentvorlagen, die Ihrem Dokument zugeordnet werden sollen. Zum Beispiel eine Bewerbung, die mehrere Dokumente wie Diplom, ID oder Reisepass erfordert. Nachdem Sie Ihre Dokumentliste hinzugefügt haben, können Sie Dokumentvorlagen hinzufügen:
    So definieren Sie ein Dokument als Vorlage:
    • Definieren Sie das Dokumentobjekt, indem Sie festlegen SystemDocument – template() Methode auf „wahr“. Erstellen oder aktualisieren Sie den Dokumentdatensatz mit den Methoden in DocumentService API.
    • Aktivieren Sie das Kontrollkästchen Vorlage eines Dokuments in der Tabelle Dokumente [ds_document].
    Mit den folgenden APIs können Sie Dokumente definieren und verwalten:
    So definieren Sie ein Dokument als Vorlage:
    • Definieren Sie das Dokumentobjekt, indem Sie festlegen SystemDocument – template() Methode auf „wahr“. Erstellen oder aktualisieren Sie den Dokumentdatensatz mit den Methoden in DocumentService API.
    • Aktivieren Sie das Kontrollkästchen Vorlage eines Dokuments in der Tabelle Dokumente [ds_document].

    Siehe auch SystemdokumentListe .

    DocumentListService: DocumentListService()

    Instanziiert einen DocumentListService Objekt.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine

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

    var s = new sn_doc_services.DocumentListService();

    DocumentListService – createDocumentList(SystemDocumentList-Dokument)

    Erstellt eine Dokumentliste in der Tabelle „Dokumentlisten“ [ds_document_lists].

    Die Dokumentverwaltung Das Plugin unterstützt auch die Erstellung von Listen von Dokumentvorlagen, die Ihrem Dokument zugeordnet werden sollen. Zum Beispiel eine Bewerbung, die mehrere Dokumente wie Diplom, ID oder Reisepass erfordert. Nachdem Sie Ihre Dokumentliste hinzugefügt haben, können Sie Dokumentvorlagen hinzufügen:

    Verwenden Sie CreateDocumentsFromList() Methode zum Erstellen von Dokumenten aus der Dokumentvorlagenliste.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    doc SystemdokumentListe Mindestens eine Eigenschaft, die Felder eines neuen Datensatzes darstellt. Die Namenseigenschaft ist erforderlich und kann mit festgelegt werden SystemdokumentListe Konstruktor oder Name () Methode.
    Tabelle : 3. Rückgaben
    Typ Beschreibung
    Objekt SYS_ID des neuen Datensatzes in der Tabelle „Dokumentlisten“ [ds_document_lists] mit einer Erfolgsmeldung. Andernfalls Fehlermeldung.
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.Nachricht Nachricht, die Erfolg oder Fehler bestätigt.

    Datentyp: Zeichenfolge
    <Object>.Request_ID SYS_ID des Datensatzes in der Tabelle „Dokumentlisten“ [ds_document_lists].

    Datentyp: Zeichenfolge
    <Object>.Status Status, der angibt, ob der Vorgang erfolgreich ist.
    Mögliche Werte:
    • Erfolg: Der Vorgang war erfolgreich.
    • Fehler: Der Vorgang war nicht erfolgreich. Die messageStellt Details bereit.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie Sie eine Dokumentliste erstellen. Siehe auch SystemdokumentListe .

    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"
}

    DocumentListService – createDocumentsFromList(Zeichenfolge listSysId, Zeichenfolge tableName, Zeichenfolge tableSysId)

    Erstellt Dokumente aus einer Liste von Dokumentvorlagen.

    Hinweis:
    Bevor Sie diese Methode verwenden, erstellen Sie mit eine Dokumentvorlagenliste CreateDocumentList() Methode.
    Tabelle : 4. Parameter
    Name Typ Beschreibung
    ListSysId Zeichenfolge SYS_ID eines Dokumentlistendatensatzes in der Tabelle „Dokumentlisten“ [ds_document_lists].
    tableName Zeichenfolge Name der Tabelle, die den Datensatz enthält, für den eine Liste von Dokumentvorlagenreferenzen hinzugefügt wird.
    tableSysId Zeichenfolge SYS_ID des Datensatzes, der den Inhalt enthält, aus dem eine Liste von Dokumentvorlagenreferenzen hinzugefügt werden soll.
    Tabelle : 5. Rückgaben
    Typ Beschreibung
    Objekt Erfolgs- oder Fehlermeldung. 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.Nachricht

    Nachricht, die die Anzahl der Dokumentvorlagen in der Dokumentliste enthält.

    Datentyp: Zeichenfolge
    <Object>.Request_ID SYS_ID des Datensatzes in der Tabelle „Dokumentlisten“ [ds_document_lists].

    Datentyp: Zeichenfolge
    <Object>.Status Status, der angibt, ob der Vorgang erfolgreich ist.
    Mögliche Werte:
    • Erfolg: Der Vorgang war erfolgreich.
    • Fehler: Der Vorgang war nicht erfolgreich. Die messageStellt Details bereit.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie eine Liste von Dokumentvorlagenreferenzen zu einem Datensatz hinzugefügt wird. Die Dokumentation wird einem Datensatz in der Tabelle „Incidents“ [Incident] hinzugefügt.

    var result = new sn_doc_services.DocumentListService().createDocumentsFromList('21afddea2460fc10f877a6fed1c2b0dd', 'incident', 'd7158da0c0a8016700eef46c8d1f3661');
gs.info(JSON.stringify(result, null, 2));
    Ausgabe:
    {
  "message": "Created 1 document references for the given table name: incident, table sysId : d7158da0c0a8016700eef46c8d1f3661 with list SysId 21afddea2460fc10f877a6fed1c2b0dd",
  "request_id": "21afddea2460fc10f877a6fed1c2b0dd",
  "status": "success"
}

    DocumentListService – deleteDocumentList(String listSysId)

    Entfernt einen Dokumentdatensatz aus der Tabelle „Dokumentlisten“ [ds_document_lists].

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    ListSysId Zeichenfolge SYS_ID eines Dokumentlistendatensatzes in der Tabelle „Dokumentlisten“ [ds_document_lists].
    Tabelle : 7. Ausgabe
    Typ Beschreibung
    Objekt Erfolgs- oder Fehlermeldung. 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.Nachricht Nachricht, die Erfolg oder Fehler bestätigt.

    Datentyp: Zeichenfolge
    <Object>.Request_ID SYS_ID des Datensatzes in der Tabelle „Dokumentlisten“ [ds_document_lists].

    Datentyp: Zeichenfolge
    <Object>.Status Status, der angibt, ob der Vorgang erfolgreich ist.
    Mögliche Werte:
    • Erfolg: Der Vorgang war erfolgreich.
    • Fehler: Der Vorgang war nicht erfolgreich. Die messageStellt Details bereit.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie ein Dokumentlistendatensatz gelöscht wird. Siehe auch SystemdokumentListe .

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';

var docListSvc = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docListSvc.deleteDocumentList(docListID), null, 2));
    Ausgabe:
    {
  "message": "Delete List for the given sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}

    DocumentListService – updateDocumentList(Zeichenfolge docSysId, SystemDocumentList-Dokument)

    Aktualisiert die Feldwerte einer vorhandenen Dokumentliste.

    Tabelle : 8. Parameter
    Name Typ Beschreibung
    ListSysId Zeichenfolge SYS_ID eines Dokumentlistendatensatzes in der Tabelle „Dokumentlisten“ [ds_document_lists].
    doc Systemdokument Mindestens eine Eigenschaft, die Dokumentlistenfelder darstellt, die aktualisiert werden sollen.
    Tabelle : 9. Rückgaben
    Typ Beschreibung
    Objekt Erfolgs- oder Fehlermeldung. 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.Nachricht Nachricht, die Erfolg oder Fehler bestätigt.

    Datentyp: Zeichenfolge
    <Object>.Request_ID SYS_ID des Datensatzes in der Tabelle „Dokumentlisten“ [ds_document_lists].

    Datentyp: Zeichenfolge
    <Object>.Status Status, der angibt, ob der Vorgang erfolgreich ist.
    Mögliche Werte:
    • Erfolg: Der Vorgang war erfolgreich.
    • Fehler: Der Vorgang war nicht erfolgreich. Die messageStellt Details bereit.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie Sie den Namen und die Beschreibung einer Dokumentliste aktualisieren. Siehe auch SystemdokumentListe .

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';

var docListUpdate = new sn_doc_services.SystemDocumentList();
docListUpdate.name('name change');
docListUpdate.description('description update');

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"
}