Get Project Definition

Back to JEA API docs

The Get Project Definition command retrieves the latest project definition in a Update Command object ready to be modified. A valid JWT token must be included in the header, or the transaction will be rejected with an HTTP 401 Unauthorized error code.

• Method: GET
• Target: https://api.ensims.com/jea_web/api/definition/<project ID>
• Header: Authorization “Bearer <existing JWT>”
• Body: none
• Success: Update Command Object
• Error: HTTP 401 - Unauthorized

To send the Project Report command using curl:

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

On successful operation, an Command object for Update operation is returned. This object can be modified and submitted to update the project. 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

# Get a report of the 'circle' project 
r = requests.get('https://api.ensims.com/jea_web/api/definition/circle', cookies=cookies)
  
r.json()