Delete An Entity

To soft delete an entity, we need to make the following HTTP request

delete
 
/api/v1/{entity-type}/{id}
Deleting an Entity
Parameters
Path
entity-type*
The type of entity to modify
entity-id*
The ID of entity to modify
Header
content-type*
Set to application/json
authorization
Set to Bearer {access-token} if roles in Schema is not anonymous. Else token can be empty
Responses
200: OK
Entity Deleted Success Response
​
Usage
cURL
curl --location \
	 --request 'DELETE' \
	 --header 'content-type: application/json' \
	 --header 'authorization: Bearer {access-token}' \
	 '{registry-url}/api/v1/Teacher/{id}'
HTTPie
http DELETE \
	'{registry_url}/api/v1/Teacher/{id}' \
	'content-type: application/json' \
	'authorization: Bearer {access-token}'
{registry-url} is usually http://localhost:{port}. The port can be found under the registry section in the docker-compose.yml file and is usually 8081.

Update A Property Of An Entity

Next - API Reference

Schema

Last modified 6mo ago