resources/documents/{did} (delete)

To permanently delete a single import batch (document) from a translation memory or terminology database.

An import batch groups all segments that were added to the memory in a single import operation — for example the result of consolidating segments from a project, or the content of an uploaded TMX or XLIFF file. The import label shown in the "History of imported data" popup identifies each batch.

Any attempt to delete an import batch from a project memory will raise an error. To delete a project memory's content you need to delete the related project.

URL

CODE

(DELETE) /api/resources/documents/{did}

PARAMETERS

The URL parameters are:

did

The import batch ID (also referred to as the document ID in the API). The batch must belong to a translation memory or term base.

int, Mandatory

ACCESS RIGHTS

The method returns an error if the user is not authorized to delete resources (R603), the import batch does not exist, or belongs to a project memory.

RESULTS

This method is an Asynchronous operations: Your request is queued and will execute as soon as possible.

Asynchronous operations - How to:

The API method immediately returns a JSON object that includes the ID of the operation (look for the requestId property).

However, the operation has not yet been executed. You will need to await the operation’s termination to obtain results.

Waiting can be done in two ways: Polling: Regularly check the operation’s status. Webhook Call: Wait for a callback using the callbackurl parameter in your request. We strongly recommend the latter approach. For more details, please refer to the documentation: Asynchronous operations

The JSON results, obtained with polling or with a callback, include the operation status as well as any results specific to the API method. Below is an example of successful termination:

JSON

{
  "trm": {
    "requestid": 1234,
    "status": "Finished",
    "statusText": "Finished!"
  }
}