Data Access OEE Split Periods

Endpoints

Get oee split periods list

/companies/{companycode}/establishments/{establishmentcode}/data-access/oee/split-periods

Description

Returns oee split periods paginated.

Parameters

Type Name Description Schema

Path

companyCode
required

Company code

string

Path

establishmentCode
required

Establishment code

string

Query

from
required

Begin datetime

string
(YYYY-MM-DDTHH:MM:SSZ)

Query

to
required

End datetime

string
(YYYY-MM-DDTHH:MM:SSZ)

Query

page
optional

Page index

integer
DEFAULT(1)

Query

size
optional

Entity count per page

integer
DEFAULT(100)

Query

lineCode
optional

Line code

string

Responses

HTTP Code Description Schema

200

Successful

OeeSplitPeriodsPagingEntity

400

The difference between from and to must not exceed 7 days

No Content

400

The size must be strictly less than 500

No Content

500

Internal server error

No Content

Produces

  • application/json

Get oee split periods list - Initialization

/companies/{companycode}/establishments/{establishmentcode}/data-access/oee/split-periods/initialization

Description

Returns oee split periods paginated.

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

page
optional

Page index

integer
DEFAULT(1)

Query

size
optional

Entity count per page

integer
DEFAULT(100)

Query

lineCode
optional

Line code

string

Responses

HTTP Code Description Schema

200

Successful

OeeSplitPeriodsPagingEntity

400

The difference between from and to must not exceed 7 days

No Content

400

The size must be strictly less than 500

No Content

405

Initialization is not allowed

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

OeeSplitPeriodsPagingEntity

Description of OEE split periods paging response

Name Description Value

page
required

Number page

int

size
required

Size

int

total
required

Total values

int

values
required

OEE split periods of team period

OeeSplitPeriodsOfTeamPeriod list

OeeSplitPeriodsOfTeamPeriod

Name Description Value

companyCode
required

Company Code

String

establishmentCode
required

Establishment Code

String

teamPeriodId
required

Team period id

Long

periods
required

OEE split periods

OeeSplitPeriod list

OeeSplitPeriod

Name Description Value

areaCode
required

Area code

string

cadenceLostDuration
required

Cadence lost duration

long

cancelled
required

Cancelled

boolean

deductedFromDoneQuantity
required

Deducted from done quantity

double

doneProductionDuration
required

Done production duration

long

doneQuantity
required

Done quantity

double

goodProductionDuration
required

Good production duration

long

goodProductionFinalDuration
required

good production final duration

long

itemCode
optional

Item code

string

lineCode
required

Line code

string

lineConfigurationCode
required

Line configuration code

string

moNb
optional

MO number

string
(empty string if not present)

noneQualityDuration
required

None quality duration

long

periodBegin
required

Period begin

datetime
(YYYY-MM-DDTHH:MM:SSZ)

periodDuration
required

Period duration

long

periodEnd
required

Period end

datetime
(YYYY-MM-DDTHH:MM:SSZ)

prodDay
required

Production day

date
(YYYY-MM-DD)

runningTimeDuration
required

Running time duration

long

scrapQuantity
required

Scrap quantity

double

stop
optional

Stop

Stop

teamCode
required

Team code

string

unitCode
optional

Unit code

string

workingDuration
required

Working duration

long

Stop

Name Description Value

actionCode
optional

Action code

string

duration
required

Stop duration

long

equipment
required

Equipment

Equipment

externalEquipmentCode
optional

External equipment

string

id
required

Stop id

long

reason
optional

Stop reason

StopReason

StopReason

Name Description Value

stopReasonCode
required

Stop reason code

string

cause
required

Cause

string

familyCode
required

Stop reason family code

string

includedInOee
required

Included in OEE

boolean

type
required

Stop reason type

string

typeVIF
required

Type VIF

string

Equipment

Name Description Value

equipmentCode
required

Code

string

oeeReference
required

Is OEE reference

boolean