Energy Unit Resource¶

Get Energy Unit¶

HTTP Request

GET /api/energyUnit/{id}

📋 Description: Retrieves detailed information about a specific energy unit identified by the provided ID, enabling users to access critical data for energy management and reporting.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	EnergyUnitDTO

Example Responses

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "displayId": "string",
  "name": "string",
  "objectAvailable": true
}

Update Energy Unit¶

HTTP Request

PUT /api/energyUnit/{id}

📋 Description: Updates the details of a specific energy unit identified by its unique ID, allowing for modifications to its attributes to ensure accurate energy management and reporting.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	EnergyUnitDTO	true	Request body containing the updated energy unit details, including attributes such as name, measurement type, and conversion factors, to ensure accurate energy management.

Body Parameters

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "displayId": "string",
  "name": "string",
  "objectAvailable": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

1{}

Response Schema

Delete Energy Unit¶

HTTP Request

DELETE /api/energyUnit/{id}

📋 Description: Deletes a specified energy unit from the system, ensuring that outdated or unnecessary entries are removed to maintain data integrity and operational efficiency.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None

Get All Energy Unit¶

HTTP Request

GET /api/energyUnit

📋 Description: Retrieves a list of available energy units, providing essential information for energy management and optimization within your business operations.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "displayId": "string",
    "name": "string",
    "objectAvailable": true
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[EnergyUnitDTO]	false	none	[Data transfer object representing an energy unit, encapsulating key attributes such as measurement type and value, essential for energy consumption analysis and reporting within enterprise resource management.]
» 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
» objectAvailable	boolean	false	none	Indicates whether the energy unit is currently available for allocation or use within the system.

Create Energy Unit¶

HTTP Request

POST /api/energyUnit

📋 Description: Creates a new energy unit entry in the system, allowing businesses to effectively manage and track energy consumption metrics.

Parameters

Name	In	Type	Required	Description
body	body	EnergyUnitDTO	true	Request body containing the energy unit details, including measurement type, value, and associated metadata for effective energy management.

Body Parameters

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "displayId": "string",
  "name": "string",
  "objectAvailable": true
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	Inline

Example Responses

1{}