Skip to main content
Version: V2 (Ignition 8.1)

system.mes.location.getLocationsByPartialPath

Description​

Retrieves all Locations records with paths that contain the specified partial path.

Permissions​

This method requires the LOCATION.READ.GET permission.

Syntax​

system.mes.location.getLocationsByPartialPath('partial/path/example')

Parameters​

ParameterTypeNullableDescription
pathStringFalseThe partial path to search for in locations.

Returns​

Returns a list of JSON objects representing all locations with paths that include the given partial path.

Code Examples​

# Retrieve locations by partial path
matchingLocations = system.mes.location.getLocationsByPartialPath('DairyCo')

# Output the list of matching locations
print(matchingLocations)