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"
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: Bearer JWT_TOKEN
Responses
200

OK

400

Bad request

404

Not Found

500

Internal Server Error

get/jobs

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: 1
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN
Responses
200

OK

400

Bad request

404

Not Found

500

Internal Server Error

get/jobs/{jobId}
Response samples
application/json
{
  • "id": 0,
  • "jobType": "Project Branching",
  • "project": {
    },
  • "status": "NEW",
  • "triggeredBy": {
    },
  • "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"
}