TaskModel

Record of an administrative task.

Properties

NameDescription Additional information
Href

See Hypermedia.

Type: String

RelatedActions

See Hypermedia.

Type: Array of RelationModel

Id

ID of the task.

Type: String

Name

Name of the task.

Type: String

UserName

Name of the user who performed the task. Note that some tasks are performed automatically by the system.

Type: String

UserSid

SID of the user who performed the task. Note that some tasks are performed automatically by the system.

Type: String

IsActive

True if at least one workflow step is running.

Type: Boolean

IsError

True if at least one workflow step is failed.

Type: Boolean

IsWarning

True if at least one workflow step has warning.

Type: Boolean

CanRetry

True if at least one workflow step is failed or cancelled, while all other workflow steps are failed, cancelled, or pending.

Type: Boolean

CanCancel

True if no workflow step is in the cancelling state and CanRetry is false.

Type: Boolean

CreationTime

The time that the task was performed.

Type: String (ISO 8601 standard date)

Steps

List of all steps taken by an agent to bring the deployed components into compliance with the new desired state that was created by performing the task.

Type: Array of WorkflowStepModel

Sample

application/json

Sample:
{
  "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,
  "CanCancel": true,
  "CreationTime": "2013-12-05T16:13:32.5377947-05:00",
  "Steps": [
    {
      "Id": "e2fd3ae5-179a-4fb5-81f9-832daa69ddfb",
      "Name": "Widget wiggle",
      "Description": "Widget wiggle 1",
      "State": "Succeeded",
      "Message": "Wiggled widget wisely",
      "CreationTime": "2013-12-05T16:13:32.5377947-05:00",
      "StartTime": "2013-12-05T16:13:32.5377947-05:00",
      "FinishTime": "2013-12-05T16:13:32.5377947-05:00",
      "TargetAgent": {
        "Href": "[api:Agents(941e92f1-5dd6-4720-bca2-6875c8b04acd)]",
        "Name": "SERVER1",
        "Id": "941e92f1-5dd6-4720-bca2-6875c8b04acd"
      }
    }
  ]
}