GetTaskGroupReportJson
HTTP Request Formats
POST api/report/TaskGroup
GET api/report/TaskGroup/{taskName}
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/report/TaskGroup
GET api/schedule/{scheduleName}/report/TaskGroup/{taskName}
Description
The GetTaskGroupReportJson REST API command returns a detailed report of the task group(s) in JSON format. The output will be formatted as a JSON array, even if information on only a single task group is requested. Each element in this JSON array maps to a single task group.
GetTaskGroupReportJson vs. GetTaskGroupReport
The choice of command will depend on use case.
GetTaskGroupReportJson provides output in a commonly used format that is easy to parse. This command is preferred if task group information will be further processed.
GetTaskGroupReport provides output that is difficult to parse but easy to understand. This command is preferred if no further processing is required.
Parameters
Parameters are only required if a POST endpoint is used
| JSON Parameters | Body Format | Description |
|---|---|---|
| Id | "Id" : "TaskGroup1" | Parameter is a string of a single task group name |
| IdList | "IdList": ["TaskGroup","TaskGroup","TaskGroup"] | Parameter is a string of text in single quotes of a comma delimited list of task group names. |
| All | "All" : "TRUE" | Optional boolean will make a report for all task groups within the schedule |
Examples
Requests all Task Group reports for the active schedule
POST api/report/TaskGroup
Body:
{
"All" : "TRUE"
}
Return Message
Returns a message that contains all of the report data for the task group(s) in JSON format.
The following JSON file contains sample output of the above command.
Group Membership
This command belongs to the following group(s):
Version
12.3
