Stop reason

Endpoints

Create new stop reason

/companies/{companycode}/establishments/{establishmentcode}/stop-reasons

Description

Returns created stop reason.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Path

establishmentCode
required

Current context establishment code

string

2 characters max

Body

body
required

Responses

HTTP Code Description Schema

201

Successfully created

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/companies/{companycode}/establishments/{establishmentcode}/stop-reasons

Description

Returns entities.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Path

establishmentCode
required

Current context establishment code

string

2 characters max

Query

page
optional

Page index

integer (int32)

Query

size
optional

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

Produces

  • application/json

Import entity list

/companies/{companycode}/establishments/{establishmentcode}/stop-reasons/import

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Path

establishmentCode
required

Current context establishment code

string

2 characters max

Body

body
required

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get one stop reason

/companies/{companycode}/establishments/{establishmentcode}/stop-reasons/{code}

operation.deprecated

Description

Returns retrieved stop reason.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity code to retrieve

string

15 characters max

Path

companyCode
required

Current context company code

string

2 characters max

Path

establishmentCode
required

Current context establishment code

string

2 characters max

Responses

HTTP Code Description Schema

200

Successful

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete stop reason

/companies/{companycode}/establishments/{establishmentcode}/stop-reasons/{code}

Description

In fact disable this entity.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity public uuid code to delete

string

15 characters max

Path

companyCode
required

Current context company code

string

2 characters max

Path

establishmentCode
required

Current context establishment code

string

2 characters max

Responses

HTTP Code Description Schema

204

Succefully deleted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

StopReason

Stop reason data structure.

Name Description Value Business Rules

code
required

Stop reason code

string

15 characters max

companyCode
required

Current company code

string

2 characters max

defaultDurationSecond
required

Default duration

integer

establishmentCode
required

Current establishment code

string

2 characters max

hasInducedStopReason
optional

Has induced stop reason

boolean

imageCode
optional

Image code

string

includedInOee
optional

Included in OEE

boolean

inducedStopReasonCode
optional

Induced stop reason code

string

15 characters max

label
required

Stop reason label

string

50 characters max

lossQuantity
optional

Loss quantity

double

lossReasonCode
optional

Loss reason code

string

15 characters max

lossUnitCode
optional

Loss unit code

string

5 characters max

publicUuid
optional
read-only

Stop reason public uuid

string

restriction
required

Restriction

string

IN(ONLY_WHEN_WORKING=Only when MO is in progress,ONLY_WHEN_OPENED=Only when MO is opened,NONE=No restriction)

stopReasonFamilyCode
required

Family code

string

10 characters max

tags
optional

Tags

TagLink list

triggerPauseInControl
optional

Trigger pause in control

boolean

triggerPauseInLabor
optional

Trigger pause in labor

boolean

type
required

Type

string

IN(PLANNED=Planned,UNPLANNED=Unplanned)

validityEndDate
optional

Validity end date

datetime

AAAA-MM-JJTHH:MM:SSZ
Set a passed date to make the entity inactive.

vifType
required

VIF type

string

IN(FAILURE=Failure,MICRO_STOP=Micro stop,BREAK=Break,INDUCED_STOP=Induced stop,LINE_PREPARATION=Line preparation,OTHER=Other reason)

Name Value Business Rules

code
optional

string

15 characters max

establishmentCode
optional

string

2 characters max

label
optional

string

50 characters max

ImportStopReasonList

Name Value

callback
optional

string

data
optional

StopReason list