copyCase

Creates a copy of an existing case with a new business key.

The case you'd like to copy can be open or closed. If the original case is already closed, the terminated process instance must still exist in the workflow engine as this is the source of the data for the copy (the default behaviour is for an iCM Scheduled Tasks to delete terminated processes that are over a year old).

Copies can be linked, and it's possible to close both the original and the copy as part of the copying process. Values from the original case can also be overridden.

Note that this function creates a "shallow" copy of a case. The copy only includes:

• case type
• stage
• status
• contact details
• form fields from the original case and additional details form

It does not copy:

• attachments
• emails
• history
• appointments
• tasks
• subscribers
• questions

The copy of the case starts a new workflow process instance with a new business key and a start date of the time the copy was made. As the copy is a new case, emails and notifications will be sent as if the case had been raised normally.

Namespace

goss.CaseManagement.v1.api.copyCase

Worker

serverlibrary

Parameters

Examples

See Case Management API for a full example call.

This first example shows the minimum that needs to be set to copy a case:

{
    "case": {
        "caseId": "6651-5379-9769-1525"
    }
}

This example shows the full parameter structure:

{
    "case": {
        "caseId": "7078-6032-7376-9241",
        "close": {
            "closureNote": "Abc",
            "closureReason": "Closed"
        }
    },
    "user": {
        "siteUserName": "TIMG"
    },
    "copiedCase": {
        "contact": {
            "phoneNumber": "01752123456",
            "name": "Bill",
            "address": "New address",
            "email": "support@gossinteractive.com"
        },
        "language": "CY",
        "targetDate": "2022-10-22T11:44:29Z",
        "caseStatus": "In progress",
        "form": {
            "startForm": "ALLOTMENTENQUIRIES",
            "summaryForm": "ALLOTMENTENQUIRIES"
        },
        "close": {
            "closureNote": "Abc",
            "closureReason": "Closed"
        },
        "caseSubTypeId": "inspection",
        "caseManagerId": "TIMG",
        "ownerUserName": "TIMTEST",
        "caseStageId": "Stage 1",
        "caseTypeId": "newtype"
    },
    "linkCase": {
        "linkType": "Parent Of/Child Of"
    }
}

Responses

Success

{
    "id": 133,
    "result": {
        "success": true,
        "warnings": [],
        "errors": [],
        "caseBusinessKey": "7843-2019-5614-1867"
    },
    "jsonrpc": "2.0"
}

Error Messages

1. "Case links have not been enabled"
2. "Link type {0} is not configured on this environment - Available types are ({1}}"
3. "Could not retrieve case {0}"
4. "Process {0} is not a case"
5. "User {0} does not exist"
6. "Could not write process variables to case {0} during force closure"
7. "Could not terminate processes ({0}) during force closure"

Warning Messages

1. "No link type provided using default {0}"
2. "Could not load tasks from workflow"
3. "Original case has already been closed"
4. "Could not close case {0} using standard closure attempting to force the closure of the case"