Menü der Dokumentation

Anforderungen der Metadaten und Download-URLs

Im folgenden Beispiel erfahren Sie, wie Sie mit Hilfe der im Kapitel "Festlegen des Exportfilters" generierten Batch-URLs, die zum Filter passenden Metadaten und Download-URLs der zugehörigen Nutzdateien anfordern können.

Die URLs zum Abrufen der Metadaten erhalten Sie durch das Anlegen eines Exportfilters, oder indem Sie dem "next"-Links in den Metadaten folgen.

Anmerkung

Für einen vollständigen Export müssen Sie alle Seiten aus allen bereitgestellten Batches abrufen.

Anfrage:

  • dmsdocs-App: GET https://<BaseURL>/<URL aus Batch oder "next"-Link>

  • Standalone-Anwendung: GET http://<Lokale IP>/<URL aus Batch oder "next"-Link>

  • Accept: application/json

Antwort:

Beispielhafter Aufbau einer Antwort (Content-Type: application/json):

{
    "docs": [
        {
            "files": [
                {
                    "fileId": 1,
                    "filename": "DE00000000.1",
                    "downloadUrl": "/dmsdocs/r/a88362cb-f626-5fc2-9293-61f6eafc4b0b/Document/DE00000000/files/1/root"
                },
                {
                    "fileId": 1,
                    "downloadUrl": "/dmsdocs/r/a88362cb-f626-5fc2-9293-61f6eafc4b0b/Document/DE00000000/files/1/P1",
                    "dependentExtension": "P1"
              }
          ],
            "metadata": {
                "docId": "DE00000000",
                [...]
          }
        }
    ],
        "errorDocs" : [
                {
                        "docId": "DE00000001",
                        "message": "<Beschreibung eines Exportfehlers>"
                }
        ],
    "_links": {
        "next": {
            "href": "/dmsdocs/r/a88362cb-f626-5fc2-9293-61f6eafc4b0b/export?startDocId=DE00000004&batchNumber=4&mB=2021-11-07T13:27:37.643Z&mA=2017-11-07T13:27:37.643Z&dTD3Id=1e4b6,5fa04&bS=1&nP=4&"
        },
        "self": {
            "href": "/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=1&nP=4&"
        }
    }
}

Beschreibung der Tags:

Name des Tags

Beschreibung

_links.self

Link zum eigenen Export-Batch.

_links.next

Link zum nächsten Batch, unter dem weitere Dokumente und Metadaten bereitgestellt werden. Wenn kein Link vorhanden ist, wurde dieser Batch vollständig abgefragt.

docs

Element, das Metadaten und Informationen zu den Dateien enthält.

errorDocs

Liste von Fehlern, die beim Verarbeiten des Export-Batches aufgetreten sind. Dokumente, die in dieser Liste aufgeführt werden, konnten nicht vollständig exportiert werden.

files

Fasst alle Informationen der Dateien zu einem Metadatensatz zusammen.

metadata

Dokumentinformationen im Standardimportformat (importierbares Format).

/dmsdocs