Document Uploader Service

The document uploader service allows for the upload of physical documents as well as document links. It accepts both https, post (multipart/formdata & JSON/base64 file) and web socket connections (json/base64 file). See the bottom of this document for a list of all allowed file extensions.

Expected Behavior when uploading a file

Adding files with different titles

Adding files with different filenames

Adding files with different content based hash

Adding files with same filename, title and content based hash

Uploading a Linked File

The simplest method of registering a document in the system is via an external link. However, many of the fields are the same when uploading a physical file.

{
    "clientCode": "testDoc2",
    "cultureCode": "en-GB",
    "title": "China Select FactSheet Individual",
    "path": "http://www.myassetmanager.com/factsheet.pdf",
    "meta": {
        "doctype":{
            "value":"FactSheet"
        }
    }
}

Uploading a File Via multipart/form-data

The above details apply to uploading a document and including a file, except that the fields need to be passed as form variables. The one key difference is that a file must be passed instead of a path.

Uploading a File using a Base64 encoded file

The above details apply to uploading a document and including a file, the file will need to be base64 encoded and supplied with the body of the request.

{
    "clientCode": "china_select_individual_fs",
    "cultureCode": "en-GB",
    "title": "China Select FactSheet Individual",
    "file": "< BASE 64 ENCODED FILE >",
    "originalname": "China_Select_Individual_Factsheet.pdf",
    "meta": {
        "doctype":{
            "value":["FactSheet"]
        }
    }
}

Note that the originalname is required for this call.

Uploading a File Via Websocket

If a bulk load of files is required the websocket can be used to push multiple files at once.

Initiating a websocket connection is as simple as connecting to the above endpoint using a websocket library in the language of your choice. An initiation handshake must be made by sending a JSON message as below:

{
    "token": <INSERT TOKEN HERE>,
    "entityType": "document",
    "totalRows": <INSERT TOTAL NUMBER OF DOCUMENTS HERE>
}

This should be the first message sent. If the handshake is successful then a response message will be sent as:

{
    "status": "GO"
}

It is important not to send any more messages until the handshake response has been accepted, only then can messages be sent. The loader will wait until it has received totalRows messages before invoking its loading function.

When done it will respond with an object of the form:

{
    "status": "FINISHED",
    "failures": "[<LIST OF FAILED ITEMS>]"
}

Any failures and their associated error messages will be in the failures string array.

The endpoint accepts messages similar to that of the /addDocumentNoFile endpoint. However, the wss method also accepts documents as base64 encoded strings.

{
    "clientCode": "testDoc2",
    "cultureCode": "en-GB",
    "title": "China Select FactSheet Individual",
    "file": <DOCUMENT AS BASE64 ENCODED STRING>,
    "meta": {
        "doctype": {
            "value": "FactSheet"
        }
    }
}

Allowed File Extensions

Uploading with Document expiry

Include an expires property to set the expires field within the data base. This field is used to determine if the document has expired. If the expires property is not supplied, then the default value of 0000-00-00 00:00:00 will be save and cause the system to consider that the document does not expire.

{
    "clientCode": "testDoc2",
    "cultureCode": "en-GB",
    "title": "China Select FactSheet Individual",
    "path": "http://www.myassetmanager.com/factsheet.pdf",
    "meta": {
        "doctype":{
            "value":"FactSheet"
        }
    },
    "expires": "2022-12-01"
}

Updating Document Meta

Update the meta for a document

{
    "clientCode": "80e2a0e762993542db7f028e014f2e16777e576f",
    "cultureCode": "en-GB",
    "title": "Test",
    "meta": {
        "abc": { "value": "foo" },
        "xyz": { "value": "bar" },
        "asd": { "value": ["yu", "me", "tu"] }
    }
}