EditFOM
HTTP Request Formats
PATCH api/Fom
To specify the schedule the command shall be sent to:
PATCH api/schedule/{scheduleName}/Fom
Description
The EditFOM REST API command updates the values of the Figure of Merit (FOM) used by the current schedule, or the schedule specified using the schedule/{scheduleName}/ request format. This command can update any number of attributes of the FOM.
Parameters
| JSON Parameters | Body Format | Description |
|---|---|---|
| Kassign | "Kassign": 1 | Parameter is an integer >= 0 |
| Kdur | "Kdur": 2 | Parameter is an integer >= 0 |
| Kpp | "Kpp": 3 | Parameter is an integer >= 0 |
| Kpn | "Kpn": 4 | Parameter is an integer >= 0 |
| Kearly | "Kearly": 5 | Parameter is an integer >= 0 |
| Kmaxdur | "Kmaxdur": 6 | Parameter is an integer >= 0 |
| Kpt | "Kpt": 7 | Parameter is an integer >= 0 |
| Kcost | "Kcost": 8 | Parameter is an integer >= 0 |
Examples
Updates the values of Kassign, Kearly, and Kpp in the FOM to 3, 1, and 7, respectively.
PATCH api/Fom
Body:
{
"Kassign" : 3,
"Kearly" : 1,
"Kpp" : 7
}
Return Message
If activated, a standard response for a successful HTTP response shall appear.
Group Membership
This command belongs to the following group(s):
Version
12.6
