Network Pipe Definition

Variable
Data Type
Unit of Measure
Is Nullable?
Default Value
Description
sourceNetworkId
String
-
No
-
SourceNetworkId the pipe belongs to
sourceId
String
-
No
-
Source ID for the pipe definition. This sourceID enables upsert functionality from client source systems of record
name
String
-
No
-
Pipe name
date
DateTimeOffset
-
No
-
Date at which the pipe becomes part of the network. Datetime offset (with timezone) in ISO 8601 format. Example: 2022-09-27T16:28:37+0000
upstreamNode
String
-
No
-
Network element upstream of the pipe
downstreamNode
String
-
No
-
Network element downstream of the pipe
enabled
Bool
-
No
-
Whether the pipe should participate in the network (false would be the equivalent of a mask in GAP)
length
List<Double>
ft
No
-
List of lengths making up the pipe segments. All pipe property lists must be the same length.
trueVerticalDepth
List<Double>
ft
No
-
List of true vertical depths making up the pipe segments. All pipe property lists must be the same length.
innerDiameter
List<Double>
in
No
-
List of inner diamters making up the pipe segments. All pipe property lists must be the same length.
roughness
List<Double>
in
No
-
List of roughnesses making up the pipe segments. All pipe property lists must be the same length.
﻿

Updated 14 Nov 2023

Did this page help you?

Network Source Definition

Network Compressor Definition

Variable	Data Type	Unit of Measure	Is Nullable?	Default Value	Description
sourceNetworkId	String	-	No	-	SourceNetworkId the pipe belongs to
sourceId	String	-	No	-	Source ID for the pipe definition. This sourceID enables upsert functionality from client source systems of record
name	String	-	No	-	Pipe name
date	DateTimeOffset	-	No	-	Date at which the pipe becomes part of the network. Datetime offset (with timezone) in ISO 8601 format. Example: 2022-09-27T16:28:37+0000
upstreamNode	String	-	No	-	Network element upstream of the pipe
downstreamNode	String	-	No	-	Network element downstream of the pipe
enabled	Bool	-	No	-	Whether the pipe should participate in the network (false would be the equivalent of a mask in GAP)
length	List<Double>	ft	No	-	List of lengths making up the pipe segments. All pipe property lists must be the same length.
trueVerticalDepth	List<Double>	ft	No	-	List of true vertical depths making up the pipe segments. All pipe property lists must be the same length.
innerDiameter	List<Double>	in	No	-	List of inner diamters making up the pipe segments. All pipe property lists must be the same length.
roughness	List<Double>	in	No	-	List of roughnesses making up the pipe segments. All pipe property lists must be the same length.