# ApiCommandWithSteps Data Model

Provides detailed information about a submitted command including all steps and a summary of subcommands.

There are two types of commands: synchronous and asynchronous. Synchronous commands complete immediately, and their results are passed back in the returned command object after the execution of an API call. Outside of that returned object, there is no way to check the result of a synchronous command.

Asynchronous commands have unique non-negative IDs. They may still be running when the API call returns. Clients can check the status of such commands using the API.

Properties
name | data type | description
--- | --- | ---
displayName | string | The command display name.
steps | array of ApiCommandStep | The steps of the command.

##### Properties inherited from ApiCommand

id | number | The command ID.
name | string | The command name.
startTime | string | The start time.
endTime | string | The end time, if the command is finished.
active | boolean | Whether the command is currently active.
success | boolean | If the command is finished, whether it was successful.
resultMessage | string | If the command is finished, the result message.
resultDataUrl | string | URL to the command's downloadable result data, if any exists.
clusterRef | ApiClusterRef | Reference to the cluster (for cluster commands only).
serviceRef | ApiServiceRef | Reference to the service (for service commands only).
roleRef | ApiRoleRef | Reference to the role (for role commands only).
hostRef | ApiHostRef | Reference to the host (for host commands only).
parent | ApiCommand | Reference to the parent command, if any.
children | ApiCommandList | List of child commands. Only available in the full view. The list contains only the summary view of the children.
canRetry | boolean | If the command can be retried. Available since V11

