GetTaskGroupReport
HTTP Request Formats
POST api/report/TaskGroup/plain
GET api/report/TaskGroup/{taskName}/plain
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/report/TaskGroup/plain
GET api/schedule/{scheduleName}/report/TaskGroup/{taskName}/plain
Description
The GetTaskGroupReport REST API command returns a detailed report of the task group(s).
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 |
| FieldList | "FieldList" : ["<ReportField1>","<ReportField2>"] | <ReportField> are specific report fields that are desired. If this parameter is used, the report produced will only contain these fields (if not used the report will contain all fields). A list of fields can be found on the Task Group Reports page. |
Examples
Requests all Task Group reports for the active schedule
POST api/report/TaskGroup/plain
Body:
{
"All" : "TRUE"
}
Return Message
Returns a message that contains all of the report data for the task group(s). The report matches the format specified on the Task Group Report Details page.
Group Membership
This command belongs to the following group(s):
Version
12.3
