Api session event editor indicator: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 7: | Line 7: | ||
|- | |- | ||
| [[Api session event editor indicator add|add]] | | [[Api session event editor indicator add|add]] | ||
| Add new [[Indicator]] | | Add a new [[Indicator]] with a default [[Excel Sheet]] | ||
|- | |- | ||
| [[Api session event editor indicator append attribute|append_attribute]] | | [[Api session event editor indicator append attribute|append_attribute]] | ||
| Line 22: | Line 22: | ||
|- | |- | ||
| [[Api session event editor indicator set active|set_active]] | | [[Api session event editor indicator set active|set_active]] | ||
| Set [[Indicator]] active | | Set whether an [[Indicator]] is active (recalculated and visible to [[Stakeholder]]s). | ||
|- | |- | ||
| [[Api session event editor indicator set attribute|set_attribute]] | | [[Api session event editor indicator set attribute|set_attribute]] | ||
| Line 31: | Line 31: | ||
|- | |- | ||
| [[Api session event editor indicator set color|set_color]] | | [[Api session event editor indicator set color|set_color]] | ||
| Set | | Set the color of an [[Indicator]]. | ||
|- | |- | ||
| [[Api session event editor indicator set name|set_name]] | | [[Api session event editor indicator set name|set_name]] | ||
| Set | | Set the name of an [[Indicator]]. | ||
|} | |} | ||
| Line 43: | Line 43: | ||
|- | |- | ||
| [[Api session event editor indicator excel min log time|excel_min_log_time]] | | [[Api session event editor indicator excel min log time|excel_min_log_time]] | ||
| [[ | | Set the minimum [[Time]] for a performance entry to be recorded in an [[Excel Sheet]] Call Tree. | ||
|- | |- | ||
| [[Api session event editor indicator export debug excel|export_debug_excel]] | | [[Api session event editor indicator export debug excel|export_debug_excel]] | ||
| Export | | Export an [[Excel Sheet]], populated with data related to the [[Indicator]], to Byte array content | ||
|- | |- | ||
| [[Api session event editor indicator export excel call tree|export_excel_call_tree]] | | [[Api session event editor indicator export excel call tree|export_excel_call_tree]] | ||
| Export [[Excel Sheet]] | | Export a performance report of an [[Excel Sheet]], populated with data related to the [[Indicator]], to text as Byte array content | ||
|- | |- | ||
| [[Api session event editor indicator remove stakeholder|remove_stakeholder]] | | [[Api session event editor indicator remove stakeholder|remove_stakeholder]] | ||
| Remove [[Stakeholder]] | | Remove the association to a particular [[Stakeholder]] from an [[Indicator]]. | ||
|- | |- | ||
| [[Api session event editor indicator set absolute|set_absolute]] | | [[Api session event editor indicator set absolute|set_absolute]] | ||
| | | Make the score of an [[Indicator]] absolute, extending the allowed range. (Relative score must be between 0 and 1) | ||
|- | |- | ||
| [[Api session event editor indicator set description|set_description]] | | [[Api session event editor indicator set description|set_description]] | ||
| Set | | Set the description of an [[Indicator]]. | ||
|- | |- | ||
| [[Api session event editor indicator set excel|set_excel]] | | [[Api session event editor indicator set excel|set_excel]] | ||
| Set [[Excel Sheet]] | | Set the [[Excel Sheet]] used by an [[Indicator]]. | ||
|- | |- | ||
| [[Api session event editor indicator set image|set_image]] | | [[Api session event editor indicator set image|set_image]] | ||
| Set | | Set the image of an [[Indicator]]. | ||
|- | |- | ||
| [[Api session event editor indicator set parent|set_parent]] | | [[Api session event editor indicator set parent|set_parent]] | ||
| Line 70: | Line 70: | ||
|- | |- | ||
| [[Api session event editor indicator set short name|set_short_name]] | | [[Api session event editor indicator set short name|set_short_name]] | ||
| Set | | Set the short name of an [[Indicator]]. | ||
|- | |- | ||
| [[Api session event editor indicator set stakeholder|set_stakeholder]] | | [[Api session event editor indicator set stakeholder|set_stakeholder]] | ||
| | | Assign an [[Indicator]] to a particular [[Stakeholder]]. | ||
|- | |- | ||
| [[Api session event editor indicator set target|set_target]] | | [[Api session event editor indicator set target|set_target]] | ||
| Line 79: | Line 79: | ||
|- | |- | ||
| [[Api session event editor indicator set update timing|set_update_timing]] | | [[Api session event editor indicator set update timing|set_update_timing]] | ||
| Set | | Set the calculation Timing of an [[Indicator]] | ||
|- | |- | ||
| [[Api session event editor indicator swap order|swap_order]] | | [[Api session event editor indicator swap order|swap_order]] | ||
| Swap | | Swap the order of paired [[Indicator]]s | ||
|} | |} | ||
{{article end|seealso=*[[Api Session Endpoints]] | {{article end|seealso=*[[Api Session Endpoints]] | ||
Revision as of 15:30, 10 November 2026
API Endpoint: api/session/event/editorindicator/
API Endpoints for Indicator editing.
| Name | Description |
|---|---|
| add | Add a new Indicator with a default Excel Sheet |
| append_attribute | Appended to existing Indicator numeric Attribute value |
| duplicate | Duplicate existing Indicator |
| remove | Remove existing Indicator |
| remove_attribute | Remove numeric Attribute from Indicator |
| set_active | Set whether an Indicator is active (recalculated and visible to Stakeholders). |
| set_attribute | Set Indicator numeric Attribute value |
| set_attributes | Set multiple Indicator numeric Attribute values |
| set_color | Set the color of an Indicator. |
| set_name | Set the name of an Indicator. |
Additional API Endpoints:
| Name | Description |
|---|---|
| excel_min_log_time | Set the minimum Time for a performance entry to be recorded in an Excel Sheet Call Tree. |
| export_debug_excel | Export an Excel Sheet, populated with data related to the Indicator, to Byte array content |
| export_excel_call_tree | Export a performance report of an Excel Sheet, populated with data related to the Indicator, to text as Byte array content |
| remove_stakeholder | Remove the association to a particular Stakeholder from an Indicator. |
| set_absolute | Make the score of an Indicator absolute, extending the allowed range. (Relative score must be between 0 and 1) |
| set_description | Set the description of an Indicator. |
| set_excel | Set the Excel Sheet used by an Indicator. |
| set_image | Set the image of an Indicator. |
| set_parent | Set a parent Indicator for a specified Indicator, making it a subselectable Indicator. An Indicator that already has a parent cannot be assigned as a parent to another Indicator. |
| set_short_name | Set the short name of an Indicator. |
| set_stakeholder | Assign an Indicator to a particular Stakeholder. |
| set_target | Set a target value of an Indicator for a Scenario. A target index value is required. |
| set_update_timing | Set the calculation Timing of an Indicator |
| swap_order | Swap the order of paired Indicators |