JobsApi API

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

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

Quick Reference

Method	Description
acceptSplitProposal
addDependency
addPheromone
bulkDelete
create
createGroup
createLabel
createPheromoneType
createSplitProposal
delete
deleteGroup
deleteLabel
deletePheromoneType
deleteSplitProposal
get
getAggregatedPheromones
getAll
getBlocked
getGroups
getJobsByPheromone
getLabels
getPheromones
getPheromoneTypes
getReady
getStatistics
removeDependency
removePheromone
update
updateGroup

Methods

---

acceptSplitProposal

plugin.jobsApi.acceptSplitProposal(id: string, proposalId: string, data?: AcceptSplitProposalRequest): Promise<Job[]>

Parameter	Type	Required	Description
id	string	Yes
proposalId	string	Yes
data	AcceptSplitProposalRequest	No

Returns: Promise<Job[]>

Full reference →

---

addDependency

plugin.jobsApi.addDependency(id: string, data: AddDependencyRequest): Promise<void>

Parameter	Type	Required	Description
id	string	Yes
data	AddDependencyRequest	Yes

Returns: Promise<void>

Full reference →

---

addPheromone

plugin.jobsApi.addPheromone(id: string, data: PheromoneDepositRequest): Promise<Pheromone>

Parameter	Type	Required	Description
id	string	Yes
data	PheromoneDepositRequest	Yes

Returns: Promise<Pheromone>

Full reference →

---

bulkDelete

plugin.jobsApi.bulkDelete(data: BulkDeleteJobsRequest): Promise<void>

Parameter	Type	Required	Description
data	BulkDeleteJobsRequest	Yes

Returns: Promise<void>

Full reference →

---

create

plugin.jobsApi.create(data: CreateJobRequest): Promise<Job>

Parameter	Type	Required	Description
data	CreateJobRequest	Yes

Returns: Promise<Job>

Full reference →

---

createGroup

plugin.jobsApi.createGroup(data: CreateJobGroupRequest): Promise<JobGroup>

Parameter	Type	Required	Description
data	CreateJobGroupRequest	Yes

Returns: Promise<JobGroup>

Full reference →

---

createLabel

plugin.jobsApi.createLabel(data: CreateLabelRequest): Promise<JobLabel>

Parameter	Type	Required	Description
data	CreateLabelRequest	Yes

Returns: Promise<JobLabel>

Full reference →

---

createPheromoneType

plugin.jobsApi.createPheromoneType(data: CreatePheromoneTypeRequest): Promise<PheromoneType>

Parameter	Type	Required	Description
data	CreatePheromoneTypeRequest	Yes

Returns: Promise<PheromoneType>

Full reference →

---

createSplitProposal

plugin.jobsApi.createSplitProposal(id: string, data: CreateSplitProposalRequest): Promise<JobSplitProposal>

Parameter	Type	Required	Description
id	string	Yes
data	CreateSplitProposalRequest	Yes

Returns: Promise<JobSplitProposal>

Full reference →

---

delete

plugin.jobsApi.delete(id: string): Promise<void>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<void>

Full reference →

---

deleteGroup

plugin.jobsApi.deleteGroup(id: string): Promise<void>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<void>

Full reference →

---

deleteLabel

plugin.jobsApi.deleteLabel(name: string): Promise<void>

Parameter	Type	Required	Description
name	string	Yes

Returns: Promise<void>

Full reference →

---

deletePheromoneType

plugin.jobsApi.deletePheromoneType(name: string): Promise<void>

Parameter	Type	Required	Description
name	string	Yes

Returns: Promise<void>

Full reference →

---

deleteSplitProposal

plugin.jobsApi.deleteSplitProposal(id: string, proposalId: string): Promise<void>

Parameter	Type	Required	Description
id	string	Yes
proposalId	string	Yes

Returns: Promise<void>

Full reference →

---

get

plugin.jobsApi.get(id: string): Promise<Job>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<Job>

Full reference →

---

getAggregatedPheromones

plugin.jobsApi.getAggregatedPheromones(id: string): Promise<Record<string, unknown>>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<Record<string, unknown>>

Full reference →

---

getAll

plugin.jobsApi.getAll(params?: JobListFilters): Promise<Job[]>

Parameter	Type	Required	Description
params	JobListFilters	No

Returns: Promise<Job[]>

Full reference →

---

getBlocked

plugin.jobsApi.getBlocked(): Promise<Job[]>

No parameters.

Returns: Promise<Job[]>

Full reference →

---

getGroups

plugin.jobsApi.getGroups(): Promise<JobGroup[]>

No parameters.

Returns: Promise<JobGroup[]>

Full reference →

---

getJobsByPheromone

plugin.jobsApi.getJobsByPheromone(type: string): Promise<Job[]>

Parameter	Type	Required	Description
type	string	Yes

Returns: Promise<Job[]>

Full reference →

---

getLabels

plugin.jobsApi.getLabels(): Promise<JobLabel[]>

No parameters.

Returns: Promise<JobLabel[]>

Full reference →

---

getPheromones

plugin.jobsApi.getPheromones(id: string): Promise<Pheromone[]>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<Pheromone[]>

Full reference →

---

getPheromoneTypes

plugin.jobsApi.getPheromoneTypes(): Promise<PheromoneType[]>

No parameters.

Returns: Promise<PheromoneType[]>

Full reference →

---

getReady

plugin.jobsApi.getReady(): Promise<Job[]>

No parameters.

Returns: Promise<Job[]>

Full reference →

---

getStatistics

plugin.jobsApi.getStatistics(): Promise<JobStatistics>

No parameters.

Returns: Promise<JobStatistics>

Full reference →

---

removeDependency

plugin.jobsApi.removeDependency(id: string, targetId: string): Promise<void>

Parameter	Type	Required	Description
id	string	Yes
targetId	string	Yes

Returns: Promise<void>

Full reference →

---

removePheromone

plugin.jobsApi.removePheromone(id: string, type: string): Promise<void>

Parameter	Type	Required	Description
id	string	Yes
type	string	Yes

Returns: Promise<void>

Full reference →

---

update

plugin.jobsApi.update(id: string, data: UpdateJobRequest): Promise<Job>

Parameter	Type	Required	Description
id	string	Yes
data	UpdateJobRequest	Yes

Returns: Promise<Job>

Full reference →

---

updateGroup

plugin.jobsApi.updateGroup(id: string, data: UpdateJobGroupRequest): Promise<JobGroup>

Parameter	Type	Required	Description
id	string	Yes
data	UpdateJobGroupRequest	Yes

Returns: Promise<JobGroup>

Full reference →