Skip to main content

POST /clone

Description​

Creates a copy of a task and returns a json object with the client task ID and duplicated task ID of the server

The route handles the POST request made to the /clone path.

HTTP methodRoute
POST/clone

Once the request is received, the following items are created on the server side:

  • the duplicates of the tasks to be cloned
  • the map with the pair of the client task ID: duplicated task ID for each task being cloned

Payload​

The server needs to receive a json object with the next properties:

NameTypeDescription
targetIdnumberOptional. The ID of the target task where the cloned task will be added.
parentnumberOptional. The ID of the parent task.
projectnumberOptional. The ID of the project to which a new task should be added.
batchobjectRequired. An array of objects of all tasks that are cloned. If a task has child items, they should be included into the object.

Only tasks with the same parent ID/project ID will be processed per request.

Example:

{
    "parent": null,
    "targetId": 18,
    "batch": [
        {
            "text": "If you press Tab, this task will become a subtask. To edit it, press Ctrl (Cmd) + Enter.",
            "checked": false,
            "due_date": "2022-10-07T21:00:00Z",
            "creation_date": "2022-10-31T11:20:04.171Z",
            "project": 1,
            "assigned": [4],
            "id": "temp://1667215197027",
            "parent": null
        },
        {
            "text": "You can create tasks with an infinite number of subtasks.",
            "checked": false,
            "creation_date": "2022-10-31T11:20:04.173Z",
            "project": 1,
            "assigned": [4],
            "id": "temp://1667215197028",
            "parent": null
        },
        {
            "text": "Use the Tab and Shift + Tab keys for this.",
            "checked": false,
            "creation_date": "2022-10-31T11:20:04.174Z",
            "parent": "temp://1667215197028",
            "project": 1,
            "id": "temp://1667215197029"
        }
    ]
}

Response​

The route returns a json object with the client task ID and duplicated task ID of the server.
Client tasks IDs are temporary IDs received in the requests and values are new tasks IDs generated during data saving.

Example:

{
    //“clientId”: serverId,
    "temp://1667215197027": 62,
    "temp://1667215197028": 63,
    "temp://1667215197029": 65,
    //...
}

The HTTP status code shows whether the request succeeds (response.status == 200) or fails (response.status == 500).

Related articles: