Content

Overview

The multipart interface can accept multipart messages (https://www.w3.org/Protocols/rfc1341/7_2_Multipart.html ) with files for a configured and started DocumentRouterInstance.

Each part is saved as a file using the filename from the Content-Disposition header. An index file is created according its schema definition. Each Part is handled individually.

It is possible that some parts can be saved and other parts are rejected for multiple reasons.

The files are archived directly (synchrone). They are temporarily stored in a temp folder, which is deleted after request is handled.

Interface

X-index-<key> Header

The X-index-<Key> headers are used to build the idx file. Any number of headers per part is allowed. Make sure that X-Index header fields do have all keys required by schema file (field position > 0)

A special order of the fields is not required.

Example:

The idx files contains only the values.

field names in Content-Disposition header can’t be changed.

Example for Postman

You can use this sample with postman:

Example 2 for Postman

URI

HTTP POST http://localhost:8090/KGSAdmin-DR-4.0.7/documentrouter?CREATE&instanceName=IndexFileBased

Headers

Content-Type: multipart/form-data; boundary=0kao5EFK-fUENGjSjSlfk3DnForlirbP4

Body

--0kao5EFK-fUENGjSjSlfk3DnForlirbP4
Content-Disposition: form-data;  name="file1"; fileName="fileone.pdf"
Content-Type: application/pdf
Content-Length: 3
X-index-ImageFileName: fileone.pdf
X-index-repository: FI
x-index-SAP_OBJECT_ID: 100019000000002021
Content-Transfer-Encoding: binary

abc
--0kao5EFK-fUENGjSjSlfk3DnForlirbP4
Content-Disposition: form-data;  name="file2"; fileName="filetwo.pdf"
Content-Type: application/pdf
Content-Length: 3
X-index-repository: FI
X-index-ImageFileName: filetwo.pdf
x-index-SAP_OBJECT_ID: 100019000000002021
Content-Transfer-Encoding: binary

abc
--0kao5EFK-fUENGjSjSlfk3DnForlirbP4--

Cache Directory and config

Multipart request can contain files of any size. All files bigger than a certain value will be saved in the cache directory and deleted after processing in: <Instance WorkDirectory>/multipartcache. Make sure that the DocumentRouter has read and write permissions. In certain scenarios it could make sense to change the cache size to prevent to many files in memory and a possible out of memory exception. Configure the default value in bytes in the Instance Config in “Common”-Tab:

...

When the file exceeds this value it is not stored in memory but saved in the cache directory.

Possible Return Codes

 [{
        "statuscode": <errorCode>,
        "message": <error Message>,
        "filename": <Filename that could not be processed>
 }]

Response Bodies

201

[
    {
        "statuscode": 201,
        "message": ""
    },
    {
        "statuscode": 201,
        "message": ""
    }
]

400

503

{
    "statuscode": 503,
    "message": "DR instance IndexFileBased not running."
}