Models
List models
The following query parameters are available:
Name | Type | Description |
---|---|---|
limit |
integer | Number of results to return per page. |
offset |
integer | The initial index from which to return the results. |
id |
string | id |
organization |
string | organization |
battery_type |
string | battery_type |
name |
string | name |
project |
string | project |
created |
string | created |
updated |
string | updated |
Create a model
Member Role required
Editing requires an Member role in the organization the resource belongs to. Find out more.
curl https://app.rejoule.io/models/ \
-X POST \
-H "Authorization: User <token>" \
-F "organization=8" \
-F "name=hello-world"
Get a single model
The response object contains the following fields:
Name | Type | Description |
---|---|---|
id |
integer | |
organization |
integer | |
battery_type |
array | Selection of all battery types for which this model can produce estimates. |
name |
string | Free-form name to identify this battery model. |
projects |
array | |
notes |
string | |
created_at |
string | |
updated_at |
string | |
created_by |
string |
Update a model
Member Role required
Editing requires an Member role in the organization the resource belongs to. Find out more.
curl https://app.rejoule.io/models/{id}/ \
-X PUT \
-H "Authorization: User <token>" \
-F "organization=16" \
-F "name=hello-world"
Delete a model
Owner Role required
Deleting requires an Owner role in the organization the resource belongs to. Find out more.