Creates a task in a case. The parameters supplied should conform to the task's settings.
The user details supplied when creating the task should be those of the assigned case manager, or the system user. The system user is defined in the Setup and Naming section of the case configuration and by convention is called CMSYSTEMUSER.
Namespace
goss.CaseManagement.v1.api.caseTask.caseTaskCreate
Worker
serverlibrary
Parameters
| Name | Type | Description |
|---|---|---|
| caseBusinessKey | String | Required. The business key of the the case to create the task for |
| caseTaskToCreate | Object | Required. The details of the case task to create |
| caseTaskToCreate.caseTypeTaskId | String | Required. The ID of the task to create. This can be found in the "Setup" section of the task configuration |
| caseTaskToCreate.groupId | String | Required. The name of the group (as set in iCM) the case task will be assigned to |
| caseTaskToCreate.userId | String | Optional. The username of the user (as set in iCM) that the task will be assigned to. The user must be a member of the group defined above |
| caseTaskToCreate.userName | String | Optional. A name for the user to display in the case history notes |
| caseTaskToCreate.permissions | Object | Optional. These settings control what the task user will be able to see from the parent case |
| caseTaskToCreate.permissions.canViewAttachments | Object | Optional. The settings here must conform to the task configuration (ie if the task configuration doesn't allow attachments, trying to pass attachments will fail) |
| caseTaskToCreate.permissions.canViewAttachmentsallAttachments | Boolean | Optional. If true the task user will be able to access all case attachments |
| caseTaskToCreate.permissions.canViewAttachments.allowedAttachments | Array | Optional. An array of the filestore IDs of the attachments to pass to the task |
| caseTaskToCreate.permissions.canViewContactDetails | Boolean | Optional. If true the task user will be able to view the contact details of the user who raised the case |
| caseTaskToCreate.permissions.canViewCase | Boolean | Optional. If true the task user will be able to view the case details |
| caseTaskToCreate.targetOverride | Object | Optional. Optional overrides for target and reminder calculation. If not supplied the SLAs set in the task configuration will be used |
| caseTaskToCreate.targetOverride.disable | Object | Optional. Settings to disable timer and reminder calculation. If none of the properties are set this will be ignored. |
| caseTaskToCreate.targetOverride.disable.target | Boolean | Optional. If true both the SLA and reminder will be disabled |
| caseTaskToCreate.targetOverride.disable.reminder | Boolean | Optional. If true the reminder will be disabled |
| caseTaskToCreate.targetOverride.actualDate | Object | Optional. Set dates for the target SLA and reminder. If only target is supplied reminders will not be set. |
| caseTaskToCreate.targetOverride.actualDate.target | String <date-time> | Optional. The task SLA in the format "2026-03-17T09:23:08Z" |
| caseTaskToCreate.targetOverride.actualDate.reminder | String <date-time> | Optional. The date the reminder will be sent in the format "2026-03-17T09:23:08Z" |
| caseTaskToCreate.targetOverride.targetDate | Object | Optional. The supplied dates will have the working scheme for the case's rules applied to ensure a valid working day. For example, if the supplied date is a Sunday, the SLA will be advanced to the next valid working day |
| caseTaskToCreate.targetOverride.targetDate.target | String <date-time> | Optional. The task SLA in the format "2026-03-17T09:23:08Z" |
| caseTaskToCreate.targetOverride.targetDate.reminder | String <date-time> | Optional. The date the reminder will be sent in the format "2026-03-17T09:23:08Z" |
| user | Object | Required. Details of the user creating the task. This must be the current case manager, or the system user if the case is unclaimed |
| user.displayName | String | Optional. A name to use in the case history notes |
| user.siteUserName | String | Required. The username as set in iCM |
| proxyUser | Object | Optional. Details of the user being proxied (eg this could be the system user, while the user is the actual user) |
| proxyUser.displayName | String | Optional. A name to use in the case history notes |
| proxyUser.siteUserName | String | Required. The username as set in iCM |
| trackProgress | Boolean | Optional. If true the task will be created asynchronously and updates will be provided via a tracking session. |
Example
See Case Management API for the full example call structure.
{
"caseBusinessKey": "1234-1234-1234-1234",
"caseTaskToCreate": {
"caseTypeTaskId": "investigate22",
"groupId": "CM-TASKUSERS",
"userId": "TIMG",
"userName": "Tim",
"permissions": {
"canViewAttachments": {
"allowedAttachments": [
"Abc"
],
"allAttachments": false
},
"canViewContactDetails": false,
"canViewCase": false
},
"targetOverride": {
"disable": {
"reminder": false,
"target": false
},
"targetDate": {
"reminder": "2026-03-17T09:28:02Z",
"target": "2026-03-17T09:28:02Z"
}
}
},
"user": {
"displayName": "Adam",
"siteUserName": "ADAM"
},
"trackProgress": false
}
Responses
Success
The task was created successfully.
{
"id": 156,
"result": {
"success": true,
"complete": true,
"startTime": "2026-03-17T11:51:35.887Z",
"endTime": "2026-03-17T11:51:38.495Z",
"duration": 2608,
"createdTasks": [{
"allAttachments": false,
"cancellable": false,
"details": "Investigate\n\nName: Tim Gulliver-Haynes\nEmail: [email protected]\nPhone: 01752123456\nAddress: address",
"formEnquiry": "CASEMANAGEMENTINVESTIGATEENQUIRYVIEWV1EN",
"groupID": "CM-ALLOTMENTENQUIRIES",
"groupName": "CM-ALLOTMENTENQUIRIES",
"processName": "cminvestigatev1",
"raised": "2026-03-17T11:51:36.266Z",
"reminder": "",
"showAttachments": "",
"showReadOnly": true,
"status": "New",
"statusDesc": "New",
"started": "2026-03-17T11:51:36.266Z",
"summary": "Investigate",
"target": "",
"taskID": 8,
"taskType": "investigate65",
"taskName": "Investigate",
"userID": "TIMG",
"userName": "Tim",
"businessKey": "0630-0387-2840-1148"
}]
},
"jsonrpc": "2.0"
}
Error
The message property will contain details of the error.
{
"jsonrpc": "2.0",
"id": 19,
"result": {
"success": false,
"complete": true,
"startTime": "2026-03-17T09:56:35.739Z",
"endTime": "2026-03-17T09:56:36.767Z",
"duration": 1028,
"errors": [{
"message": "Case task Investigate does not allow attachments to be passed to it, but permissions.canViewAttachments is set",
"data": {}
}]
}
}
