Sign in
generic

DELETE: Deletes a document from the collection

If the document has already been deleted, the operation will succeed anyway. Normally, documents are not really deleted from the collection but they are only marked as deleted. For special cases the deletion can be irreversible using permanent parameter.

This operation provides autopruning of the collection (if autopruning is enabled).

This operation requires delete permission for the API and the collection (e.g. api:treatments:delete)

delete/{collection}/{identifier}

Query parameters

permanentboolean

If true, the deletion will be irreversible and it will not appear in HISTORY operation. Normally there is no reason for setting this flag.

Response

The request was successfully processed

statusinteger

Example response

{
  "status": 200
}

Changes

Changed in 4 of the 6 revisions of this API.517

  • 5b0d424433e11See the full diff
    • ○

      the endpoint scheme security accessToken was removed from the API

      api-security-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8252719e8e3418See the full diff
    • ▲

      removed the success response with the status 204

      response-success-status-removed

    • ○

      the endpoint scheme security accessToken was added to the API

      api-security-added

    • ○

      the endpoint scheme security jwtoken was added to the API

      api-security-added

    • ○

      the endpoint scheme security apiKeyAuth was removed from the API

      api-security-removed

    • ○

      added the media type application/json for the response with the status 401

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 403

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 404

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 422

      response-media-type-added

    • ○

      added the success response with the status 200

      response-success-status-added

  • 6b2eb690f4ab1See the full diff
    • ○

      added the non-success response with the status 422

      response-non-success-status-added

  • e3a79347562947See the full diff
    • ▲

      removed the media type application/json for the response with the status 401

      response-media-type-removed

    • ▲

      removed the media type application/json for the response with the status 403

      response-media-type-removed

    • ▲

      removed the media type application/json for the response with the status 404

      response-media-type-removed

    • ▲

      removed the success response with the status 200

      response-success-status-removed

    • ○

      the endpoint scheme security apiKeyAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security jwtoken was removed from the API

      api-security-removed

    • ○

      added the new optional header request parameter Date to all path's operations

      new-optional-request-default-parameter-to-existing-path

    • ○

      added the new optional query request parameter now to all path's operations

      new-optional-request-default-parameter-to-existing-path

    • ○

      added the new optional query request parameter token to all path's operations

      new-optional-request-default-parameter-to-existing-path

    • ○

      removed the non-success response with the status 422

      response-non-success-status-removed

    • ○

      added the success response with the status 204

      response-success-status-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog