Interface

Represents a job hold or dependency.

A hold can either be a scheduled or a manual hold. A dependency can either be a job or a webhook dependency.

Properties

PropertyTypeNotes
dependentJobIdstring

Job id of a dependent job when there is a job dependency.

dependentStepIdstring

Step id of the dependent job when there is a job dependency.

holdIdstring

Id for the hold or dependency.

jobIdstring

Job id of the job with a hold or dependency.

releasedBystring

User who released the hold or dependency.

releasedDateDate

Date when a hold or dependency was released.

scheduledReleaseDate

Scheduled release date for when a scheduled hold will be released.

setBystring

User that added the hold or dependency.

setDateDate

Date when hold or dependency was set.

stepIdstring

Step id for the step with a hold or dependency.

webhookConnectionIdstring

Webhook connection id when there is a webhook dependency.

webhookDependencyWebhookDependency

Object containing webhook details when there is a webhook dependency.

dependentJobId

optional
Interface Property
dependentJobId: string

Job id of a dependent job when there is a job dependency.

dependentStepId

optional
Interface Property
dependentStepId: string

Step id of the dependent job when there is a job dependency.

holdId

Interface Property
holdId: string

Id for the hold or dependency.

jobId

Interface Property
jobId: string

Job id of the job with a hold or dependency.

releasedBy

optional
Interface Property
releasedBy: string

User who released the hold or dependency.

releasedDate

optional
Interface Property
releasedDate: Date

Date when a hold or dependency was released.

scheduledRelease

optional
Interface Property
scheduledRelease: Date

Scheduled release date for when a scheduled hold will be released.

setBy

Interface Property
setBy: string

User that added the hold or dependency.

setDate

Interface Property
setDate: Date

Date when hold or dependency was set.

stepId

Interface Property
stepId: string

Step id for the step with a hold or dependency.

webhookConnectionId

optional
Interface Property
webhookConnectionId: string

Webhook connection id when there is a webhook dependency.

webhookDependency

optional
Interface Property
webhookDependency: WebhookDependency

Object containing webhook details when there is a webhook dependency.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.