EMS Monitor

Fetch Energy Metrics for Monitor

GET /_ems/monitor/<monitor_id>

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

HTTP Method GET

ENDPOINT /_ems/monitor/<monitor_id>

Request Header Authorization Basic <token>

Request Parameters

URL Parameters

  • monitor_id (string, required): The ID of the monitor to retrieve details for.

Query Parameters

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

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

Sample Request

curl -X GET 'https://app.4pointx.com/_ems/monitor/95598859-bc7b-4168-9b59-4850219c0bb9?from=2022-07-01T07:38:25.365Z&to=2023-11-07T07:38:25.365Z' \
--header 'Authorization: Basic <token>' \

Sample Response

Success

{
  "monitor_id": "95598859-bc7b-4168-9b59-4850219c0bb9",
  "monitor_name": "O/G to Stand-4",
  "function_id": "3626c23b-2070-48bb-baaa-1170a39c0f88",
  "function_name": "PLTCM",
  "plant_id": "219019d7-bb0f-4a5c-89a7-753be0079dfe",
  "plant_name": "CRM-2",
  "site_id": "7484c0b9-bc61-4da3-8e17-a0d1ef3d59ce",
  "site_name": "JSW VJNR",
  "total_consumption": 1612.39,
  "percent_of_total": 16.83,
  "total_energy": 1612.39,
  "energy_unit": "MWh",
  "current_unit": "A",
  "power_unit": "KW",
  "Voltage": 33355.257,
  "voltage_unit": "V",
  "Current": 48.0,
  "Power": 2462.34
}

Error

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

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

{
  "error": {
      "status": 400,
      "message": "Monitor id is invalid."
  }
}

Fetch Energy Metrics Monitors in Plant or Function

GET /_ems/monitor/_all

Description Fetch details of Energy Metrics of Monitors in Plant or Function.

HTTP Method GET

ENDPOINT /_ems/monitor/_all

Request Header Authorization Basic <token>

Request Parameters

URL Parameters

  • function_id (string, required): The ID of the Function specific to the Plant.

Query Parameters

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

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

  • label (string,*required*): It specifies how to organise retrieved monitor data based on it’s value such as “function” or “asset” by default.

Sample Request

curl -X GET 'https://app.4pointx.com/_ems/monitor/_all?from=2022-07-01T07:38:25.365Z&to=2023-11-07T07:38:25.365Z&function_id=3626c23b-2070-48bb-baaa-1170a39c0f88&label=function' \
--header 'Authorization: Basic <token>' \

Sample Response

Success

