Job API

The job module of the @codebolt/plugin-sdk.

import plugin from '@codebolt/plugin-sdk';

Quick Reference

Method	Description
`acceptBid`
`acceptSplitProposal`
`addBid`
`addBlocker`
`addDependency`
`addLabel`
`addPheromoneType`
`addSplitProposal`
`addUnlockRequest`
`approveUnlockRequest`
`createJob`
`createJobGroup`
`deleteJob`
`deleteJobs`
`deleteSplitProposal`
`deleteUnlockRequest`
`depositPheromone`
`getBlockedJobs`
`getJob`
`getPheromones`
`getPheromonesAggregated`
`getPheromonesAggregatedWithDecay`
`getPheromonesWithDecay`
`getPheromoneTypes`
`getReadyJobs`
`isJobLocked`
`listBids`
`listJobs`
`listJobsByPheromone`
`listLabels`
`lockJob`
`rejectUnlockRequest`
`removeBlocker`
`removeDependency`
`removeLabel`
`removePheromone`
`removePheromoneType`
`resolveBlocker`
`unlockJob`
`updateJob`
`withdrawBid`

Methods

`acceptBid`

plugin.job.acceptBid(jobId: string, bidId: string): Promise<JobBidAcceptResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes
`bidId`	`string`	Yes

Returns: Promise<JobBidAcceptResponse>

Full reference →

`acceptSplitProposal`

plugin.job.acceptSplitProposal(jobId: string, proposalId: string): Promise<JobSplitAcceptResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes
`proposalId`	`string`	Yes

Returns: Promise<JobSplitAcceptResponse>

Full reference →

`addBid`

plugin.job.addBid(jobId: string, bid: AddBidData): Promise<JobBidAddResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes
`bid`	`AddBidData`	Yes

Returns: Promise<JobBidAddResponse>

Full reference →

`addBlocker`

plugin.job.addBlocker(jobId: string, blocker: AddBlockerData): Promise<JobBlockerAddResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes
`blocker`	`AddBlockerData`	Yes

Returns: Promise<JobBlockerAddResponse>

Full reference →

`addDependency`

plugin.job.addDependency(jobId: string, targetId: string, type?: DependencyType): Promise<JobDependencyResponse>

Parameter	Type	Required
`jobId`	`string`	Yes
`targetId`	`string`	Yes
`type`	`DependencyType`	No

Returns: Promise<JobDependencyResponse>

Full reference →

`addLabel`

plugin.job.addLabel(label: string): Promise<JobLabelsResponse>

Parameter	Type	Required	Description
`label`	`string`	Yes

Returns: Promise<JobLabelsResponse>

Full reference →

`addPheromoneType`

plugin.job.addPheromoneType(data: AddPheromoneTypeData): Promise<JobPheromoneTypeResponse>

Parameter	Type	Required	Description
`data`	`AddPheromoneTypeData`	Yes

Returns: Promise<JobPheromoneTypeResponse>

Full reference →

`addSplitProposal`

plugin.job.addSplitProposal(jobId: string, proposal: AddSplitProposalData): Promise<JobSplitProposeResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes
`proposal`	`AddSplitProposalData`	Yes

Returns: Promise<JobSplitProposeResponse>

Full reference →

`addUnlockRequest`

plugin.job.addUnlockRequest(jobId: string, request: AddUnlockRequestData): Promise<JobUnlockRequestAddResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes
`request`	`AddUnlockRequestData`	Yes

Returns: Promise<JobUnlockRequestAddResponse>

Full reference →

`approveUnlockRequest`

plugin.job.approveUnlockRequest(jobId: string, unlockRequestId: string, respondedBy: string): Promise<JobUnlockRequestApproveResponse>

Parameter	Type	Required
`jobId`	`string`	Yes
`unlockRequestId`	`string`	Yes
`respondedBy`	`string`	Yes

Returns: Promise<JobUnlockRequestApproveResponse>

Full reference →

`createJob`

plugin.job.createJob(groupId: string, data: CreateJobData): Promise<JobCreateResponse>

Parameter	Type	Required	Description
`groupId`	`string`	Yes
`data`	`CreateJobData`	Yes

Returns: Promise<JobCreateResponse>

Full reference →

`createJobGroup`

plugin.job.createJobGroup(data: CreateJobGroupData): Promise<JobGroupCreateResponse>

Parameter	Type	Required	Description
`data`	`CreateJobGroupData`	Yes

Returns: Promise<JobGroupCreateResponse>

Full reference →

`deleteJob`

plugin.job.deleteJob(jobId: string): Promise<JobDeleteResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes

