Energy Cost Ingest Resource¶
Create Auto Energy Cost¶
HTTP Request
POST /api/energyIngest/energyCost/single
📋 Description: Submits a single energy cost entry for ingestion into the system, enabling accurate tracking and analysis of energy expenditures.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the energy cost data for a single entry, including relevant metrics and identifiers necessary for accurate processing and analysis. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "date": "2019-08-24",
7 "amount": 0,
8 "energyTypeId": 0,
9 "energyTypeName": "string",
10 "energyUnitId": 0,
11 "energyUnitName": "string",
12 "energyStatusId": 0,
13 "energyStatus": "string",
14 "energyStatusType": "string",
15 "premiseId": 0,
16 "premiseDisplayId": "string",
17 "documentIds": [
18 0
19 ],
20 "source": "MANUAL",
21 "consumedQuantity": 0
22}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
|
400 |
Validation/creation failed |
Inline |
Example Responses
1{}
Response Schema
Ingest Energy Costs¶
HTTP Request
POST /api/energyIngest/energyCost/batch
📋 Description: Submits a batch of energy cost data for processing, enabling efficient management and analysis of energy expenditures within the organization.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a batch of energy cost data, including relevant metrics and identifiers for efficient processing and analysis. |
Body Parameters
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "date": "2019-08-24",
8 "amount": 0,
9 "energyTypeId": 0,
10 "energyTypeName": "string",
11 "energyUnitId": 0,
12 "energyUnitName": "string",
13 "energyStatusId": 0,
14 "energyStatus": "string",
15 "energyStatusType": "string",
16 "premiseId": 0,
17 "premiseDisplayId": "string",
18 "documentIds": [
19 0
20 ],
21 "source": "MANUAL",
22 "consumedQuantity": 0
23 }
24]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
All items created |
||
207 |
Partial success |
||
400 |
All failed / invalid payload |
Example Responses
1{
2 "total": 0,
3 "created": 0,
4 "failed": 0,
5 "successes": [
6 {
7 "id": 0,
8 "createdBy": "string",
9 "createdAt": "2019-08-24T14:15:22Z",
10 "displayId": "string",
11 "date": "2019-08-24",
12 "amount": 0,
13 "energyTypeId": 0,
14 "energyTypeName": "string",
15 "energyUnitId": 0,
16 "energyUnitName": "string",
17 "energyStatusId": 0,
18 "energyStatus": "string",
19 "energyStatusType": "string",
20 "premiseId": 0,
21 "premiseDisplayId": "string",
22 "documentIds": [
23 0
24 ],
25 "source": "MANUAL",
26 "consumedQuantity": 0
27 }
28 ],
29 "failures": [
30 {
31 "index": 0,
32 "code": "string",
33 "message": "string"
34 }
35 ]
36}