Api session event editor parametric: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 7: | Line 7: | ||
|- | |- | ||
| [[Api session event editor parametric add|add]] | | [[Api session event editor parametric add|add]] | ||
| Add | | Add a [[Parametric Design]] of a particular Alignment | ||
|- | |- | ||
| [[Api session event editor parametric append attribute|append_attribute]] | | [[Api session event editor parametric append attribute|append_attribute]] | ||
| Line 28: | Line 28: | ||
|- | |- | ||
| [[Api session event editor parametric set name|set_name]] | | [[Api session event editor parametric set name|set_name]] | ||
| Set | | Set the name of a [[Parametric Design]]. | ||
|- | |- | ||
| [[Api session event editor parametric set polygons|set_polygons]] | | [[Api session event editor parametric set polygons|set_polygons]] | ||
| Line 40: | Line 40: | ||
|- | |- | ||
| [[Api session event editor parametric add example|add_example]] | | [[Api session event editor parametric add example|add_example]] | ||
| Add | | Add a [[Parametric Design]] using a particular example | ||
|- | |- | ||
| [[Api session event editor parametric add plot|add_plot]] | | [[Api session event editor parametric add plot|add_plot]] | ||
| Add [[Plot]] | | Add a [[Plot]] Design of a particular [[Function]] to a [[Parametric Design]] | ||
|- | |- | ||
| [[Api session event editor parametric apply|apply]] | | [[Api session event editor parametric apply|apply]] | ||
| Apply | | Apply a [[Parametric Design]] for a [[Stakeholder]], [[Function]] Types, [[Function]] IDs and one or more [[MultiPolygon]]s per [[Function]] Type. | ||
|- | |- | ||
| [[Api session event editor parametric generate|generate]] | | [[Api session event editor parametric generate|generate]] | ||
| Generate | | Generate a result for a [[Parametric Design]] | ||
|- | |- | ||
| [[Api session event editor parametric remove plot|remove_plot]] | | [[Api session event editor parametric remove plot|remove_plot]] | ||
| Remove [[Plot]] | | Remove a [[Plot]] Design of a [[Parametric Design]] | ||
|- | |- | ||
| [[Api session event editor parametric remove plot attributes|remove_plot_attributes]] | | [[Api session event editor parametric remove plot attributes|remove_plot_attributes]] | ||
| Remove [[Plot]] [[ | | Remove [[Attribute]]s from a [[Plot]] Design of a [[Parametric Design]] | ||
|- | |- | ||
| [[Api session event editor parametric save as measure|save_as_measure]] | | [[Api session event editor parametric save as measure|save_as_measure]] | ||
| Save | | Save a [[Parametric Design]] as a new [[Measure]] for a [[Stakeholder]], using [[Function]] Types, [[Function]] IDs and one or more [[MultiPolygon]]s per [[Function]] Type. | ||
|- | |- | ||
| [[Api session event editor parametric set alignment|set_alignment]] | | [[Api session event editor parametric set alignment|set_alignment]] | ||
| Set | | Set the alignment of a [[Parametric Design]]. | ||
|- | |- | ||
| [[Api session event editor parametric set function|set_function]] | | [[Api session event editor parametric set function|set_function]] | ||
| Set [[Function]] | | Set a [[Function]] of a [[Function]] Type for a [[Parametric Design]]. Use [[Function]] ID -1 to remove it for a [[Function]] Type. | ||
|- | |- | ||
| [[Api session event editor parametric set plot attributes|set_plot_attributes]] | | [[Api session event editor parametric set plot attributes|set_plot_attributes]] | ||
| Set [[Plot]] [[ | | Set [[Attribute]]s of a [[Plot]] Design of a [[Parametric Design]] | ||
|- | |- | ||
| [[Api session event editor parametric set plot function|set_plot_function]] | | [[Api session event editor parametric set plot function|set_plot_function]] | ||
| Set [[Plot]] [[ | | Set the [[Function]] of a [[Plot]] Design of a [[Parametric Design]] | ||
|} | |} | ||
{{article end|seealso=*[[Api Session Endpoints]] | {{article end|seealso=*[[Api Session Endpoints]] | ||
Revision as of 15:31, 10 November 2026
API Endpoint: api/session/event/editorparametric/
API Endpoints for Parametric editing.
| Name | Description |
|---|---|
| add | Add a Parametric Design of a particular Alignment |
| append_attribute | Appended to existing Parametric numeric Attribute value |
| duplicate | Duplicate existing Parametric |
| remove | Remove existing Parametric |
| remove_attribute | Remove numeric Attribute from Parametric |
| set_attribute | Set Parametric numeric Attribute value |
| set_attributes | Set multiple Parametric numeric Attribute values |
| set_name | Set the name of a Parametric Design. |
| set_polygons | Set Polygons to existing Parametric |
Additional API Endpoints:
| Name | Description |
|---|---|
| add_example | Add a Parametric Design using a particular example |
| add_plot | Add a Plot Design of a particular Function to a Parametric Design |
| apply | Apply a Parametric Design for a Stakeholder, Function Types, Function IDs and one or more MultiPolygons per Function Type. |
| generate | Generate a result for a Parametric Design |
| remove_plot | Remove a Plot Design of a Parametric Design |
| remove_plot_attributes | Remove Attributes from a Plot Design of a Parametric Design |
| save_as_measure | Save a Parametric Design as a new Measure for a Stakeholder, using Function Types, Function IDs and one or more MultiPolygons per Function Type. |
| set_alignment | Set the alignment of a Parametric Design. |
| set_function | Set a Function of a Function Type for a Parametric Design. Use Function ID -1 to remove it for a Function Type. |
| set_plot_attributes | Set Attributes of a Plot Design of a Parametric Design |
| set_plot_function | Set the Function of a Plot Design of a Parametric Design |