Delete Project

Back to JEA API docs

Use the Delete Project command to delete the exploration process of an existing project to its original created state. The command deletes all exist data associated with the project.

A valid JWT token must be included in the header, otherwise, the transaction will be rejected with an HTTP 401 Unauthorized error code. The result of the operation will be reported in an Engine Response object.

• Method: GET
• Target: https://api.ensims.com/jea_web/api/delete/<projectId>
• Header: Authorization “Bearer <existing JWT>”
• Body: none
• Success: Engine Response
• Error: HTTP 401 - Unauthorized

Result of the operation is returned as an engine response object as seen in the example here:

{
  "description": "EA Engine of project circle has been deleted. Project name can now be reuesed.",
  "ok": true
}

If the project is not accessible, the response may be:

{
  "description": "Project \"circle\" does not exist or not accessible to user \"yi@jeplus.org\".",
  "ok": false
}

To send the Delete Project command using curl:

curl -b cookies  https://api.ensims.com/jea_web/api/delete/circle

On successful operation, an engine response object is returned. If the existing JWT is invalid, an HTTP 401 Unauthorized code will be returned.

Make sure Requests is correctly installed in your Python environment, and run the following the lines:

import requests

# Make a request with the stored cookies from the log on transaction

# Delete 'circle' project 
r = requests.get('https://api.ensims.com/jea_web/api/delete/circle', cookies=cookies)
  
r.json()