Data Access Stop Comments

Endpoints

Get Oee stop comments list

/companies/{companycode}/establishments/{establishmentcode}/data-access/oee/stop-comments

Description

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

StopCommentsPagingEntity

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 all stop comments paginated - Initialization

/companies/{companycode}/establishments/{establishmentcode}/data-access/oee/stop-comments/initialization

Description

Returns all stop comments 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

StopCommentsPagingEntity

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

StopCommentsPagingEntity

Description of Stop comments paging response.

Name Description Value

page
required

Number page

int

size
required

Size

int

total
required

Total values

int

values
required

Stop comments paginated

StopCommentsOfTeamPeriod list

StopCommentsOfTeamPeriod

Deletion key is <CompanyCode, EstablishmentCode, TeamPeriodId>

Description of Stop comments group by team period.

Name Description Value

companyCode
required

Company Code

String

establishmentCode
required

Establishment Code

String

teamPeriodId
required

Id team period

Long

stopComments
required

Stop comments

StopCommentSplitPeriod list

StopCommentSplitPeriod

Description of Stop comment 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

lineCode
required

Line code

string

lineConfCode
required

Line configuration code

string

periodBegin
required

Begin of period

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

periodEnd
required

End of period

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

prodDay
required

Production day

date
(YYYY-MM-DD)

stop
required

Stop

Stop

teamCode
required

Team code

string

Stop

Name Description Value

comment
optional

Stop comment

string

duration
required

Stop duration

long

id
required

Stop id

long

reason
optional

Stop reason

StopReason

StopReason

Name Description Value

stopReasonCode
required

Stop reason code

string

cause
required

Cause

string

stopReasonFamilyCode
required

Stop reason family code

string

type
required

Stop reason type

string

vifType
required

VIF type

string