Example

    {
      "displayName" : "...",
      "steps" : [ {
        "description" : "...",
        "startTime" : "...",
        "endTime" : "...",
        "state" : "NOT_RUN",
        "resultMessage" : "...",
        "ignoreError" : true,
        "parallel" : true,
        "processes" : [ {
          "name" : "...",
          "id" : 12345,
          "program" : "...",
          "args" : "...",
          "stdout" : "...",
          "stderr" : "...",
          "exitCode" : 12345
        }, {
          "name" : "...",
          "id" : 12345,
          "program" : "...",
          "args" : "...",
          "stdout" : "...",
          "stderr" : "...",
          "exitCode" : 12345
        } ],
        "clientConfigs" : [ {
          "name" : "...",
          "id" : 12345,
          "program" : "...",
          "args" : "...",
          "stdout" : "...",
          "stderr" : "...",
          "exitCode" : 12345
        }, {
          "name" : "...",
          "id" : 12345,
          "program" : "...",
          "args" : "...",
          "stdout" : "...",
          "stderr" : "...",
          "exitCode" : 12345
        } ],
        "roles" : [ {
          "clusterName" : "...",
          "serviceName" : "...",
          "roleName" : "...",
          "healthSummary" : "BAD",
          "roleStatus" : "STOPPED"
        }, {
          "clusterName" : "...",
          "serviceName" : "...",
          "roleName" : "...",
          "healthSummary" : "GOOD",
          "roleStatus" : "STARTED"
        } ],
        "clusters" : [ {
          "clusterName" : "...",
          "displayName" : "..."
        }, {
          "clusterName" : "...",
          "displayName" : "..."
        } ],
        "hosts" : [ {
          "hostId" : "...",
          "hostname" : "..."
        }, {
          "hostId" : "...",
          "hostname" : "..."
        } ],
        "services" : [ {
          "peerName" : "...",
          "clusterName" : "...",
          "clusterDisplayName" : "...",
          "serviceName" : "...",
          "serviceDisplayName" : "...",
          "serviceType" : "..."
        }, {
          "peerName" : "...",
          "clusterName" : "...",
          "clusterDisplayName" : "...",
          "serviceName" : "...",
          "serviceDisplayName" : "...",
          "serviceType" : "..."
        } ],
        "children" : [ { }, { } ],
        "commands" : [ {
          "id" : 12345,
          "name" : "...",
          "startTime" : "...",
          "endTime" : "...",
          "active" : true,
          "success" : true,
          "resultMessage" : "...",
          "resultDataUrl" : "...",
          "clusterRef" : { },
          "serviceRef" : { },
          "roleRef" : { },
          "hostRef" : { },
          "parent" : { },
          "children" : { },
          "canRetry" : true
        }, {
          "id" : 12345,
          "name" : "...",
          "startTime" : "...",
          "endTime" : "...",
          "active" : true,
          "success" : true,
          "resultMessage" : "...",
          "resultDataUrl" : "...",
          "clusterRef" : { },
          "serviceRef" : { },
          "roleRef" : { },
          "hostRef" : { },
          "parent" : { },
          "children" : { },
          "canRetry" : true
        } ],
        "remoteCommand" : {
          "id" : 12345,
          "peerName" : "..."
        }
      }, {
        "description" : "...",
        "startTime" : "...",
        "endTime" : "...",
        "state" : "NOT_RUN",
        "resultMessage" : "...",
        "ignoreError" : true,
        "parallel" : true,
        "processes" : [ {
          "name" : "...",
          "id" : 12345,
          "program" : "...",
          "args" : "...",
          "stdout" : "...",
          "stderr" : "...",
          "exitCode" : 12345
        }, {
          "name" : "...",
          "id" : 12345,
          "program" : "...",
          "args" : "...",
          "stdout" : "...",
          "stderr" : "...",
          "exitCode" : 12345
        } ],
        "clientConfigs" : [ {
          "name" : "...",
          "id" : 12345,
          "program" : "...",
          "args" : "...",
          "stdout" : "...",
          "stderr" : "...",
          "exitCode" : 12345
        }, {
          "name" : "...",
          "id" : 12345,
          "program" : "...",
          "args" : "...",
          "stdout" : "...",
          "stderr" : "...",
          "exitCode" : 12345
        } ],
        "roles" : [ {
          "clusterName" : "...",
          "serviceName" : "...",
          "roleName" : "...",
          "healthSummary" : "BAD",
          "roleStatus" : "BUSY"
        }, {
          "clusterName" : "...",
          "serviceName" : "...",
          "roleName" : "...",
          "healthSummary" : "CONCERNING",
          "roleStatus" : "STOPPED"
        } ],
        "clusters" : [ {
          "clusterName" : "...",
          "displayName" : "..."
        }, {
          "clusterName" : "...",
          "displayName" : "..."
        } ],
        "hosts" : [ {
          "hostId" : "...",
          "hostname" : "..."
        }, {
          "hostId" : "...",
          "hostname" : "..."
        } ],
        "services" : [ {
          "peerName" : "...",
          "clusterName" : "...",
          "clusterDisplayName" : "...",
          "serviceName" : "...",
          "serviceDisplayName" : "...",
          "serviceType" : "..."
        }, {
          "peerName" : "...",
          "clusterName" : "...",
          "clusterDisplayName" : "...",
          "serviceName" : "...",
          "serviceDisplayName" : "...",
          "serviceType" : "..."
        } ],
        "children" : [ { }, { } ],
        "commands" : [ {
          "id" : 12345,
          "name" : "...",
          "startTime" : "...",
          "endTime" : "...",
          "active" : true,
          "success" : true,
          "resultMessage" : "...",
          "resultDataUrl" : "...",
          "clusterRef" : { },
          "serviceRef" : { },
          "roleRef" : { },
          "hostRef" : { },
          "parent" : { },
          "children" : { },
          "canRetry" : true
        }, {
          "id" : 12345,
          "name" : "...",
          "startTime" : "...",
          "endTime" : "...",
          "active" : true,
          "success" : true,
          "resultMessage" : "...",
          "resultDataUrl" : "...",
          "clusterRef" : { },
          "serviceRef" : { },
          "roleRef" : { },
          "hostRef" : { },
          "parent" : { },
          "children" : { },
          "canRetry" : true
        } ],
        "remoteCommand" : {
          "id" : 12345,
          "peerName" : "..."
        }
      } ],
      "id" : 12345,
      "name" : "...",
      "startTime" : "...",
      "endTime" : "...",
      "active" : true,
      "success" : true,
      "resultMessage" : "...",
      "resultDataUrl" : "...",
      "clusterRef" : {
        "clusterName" : "...",
        "displayName" : "..."
      },
      "serviceRef" : {
        "peerName" : "...",
        "clusterName" : "...",
        "clusterDisplayName" : "...",
        "serviceName" : "...",
        "serviceDisplayName" : "...",
        "serviceType" : "..."
      },
      "roleRef" : {
        "clusterName" : "...",
        "serviceName" : "...",
        "roleName" : "...",
        "healthSummary" : "DISABLED",
        "roleStatus" : "HISTORY_NOT_AVAILABLE"
      },
      "hostRef" : {
        "hostId" : "...",
        "hostname" : "..."
      },
      "parent" : {
        "id" : 12345,
        "name" : "...",
        "startTime" : "...",
        "endTime" : "...",
        "active" : true,
        "success" : true,
        "resultMessage" : "...",
        "resultDataUrl" : "...",
        "clusterRef" : {
          "clusterName" : "...",
          "displayName" : "..."
        },
        "serviceRef" : {
          "peerName" : "...",
          "clusterName" : "...",
          "clusterDisplayName" : "...",
          "serviceName" : "...",
          "serviceDisplayName" : "...",
          "serviceType" : "..."
        },
        "roleRef" : {
          "clusterName" : "...",
          "serviceName" : "...",
          "roleName" : "...",
          "healthSummary" : "DISABLED",
          "roleStatus" : "STARTING"
        },
        "hostRef" : {
          "hostId" : "...",
          "hostname" : "..."
        },
        "parent" : { },
        "children" : {
          "items" : [ { }, { } ]
        },
        "canRetry" : true
      },
      "children" : {
        "items" : [ {
          "id" : 12345,
          "name" : "...",
          "startTime" : "...",
          "endTime" : "...",
          "active" : true,
          "success" : true,
          "resultMessage" : "...",
          "resultDataUrl" : "...",
          "clusterRef" : { },
          "serviceRef" : { },
          "roleRef" : { },
          "hostRef" : { },
          "parent" : { },
          "children" : { },
          "canRetry" : true
        }, {
          "id" : 12345,
          "name" : "...",
          "startTime" : "...",
          "endTime" : "...",
          "active" : true,
          "success" : true,
          "resultMessage" : "...",
          "resultDataUrl" : "...",
          "clusterRef" : { },
          "serviceRef" : { },
          "roleRef" : { },
          "hostRef" : { },
          "parent" : { },
          "children" : { },
          "canRetry" : true
        } ]
      },
      "canRetry" : true
    }