Document Management Services

You can save files sent from customers, screenshots taken, etc. via Diyalog to your institution's document management system. For this, if a rest API is provided as detailed below, the Diyalog system will be able to integrate automatically with this system.

In addition, if you already have an API for integration into your document management system, a development can be made and integrated into the Diyalog system to integrate with this platform via Diyalog. For this, it will be sufficient to share the API details with the Diyalog technical team.

Create Document (API)#

For saving documents to your system, the followinf rest api service is expected to be implemented and openned to us in your system.

Request URI#

https://<YOUR-API-ENDPOINT>/CreateDocument

Request Method#

POST

Request#

Sample Request

{
  "userId" : "<enterprise user id that will save the document>",
  "fileName" : "<file name to be saved>",
  "fileType" : "<file type (file extension) to be saved>",
  "fileDescription" : "<Description about document to be saved>"
  "base64FileContent" : "<content of the file as base64 encoded>",
  "dmsFolderName" : "<Folder name that file will be saved to in your document managent system.>",
  "documentFields" : [
    {
      "some field 1" : "meta data value 1" 
    },
    {
      "some metadata 2" : "meta data value 2"
    },
    ...
  ]
}

` Details of the fields in the above request are given below.

Field Name	Type	Definition
userId	String	enterprise user id that will save the document
fileName	String	file name to be saved
fileType	String	file type (file extension) to be saved
fileDescription	String	Description about document to be saved
base64FileContent	String	Content of the file as base64 encoded
dmsFolderName	String	Folder name that file will be saved to in your document managent system.
documentFields	Array of Json Object	If you need some metadata information specific to your document management system, we provide this information in this field.

Response#

A following json object response is expected as a response.

{
    "success" : true,
  "documentId" : "document id created in your system",
  "errorMessage" : "Optional - Error message if success is false"
}