Api session event editor netload: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session event editor netload Events.
<noinclude lang="text" copy>API Endpoint: api/session/event/editornetload/
 
</noinclude><noinclude lang="text" copy>
API Endpoints for [[Net Load]] editing.
API Endpoints for [[Net Load]] editing.
{|class=wikitable
</noinclude>{|class=wikitable
!Name
!Name
!Description
!Description
|-
|-
|[[Api session event editor netload add|add]]
| [[Api session event editor netload add|add]]
|Add new [[Net Load]]
| Add a new [[Net Load]] for a [[Net Type]] and optionally set as Root Load
|-
|-
|[[Api session event editor netload append attribute|append_attribute]]
| [[Api session event editor netload append attribute|append_attribute]]
|Appended to existing [[Net Load]] attribute value
| Appended to existing [[Net Load]] numeric [[Attribute]] value
|-
|-
|[[Api session event editor netload import|import]]
| [[Api session event editor netload import|import]]
|Import multiple [[Net Load]]s
| Import a Collection of [[Net Load]] geometries, names, [[Net Type]]s, [[Net state]], to an existing Net by adding [[Net Line]]s with the provided [[Net Function]]. A [[Building]] is assigned to a [[Net Load]] when within [[Building]] range. A [[Net Load]] is assigned to a [[Net Node]] when within [[Net Node]] range
|-
|-
|[[Api session event editor netload remove|remove]]
| [[Api session event editor netload remove|remove]]
|Remove existing [[Net Load]]
| Remove existing [[Net Load]]
|-
|-
|[[Api session event editor netload remove attribute|remove_attribute]]
| [[Api session event editor netload remove attribute|remove_attribute]]
|Remove attribute from [[Net Load]]
| Remove numeric [[Attribute]] from [[Net Load]]
|-
|-
|[[Api session event editor netload set attribute|set_attribute]]
| [[Api session event editor netload set attribute|set_attribute]]
|Set [[Net Load]] attribute value
| Set [[Net Load]] numeric [[Attribute]] value
|-
|-
|[[Api session event editor netload set attributes|set_attributes]]
| [[Api session event editor netload set attributes|set_attributes]]
|Set multiple [[Net Load]] attribute values
| Set multiple [[Net Load]] numeric [[Attribute]] values
|-
|-
|[[Api session event editor netload set name|set_name]]
| [[Api session event editor netload set name|set_name]]
|Set new name of existing [[Net Load]]
| Set the name of a [[Net Load]]
|}
|}
 
<noinclude lang="text" copy>
Additional API Endpoints:
Additional API Endpoints:
{|class=wikitable
</noinclude>{|class=wikitable
!Name
!Name
!Description
!Description
|-
|-
|[[Api session event editor netload add address|add_address]]
| [[Api session event editor netload add address|add_address]]
|Add [[Address]]
| Assign an [[Address]] to a [[Net Load]]
|-
|-
|[[Api session event editor netload add and set node|add_and_set_node]]
| [[Api session event editor netload add and set node|add_and_set_node]]
|Add And Set Node
| Add a new [[Net Node]] for a [[Point]] and assign it to a [[Net Load]]
|-
|-
|[[Api session event editor netload generate loads|generate_loads]]
| [[Api session event editor netload generate loads|generate_loads]]
|Generate Loads
| Generate [[Net Load]]s with a provided [[Net Type]], for [[Address]]es of [[Building]]s inside the provided [[Polygon]]s, for [[Building]]s of the provided [[Category]] and [[Stakeholder]]s and optionally only for [[Building]]s without [[Net Load]]s. [[Address]]es are bundled into one [[Net Load]] given a bundle threshold. [[Net Load]]s are set as Collective given another threshold. [[Stakeholder]] owning the [[Net Load]] can be mapped from the [[Building]] owner to a different one using the mappingIDs
|-
|-
|[[Api session event editor netload generate loads and paths|generate_loads_and_paths]]
| [[Api session event editor netload generate loads and paths|generate_loads_and_paths]]
|Generate Loads And Paths
| Generate [[Net Load]]s and [[Net Line]]s given a [[Net Function]], for [[Address]]es of [[Building]]s inside the provided [[Polygon]]s, for [[Building]]s of the provided [[Category]] and [[Stakeholder]]s and optionally only for [[Building]]s without [[Net Load]]s. [[Address]]es are bundled into one [[Net Load]] given a bundle threshold. [[Net Load]]s are set as Collective given another threshold. [[Stakeholder]] owning the [[Net Load]] can be mapped from the [[Building]] owner to a different one using the mappingIDs. [[Net Line]]s are generated with a Search Range for paths to existing [[Net Node]]s and a Merge Range to combine [[Net Node]]s
|-
|-
|[[Api session event editor netload generate paths|generate_paths]]
| [[Api session event editor netload generate paths|generate_paths]]
|Generate Paths
| Connect [[Net Load]]s to an existing Net by adding [[Net Line]]s with the provided [[Net Function]]. [[Net Line]]s are generated with a Search Range for paths to existing [[Net Node]]s and a Merge Range to combine [[Net Node]]s
|-
|-
|[[Api session event editor netload import net|import_net]]
| [[Api session event editor netload import net|import_net]]
|Import Net
| Import Net
|-
|-
|[[Api session event editor netload remove address|remove_address]]
| [[Api session event editor netload remove address|remove_address]]
|Remove [[Address]]
| Remove an [[Address]] from a [[Net Load]]
|-
|-
|[[Api session event editor netload remove all attributes|remove_all_attributes]]
| [[Api session event editor netload remove all attributes|remove_all_attributes]]
|Remove All Attributes
| Remove all [[Attribute]]s of a [[Net Load]]
|-
|-
|[[Api session event editor netload remove building|remove_building]]
| [[Api session event editor netload remove building|remove_building]]
|Remove [[Building]]
| Assign a [[Net Load]] to no particular [[Building]]
|-
|-
|[[Api session event editor netload remove node|remove_node]]
| [[Api session event editor netload remove node|remove_node]]
|Remove Node
| Assign the [[Net Load]] to no particular [[Net Node]]
|-
|-
|[[Api session event editor netload set building|set_building]]
| [[Api session event editor netload set building|set_building]]
|Set [[Building]]
| Assign a [[Net Load]] to a particular [[Building]]
|-
|-
|[[Api session event editor netload set net type|set_net_type]]
| [[Api session event editor netload set net type|set_net_type]]
|Set Net Type
| Set the [[Net Type]] of a [[Net Load]]
|-
|-
|[[Api session event editor netload set node|set_node]]
| [[Api session event editor netload set node|set_node]]
|Set Node
| Set the [[Net Node]] of a [[Net Load]]
|-
|-
|[[Api session event editor netload set point|set_point]]
| [[Api session event editor netload set point|set_point]]
|Set Point
| Set the Location of a [[Net Load]]
|-
|-
|[[Api session event editor netload set state|set_state]]
| [[Api session event editor netload set state|set_state]]
|Set State
| Set the [[Net state]] of a [[Net Load]]
|}
|}
{{article end|seealso=*[[Api Events]]
<noinclude lang="text" copy>{{article end|seealso=*[[Api Session Endpoints]]
*[[Api session items netloads]]
}}
}}
 
