Delete an item and optionally, its children in a Push source
Delete an item and optionally, its children in a Push source
Being able to delete a single item in a Push source, possibly along with its children, can especially useful when you’re testing the service or when you need to perform a very small content update.
This article provides an overview of the DELETE /sources/{sourceId}/documents HTTP request.
DELETE /sources/{sourceId}/documents Push API request (highlighted) as it progresses through the Coveo indexing pipeline.
|
You should never use this operation repetitively to delete many items in a Push source (that is, to perform a large scale content update). When this is what you need to do, depending on what you want to achieve, you should either use:
|
Request template
|
Request definition |
In the request path:
-
Replace
<MyOrganizationId>with the actual ID of the target Coveo organization (see Retrieve the organization ID). -
Replace
<MySourceId>with the actual ID of the target Push source (see Create a Push source).
In the query string:
-
Set
deleteChildrentotrueif you want to recursively delete all items matching the<MyItemURI>+/. Set it tofalseotherwise.
This means that the following request:
DELETE https://api.cloud.coveo.com/push/v1/organizations/mycoveocloudv2organizationg8tp8wu3/sources/mycoveocloudv2organizationg8tp8wu3-rp5rxzbdz753uhndklv2ztkfgy/documents?deleteChildren=true&documentId=file%3A%2F%2Ffolder HTTP/1.1 Authorization: Bearer **********-****-****-****-************will recursively delete all items whose
documentIdmatchesfile://folder/*from the target Push source (for example,file://folder/file1.txt,file://folder/subfolder/file2.txt, etc.). -
Replace
<MyItemURI>with the URL-encoded URI of the item to delete in the target Push source (for example,file%3A%2F%2Ffolder%2FdummyItem.html).
In the Authorization HTTP header:
-
Replace
<MyAccessToken>with a Push source API key that grants the set of privileges required to push items to your source.
A successful response (202 Accepted) indicates that the delete operation was successfully forwarded to the service and is now enqueued to be processed in the Coveo indexing pipeline.
|
|
Note
This doesn’t imply that the item was successfully deleted in the target Push source (see About the Push API processing delay). |
|
Leading practice: Update the status of your Push source
If you set your Push source to an active status before, you should consider setting it back to the |
Sample request
The following example shows how to delete an item and its children.
|
|
Request definition |
|
|
Successful response - 202 Accepted |
Very useful
Not really
Very useful
Not really