Skip to main content

system.mes.operation.getOperation

Description

Retrieves a Operations record by its ID.

Syntax

system.mes.operation.getOperation(id)

Parameters

ParameterTypeDescription
idString (ULID)The ID of the operation to retrieve.

Returns

Returns a JSON representation of the operation. Returns nothing if no operation is found.

NameTypeDescription
locationIdString (ULID)The ULID of the location associated with the operation.
locationPathStringThe path of the location associated with the operation.
nameStringThe name of the operation.
statusStringThe status of the operation.
currentOperationRecordIdString (ULID)The ULID of the current operation record.
currentProductionOrderIdString (ULID)The ULID of the current production order associated with the operation.
runningConflictStrategyStringThe conflict strategy when a new operation is started while another is running.
triggerSourceStringThe ways that the various operations can trigger.
startTriggerExpressionStringThe Ignition expression to trigger the start of the operation.
startTriggerTypeStringThe trigger type when starting the operation.
stopTriggerExpressionStringThe Ignition expression to trigger the end of the operation.
stopTriggerTypeStringThe trigger type when stopping the operation.
productionOrderResolutionStrategyStringThe resolution strategy to get the production order.
productionOrderUpdateStrategyStringThe update strategy if the production order expression changes while the operation is active.
productionOrderExpressionStringThe Ignition expression of the production order associated with the operation.
updateProductionOrderStatusOnStartBooleanIndicates if the production order status should update when the operation starts.
startProductionOrderStatusStringThe status of the production order when the operation starts.
updateProductionOrderStatusOnStopBooleanIndicates if the production order status should update when the operation stops.
stopProductionOrderStatusStringThe status of the production order when the operation stops.
autoAddToScheduleBooleanIndicates if the operation should be automatically added to the schedule if it doesn't exist.
expectedDurationCalculationStrategyStringThe resolution strategy to get the expected duration of the operation.
expectedDurationSecondsIntegerThe expected duration of the operation in seconds.
expectedDurationExpressionStringThe Ignition expression of the expected duration of the operation.
flushIntervalMillisIntegerThe flush interval in milliseconds.
idString (ULID)The ULID of the operation (optional, used for updating an existing operation).
notesStringNotes related to the operation.
enabledBooleanIndicates if the operation is active and enabled.
spare1StringAdditional field for user-defined context.
spare2StringAdditional field for user-defined context.
spare3StringAdditional field for user-defined context.

Code Examples

# Retrieve an operation by ID
operation = system.mes.operation.getOperation('01JPBCPKSR-972W3V0Y-H00NNSKQ')

# Output the operation
print(operation)