Festlegen des Exportfilters

Verwenden der API-Funktionen

Sie müssen URLs, die von der API zurückgegeben wurden, ggf. um die Basis-URL erweitern.

Warnung

Sicherheitshinweis: Beachten Sie, dass Authentifizierungsinformationen ausschließlich an den konfigurierten API-Endpunkt übermittelt werden dürfen.

Der Ablauf eines Exportvorganges besteht aus mehreren Schritten:

ein Export-Job wird erzeugt, der den Filter und die Anzahl der parallelen Exportvorgänge beschreibt.
Für jede zurückgegebene Batch-URL in der Auflistung "batches" wird eine weitere Anfrage durchgeführt. Siehe dazu: .Anforderungen der Metadaten und Download-URLs
Nach Abruf einer Batch-URL wird in dem Ergebnis ermittelt, ob es zu dem Batch eine weitere Seite gibt. Es muss so lange einem ggf. vorhandenen "next"-Link gefolgt werden, bis die zurückgegebene Ressource keinen weiteren Eintrag für "next" beinhaltet.
Wenn alle parallelen Anfragen abgeschlossen sind, ist der Export beendet.

Anfrage:

Initiale Anfrage zur Anforderung eines Exports mit Verwendung eines Filters zur Einschränkung der für den Export vorgesehenen Dokumente.

dmsdocs-App: PUT https://<Basis-URL>/dmsdocs/r/<Repository-ID>/export
Standalone-Anwendung: PUT http://<Lokale IP>:8333/repoexport/export
Content-Type: application/json
Accept: application/json

{
    "modifiedAfter": "2017-11-07T13:27:37.643Z",
    "modifiedBefore": "2021-11-07T13:27:37.643Z",
    "numberOfProcesses": 4,
    "documentTypesByD3Id": [
        "1e4b6",
        "5fa04"
    ],
    "documentTypesById": [],
    "docIds": [],
    "batchSize": 10,
    "migrated" : false
}

Name des Tags	Beschreibung
documentTypeById	Kategorie, auf die der Filter angewendet wird. Verwenden Sie diesen Tag für GUIDs. Wenn Sie keine Kategorie festlegen, werden alle Dokumente ausgewählt.
documentTypeByD3Id	Kategorie, auf die der Filter angewendet wird. Verwenden Sie diesen Tag für d.3-IDs. Wenn Sie keine Kategorie festlegen, werden alle Dokumente ausgewählt.
modifiedAfter	Zeitstempel nach ISO 8601. Dieser Zeitstempel wird für Delta-Exporte verwendet und markiert den Zeitpunkt der letzten Bearbeitung eines Dokuments (overAllProcDate). Dokumente, die exakt zum Zeitpunkt des Zeitstempels bearbeitet wurden, werden nicht herausgefiltert. Der Zeitstempel muss mit dem dahinterliegenden DBMS kompatibel sein.
modifiedBefore	Zeitstempel nach ISO 8601. Dieser Zeitstempel wird für Delta-Exporte verwendet und markiert den Zeitpunkt der letzten Bearbeitung eines Dokuments (overAllProcDate). Dokumente, die exakt zum Zeitpunkt des Zeitstempels bearbeitet wurden, werden nicht herausgefiltert. Der Zeitstempel muss mit dem zugrunde liegenden DBMS kompatibel sein.
docIds	Spezielle Liste von Dokument-IDs (docIds), die exportiert werden sollen. Aktuell können serverseitig maximal 100 Dokument-IDs verarbeitet werden.
batchSize	Maximale Blockgröße (Anzahl der Dokumente), die über einen GET-Request abgerufen werden.
numberOfProcesses	Die geplante Anzahl von Prozessen, die auf die Export-API planmäßig parallel zugreifen.

Antwort:

Content-Type: application/json

{
    "documentsToExportCount": "164",
    "filter": {
        "modifiedAfter": "2017-11-07T13:27:37.643Z",
        "modifiedBefore": "2023-01-01T01:01:01.001Z",
        "numberOfProcesses": 4,
        "documentTypesByD3Id": [],
        "documentTypesById": [],
        "docIds": [],
        "batchSize": 200
    },
    "batches": [
        "/dmsdocs/r/a88362cb-f626-5fc2-9293-61f6eafc4b0b/export?startDocId=DE00000000&batchNumber=0&mB=2021-11-07T13:27:37.643Z&mA=2017-11-07T13:27:37.643Z&dTD3Id=1e4b6,5fa04&bS=10&nP=4&",
        "/dmsdocs/r/a88362cb-f626-5fc2-9293-61f6eafc4b0b/export?startDocId=G200000001&batchNumber=1&mB=2021-11-07T13:27:37.643Z&mA=2017-11-07T13:27:37.643Z&dTD3Id=1e4b6,5fa04&bS=10&nP=4&",
        "/dmsdocs/r/a88362cb-f626-5fc2-9293-61f6eafc4b0b/export?startDocId=M100000007&batchNumber=2&mB=2021-11-07T13:27:37.643Z&mA=2017-11-07T13:27:37.643Z&dTD3Id=1e4b6,5fa04&bS=10&nP=4&",
        "/dmsdocs/r/a88362cb-f626-5fc2-9293-61f6eafc4b0b/export?startDocId=M200000007&batchNumber=3&mB=2021-11-07T13:27:37.643Z&mA=2017-11-07T13:27:37.643Z&dTD3Id=1e4b6,5fa04&bS=10&nP=4&"
    ]
}

Name des Tags	Beschreibung
documentsToExportCount	Anzahl der Dokumente, die den Filterkriterien entsprechen.
filter	Bestätigung der erhaltenen Filterkriterien.
batches	Links zu Export-Batches (relativ angegeben zur Export-API). Unter diesen Adressen werden per GET-Request Metadaten und Download-URL bereitgestellt. Der Link enthält dabei die Batch-Nummer und die zugehörigen Filterkriterien.

Aktivieren der API für On-Premises

Anforderungen der Metadaten und Download-URLs