Energy Status Resource¶
Get Energy Status¶
HTTP Request
GET /api/energyStatuses/{id}
📋 Description: Retrieves detailed information about a specific energy status identified by the provided ID, enabling users to monitor and assess energy performance metrics effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "isDefault": true,
8 "objectAvailable": true,
9 "energyStatusType": "string",
10 "isDefaultType": true
11}
Update Energy Status¶
HTTP Request
PUT /api/energyStatuses/{id}
📋 Description: Updates the energy status identified by the specified ID, allowing for modifications to its attributes to reflect current operational conditions.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated energy status information, including relevant metrics and attributes for the specified energy resource. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "isDefault": true,
8 "objectAvailable": true,
9 "energyStatusType": "string",
10 "isDefaultType": true
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{}
Response Schema
Delete Energy Status¶
HTTP Request
DELETE /api/energyStatuses/{id}
📋 Description: Deletes a specific energy status record identified by the provided ID, ensuring the removal of outdated or incorrect data from the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Get All Energy Statuses¶
HTTP Request
GET /api/energyStatuses
📋 Description: Retrieves the current energy status data, providing insights into energy consumption and efficiency metrics for informed decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
isAvailable |
query |
boolean |
false |
Whether the resource is available |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
isAvailable |
|
query |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "name": "string",
8 "isDefault": true,
9 "objectAvailable": true,
10 "energyStatusType": "string",
11 "isDefaultType": true
12 }
13]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the current status of energy consumption and production metrics, facilitating informed decision-making in energy management and sustainability initiatives.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» name |
string |
true |
none |
Name of the resource |
» isDefault |
boolean |
false |
none |
Whether the resource is default |
» objectAvailable |
boolean |
false |
none |
Indicates whether the energy object is currently available for use within the system. |
» energyStatusType |
string |
false |
none |
Type of the energy status |
» isDefaultType |
boolean |
false |
none |
Whether the resource is default |
Create Energy Status¶
HTTP Request
POST /api/energyStatuses
📋 Description: Creates a new energy status entry in the system, enabling the tracking and management of energy consumption data for enhanced operational efficiency.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the energy status data, including metrics and timestamps, necessary for tracking and managing energy consumption effectively. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "isDefault": true,
8 "objectAvailable": true,
9 "energyStatusType": "string",
10 "isDefaultType": true
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1{}
Response Schema
Get All Energy Status Type¶
HTTP Request
GET /api/energyStatuses/energyStatusType
📋 Description: Retrieves the available energy status types, providing essential information for energy management and reporting purposes. This operation supports informed decision-making by ensuring access to relevant energy status classifications.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "OPEN"
3]