WorkflowStepModel
Workflow step performed due to an administrative task.
Properties
Name | Description | Additional information |
---|---|---|
Id | ID of the workflow step. |
Type: String |
Name | Name of the workflow step. |
Type: String |
Description | Description. |
Type: String |
IsHistory | True if the workflow step is part of a larger group of steps which has fully succeeded in bringing part of the system into compliance with the desired state. |
Type: Boolean |
IsWarning | True if the workflow step has been executing for an inordinate amount of time without reporting progress. |
Type: Boolean |
State | State of the workflow step. |
Type: WorkflowStepState |
Message | Message associated with the workflow step. |
Type: String |
CreationTime | The time that the workflow step was created. |
Type: String (ISO 8601 standard date) |
StartTime | The time that the workflow step was started. If the step has not started, this will be unset. |
Type: String (ISO 8601 standard date) |
FinishTime | The time that the workflow step was finished. If the step has not finished, this will be unset. |
Type: String (ISO 8601 standard date) |
TargetAgent | The target agent for the workflow step. Note: currently this is only set for workflow steps which have not completed; the system does not track which agent executed a workflow step after it has completed. |
Type: ReferenceModel |
Sample
application/json
{ "Id": "e2fd3ae5-179a-4fb5-81f9-832daa69ddfb", "Name": "Widget wiggle", "Description": "Widget wiggle 1", "State": "Succeeded", "Message": "Wiggled widget wisely", "CreationTime": "2013-12-05T16:14:03.9103461-05:00", "StartTime": "2013-12-05T16:14:03.9103461-05:00", "FinishTime": "2013-12-05T16:14:03.9103461-05:00", "TargetAgent": { "Href": "[api:Agents(941e92f1-5dd6-4720-bca2-6875c8b04acd)]", "Name": "SERVER1", "Id": "941e92f1-5dd6-4720-bca2-6875c8b04acd" } }