Toggle menu

caseQuestionCreate

Creates a question and sends it to the case owner.

Namespace

goss.CaseManagement.v1.api.case.caseQuestion.caseQuestionCreate

Worker

serverlibrary

Parameters

Required PropertiesTypeDescription
caseBusinessKeyString <businessKey>The business key of the case
caseQuestionObjectDetails of the question
caseQuestion.questionStringThe question to send to the case owner
userObjectDetails of the user
user.siteUserNameStringThe username of the person who raised the case, or a valid case manager
Optional PropertiesTypeDescription
caseQuestion.taskBusinessKeyStringThe business key of the task the question relates to
caseQuestion.taskRefStringThe reference of the task the question relates to
caseQuestion.taskStageStringThe stage of the task the question relates to

{
    "caseBusinessKey": "0123-4567-8901-2345",
    "caseQuestion": {
        "question": "Abc",
        "taskBusinessKey": "Abc",
        "taskRef": "Abc",
        "taskStage": "Abc"
    },
    "user": {
        "siteUserName": "Abc"
    }
}

Returns

PropertyTypeDescription
successBooleanWhether the request completed successfully
errorsArrayAny errors that occurred. Only returned if there are errors
warningsArrayAny warnings that occurred. Only returned if there are warnings

Rules

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

Behaviour

If the validation rules pass

  • Creates the question against the case
  • Sends the question to the case owner
Last modified on 20 October 2026