/
_API CancelDependencyGroupRequest Definition

_API CancelDependencyGroupRequest Definition

 Click here to expand...

Web Service

Type

Description

Req?

Val?

<sp:CancelDependencyGroupRequest>

    

 

<multiJobID>?</multiJobID>

JobID

MultiJobID is normally the unique identifier of the dependency group, but, if IsJobID is set, it can alternatively be the JobID of any of the jobs in a dependency group.

(tick)

(tick)

 

<options>

 

 

(error)

 

 

 

DontCancelCleared>?</DontCancelCleared>

boolean

When true, any jobs in the dependency group/split dependency group whose status is Cleared won’t be cancelled.

(error)

 

 

 

<DontCancelLoggedOff>?</DontCancelLoggedOff>

boolean 

When true, any jobs in the dependency group/split dependency group whose status is Logged Off won’t be cancelled.

(error)

 

  <DontCancelLoggedOn>?</DontCancelLoggedOn>booleanWhen true, any jobs in the dependency group/split dependency group whose status is Logged On won’t be cancelled.(error) 

 

 

<IsJobID>?</IsJobID>

boolean

Indicates if the multiJobID parameter is the JobID of a job in a dependency group/split dependency group, not the multiJobID of the group itself. The whole dependency group/split dependency group that contains that job is cancelled in the same way as would have been had the dependency group/split dependency group MultiJobID been supplied.

(error)

 

 

</options>

 

 

 

 


<cancelReason>





<cancelReasonId>?</cancelReasonId>cancelReasonIdCancellation reason ID.(error)(error)


<cancelDescription>?</cancelDescription>cancelReasonDescFree-form text reason for cancellation.(error)(error)

</cancelReason>



</sp:CancelDependencyGroupRequest>