Workstation

Endpoints

Get entity list

/companies/{companycode}/establishments/{establishmentcode}/workstations

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

< Workstation > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

Workstation

Workstation data structure.

Name Description Value Business Rules

areaCode
optional

String

attachmentTags
optional

String list

autoInactivityLogout
optional

boolean

autoInactivityLogoutDuration
optional

badgeReaderEnable
optional

code
required

Workstation 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

endBatchNatureCode
optional

equipmentTag
optional

establishmentCode
required

Current establishment code

String

2 characters max

forbiddenFeatures
optional

imageCode
optional

inputFavoriteFunctionalities
optional

inputFinishedItemModeOnDeclaration
optional

inputMoItemFilterMode
optional

inputScaleMode
optional

inputsForbiddenFeatures
optional

keyboardType
required

Workstation type

String

in(PC_KEYBOARD, PC_NO_KEYBOARD, ANDROID_TABLET)

label
required

Workstation label

String

50 characters max

masterWorkstationCodeForSharedPlanning
optional

miscMvtNaturesInput
optional

String list

miscMvtNaturesOutput
optional

String list

miscMvtNaturesTransfert
optional

String list

miscMvtNaturesTransformation
optional

String list

miscMvtNatureTypeInput
optional

String

in(ALL, NONE, LIST)

miscMvtNatureTypeOutput
optional

String

in(ALL, NONE, LIST)

miscMvtNatureTypeTransfert
optional

String

in(ALL, NONE, LIST)

miscMvtNatureTypeTransformation
optional

String

in(ALL, NONE, LIST)

moPlanningAddMoAuthorized
optional

moPlanningFavorites
optional

moPlanningFavoriteFunctionalities
optional

moPlanningFinishDataEntryForAllWorkstationsAuthorized
optional

moPlanningFinishDataEntryForTheWorkstationAuthorized
optional

moPlanningHelpModeOnMoCreation
optional

moPlanningMoDisplayMode
optional

multiresourceFavorites
optional

multiresourceMoQuickLaunch
optional

oeeChronogramDurationMsec
optional

oeeDisplays
optional

oeeFavorites
optional

oeeViewType
optional

String

in(EQUIPMENT_GRAPH, CUMULATED_MO_QTIES, PRODUCED_QUANTITIES_PER_HOUR)

operatorTag
optional

opModesFavoriteFunctionalities
optional

outputFavoriteFunctionalities
optional

outputMoDisplayWithoutInputDeclarationAuthorized
optional

outputMoItemFilterMode
optional

outputScaleMode
optional

printers
optional

String list

publicUuid
optional
read-only

Workstation public uuid

String

resources
optional

resourceMonitoringFavorites
optional

scales
optional

String list

supervisedArea
optional

tags
optional

Tag list

validityEndDate
optional

datetime

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

Tag

Name Description Value Business Rules

code
mandatory

String

10 characters max

label
mandatory

String

50 characters max

establishmentCode
optional

String

2 characters