Deletes all form sessions linked against certain forms identified by their formId or sessionId.
This method is called by iCM after republishing a form as existing form sessions may not be valid for the newly published form definition. For example, the form session may refer to a field which has been deleted in the updated version of the form.
Any files in the filestore owned by each form session will be deleted if otherwise unreferenced.
Parameters
Name | Type | Description |
---|---|---|
formIDs | Array<Long> | IDs of forms to delete all sessions from. Either formIDs or publicSessionIDs must be set |
publicSessionIDs | Array<String> | Session IDs of the sessions to delete. Either formIDs or publicSessionIDs must be set |
userIDs | Array<Long> | If set only sessions with a user ID matching those in the list will be deleted |
Example Request
{
"id": 1,
"method": "deleteFormSessions",
"params": {
"formIDs": [220, 221],
"publicSessionIDs": ["", ""],
"userIDs": [1, 2, 3]
}
}
Example Response
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"result": {
"deletedCount": 2
}
}
}
Last modified on June 27, 2023