KPI gets the main KPIs (ratios).

GET processes/kpis

URL parameters:

    • company [mandatory]: the company name or id.
    • session [mandatory]: the Id of the active session.
    • process [mandatory]: id of the process.
    • datefrom [mandatory]: start date of the period.
    • dateto [mandatory]: end date of the period.
    • team: id of the team.
    • fields: useful to filter with data fields.

Response:

    • status: returns "0" on success, and an error code in any other case.
    • data: returns the schema of areas and processes.
    • message: "success" or a descriptive information of the error in any other case.

Example:

Content-Type: application/json

Request: /processes/kpis?company=demo01&session=LebEWTNf8GEhxfQeeGbBmVUlxmUIDLVdEoeVYrnWNzkdRXKxmgCNc92wnSjA&process=A0L1&dateFrom=20090302070000&dateTo=20090302150000

Reponse (success):

{

 "status": "0",

 "data": [

   {

     "RealTime": "480",

     "TotalTime": "480",

     "WaitingTime": "440,933333333333",

     "ProductionTime": "338,566666666667",

     "PlannedQuantity": "2444,45108497143",

     "ProducedQuantity": "2386",

     "GoodQuantity": "2380",

     "ScrapQuantity": "6",

     "ReworkQuantity": "0",

     "OperatingTime": "329,639922688854",

     "OEE": "68,67499",

     "OEETarget": "86,9757",

     "ProductiveEfficiency": "74,75958",

     "ProductiveEfficiencyTarget": "86,9757",

     "ProductiveAvailability": "76,7841",

     "Availability": "70,53472",

     "Speed": "97,60883",

     "Quality": "99,74854"

   }

 ],

 "message": "Success"

}

GET processes/kpis/dashboard

URL parameters:

    • company [mandatory]: the company name or id.
    • session [mandatory]: the Id of the active session.
    • process [mandatory]: id of the process.
    • datefrom [mandatory]: start date of the period.
    • dateto [mandatory]: end date of the period.
    • team: id of the team.
    • fields: useful to filter with data fields.

Response:

    • status: returns "0" on success, and an error code in any other case.
    • data: returns the schema of areas and processes.
    • message: "success" or a descriptive information of the error in any other case.

Example:

Content-Type: application/json

Request: /processes/kpis/dashboard?session=Mehm6MjyZ7DPEPz2a4HhQeWCVPPcDBbsfWQAEyQqZhClDkJBqzxP0epMHOYm&company=FEDERAL MOGUL&process=L3&datefrom=20181010070000&dateto=20181010100000

Reponse (success):

{

 "status": "0",

 "data" : [

    {

         "OEE":"33.5594663023949",

         "DateTime":"20181004072045",

         "OEETargetYellow":"0",

         "OEETargetGreen":"72.369"

    }

]

 "message": "Success"

}

GET processes/kpis/followup

URL parameters:

    • company [mandatory]: the company name or id.
    • session [mandatory]: the Id of the active session.
    • process [mandatory]: id of the process.
    • datefrom [mandatory]: start date of the period.
    • dateto [mandatory]: end date of the period.
    • planned: indicates if the planned statuses should be taken.
    • hourly: indicates if the data should be by hours or not.

Response:

    • status: returns "0" on success, and an error code in any other case.
    • data: returns the schema of areas and processes.
    • message: "success" or a descriptive information of the error in any other case.

Example:

Content-Type: application/json

Request: processes/kpis/followup?process=A0L1&datefrom=20241101060000&dateto=20241101070000&session=4mqPwIsCHGdzofOcwXE3726RvOh5Lk6MseGryWPpD0XjlM4S9hdSakTuwZ5J&company=4444444444&planned=0&hourly=0

Reponse (success):

{

 "status": "0",

 "data": [{"OEETheoricalQuantity":{"type":"Number","value":"25200"},"OEEPlannedQuantityGreen":{"type":"Number","value":"12927.6000090122"},"OEEPlannedQuantityYellow":{"type":"Number","value":"9071.9998948574"},"SpeedTargetGreen":{"type":"Number","value":"22680"},"SpeedTargetYellow":{"type":"Number","value":"20160"},"PETheoricalQuantity":{"type":"Number","value":"0"},"PEPlannedQuantityGreen":{"type":"Number","value":"0"},"PEPlannedQuantityYellow":{"type":"Number","value":"0"},"ProducedQuantity":{"type":"Number","value":"0"},"ScrapQuantity":{"type":"Number","value":"0"},"ReworkQuantity":{"type":"Number","value":"0"},"GoodQuantity":{"type":"Number","value":"0"},"OEETargetGreen":{"type":"Number","value":"0.513"},"OEETargetYellow":{"type":"Number","value":"0.36"},"Activity":{"type":"Number","value":"12600"},"Datetime":{"type":"DateTime","value":"20241101060000"}}],

 "message": "Success"

}