Undelete API

Undelete Projects and Users

It is possible to manage deleted Projects and Users via the API.

Manage deleted Projects via the API

Deleted Projects are available by call:

POST /api/v2/projects?where=(DeleteDate!=null)&includeDeleted=true

The result will be as follows:

[
	{
    "resourceType": "Project",
    "id": 13,
    "name": "Scrum"
  },
  {
    "resourceType": "Project",
    "id": 15,
    "name": "Kanban"
  }
]

If you need to restore deleted a Project, use the following query. Just replace {id} with the ID of the target Project:

POST /api/deletedItems/v1/projects/{id}/restore

Manage deleted users via API

Similar calls for deleted Users. To get a list, use the following endpoint:

POST /api/v2/users?where=(DeleteDate!=null)&includeDeleted=true

To restore a User, use:

POST /api/deletedItems/v1/users/{id}/restore

Undelete Projects and Users (v.3.10 and earlier)

It is possible to undelete a project or a user using the following endpoint:

POST /api/v1/Undelete
Content-type: application/json

Two fields should be passed as a parameters within POST request:

entityType: Project or User
id: numeric ID of an entity that is the subject for recovery

Undelete Project:

{
 "entityType" : "Project",
 "Id": 13
}

Undelete User:

{
 "entityType" : "User",
 "Id": 9
}

Undelete of Native + Extendable Domain Entities (v. 2206.1.0.9518+)

Undelete API is available on URI /api/v1/undelete by method POST and accepts next JSON bodies:

{
"Id": 8,
"EntityType": "UserStory"
}

Please note that Administrator's token is required to perform the action.

Moreover, there is bulk API on URI /api/v1/undelete/bulk by method POST and accepts next JSON bodies:

[{
"Id": 8,
"EntityType": "UserStory"
},
{
"Id": 2,
"EntityType": "UserStory"
}]

Entities that cannot be undeleted

1. Comments
2. Milestones
3. Group/Program

Undelete of Work Items within UI (v.2410.1+)

Starting from v.2410.1, Assignable Entities can be undeleted by Users with Administrator permissions at Settings > Deleted Items. For more details, check Targetprocess Guide: https://targetprocess.com/guide/working-with-entities/undelete-entity/