User Tools


Start Project

Back to JEA API docs


The Start Project command kicks off the exploration process of an existing project. The project must be in the “Created”, “Terminated”, or “Cancelled” states for the operation to be successful. 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.

Synopsis

Engine Response

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

{
  "description": "EA engine for project circle is launched.",
  "ok": true
}

If the project is in a state that cannot be started, the response may be:

{
  "description": "EA engine for project circle is already running.",
  "ok": false
}

Or:

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

Example using curl://

To send the Start Project command using curl:

curl -H "Authorization:Bearer eyJraWQiOiIxNTAyMzE2Mz...Qons9gjFXUrpQ" http://jea.ensims.com/jea_web/api/start/circle

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

Example using Python Requests

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

import requests

jwt = 'eyJraWQiOiIxNTAyMzE2MzY...JEwH4KoyBqDDTkfjmsQons9gjFXUrpQ'
headers = {'Authorization': 'Bearer ' + jwt}
body = {}

# Start 'circle' project 
r = requests.get('http://jea.ensims.com/jea_web/api/start/circle', headers=headers, json=body)
  
r.json()


Site Tools