Returns: Promise<JobDeleteResponse>

Full reference →

`deleteJobs`

plugin.job.deleteJobs(jobIds: string[]): Promise<JobDeleteBulkResponse>

Parameter	Type	Required	Description
`jobIds`	`string[]`	Yes

Returns: Promise<JobDeleteBulkResponse>

Full reference →

`deleteSplitProposal`

plugin.job.deleteSplitProposal(jobId: string, proposalId: string): Promise<JobSplitDeleteResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes
`proposalId`	`string`	Yes

Returns: Promise<JobSplitDeleteResponse>

Full reference →

`deleteUnlockRequest`

plugin.job.deleteUnlockRequest(jobId: string, unlockRequestId: string): Promise<JobUnlockRequestDeleteResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes
`unlockRequestId`	`string`	Yes

Returns: Promise<JobUnlockRequestDeleteResponse>

Full reference →

`depositPheromone`

plugin.job.depositPheromone(jobId: string, deposit: DepositPheromoneData): Promise<JobPheromoneDepositResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes
`deposit`	`DepositPheromoneData`	Yes

Returns: Promise<JobPheromoneDepositResponse>

Full reference →

`getBlockedJobs`

plugin.job.getBlockedJobs(filters: JobListFilters): Promise<JobReadyBlockedResponse>

Parameter	Type	Required	Description
`filters`	`JobListFilters`	Yes	(default: `{}`)

Returns: Promise<JobReadyBlockedResponse>

Full reference →

`getJob`

plugin.job.getJob(jobId: string): Promise<JobShowResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes

Returns: Promise<JobShowResponse>

Full reference →

`getPheromones`

plugin.job.getPheromones(jobId: string): Promise<JobPheromoneListResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes

Returns: Promise<JobPheromoneListResponse>

Full reference →

`getPheromonesAggregated`

plugin.job.getPheromonesAggregated(jobId: string): Promise<JobPheromoneAggregatedResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes

Returns: Promise<JobPheromoneAggregatedResponse>

Full reference →

`getPheromonesAggregatedWithDecay`

plugin.job.getPheromonesAggregatedWithDecay(jobId: string): Promise<JobPheromoneAggregatedResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes

Returns: Promise<JobPheromoneAggregatedResponse>

Full reference →

`getPheromonesWithDecay`

plugin.job.getPheromonesWithDecay(jobId: string): Promise<JobPheromoneListResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes

Returns: Promise<JobPheromoneListResponse>

Full reference →

`getPheromoneTypes`

plugin.job.getPheromoneTypes(): Promise<JobPheromoneTypesResponse>

No parameters.

Returns: Promise<JobPheromoneTypesResponse>

Full reference →

`getReadyJobs`

plugin.job.getReadyJobs(filters: JobListFilters): Promise<JobReadyBlockedResponse>

Parameter	Type	Required	Description
`filters`	`JobListFilters`	Yes	(default: `{}`)

Returns: Promise<JobReadyBlockedResponse>

Full reference →

`isJobLocked`

plugin.job.isJobLocked(jobId: string): Promise<JobLockCheckResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes

Returns: Promise<JobLockCheckResponse>

Full reference →

`listBids`

plugin.job.listBids(jobId: string): Promise<JobBidListResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes

Returns: Promise<JobBidListResponse>

Full reference →

`listJobs`

plugin.job.listJobs(filters: JobListFilters): Promise<JobListResponse>

Parameter	Type	Required	Description
`filters`	`JobListFilters`	Yes	(default: `{}`)

Returns: Promise<JobListResponse>

Full reference →

`listJobsByPheromone`

plugin.job.listJobsByPheromone(type: string, minIntensity?: number): Promise<JobPheromoneSearchResponse>

Parameter	Type	Required	Description
`type`	`string`	Yes
`minIntensity`	`number`	No

Returns: Promise<JobPheromoneSearchResponse>

Full reference →

`listLabels`

plugin.job.listLabels(): Promise<JobLabelsResponse>

No parameters.

Returns: Promise<JobLabelsResponse>

Full reference →

`lockJob`

plugin.job.lockJob(jobId: string, agentId: string, agentName?: string): Promise<JobLockAcquireResponse>

Parameter	Type	Required
`jobId`	`string`	Yes
`agentId`	`string`	Yes
`agentName`	`string`	No

Returns: Promise<JobLockAcquireResponse>

Full reference →

`rejectUnlockRequest`

plugin.job.rejectUnlockRequest(jobId: string, unlockRequestId: string, respondedBy: string): Promise<JobUnlockRequestRejectResponse>

