Equipment

Endpoints

Get entity list

/companies/{companycode}/establishments/{establishmentcode}/equipments

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

< Equipment > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

Equipment

Equipment data structure.

Name Description Value Business Rules

actionCodes
optional

code
required

Equipment code

String

10 characters max
All characters in uppercase accepted except characters \ ; | " < > µ and spaces at the beginning and at the end

companyCode
required

Current company code

String

2 characters max

canBeShared
required

boolean

defaultAutoMicroStopReasonCode
optional

defaultOrigin
optional

equipmentUsedInLine
required

equipmentUsedInOpMode
required

establishmentCode
required

Current establishment code

String

2 characters max

goodQuantityPlcVariables
optional

imageCode
optional

Image code

String

label
required

Criterion label

String

50 characters max

lossQuantityPlcVariables
required

manualStopsAllowed
required

Connected equipment

true = equipment not connected
false = Connected equipment

maxDurationForAutoMicroStops
required

maxDurationForUnmotivatedStop
required

oeeReference
required

Reference equipment

boolean

publicUuid
optional
read-only

Equipment public uuid

String

stopReasonCodes
optional

stopSpreading
optional

stopErrors
optional

tags
optional

Tag list

validityEndDate
optional

datetime

YYYY-MM-DDTHH:MM:SSZ
Set a passed date to make the entity inactive.

workingPlcVariable
optional

Tag

Name Description Value Business Rules

code
mandatory

String

10 characters max

label
mandatory

String

50 characters max

establishmentCode
optional

String

2 characters