Help Page Home

# GET Tasks

Get all task records.

## Request Information

### Parameters

Name | Description | Additional information
--- | --- | ---
name | See Filtering, Arranging, and Paging. | Type: String
filterBy | See Filtering, Arranging, and Paging. The supported filters are: All: All tasks. (default) Active: All tasks which are have not completed. Error: All tasks that have an error. | Type: Filter
filterProp | See Filtering, Arranging, and Paging. | Type: String
arrangeBy | See Filtering, Arranging, and Paging. The supported arrangers are: Relevance: Tasks with errors or warnings are returned first, followed by tasks that are active or not yet started. (default) Name: Arrange by name. Time: Arrange by the time the task was created. | Type: String
skip | See Filtering, Arranging, and Paging. | Type: Number
take | See Filtering, Arranging, and Paging. | Type: Number

## Response Information

A list of tasks.

### Response type

CollectionResultModel<TaskModel>

### Response body formats

#### application/json, text/json

Sample:

    {
      "Href": "[api:Tasks]",
      "Count": 1,
      "TotalMatchingFilter": 1,
      "Items": [
        {
          "Href": "[api:Tasks(06322394-68fc-4fb9-853f-62336fa78d2e)]",
          "Id": "06322394-68fc-4fb9-853f-62336fa78d2e",
          "Name": "Frobnicating widgets",
          "UserName": "DOMAIN\\user",
          "UserSid": "S-1-5-21-1180699209-877415012-3182924384-1004",
          "IsActive": true,
          "IsError": false,
          "IsWarning": false,
          "CanRetry": false,
          "CanCancel": true,
          "CreationTime": "2013-12-05T16:12:55.7760275-05:00",
          "Steps": [
            {
              "Id": "e2fd3ae5-179a-4fb5-81f9-832daa69ddfb",
              "Name": "Widget wiggle",
              "Description": "Widget wiggle 1",
              "IsHistory": false,
              "IsWarning": false,
              "State": "Succeeded",
              "Message": "Wiggled widget wisely",
              "CreationTime": "2013-12-05T16:12:55.7780264-05:00",
              "StartTime": "2013-12-05T16:12:55.7800307-05:00",
              "FinishTime": "2013-12-05T16:12:55.7790299-05:00",
              "TargetAgent": {
                "Href": "[api:Agents(941e92f1-5dd6-4720-bca2-6875c8b04acd)]",
                "Name": "SERVER1",
                "Id": "941e92f1-5dd6-4720-bca2-6875c8b04acd"
              }
            }
          ]
        }
      ]
    }