[
    {
      "monitor_id": "f1a99756-a72e-4967-aac5-308f55a1abbe",
      "monitor_name": "O/G to Stand-2",
      "function_id": "3626c23b-2070-48bb-baaa-1170a39c0f88",
      "function_name": "PLTCM",
      "plant_id": "219019d7-bb0f-4a5c-89a7-753be0079dfe",
      "plant_name": "CRM-2",
      "site_id": "7484c0b9-bc61-4da3-8e17-a0d1ef3d59ce",
      "site_name": "JSW VJNR",
      "total_consumption": 2026.69,
      "percent_of_total": 21.15,
      "total_energy": 2026.69,
      "energy_unit": "MWh",
      "current_unit": "A",
      "power_unit": "KW",
      "Voltage": 33362.643,
      "voltage_unit": "V",
      "Current": 50.91,
      "Power": 2733.21
  },
  {
      "monitor_id": "95598859-bc7b-4168-9b59-4850219c0bb9",
      "monitor_name": "O/G to Stand-4",
      "function_id": "3626c23b-2070-48bb-baaa-1170a39c0f88",
      "function_name": "PLTCM",
      "plant_id": "219019d7-bb0f-4a5c-89a7-753be0079dfe",
      "plant_name": "CRM-2",
      "site_id": "7484c0b9-bc61-4da3-8e17-a0d1ef3d59ce",
      "site_name": "JSW VJNR",
      "total_consumption": 1612.39,
      "percent_of_total": 16.83,
      "total_energy": 1612.39,
      "energy_unit": "MWh",
      "current_unit": "A",
      "power_unit": "KW",
      "Voltage": 33355.257,
      "voltage_unit": "V",
      "Current": 48.0,
      "Power": 2462.34
  },
  {
      "monitor_id": "8b0d809d-6727-45c6-8767-aa4f0b7b5e20",
      "monitor_name": "O/G to Tension Reel",
      "function_id": "3626c23b-2070-48bb-baaa-1170a39c0f88",
      "function_name": "PLTCM",
      "plant_id": "219019d7-bb0f-4a5c-89a7-753be0079dfe",
      "plant_name": "CRM-2",
      "site_id": "7484c0b9-bc61-4da3-8e17-a0d1ef3d59ce",
      "site_name": "JSW VJNR",
      "total_consumption": 355.31,
      "percent_of_total": 3.71,
      "total_energy": 355.31,
      "energy_unit": "MWh",
      "current_unit": "A",
      "power_unit": "KW",
      "Voltage": 33373.186,
      "voltage_unit": "V",
      "Current": 12.85,
      "Power": 473.01
  },
  {
      "monitor_id": "919fbb20-7c43-45f5-841c-3cc799c7757d",
      "monitor_name": "O/G to Stand-3",
      "function_id": "3626c23b-2070-48bb-baaa-1170a39c0f88",
      "function_name": "PLTCM",
      "plant_id": "219019d7-bb0f-4a5c-89a7-753be0079dfe",
      "plant_name": "CRM-2",
      "site_id": "7484c0b9-bc61-4da3-8e17-a0d1ef3d59ce",
      "site_name": "JSW VJNR",
      "total_consumption": 1914.87,
      "percent_of_total": 19.98,
      "total_energy": 1914.87,
      "energy_unit": "MWh",
      "current_unit": "A",
      "power_unit": "KW",
      "Voltage": 33358.156,
      "voltage_unit": "V",
      "Current": 47.12,
      "Power": 2531.17
  },
  {
      "monitor_id": "b5b666a0-bd17-4ee6-907f-958561830c85",
      "monitor_name": "O/G to Stand-5",
      "function_id": "3626c23b-2070-48bb-baaa-1170a39c0f88",
      "function_name": "PLTCM",
      "plant_id": "219019d7-bb0f-4a5c-89a7-753be0079dfe",
      "plant_name": "CRM-2",
      "site_id": "7484c0b9-bc61-4da3-8e17-a0d1ef3d59ce",
      "site_name": "JSW VJNR",
      "total_consumption": 854.93,
      "percent_of_total": 8.92,
      "total_energy": 854.93,
      "energy_unit": "MWh",
      "current_unit": "A",
      "power_unit": "KW",
      "Voltage": 33368.76,
      "voltage_unit": "V",
      "Current": 22.62,
      "Power": 1035.46
  },
  {
      "monitor_id": "a0a60a83-948c-4706-8b81-3689608be980",
      "monitor_name": "Bus Coupler",
      "function_id": "3626c23b-2070-48bb-baaa-1170a39c0f88",
      "function_name": "PLTCM",
      "plant_id": "219019d7-bb0f-4a5c-89a7-753be0079dfe",
      "plant_name": "CRM-2",
      "site_id": "7484c0b9-bc61-4da3-8e17-a0d1ef3d59ce",
      "site_name": "JSW VJNR",
      "total_consumption": 2818.13,
      "percent_of_total": 29.41,
      "total_energy": 2818.13,
      "energy_unit": "MWh",
      "current_unit": "A",
      "power_unit": "KW",
      "Voltage": 33358.831,
      "voltage_unit": "V",
      "Current": 71.13,
      "Power": 3861.07
  },
  {
      "monitor_id": "f7aa9485-30f0-4cc5-b04f-03aa33e7b7d9",
      "monitor_name": "Incomer FDR",
      "function_id": "3626c23b-2070-48bb-baaa-1170a39c0f88",
      "function_name": "PLTCM",
      "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,
      "percent_of_total": 0.0,
      "total_energy": 0.0,
      "energy_unit": "MWh",
      "current_unit": "A",
      "power_unit": "KW",
      "Voltage": 33350.235,
      "voltage_unit": "V",
      "Current": 0.0,
      "Power": 0.0
  }
]

Error

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

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

{
  "error": {
      "status": 415,
      "message": "Error <message>"
  }
}

Fetch Energy Metric trend for Monitor

GET /_ems/monitor/_trend/<monitor_id>

Description Fetch details of Energy Metrics trends for Monitor.

HTTP Method GET

ENDPOINT /_ems/monitor/_trend/<monitor_id>

Request Header Authorization Basic <token>

Request Parameters

URL Parameters

  • monitor_id (string, required): The ID of the monitor to retrieve details for.

Query Parameters

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

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

  • metric (string, required): The type of trend selected from predefined option such as (consumption_chart).

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

Sample Request

curl -X GET 'https://app.4pointx.com/_ems/monitor/_trend/95598859-bc7b-4168-9b59-4850219c0bb9?from=2023-04-26T18:30:00.000Z&to=2023-07-29T18:29:59.999Z&metric=consumption_chart&interval=month' \
--header 'Authorization: Basic <token>' \

Sample Response

Success

[
    {
        "Date": "2023-05-31T00:00:00.000Z",
        "Energy": 1612.386816,
        "unit": "MWh"
    }
]

Error

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

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

{
  "error": {
      "status": 400,
      "message": "metric not given"
  }
}

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

{
  "error": {
      "status": 415,
      "message": "Error <message>"
  }
}