Data Access Quantities

Endpoints

Get oee quantities list

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

Description

Returns oee scrap quantities paginated.

Offer is necessary to get all quantities (even not scrapped)

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

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 quantities list - Initialization

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

Description

Returns oee quantities 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

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

OeeQuantities

Description of OEE quantities paginated.

Name Description Value

page
required

Number page

int

size
required

Size

int

total
required

Total quantities

int

quantities
required

OEE quantities

OeeQuantity

Functional unicity key is <CompanyCode, EstablishmentCode, QuantityId>

Name Description Value

areaCode
required

Area code

string

cadenceHour
required

Cadence hour

double

cancelled
required

Cancelled quantity

boolean

companyCode
required

Company code

string

creationDate
required

Creation date

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

deductedFromDone
required

Deducted from done

boolean

establishmentCode
required

Establishment code

string

itemCode
required

Item code

string

lineCode
required

Line code

string

moDetail
required

MO detail

Mo

operatorCode
optional

Operator code

string

operatorFirstName
optional

Operator firstname

string

operatorLastName
optional

Operator lastname

string

prodDay
required

Production day

date
(YYYY-MM-DD)

quantity
required

Quantity

double

quantityId
required

Quantity id

string

quantityType
required

Quantity type

string

quantityUnit
required

Quantity unit

string

scrapReasonCode
optional

Scrap reason code

string

teamCode
required

Team code

string

userFirstName
optional

User firstname

string

userLastName
optional

User lastname

string

workstationCode
optional

Workstation code

string

Mo

Name Description Value

moNb
required

MO number

string
(empty string if not present)

plannedBeginDate
required

Planned begin date

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

plannedEndDate
required

Planned end date

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

realBeginDate
optional

Real begin date

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

realEndDate
optional

Real end date

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