-
Managing Items and Permissions
- Adding or Updating a Single Basic Item in a Shared Push Source
- Adding or Updating a Single Item in a Push Source
- Deleting an Item and Optionally its Children
- Deleting Old Items in a Push Source
- Managing Batches of Items in a Push Source
- Pushing Item Data
- Understanding Push Source Item Metadata
- Simple Permission Model Definition Examples
- Complex Permission Model Definition Example
- Understanding the parentId Property
- Item Models
Deleting 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 are testing the service or when you need to perform a very small content update.
Use the Delete an item and optionally its children operation to remove an item from a specific Push source.
You should never use this operation repetitively to delete many items in a Push source (i.e., 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:
- The batch operation (see Managing Batches of Items in a Push Source).
- The delete older than operation (see Deleting Old Items in a Push Source).
Request template
DELETE https://push.cloud.coveo.com/v1/organizations/<MyOrganizationId>/sources/<MySourceId>/documents?deleteChildren=<true|false>&documentId=<MyItemURI> HTTP/1.1
Authorization: Bearer <MyAccessToken>
In the request path:
- Replace
<MyOrganizationId>with the actual ID of the target Coveo Cloud organization (see Retrieving the ID of a Coveo Cloud V2 Organization). - Replace
<MySourceId>with the actual ID of the target Push source (see Creating a Push Source and Retrieving the ID of a 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://push.cloud.coveo.com/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 (e.g.,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 (e.g.,file%3A%2F%2Ffolder%2FdummyItem.html).
In the Authorization HTTP header:
- Replace
<MyAccessToken>with an access token that grants the Organization - View and Sources - View/Edit privileges in the target Coveo Cloud organization (see Creating an API key, Getting the Privileges of an Access Token, and Getting Your Coveo Cloud V2 Platform Access Token).
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 Cloud indexing pipeline.
This does not imply that the item was successfully deleted in the target Push source (see Understanding the Push API Processing Delay).
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 IDLE status once this operation has successfully returned, assuming you have no more operations to perform as part of this content update (see Updating the Status of a Push Source).
Sample Request
Deleting an item and its children
DELETE https://push.cloud.coveo.com/v1/organizations/mycoveocloudv2organizationg8tp8wu3/sources/mycoveocloudv2organizationg8tp8wu3-rp5rxzbdz753uhndklv2ztkfgy/documents?deleteChildren=true&documentId=file%3A%2F%2Ffolder%2F HTTP/1.1
Authorization: Bearer **********-****-****-****-************
Successful response - 202 Accepted
null