system.mes.operation.pauseOperation

Description

Pauses an Operations object, identified either by operationId, or by both locationId and operationName.

Permissions

This method requires the OPERATION.EXECUTE permission.

Syntax

Provide either operationId, or both locationId and operationName.

# Pause by operation ID
system.mes.operation.pauseOperation(operationId=operationId)

# Pause by location and operation name
system.mes.operation.pauseOperation(locationId=locationId, operationName=operationName)

Parameters

Parameter	Type	Nullable	Description
operationId	String (ULID)	Yes	The ID of the operation to pause.
locationId	String (ULID)	Yes	The ID of the location associated with the operation.
operationName	String	Yes	The name of the operation.

Returns

Returns a JSON object of the operation execution result for the suspension of the operation.

Example Usage

# Pause the operation
pausedOperationResult = system.mes.operation.pauseOperation('01JPBCPKSR-972W3V0Y-H00NNSKQ')

# Output the operation execution result of the paused operation
print(pausedOperationResult)