Change Made to DocumentSummaryData Data Contract

A new property, FolderPath, has been added to the DocumentSummaryData data contract.

Effective Version:

This change will be live in iMIS EMS 20.3.211, which is scheduled to be released at the end of August 2025.

What’s Changing:

Third-party developers who rely on the Path property in the DocumentSummaryData data contract will need to update their integrations to use the new FolderPath property when they create new documents or communication templates using the respective POST requests.

Example (Before – v20.3.208):

Request Endpoint:

POST /Communication/ 
Content-Type: application/json

Request Body:

{  
    "$type": "Asi.Soa.Communications.DataContracts.CommunicationData, Asi.Contracts",  
    "DataSources": {...},  
    "OutputSteps": {...},  
    "Options": {...},  
    "Description": "",  
    "DocumentId": "34d2c84f-b431-477e-90ae-7b4aa63bf7e9",  
    "Name": "Default",  
    "Path": "$/Example/Communications/Templates/Samples/Default",  
}

Response (201 Created):

{ 
    "$type": "Asi.Soa.Communications.DataContracts.CommunicationData, Asi.Contracts", 
    "DataSources": {...}, 
    "OutputSteps": {...}, 
    "Options": {...}, 
    "Description": "", 
    "DocumentId": "34d2c84f-b431-477e-90ae-7b4aa63bf7e9", 
    "Name": "Default", 
    "Path": "$/Example/Communications/Templates/Samples/Default", 
}

Example (After – v20.3.211):

Request Endpoint:

POST /Communication/  
Content-Type: application/json

Request Body:

{ 
"$type": "Asi.Soa.Communications.DataContracts.CommunicationData, Asi.Contracts", 
"DataSources": {...}, 
"OutputSteps": {...}, 
"Options": {...}, 
"Description": "", 
"DocumentId": "34d2c84f-b431-477e-90ae-7b4aa63bf7e9", 
"Name": "Default", 
"Path": "$/Example/Communications/Templates/Samples/Default", 
"FolderPath": "$/Example/Communications/Templates/Samples" // 👈 New property added
}

Response (201 Created):

{  
    "$type": "Asi.Soa.Communications.DataContracts.CommunicationData, Asi.Contracts",  
    "DataSources": {...},  
    "OutputSteps": {...},  
    "Options": {...},  
    "Description": "",  
    "DocumentId": "34d2c84f-b431-477e-90ae-7b4aa63bf7e9",  
    "Name": "Default",  
    "Path": "$/Example/Communications/Templates/Samples/Default",  
    "FolderPath": "$/Example/Communications/Templates/Samples" // 👈 New property added
}

Impact:If you do not use either the Creates a DocumentSummary or Creates a Communication POST endpoints in your integrations, you are unaffected by this change and no action is required.

Please review your current implementations and plan for this change to ensure a smooth transition.