Creates a link between two cases.
Namespace
goss.CaseManagement.v1.api.case.caseLinks.caseLinkCreate
Worker
serverlibrary
Parameters
| Required Properties | Type | Description |
|---|---|---|
| caseBusinessKey | String <businessKey> | The business key of the case |
| linkedCaseBusinessKey | String <businessKey> | The business key of the case to link to |
| type | String | The type of relationship between the two cases |
| user | Object | Details of the user |
| user.siteUserId | Integer | The iCM site ID of the user |
| user.siteUserName | String | The username of a valid case manager |
| Optional Properties | Type | Description |
| description | String | A description or note for the link |
| user.displayName | String | The display name of the user |
| proxyUser | Object | Details of a user acting on behalf of the user |
| proxyUser.siteUserName | String | The username of the proxy user |
| proxyUser.displayName | String | The display name of the proxy user |
{
"caseBusinessKey": "0123-4567-8901-2345",
"linkedCaseBusinessKey": "5432-1098-7654-3210",
"type": "Abc",
"description": "Abc",
"user": {
"siteUserId": 1234,
"siteUserName": "Abc",
"displayName": "Abc"
},
"proxyUser": {
"siteUserName": "Abc",
"displayName": "Abc"
}
}
Rules
| Rule | Validation error |
|---|---|
| User must exist | Could not retrieve siteUser details |
| Case must exist | Could not retrieve case Case 1234-5678-9012-3456 |
| Linked case must exist | Could not retrieve case Case 1234-5678-9012-3456 |
| Case must be active | User aUser does not have permissions to add a case link |
| User must be the case owner, a member of the case managers group or the case manager if one is assigned | User aUser does not have permissions to add a case link |
Behaviour
If the validation rules pass
- Creates a link of the given type from the case to the linked case
- If a description is provided, it is saved with the link
Last modified on 20 October 2026
