Get Project Data

Back to JEA API docs

The Get Project Data command retrieves either the whole data archive, or the part after the specified model version and generation, of a given project. The Data Archive object contains all the information about the history of the project that the JEA engine holds.

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/data/<project ID>, or https://api.ensims.com/jea_web/api/data/<project ID>/<generation>
• Header: Authorization “Bearer <existing JWT>”
• Body: none
• Success: Data Archive JSON object
• Error: HTTP 401 - Unauthorized

The Data Archive object represent all the data that the JEA engine holds about the a project. These include the project definitions, solution details and stats, and the exploration history.

The details of this JSON object are provided here.

To send the Project Data command using curl:

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

Or, to get the new project data after generation 15:

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

On successful operation, a Data Archive object 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 the whole data archive of the 'circle' project 
r = requests.get('https://api.ensims.com/jea_web/api/data/circle', cookies=cookies)
  
# Get the data archive of the 'circle' project after generation 15
r = requests.get('https://api.ensims.com/jea_web/api/data/circle/15', cookies=cookies)
  
r.json()