Skip to main content

system.mes.equipment.getEquipmentPropertyReferences

Description

Retrieves a list of references to an Equipment Properties record by its ID or name.

Permissions

This method requires the EQUIPMENT.READ.GET permission.

Syntax

system.mes.equipment.getEquipmentPropertyReferences(idOrName)

Parameters

ParameterTypeNullableDescription
idOrNameStringFalseThe ID or name of the equipment property.

Returns

Returns a list of JSON objects. Each JSON object has the following properties:

NameTypeDescription
tableNameStringThe name of the table that the reference is in.
referencesList<JSON Object>List of JSON objects corresponding to references to the equipment property.

The JSON Objects in references has the following properties:

NameTypeDescription
fkColNameStringThe name of the foreign key column.
idString (ULID)The ULID of the object that is referencing the equipment property.

Code Examples

# Get references by name
references = system.mes.equipment.getEquipmentPropertyReferences('MaxFlowRate')
print(references)

# Get references by ID
references = system.mes.equipment.getEquipmentPropertyReferences('01ARZ3NDEKTSV4RRFFQ69G5FAV')
print(references)