Toggle menu

caseTargetDateSet

Sets the target date of a case.

Namespace

goss.CaseManagement.v1.api.case.caseTargetDate.caseTargetDateSet

Worker

serverlibrary

Parameters

Required PropertiesTypeDescription
caseBusinessKeyString <businessKey>The business key of the case
caseTargetDateString <date-time>The new target date for the case
userObjectDetails of the user
user.siteUserNameStringThe username of a valid case manager
Optional PropertiesTypeDescription
noteStringA note to record against the case
privateBooleanWhether the note is private. Defaults to true
proxyUserObjectDetails of a user acting on behalf of the user
proxyUser.siteUserNameStringThe username of the proxy user

{
    "caseBusinessKey": "0123-4567-8901-2345",
    "caseTargetDate": "2026-01-01T12:00:00.000Z",
    "note": "Abc",
    "private": true,
    "user": {
        "siteUserName": "Abc"
    },
    "proxyUser": {
        "siteUserName": "Abc"
    }
}

Returns

PropertyTypeDescription
successBooleanWhether the request completed successfully
errorsArrayAny errors that occurred
warningsArrayAny warnings that occurred
caseOperationsObjectDetails of the operations carried out on the case

Rules

RuleValidation error
User must existCould not retrieve siteUser details
Case must existCould not retrieve case Case 1234-5678-9012-3456
User must be a member of the case managers group or the case manager if one is assignedUser aUser does not have permissions to set the target date

Behaviour

If the validation rules pass

  • Sets the target date of the case
  • If a note is provided, it is recorded against the case. The note is private unless private is set to false
Last modified on 23 October 2026