Parameter	Type	Required
`jobId`	`string`	Yes
`unlockRequestId`	`string`	Yes
`respondedBy`	`string`	Yes

Returns: Promise<JobUnlockRequestRejectResponse>

Full reference →

`removeBlocker`

plugin.job.removeBlocker(jobId: string, blockerId: string): Promise<JobBlockerRemoveResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes
`blockerId`	`string`	Yes

Returns: Promise<JobBlockerRemoveResponse>

Full reference →

`removeDependency`

plugin.job.removeDependency(jobId: string, targetId: string): Promise<JobDependencyResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes
`targetId`	`string`	Yes

Returns: Promise<JobDependencyResponse>

Full reference →

`removeLabel`

plugin.job.removeLabel(label: string): Promise<JobLabelsResponse>

Parameter	Type	Required	Description
`label`	`string`	Yes

Returns: Promise<JobLabelsResponse>

Full reference →

`removePheromone`

plugin.job.removePheromone(jobId: string, type: string, depositedBy?: string): Promise<JobPheromoneRemoveResponse>

Parameter	Type	Required
`jobId`	`string`	Yes
`type`	`string`	Yes
`depositedBy`	`string`	No

Returns: Promise<JobPheromoneRemoveResponse>

Full reference →

`removePheromoneType`

plugin.job.removePheromoneType(name: string): Promise<JobPheromoneTypeResponse>

Parameter	Type	Required	Description
`name`	`string`	Yes

Returns: Promise<JobPheromoneTypeResponse>

Full reference →

`resolveBlocker`

plugin.job.resolveBlocker(jobId: string, blockerId: string, resolvedBy: string): Promise<JobBlockerResolveResponse>

Parameter	Type	Required
`jobId`	`string`	Yes
`blockerId`	`string`	Yes
`resolvedBy`	`string`	Yes

Returns: Promise<JobBlockerResolveResponse>

Full reference →

`unlockJob`

plugin.job.unlockJob(jobId: string, agentId: string): Promise<JobLockReleaseResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes
`agentId`	`string`	Yes

Returns: Promise<JobLockReleaseResponse>

Full reference →

`updateJob`

plugin.job.updateJob(jobId: string, data: UpdateJobData): Promise<JobUpdateResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes
`data`	`UpdateJobData`	Yes

Returns: Promise<JobUpdateResponse>

Full reference →

`withdrawBid`

plugin.job.withdrawBid(jobId: string, bidId: string): Promise<JobBidWithdrawResponse>

Parameter	Type	Required	Description
`jobId`	`string`	Yes
`bidId`	`string`	Yes

Returns: Promise<JobBidWithdrawResponse>

Full reference →

Quick Reference​

Methods​

acceptBid​

acceptSplitProposal​

addBid​

addBlocker​

addDependency​

addLabel​

addPheromoneType​

addSplitProposal​

addUnlockRequest​

approveUnlockRequest​

createJob​

createJobGroup​

deleteJob​

deleteJobs​

deleteSplitProposal​

deleteUnlockRequest​

depositPheromone​

getBlockedJobs​

getJob​

getPheromones​

getPheromonesAggregated​

getPheromonesAggregatedWithDecay​

getPheromonesWithDecay​

getPheromoneTypes​

getReadyJobs​

isJobLocked​

listBids​

listJobs​

listJobsByPheromone​

listLabels​

lockJob​

rejectUnlockRequest​

removeBlocker​

removeDependency​

removeLabel​

removePheromone​

removePheromoneType​

resolveBlocker​

unlockJob​

updateJob​

withdrawBid​

Quick Reference

Methods

`acceptBid`

`acceptSplitProposal`

`addBid`

`addBlocker`

`addDependency`

`addLabel`

`addPheromoneType`

`addSplitProposal`

`addUnlockRequest`

`approveUnlockRequest`

`createJob`

`createJobGroup`

`deleteJob`

`deleteJobs`

`deleteSplitProposal`

`deleteUnlockRequest`

`depositPheromone`

`getBlockedJobs`

`getJob`

`getPheromones`

`getPheromonesAggregated`

`getPheromonesAggregatedWithDecay`

`getPheromonesWithDecay`

`getPheromoneTypes`

`getReadyJobs`

`isJobLocked`

`listBids`

`listJobs`

`listJobsByPheromone`

`listLabels`

`lockJob`

`rejectUnlockRequest`

`removeBlocker`

`removeDependency`

`removeLabel`

`removePheromone`

`removePheromoneType`

`resolveBlocker`

`unlockJob`

`updateJob`

`withdrawBid`