GetTaskInfoJson
HTTP Request Formats
POST api/report/task
GET api/report/task/{taskName}
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/report/task
GET api/schedule/{scheduleName}/report/task/{taskName}
Description
The GetTaskInfoJson REST API command returns all of the attributes of the task in JSON format. The output will be formatted as a JSON array, even if information on only a single task is requested. Each element in this JSON array maps to a single task.
GetTaskInfoJson vs. GetTaskInfo
The choice of command will depend on use case.
GetTaskInfoJson provides output in a commonly used format that is easy to parse. This command is preferred if schedule information will be further processed.
GetTaskInfo 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" : "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 |
| 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 'Management Report(1)' task in the active schedule
POST api/report/task
Body:
{
"Id" : "Management Report(1)"
}
Return Message
Returns a JSON formatted message that contains all of the attribute data for the task.
The following JSON file contains sample output of the above command.
Group Membership
This command belongs to the following group(s):
Version
12.3
