Stop reason
Endpoints
Create new stop reason
/companies/{companycode}/establishments/{establishmentcode}/stop-reasons |
Parameters
Type | Name | Description | Schema | Business Rules |
---|---|---|---|---|
Path |
companyCode |
Current context company code |
string |
2 characters max |
Path |
establishmentCode |
Current context establishment code |
string |
2 characters max |
Body |
body |
Get entity list
/companies/{companycode}/establishments/{establishmentcode}/stop-reasons |
Parameters
Type | Name | Description | Schema | Business Rules |
---|---|---|---|---|
Path |
companyCode |
Current context company code |
string |
2 characters max |
Path |
establishmentCode |
Current context establishment code |
string |
2 characters max |
Query |
page |
Page index |
integer (int32) |
|
Query |
size |
Entity count per page |
integer (int32) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfull |
< StopReason > array |
400 |
Functionnal error |
No Content |
500 |
Internal server error |
No Content |
Import entity list
/companies/{companycode}/establishments/{establishmentcode}/stop-reasons/import |
Parameters
Type | Name | Description | Schema | Business Rules |
---|---|---|---|---|
Path |
companyCode |
Current context company code |
string |
2 characters max |
Path |
establishmentCode |
Current context establishment code |
string |
2 characters max |
Body |
body |
Get one stop reason
/companies/{companycode}/establishments/{establishmentcode}/stop-reasons/{code} |
operation.deprecated |
Parameters
Type | Name | Description | Schema | Business Rules |
---|---|---|---|---|
Path |
code |
Entity code to retrieve |
string |
15 characters max |
Path |
companyCode |
Current context company code |
string |
2 characters max |
Path |
establishmentCode |
Current context establishment code |
string |
2 characters max |
Delete stop reason
/companies/{companycode}/establishments/{establishmentcode}/stop-reasons/{code} |
Parameters
Type | Name | Description | Schema | Business Rules |
---|---|---|---|---|
Path |
code |
Entity public uuid code to delete |
string |
15 characters max |
Path |
companyCode |
Current context company code |
string |
2 characters max |
Path |
establishmentCode |
Current context establishment code |
string |
2 characters max |
Data structure
StopReason
Stop reason data structure.
Name | Description | Value | Business Rules |
---|---|---|---|
code |
Stop reason code |
string |
15 characters max |
companyCode |
Current company code |
string |
2 characters max |
defaultDurationSecond |
Default duration |
integer |
|
establishmentCode |
Current establishment code |
string |
2 characters max |
hasInducedStopReason |
Has induced stop reason |
boolean |
|
imageCode |
Image code |
string |
|
includedInOee |
Included in OEE |
boolean |
|
inducedStopReasonCode |
Induced stop reason code |
string |
15 characters max |
label |
Stop reason label |
string |
50 characters max |
lossQuantity |
Loss quantity |
double |
|
lossReasonCode |
Loss reason code |
string |
15 characters max |
lossUnitCode |
Loss unit code |
string |
5 characters max |
publicUuid |
Stop reason public uuid |
string |
|
restriction |
Restriction |
string |
IN(ONLY_WHEN_WORKING=Only when MO is in progress,ONLY_WHEN_OPENED=Only when MO is opened,NONE=No restriction) |
stopReasonFamilyCode |
Family code |
string |
10 characters max |
tags |
Tags |
TagLink list |
|
triggerPauseInControl |
Trigger pause in control |
boolean |
|
triggerPauseInLabor |
Trigger pause in labor |
boolean |
|
type |
Type |
string |
IN(PLANNED=Planned,UNPLANNED=Unplanned) |
validityEndDate |
Validity end date |
datetime |
AAAA-MM-JJTHH:MM:SSZ |
vifType |
VIF type |
string |
IN(FAILURE=Failure,MICRO_STOP=Micro stop,BREAK=Break,INDUCED_STOP=Induced stop,LINE_PREPARATION=Line preparation,OTHER=Other reason) |
TagLink
Name | Value | Business Rules |
---|---|---|
code |
string |
15 characters max |
establishmentCode |
string |
2 characters max |
label |
string |
50 characters max |
ImportStopReasonList
Name | Value |
---|---|
callback |
string |
data |
StopReason list |