BatchUpdateSTKReportDefs
HTTP Request Formats
POST /api/schedule/BatchUpdateStkReportDefs
To specify the schedule the command shall be sent to:
POST /api/schedule/{scheduleName}/BatchUpdateStkReportDefs
Description
The BatchUpdateStkReportDefs REST API command updates the STK report definition for all existing reports on resources and/or tasks.
Parameters
Parameters are only used if the task name is not specified in the HTTP request
| JSON Parameters | Body Format | Description |
|---|---|---|
| convertResources | "convertResources" : False | Defines if reports definitions on Resources should be updated. Options are True/False. |
| convertTasks | "convertTasks": False | Defines if reports definitions on Recurring Tasks should be updated. Options are True/False. |
| includeSingleInstance | "includeSingleInstance" : True | Defines if reports definitions on Single Instance Tasks should also be updated. Will only have an effect if convertTasks is set to True. Options are True/False. |
| convertTaskProfiles | "convertTaskProfiles" : True | Defines if reports definitions on Task Profiles should be updated. Options are True/False. |
| startingReportTypes | "startingReportTypes" : "Ascending Node" | Comma delimited string of existing report types to update |
| startingReportWindowTypes | "startingReportWindowTypes" : "FixedStart" | Optional. A comma delimited string selecting only reports that currently have the specified starting window type. Options are 'FixedStart', 'FixedStop', 'FixedStoporStop', 'Window', 'ValueRange',and 'ValueReport'. |
| targetReportType | "targetReportType" : "Line of Sight Access" | Optional. String of the new report type to replace all selected reports. |
| targetReportWindowType | "targetReportWindowType" : "FixedStop" | Optional. String of the new starting window type. Options are 'FixedStart', 'FixedStop', 'FixedStartorStop', 'Window', 'ValueRange',and 'ValueReport'. |
| recreatePossibilitiesModel | "recreatePossibilitiesModel":{ "RetainSettings" : "TRUE" } | Optional. Recreates the affected tasks, including any that use resources whose availabilities have been modified. This option must be placed at the end of the command. Accepts all parameter found in RecreatePossibilites. |
Examples
Update all Line of Sight Access reports on any recurring task or task profile using a Fixed Start window type to become Ascending Node reports using a Fixed Stop window type. Recreate any affected tasks, retaining all resource usage settings, but not retaining any existing assignments.
POST /api/schedule/BatchUpdateStkReportDefs
Body:
{
"convertResources" : False,
"convertTasks": True,
"includeSingleInstance" : False,
"convertTaskProfiles" : True,
"startingReportTypes" : "Ascending Node",
"startingReportWindowTypes" : "FixedStart",
"targetReportType" : "Line of Sight Access",
"targetReportWindowType" : "FixedStop",
"recreatePossibilitiesModel":{
"RetainSettings" : True
"RetainAssignments" : False
}
}
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.9
