Skip To Content

Filter Barriers

Summary

The properties below are returned by the filterBarriers object when using Describe on a utility network.

Learn more about using barriers to restrict traversability

Properties

PropertyExplanationData Type
combineUsingOr
(Read Only)

Whether or not the filter barrier is using an Or condition for the combine using parameter.

  • True—The combine using parameter is using an Or condition.
  • False—The combine using parameter is not using an Or condition. This means the combine using parameter could be using the And condition, or no value if there are not multiple filter barriers.

Boolean
isSpecificValue
(Read Only)

Whether or not the filter barrier is using a specific value to terminate the trace.

  • True—The filter barrier is set to a specific value.
  • False—The filter barrier is not set to a specific value.

Boolean
name
(Read Only)

The name of the network attribute or category used for the filter barrier. For example, Device status.

String
operator
(Read Only)

The operator used for the filter barrier. For example, is equal to or is greater than or equal to.

String
type
(Read Only)

The type of filter barrier used. For example, using a specific value or a network attribute.

String
value
(Read Only)

The specific value of the network attribute or category used for the filter barrier.

Integer
In this topic