Open Documentation Menu

Requirements for metadata and download URLs

In the example below, you can learn how to use the batch URLs generated in the section “Defining the export filter” to request the relevant metadata for the filter and the download URLs of the associated usage files.

You obtain the URLs for retrieving the metadata by creating an export filter or by following the “next” links in the metadata.

Note

For a complete export, you have to retrieve all the pages from all the batches provided.

Request:

  • dmsdocs app: GET https://<base URL>/<URL from batch or “next” link>

  • Standalone application: GET http://<local IP>/<URL from batch or “next” link>

  • Accept: application/json

Response:

Sample structure of a response (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&"
        }
    }
}

Description of the tag:

Tag name

Description

_links.self

Link to your export batch.

_links.next

Link to the next batch that is used to provide additional documents and metadata. If no link is present, this batch has been fully queried.

docs

Item containing the metadata and information for the files.

errorDocs

List of errors that occurred while processing the export batch. Documents in this list could not be fully exported.

files

Combines all the information for the files into a metadata record.

metadata

Document information in the standard import format (importable format).

/dmsdocs