The Open API specification for Synapse is now available for download!

Download Open API Spec

DELETE /entity/{id}

Moves an entity in the trash can, if the skipTrashCan is set to true will flag the entity for purge and it will be deleted as soon as possible.

Note: To delete an Entity the caller must be granted the ACCESS_TYPE.DELETE on the Entity.

Resource URL

https://repo-prod.prod.sagebase.org/repo/v1/entity/{id}

Resource URL Variables
{id} The ID of the Entity to delete.
Parameters
skipTrashCan

optional

If true the entity will be flag for priority purge and deleted as soon as possible
Resource Information
Authentication Required
Required OAuth Scopes modify
HTTP Method DELETE
Request Object None
Response Object None