system.mes.oee.getState

Description

Retrieves a specific OEE state definition by its unique ID.

Permissions

This method requires the OEE.READ.GET permission.

Syntax

system.mes.oee.getState(id)

Parameters

Parameter	Type	Nullable	Description
id	String	False	The unique ID of the OEE state.

Returns

A JSON representation of an OeeStateDTO object representing the requested OEE state.

Name	Type	Nullable	Description	Default Value
id	String	True	The id of the OEE State	null
locationId	String	False	Identifier of the associated location	null
locationPath	String	True	Path of the associated location	null
code	Integer	False	Integer state number, which must be unique for a given location	null
name	String	False	Name of the state	null
calculationType	OeeStateCalculationType	False	Specifies how this state contributes to OEE calculations	DOWNTIME
color	String	False	Hex color code representing the state visually	"#000000"
autoAcknowledge	Boolean	False	Whether to automatically acknowledge the state record when it is created	false
interruptionLocationId	String	True	Immediate interruption location that caused a blocked/starved state	null
interruptionLocationPath	String	True	Path to the location that caused a blocked/starved state	null
maxRootCauseDelaySeconds	Integer	True	Maximum delay in seconds for looking back at historical state records when resolving root cause for blocked/starved states	0
notes	String	True	Notes associated with the OEE State	null
enabled	boolean	True	Indicates whether the OEE State is enabled	true
spare1	String	True	Extra field 1	null
spare2	String	True	Extra field 2	null
spare3	String	True	Extra field 3	null

Code Examples

# Retrieve an OEE state by its ID
stateId = "01JCH3ENEB-SV2X8B3W-NFY8WZNK"

try:
    oeeState = system.mes.oee.getState(stateId)
    if oeeState:
        print "State Name:", oeeState['name']
        print "State Type:", oeeState['calculationType']
        print "Color:", oeeState['color']
except:
    print "OEE State with ID '{}' not found.".format(stateId)