Jobs

Get jobs details based on filters

Returns jobs in descending order with pagination based on jobType, status, projectId, triggeredBy, jobsHistoryInDays

Request

query Parameters

jobType	string Enum: "Project Branching" "Project Copy" "Project Scan" "Project Re-Scan" "PDL Update" "Audit Report" "Notices Report" "Project Report" "Custom Report" "Project Deletion" "Export to SBOM Insights" "Update Notices"
status	string Enum: "New" "Active" "Canceled" "Completed" "Failed" "Scheduled" "Terminated" "Waiting on update"
projectId	integer <int32> Id of the project
triggeredBy	string Login Name of the user
jobsHistoryInDays	integer <int32> Days in number. Get jobs in days. (Default=0, All the jobs will be fetched with other filters)
limit	integer <int32> Page Size. Number Of Records to fetch per page
offset	integer <int32> Page Number. Index of the page to start with(starts from 1)

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: E.g. Bearer JWT_TOKEN

Responses

200

400

Bad request

404

Not Found

500

Internal Server Error

get/jobs

Update project notices

Update notices operation will be added to queue. To get status of update notices use jobs/{jobId} API

Request

path Parameters

projectId

required

integer <int32>

ID of the Project

Example: E.g. 1

query Parameters

overwriteAll

boolean

Default: false

If true, overwrite all notices text, else update only empty notices texts

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: E.g. Bearer JWT_TOKEN

Responses

202

Accepted

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

503

Service Unavailable

post/jobs/notices/{projectId}

Export project inventory to SBOM Insights

Export project to SBOM Insights operation will be added to queue. To get status of Export to SBOM Insights use jobs/{jobId} API

Request

path Parameters

projectId

required

integer <int32>

ID of the Project

Example: E.g. 1

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: E.g. Bearer JWT_TOKEN

Responses

202

Accepted

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

503

Service Unavailable

post/jobs/sbomexport/{projectId}

Get Job details based on the jobId provided

Returns Job details for a given JobId which is obtained from /jobs/all

Request

path Parameters

jobId

required

integer <int32>

ID of the Job

Example: E.g. 1

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: E.g. Bearer JWT_TOKEN

Responses

200

400

Bad request

404

Not Found

500

Internal Server Error

get/jobs/{jobId}

Response samples

application/json

{"id": 0,
"jobType": "Project Branching",
"project": {"id": 0,
"name": "string"
},
"status": "NEW",
"triggeredBy": {"id": 0,
"user": "string"
},
"queuedOn": "2017-10-24 13:04:26.0",
"activatedOn": "2017-10-24 13:04:26.0",
"completedOn": "2017-10-24 13:04:26.0",
"jobDetails": "string",
"error": "string"
}

➔ Next to Project API