Api session event editor netload: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Endpoint: api/session/event/editornetload/
<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
Line 30: Line 30:
| Set the name of a [[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
Line 81: Line 81:
| Set the [[Net state]] of a [[Net Load]]
| Set the [[Net state]] of a [[Net Load]]
|}
|}
{{article end|seealso=*[[Api Session Endpoints]]
<noinclude lang="text" copy>{{article end|seealso=*[[Api Session Endpoints]]
*[[Api session items netloads]]
*[[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