PIpipeshub-ai
Knowledge Base

Restore a deleted record

Changed on

Bring a record back from the trash, together with everything deleted in the same action: a folder comes back with its contents, a file with its attachments, a multi-select delete with every item it removed.

Needs "Move Deleted Records to the Trash" on in Labs.

Required permission: the role the delete needed. A single file needs OWNER, WRITER or FILEORGANIZER on its collection; a folder or several items need OWNER or WRITER.

Names: an item whose name another item next to it now uses comes back as "name (restored)" (a file keeps its extension: "report (restored).pdf").

Search: restored files are indexed again, so they return to search and chat once indexing finishes. reindexPending lists any that could not be queued; reindex those by hand. A file that is back but whose indexing never started is queued again when it is restored again, and the indexing service queues it on its own after about an hour.

A record that is not in the trash answers 200 with nothing restored. The query string and any request body are ignored.

post/knowledgeBase/record/{recordId}/restore

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/knowledgeBase/record/{recordId}/restore
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: kb:delete

Path parameters

recordIdstring required

Record ID of any item in the delete batch

Response

Record restored, with everything deleted along with it

successtrue required
messagestring required
batchIdstring nullable

The delete batch that was restored

reindexPendingboolean

Some restored files could not be queued for indexing

reindexPendingRecordIdsstring[]

Files to reindex by hand to make them searchable again

reindexPendingReasonstring
renamePendingRecordIdsstring[]

Items restored under a name another item next to them has; rename them

renamePendingReasonstring

Changes