Sign in

v1

latestSwagger 2.02026-08-061,9128853.7 MB
Tasks

Change the state of a task

post/tasks/{id}/state

Path parameters

idstring required

The ID of the task

Request body

Idstring required
Reasonstring required
SpaceIdstring
State'Queued' | 'Executing' | 'Failed' | 'Canceled' | 'TimedOut' | 'Success' | 'Cancelling' required

Response

Returns the Task resource after the state has been changed in response to a ModifyServerTaskStateCommand

Argumentsobject
CanRerunboolean
Completedstring
CompletedTimestring date-time
Descriptionstring
Durationstring
ErrorMessagestring
EstimatedRemainingQueueDurationSecondsinteger
FinishedSuccessfullyboolean
HasBeenPickedUpByProcessorboolean
HasPendingInterruptionsboolean
HasPendingPreconditionsboolean
HasWarningsOrErrorsboolean
Idstring
IsCompletedboolean
LastModifiedBystring
LastModifiedOnstring date-time
LastUpdatedTimestring date-time
Linksobject
Namestring
PendingInterruptionTypesstring[]
PendingPreconditionTypesstring[]
ProjectIdstring
QueueTimestring date-time
QueueTimeExpirystring date-time
ServerNodestring
SpaceIdstring
StartTimestring date-time
State'Queued' | 'Executing' | 'Failed' | 'Canceled' | 'TimedOut' | 'Success' | 'Cancelling'