EMS Function¶

Fetch Energy Metrics for Function¶

GET /_ems/function/<function_id>¶

Description Fetch details of Energy Metrics of a specific Function by its ID.

HTTP Method GET

ENDPOINT /_ems/function/<function_id>

Request Header Authorization Basic <token>

Request Parameters

URL Parameters

function_id (string, required): The ID of the function to retrieve details for.

Query Parameters

from (date range, required): The date range from when to retrieve details for the plant.

to (date range, required): The date range till when to retrieve details for the plant.

Sample Request

curl -X GET 'https://app.4pointx.com/_ems/function/3626c23b-2070-48bb-baaa-1170a39c0f88%3Ffrom=2023-05-23T08:54:18.295Z&to=2023-05-31T08:54:18.296Z' \
--header 'Authorization: Basic <token>' \

Sample Response

Success

{
  "function_name": "PLTCM",
  "function_id": "3626c23b-2070-48bb-baaa-1170a39c0f88",
  "plant_id": "219019d7-bb0f-4a5c-89a7-753be0079dfe",
  "plant_name": "CRM-2",
  "site_id": "7484c0b9-bc61-4da3-8e17-a0d1ef3d59ce",
  "site_name": "JSW VJNR",
  "total_consumption": 1052.49,
  "total_energy": 1052.49,
  "energy_unit": "MWh",
  "percent_of_total": 100.0,
  "total_production": 5033.38,
  "production_unit": "ton",
  "idle_energy": 0.0,
  "idle_energy_percent": 0.0,
  "kwh_per_unit": 209.1
}

Error

{
  "error": {
    "status": 401,
    "message": "Unauthorized access to module by general-user"
  }
}

{
  "error": {
      "status": 400,
      "message": "Function id not given."
  }
}

Fetch Energy Metrics for Functions in Plant¶

GET /_ems/function/_all/<plant_id>¶

Description Fetch details of Energy Metrics for Functions in a Plant.

HTTP Method GET

ENDPOINT /_ems/function/_all/<plant_id>

Request Header Authorization Basic <token>

Request Parameters

URL Parameters

plant_id (string, required): The ID of the Plant to retrieve details of Functions for.

Query Parameters

from (date range, required): The date range from when to retrieve details for the plant.

to (date range, required): The date range till when to retrieve details for the plant.

Sample Request

curl -X GET 'https://app.4pointx.com/_ems/function/_all?from=2023-11-01T07:38:25.365Z&to=2023-11-07T07:38:25.365Z&plant_id=219019d7-bb0f-4a5c-89a7-753be0079dfe' \
--header 'Authorization: Basic <token>' \

Sample Response

Success

[
  {
    "function_name": "PLTCM",
    "function_id": "3626c23b-2070-48bb-baaa-1170a39c0f88",
    "plant_id": "219019d7-bb0f-4a5c-89a7-753be0079dfe",
    "plant_name": "CRM-2",
    "site_id": "7484c0b9-bc61-4da3-8e17-a0d1ef3d59ce",
    "site_name": "JSW VJNR",
    "total_consumption": 0.0,
    "total_energy": 0.0,
    "energy_unit": "MWh",
    "percent_of_total": 0,
    "total_production": 0.0,
    "production_unit": "ton",
    "idle_energy": 0.0,
    "idle_energy_percent": 0,
    "kwh_per_unit": 0

  }
]

Error

{
  "error": {
    "status": 401,
    "message": "Unauthorized access to module by general-user"
  }
}

{
  "error": {
      "status": 400,
      "message": "Plant id not given."
  }
}

{
  "error": {
      "status": 400,
      "message": "Function details not found."
  }
}

{
  "error": {
      "status": 400,
      "message": "Plant details not found."
  }
}

{
  "error": {
      "status": 400,
      "message": "Site details not found."
  }
}

{
  "error": {
      "status": 400,
      "message": "Function details not found."
  }
}

Fetch Energy Metric Trend for Function¶

GET /_ems/function/_trend/<function_id>¶

Description Fetch details of Energy Metrics Trend for a Function.

HTTP Method GET

ENDPOINT /_ems/function/_trend/<function_id>

Request Header Authorization Basic <token>

Request Parameters

URL Parameters

function_id (string, required): The ID of the function to retrieve details for.

Query Parameters

from (date range, required): The date range from when to retrieve details for the plant.

to (date range, required): The date range till when to retrieve details for the plant.

metric (string, required): The type of trend selected from predefined options such as (consumption_chart, prod_vs_kwh_per_ton, or idle_energy_vs_kwh_all) each triggering a distinct process.

interval (time range, required): Hourly, Daily, Weekly or Monthly trend to be collected.

Sample Request

curl -X GET 'https://app.4pointx.com/_ems/function/_trend/29d7b29a-080a-4304-b61f-d318b8a33c07?from=2023-05-22T18:30:00.000Z&to=2023-05-31T18:29:59.999Z&metric=consumption_chart&interval=week' \
--header 'Authorization: Basic <token>' \

Sample Response

Success

{
  [

    {
        "Date": "2023-05-22T00:00:00.000Z",
        "Energy": 0.0,
        "unit": "MWh"
    },
    {
        "Date": "2023-05-29T00:00:00.000Z",
        "Energy": 0.0,
        "unit": "MWh"
    },
    {
        "Date": "2023-05-28T00:00:00.000Z",
        "Energy": 1052.49,
        "unit": "MWh"
    }
  ]

}

Error

{
  "error": {
    "status": 401,
    "message": "Unauthorized access to module by general-user"
  }
}

{
  "error": {
      "status": 400,
      "message": "Function id not given."
  }
}

{
  "error": {
      "status": 400,
      "message": "Metric not given."
  }
}

{
"error": {
    "status": 400,
    "message": "Energy or Production data not available"
}
}

{
  "error": {
      "status": 400,
      "message": "No function found for given Plant."
  }
}