GetTaskInfo
HTTP Request Formats
POST api/report/task/plain
GET api/report/task/{taskName}/plain
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/report/task/plain
GET api/schedule/{scheduleName}/report/task/{taskName}/plain
Description
The GetTaskInfo REST API command returns all of the attributes of the task specified.
Parameters
Parameters are only required if a POST endpoint is used
| JSON Parameters | Body Format | Description |
|---|---|---|
| Id | "Id" : "Task1" | Parameter is a string of a single task name. Wildcards are allowed |
| IdList | "IdList": ["Task1","Task2","Task3"] | Parameter is a string of text in single quotes of a comma delimited list of task names. Wildcards are allowed |
| All | "All" : "TRUE" | Optional boolean will make a report for all tasks 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 Reports page. |
| IncludeTimeslotData | "IncludeTimeslotData": "True" | Optional boolean defining whether additional information on how the task's timeslots were generated should be in the report |
Examples
Finds out the values of all the attributes of the SSRDump task in the active schedule
POST api/report/task/plain
Body:
{
"Id" : "SSRDump"
}
Return Message
Returns a message that contains all of the attribute data for the task. The report matches the format specified on the Task Report page.
Group Membership
This command belongs to the following group(s):
Version
12.3
