Toggle menu

reassignCase

Reassigns a case to another user or group.

Namespace

goss.CaseManagement.v1.api.reassignCase

Worker

serverlibrary

Parameters

Required PropertiesTypeDescription
caseBusinessKeyString <businessKey>The business key of the case
assignGroupNameStringThe name of the user group who will be able to claim the case. If assigning to a user this value can be an empty string. No checks are made to see if the group is a valid user group for the case type (or if the group exists)
reasonDescStringA reason for reassigning
Optional PropertiesTypeDescription
assignUserNameStringThe username of the user the case will be assigned directly to. If both assignUserName and assignGroupName are supplied, assignUserName takes precedence. You must make sure the user exists
noteStringA private note that will be added to the case history
debugBooleanDefault: false. Set true to return debug information ("notes") in the response message

Example

See Case Management API for a full example call.

{
    "note": "Reassigning to another team",
    "caseBusinessKey": "0490-1464-3301-8495",
    "assignGroupName": "MANAGERS",
    "reasonDesc": "Escalated"
}

Responses

Success

{
    "jsonrpc": "2.0",
    "id": 207,
    "result": {
        "success": true
    }
}

Error

In this case the business key didn't exist.

{
    "jsonrpc": "2.0",
    "id": 206,
    "result": {
        "success": false,
        "errors": ["CM error: Couldn't find any active executions."]
    }
}

Last modified on 01 September 2022

Share this page

Facebook icon Twitter icon email icon

Print

print icon