EMS Benchmarking

Fetch Product Variation Table for Plant

GET /_ems/benchmarking/<plant_id>

Description Fetch product variable table with benchmarking for a plant and it’s functions by their ID’s.

HTTP Method GET

ENDPOINT /_ems/benchmarking/<plant_id>

Request Header Authorization Basic <token>

Request Parameters

URL Parameters

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

Query Parameters

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

• from (date range, required): The onset date from when to retrieve details for the plant and it’s function.

• to (date range, required): The final date till when to retrieve details for the plant and it’s function.

• compare_from (date range, optional): The onset date from when comparison timeframe begins.

• compare_to (date range, optional): The final date till when comparison timeframe ends.

Note

• Parameters “compare_from” and “compare_to” are initialised after input from user who wants to use the comparison timeframe.

Sample Request

• Case 1: No comparison timeframe is given

curl -X GET 'https://app.4pointx.com/_ems/benchmarking/219019d7-bb0f-4a5c-89a7-753be0079dfe?from=2023-05-01T07:49:16.077Z&to=2023-05-31T07:49:16.077Z&function_id=3626c23b-2070-48bb-baaa-1170a39c0f88' \
  --header 'Authorization: Basic <token>' \

• Case 2: Comparison timeframe is given

curl -X GET 'https://app.4pointx.com/_ems/benchmarking/219019d7-bb0f-4a5c-89a7-753be0079dfe?from=2023-05-01T07:49:16.077Z&to=2023-05-31T07:49:16.077Z&compare_from=2023-05-01T07:49:16.077Z&compare_to=2023-05-09T07:49:16.077Z&function_id=3626c23b-2070-48bb-baaa-1170a39c0f88' \
  --header 'Authorization: Basic <token>' \

Sample Response

Success

• Case 1: No comparison timeframe is given

{
  "data":
  [
      {
          "Exit Weight (kg)": "26440.0 to 47480.0",
          "Exit Width (mm)": "1262.0 to 1263.5",
          "Shift": "3",
          "Target Thickness (mm)": "0.1 to 0.3",
          "Specific Energy (kWh/ton)": 94758710.75
      },
      {
          "Exit Weight (kg)": "26440.0 to 47480.0",
          "Exit Width (mm)": "1263.5 to 1264.0",
          "Shift": "3",
          "Target Thickness (mm)": "0.4 to 0.65",
          "Specific Energy (kWh/ton)": 9656806.79
      },
      {
          "Exit Weight (kg)": "26905.0 to 47480.0",
          "Exit Width (mm)": "1264.5 to 1265.0",
          "Shift": "2",
          "Target Thickness (mm)": "0.7 to 1.0",
          "Specific Energy (kWh/ton)": 10843877.84
      },
      {
          "Exit Weight (kg)": "26905.0 to 47480.0",
          "Exit Width (mm)": "1265.0 to 1266.5",
          "Shift": "2",
          "Target Thickness (mm)": "1.0 to 1.21",
          "Specific Energy (kWh/ton)": 12518081.24
      }
  ],

  "feature_importance":
  [
      {
          "column_key": "Exit Weight (kg)",
          "column_title": "Exit Weight (kg)",
          "impact": 56.16
      },
      {
          "column_key": "Exit Width (mm)",
          "column_title": "Exit Width (mm)",
          "impact": 23.6
      },
      {
          "column_key": "Shift",
          "column_title": "Shift",
          "impact": 20.23
      },
      {
          "column_key": "Target Thickness (mm)",
          "column_title": "Target Thickness (mm)",
          "impact": 0.01
      },
      {
          "column_key": "PieceID",
          "column_title": "PieceID",
          "impact": 0.0
      },
      {
          "column_key": "Grade Name",
          "column_title": "Grade Name",
          "impact": 0.0
      }
  ]
}

• Case 2: Comparison timeframe is given

{
  "data":
  [
      {
          "Exit Weight (kg)": "26440.0 to 47480.0",
          "Exit Width (mm)": "1262.0 to 1263.5",
          "Shift": "3",
          "Target Thickness (mm)": "0.1 to 0.3",
          "Time Frame 1 Specific Energy (kWh/ton)": 94758710.75,
          "Time Frame 2 Specific Energy (kWh/ton)": 11953877.66
      },
      {
          "Exit Weight (kg)": "26440.0 to 47480.0",
          "Exit Width (mm)": "1263.5 to 1264.0",
          "Shift": "3",
          "Target Thickness (mm)": "0.4 to 0.65",
          "Time Frame 1 Specific Energy (kWh/ton)": 9656806.79,
          "Time Frame 2 Specific Energy (kWh/ton)": 74758710.75
      },
      {
          "Exit Weight (kg)": "26905.0 to 47480.0",
          "Exit Width (mm)": "",
          "Shift": "",
          "Target Thickness (mm)": "0.7 to 1.0",
          "Time Frame 1 Specific Energy (kWh/ton)": 10843877.84,
          "Time Frame 2 Specific Energy (kWh/ton)": 31424936.98
      },
      {
          "Exit Weight (kg)": "26905.0 to 47480.0",
          "Exit Width (mm)": "",
          "Shift": "",
          "Target Thickness (mm)": "1.0 to 1.21",
          "Time Frame 1 Specific Energy (kWh/ton)": 12518081.24,
          "Time Frame 2 Specific Energy (kWh/ton)": 77376943.09
      }
  ],
  "feature_importance":
  [
      {
          "column_key": "Exit Weight (kg)",
          "column_title": "Exit Weight (kg)",
          "impact": 56.16
      },
      {
          "column_key": "Exit Width (mm)",
          "column_title": "Exit Width (mm)",
          "impact": 23.6
      },
      {
          "column_key": "Shift",
          "column_title": "Shift",
          "impact": 20.23
      },
      {
          "column_key": "Target Thickness (mm)",
          "column_title": "Target Thickness (mm)",
          "impact": 0.01
      },
      {
          "column_key": "PieceID",
          "column_title": "PieceID",
          "impact": 0.0
      },
      {
          "column_key": "Grade Name",
          "column_title": "Grade Name",
          "impact": 0.0
      }
  ]
}

Error

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

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

{
  "error": {
      "status": 400,
      "message": "Date range is invalid."
  }
}

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