Data Access Masked Stop

Endpoints

Get Oee masked stop split periods list

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

Description

Returns Oee masked stop 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

OeeMaskedStopsPagingEntity

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 masked stop split periods list - Initialization

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

Description

Returns oee masked stop 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

OeeMaskedStopsPagingEntity

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

OeeMaskedStopsPagingEntity

Description of Masked stops paging response

Name Description Value

page
required

Number page

int

size
required

Size

int

total
required

Total values

int

values
required

OEE masked stop of team periods list

OeeMaskedStopOfTeamPeriod list

OeeMaskedStopOfTeamPeriod

Deletion key is <CompanyCode, EstablishmentCode, TeamPeriodId>

Description of Masked stop group by Team period

Name Description Value

companyCode
required

Company Code

String

establishmentCode
required

Establishment Code

String

teamPeriodId
required

Id team period

Long

periods
required

Oee masked stop split periods

OeeMaskedStopSplitPeriod list

OeeMaskedStopSplitPeriod

Description of Masked stop split by OEE periods

Name Description Value

actionCode
optional

Action code

string

areaCode
required

Area code

string

equipmentCode
required

Equipment code

string

externalEquipmentCode
optional

External equipment code

string

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)

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)

state
required

State

string

stop
required

Stop

Stop

teamCode
required

Team code

string

teamPeriodId
required

team period id

integer

Stop

Name Description Value

duration
required

Stop duration

long

id
required

Stop id

long

reason
optional

Stop reason

StopReason

StopReason

Name Description Value

cause
required

Cause

string

stopReasonCode
required

Stop reason code

string

familyCode
required

Stop reason family

string

type
required

Stop reason type

string

vifType
required

Type VIF

string