DocumentListEntryService: Bereichsbezogen, global

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 3 Minuten Lesedauer

    • Die DocumentListEntryService -API bietet Methoden zum Verwalten von Dokumentvorlagen in einer Dokumentliste.

    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.

    Bevor Sie die Methoden in dieser API verwenden, fügen Sie eine Dokumentvorlage mit ihrer Version hinzu, und erstellen Sie eine Dokumentliste. Verwenden Sie die SystemDocumentListEntry -API, um Dokumente einer Dokumentliste hinzuzufügen oder daraus zu entfernen.

    Bevor Sie die Methoden in dieser API verwenden können, müssen Sie ein Dokument mit seiner Standardversion hinzufügen und eine Dokumentliste erstellen.
    So definieren Sie ein Dokument als Vorlage:
    • Definieren Sie das Dokumentobjekt, indem Sie die Methode „SystemDocument – template()“ auf „wahr“ festlegen. Erstellen oder aktualisieren Sie den Dokumentdatensatz mit den Methoden in der DocumentService -API.
    • Aktivieren Sie das Kontrollkästchen Vorlage eines Dokuments in der Tabelle „Dokumente“ [ds_document].

    DocumentListEntryService: DocumentListEntryService()

    Instanziiert ein DocumentListEntryService -Objekt.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie ein DocumentListEntryService -Objekt instanziiert wird.

    var s = new sn_doc_services.DocumentListEntryService();

    DocumentListEntryService: createDocumentListEntry(SystemDocumentListEntry-Eintrag)

    Fügt einer Dokumentliste einen Dokumentvorlageneintrag hinzu.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    Eintrag SystemDocumentListEntry Eine oder mehrere Eigenschaften, die Felder eines Dokumentlisteneintrags-Objekts darstellen.
    Tabelle : 3. Ausgabe
    Typ Beschreibung
    Objekt Sys_id des neuen Datensatzes in der Tabelle „Dokumentlisteneinträge“ [ds_document_list_entry] mit einer Erfolgsmeldung. Andernfalls Fehlermeldung.
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.message Meldung, die den Erfolg oder Fehler bestätigt.

    Datentyp: Zeichenfolge
    <Object>.request_id Sys_id des Datensatzes in der Tabelle „Dokumentlisteneinträge“ [ds_document_list_entry]

    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. message enthält Details.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie Sie einen Dokumenteintrag definieren und einer Dokumentenliste hinzufügen. Siehe auch SystemDocumentListEntry.

    var docListEntry = new sn_doc_services.SystemDocumentListEntry('21afddea2460fc10f877a6fed1c2b0dd');
docListEntry.document("9acd7fea24587410f877a6fed1c2b060");
docListEntry.description('birth certificate');

var dlEntrySvc = new sn_doc_services.DocumentListEntryService();
gs.info(JSON.stringify(dlEntrySvc.createDocumentListEntry(docListEntry), null, 2));
    Ausgabe:
    {
  "message": "Create List Entry , List Entry sysId : d3f0b13624e8fc10f877a6fed1c2b0d9is successful.",
  "request_id": "d3f0b13624e8fc10f877a6fed1c2b0d9",
  "status": "success"
}

    DocumentListEntryService - deleteDocumentListEntry(String listEntryId)

    Entfernt einen Dokumentlisteneintrag aus der Tabelle „Dokumentlisteneinträge“ [ds_document_list_entry].

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    listEntryId Zeichenfolge Sys_id eines Dokumentlistendatensatzes in der Tabelle „Dokumentlisteneinträge“ [ds_document_list_entry].
    Tabelle : 5. Ausgabe
    Typ Beschreibung
    Objekt Erfolgs- oder Fehlermeldung. 
    {
  "message": "String",
  "status": "String"
}
    <Object>.message Meldung, die den Erfolg oder Fehler bestätigt.

    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. message enthält Details.

    Datentyp: Zeichenfolge

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

    var listEntryId = 'd3f0b13624e8fc10f877a6fed1c2b0d9';

var dlEntrySvc = new sn_doc_services.DocumentListEntryService();
gs.info(JSON.stringify(dlEntrySvc.deleteDocumentListEntry(listEntryId), null, 2));
    Ausgabe:
    {
  "message": "Deleting an entry for the given documentListEntrySysId : d3f0b13624e8fc10f877a6fed1c2b0d9 is successful.",
  "status": "success"
}

    DocumentListEntryService - updateDocumentListEntry(String listEntryId, SystemDocumentListEntry-Eintrag)

    Aktualisiert die Feldwerte eines vorhandenen Dokumentlisteneintrags.

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    listEntryId Zeichenfolge Sys_id eines Dokumentlistendatensatzes in der Tabelle „Dokumentlisteneinträge“ [ds_document_list_entry].
    Eintrag SystemDocumentListEntry Eine oder mehrere Eigenschaften, die Felder eines Dokumentlisteneintrags-Objekts darstellen.
    Tabelle : 7. Ausgabe
    Typ Beschreibung
    Objekt Erfolgs- oder Fehlermeldung. 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.message Meldung, die den Erfolg oder Fehler bestätigt.

    Datentyp: Zeichenfolge
    <Object>.request_id Sys_id des Datensatzes in der Tabelle „Dokumentlisteneinträge“ [ds_document_list_entry]

    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. message enthält Details.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie Sie die Beschreibung eines Dokumentlisteneintrags aktualisieren. Siehe auch SystemDocumentListEntry.

    var listEntryId = 'd3f0b13624e8fc10f877a6fed1c2b0d9';

var entry = new sn_doc_services.SystemDocumentListEntry();
entry.description('description update');

var dlEntrySvc = new sn_doc_services.DocumentListEntryService();
gs.info(JSON.stringify(dlEntrySvc.updateDocumentListEntry(listEntryId, entry), null, 2));
    Ausgabe:
    {
  "message": "Updating an entry for the given documentListEntrySysId : d3f0b13624e8fc10f877a6fed1c2b0d9 is successful.",
  "request_id": "d3f0b13624e8fc10f877a6fed1c2b0d9",
  "status": "success"
}