Data Access OEE Events and Quantities MES

Endpoints

Get oee events and quantities list

/companies/{companycode}/establishments/{establishmentcode}/data-access/oee-events-and-quantities-mes

Description

Returns oee events and quantities.

Parameters

Type Name Description Schema

Path

companyCode
required

Company code

string

Path

establishmentCode
required

Establishment code

string

Query

from
required

Begin date

string (YYYY-MM-DD)

Query

to
required

End date

string (YYYY-MM-DD)

Query

mode
optional

Mode export data
(either export created or updated quantities and events)

IN(INITIALISATION=from and to parameters compared to production day, INCREMENTAL=from and to parameters compared to updated date)
DEFAULT(INITIALISATION)

Query

lineCode
optional

Line code

string

Query

scrollIdEvents
optional

Scroll ID events of first response

string

Query

scrollIdQuantities
optional

Scroll ID quantities of first response

string

Responses

HTTP Code Description Schema

200

Successful

< oee events and quantities response information > array

400

Functional error

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

oee events and quantities response information

Description of OEE events and quantities.

Name Description Value

events
required

OEE events

OeeEventDTO list

quantities
required

OEE quantities

OeeQuantityDTO list

scrollIdEvents
required

Scroll ID events

string

scrollIdQuantities
required

Scroll ID quantities

string

OeeEventDTO

Name Description Value

action
optional

Action

CodeLabel

area
optional

Area

CodeLabel

cadenceLostDuration
optional

Cadence lost duration

long

cancelled
optional

Cancelled

boolean

company
optional

Company

CodeLabel

doneProductionDuration
optional

Done production duration

long

enteredPlannedQuantityUnitCode
optional

Entered planned quantity unit code

string

enteredPlannedQuantityValue
optional

Entered planned quantity value

double

equipment
optional

Equipment

EquipmentDTO

establishment
optional

Establishment

CodeLabel

externalEquipment
optional

External equipment

CodeLabel

goodProductionDuration
optional

Good production duration

long

goodProductionFinalDuration
optional

good production final duration

long

item
optional

Item

CodeLabel

line
optional

Line

CodeLabel

lineConfiguration
optional

Line configuration

CodeLabel

microStop
optional

Micro stop

boolean

moNb
optional

MO number

string

noneQualityDuration
optional

None quality duration

long

openDuration
optional

Open duration

long

periodBegin
optional

Period begin

datetime (ISO-8601)

periodDuration
optional

Period duration

long

periodEnd
optional

Period end

datetime (ISO-8601)

plannedBeginDate
optional

MO planned begin date

datetime (ISO-8601)

plannedEndDate
optional

MO planned end date

datetime (ISO-8601)

prodDay
optional

Production day

date

runningTimeDuration
optional

Running time duration

long

state
optional

State

string

stop
optional

Stop

StopDTO

team
optional

Team

CodeLabel

workingDuration
optional

Working duration

long

StopDTO

Name Description Value

comment
optional

Stop comment

string

duration
optional

Stop duration

long

id
optional

Stop id

long

reason
optional

Stop reason

StopReasonDTO

StopReasonDTO

Name Description Value

cause
optional

Cause

string

code
required

Code

string

includedInOee
optional

Included in OEE

boolean

label
required

Label

string

family
optional

Stop reason family

CodeLabel

type
optional

Stop reason type

string

triggerControlPause
optional

Trigger control pause

boolean

triggerLaborPause
optional

Trigger labor pause

boolean

typeVIF
optional

Type VIF

string

EquipmentDTO

Name Description Value

code
required

Code

string

label
required

Label

string

oeeReference
optional

OEE reference

boolean

OeeQuantityDTO

Name Description Value

area
optional

Area

CodeLabel

cadenceHour
optional

Cadence hour

double

company
optional

Company

CodeLabel

creationDate
optional

Creation date

datetime (ISO-8601)

deductedFromDone
optional

Deducted from done

boolean

establishment
optional

Establishment

CodeLabel

item
optional

Item

CodeLabel

line
optional

Line

CodeLabel

moDetail
optional

MO detail

MoDTO

operatorCode
optional

Operator code

string

operatorFirstName
optional

Operator firstname

string

operatorLastName
optional

Operator lastname

string

prodDay
optional

Production day

date

quantity
optional

Quantity

double

quantityId
optional

Quantity id

string

quantityType
optional

Quantity type

string

quantityUnit
optional

Quantity unit

string

referenceItem
optional

Reference item

CodeLabel

scrapReason
optional

Scrap reason

CodeLabel

userFirstName
optional

User firstname

string

userLastName
optional

User lastname

string

workstation
optional

Workstation

CodeLabel

MoDTO

Name Description Value

moNb
optional

MO number

string

plannedBeginDate
optional

Planned begin date

datetime (ISO-8601)

plannedEndDate
optional

Planned end date

datetime (ISO-8601)

realBeginDate
optional

Real begin date

datetime (ISO-8601)

realEndDate
optional

Real end date

datetime (ISO-8601)