</noinclude>
[[Category:API]]
[[Category:API]]

Latest revision as of 10:26, 13 November 2026

API Endpoint: api/session/event/editornetload/

API Endpoints for Net Load editing.

Name Description
add Add a new Net Load for a Net Type and optionally set as Root Load
append_attribute Appended to existing Net Load numeric Attribute value
import Import a Collection of Net Load geometries, names, Net Types, Net state, to an existing Net by adding Net Lines with the provided Net Function. A Building is assigned to a Net Load when within Building range. A Net Load is assigned to a Net Node when within Net Node range
remove Remove existing Net Load
remove_attribute Remove numeric Attribute from Net Load
set_attribute Set Net Load numeric Attribute value
set_attributes Set multiple Net Load numeric Attribute values
set_name Set the name of a Net Load

Additional API Endpoints:

Name Description
add_address Assign an Address to a Net Load
add_and_set_node Add a new Net Node for a Point and assign it to a Net Load
generate_loads Generate Net Loads with a provided Net Type, for Addresses of Buildings inside the provided Polygons, for Buildings of the provided Category and Stakeholders and optionally only for Buildings without Net Loads. Addresses are bundled into one Net Load given a bundle threshold. Net Loads are set as Collective given another threshold. Stakeholder owning the Net Load can be mapped from the Building owner to a different one using the mappingIDs
generate_loads_and_paths Generate Net Loads and Net Lines given a Net Function, for Addresses of Buildings inside the provided Polygons, for Buildings of the provided Category and Stakeholders and optionally only for Buildings without Net Loads. Addresses are bundled into one Net Load given a bundle threshold. Net Loads are set as Collective given another threshold. Stakeholder owning the Net Load can be mapped from the Building owner to a different one using the mappingIDs. Net Lines are generated with a Search Range for paths to existing Net Nodes and a Merge Range to combine Net Nodes
generate_paths Connect Net Loads to an existing Net by adding Net Lines with the provided Net Function. Net Lines are generated with a Search Range for paths to existing Net Nodes and a Merge Range to combine Net Nodes
import_net Import Net
remove_address Remove an Address from a Net Load
remove_all_attributes Remove all Attributes of a Net Load
remove_building Assign a Net Load to no particular Building
remove_node Assign the Net Load to no particular Net Node
set_building Assign a Net Load to a particular Building
set_net_type Set the Net Type of a Net Load
set_node Set the Net Node of a Net Load
set_point Set the Location of a Net Load
set_state Set the Net state of a Net Load