Name / Description | Type / Format | Example | |
---|---|---|---|
id
Job public Id.
|
string
uuid
|
"string"
|
|
employerId
Employer public Id.
|
string
uuid
|
"string"
|
|
employerName
Employer name.
|
string
|
"string"
|
|
type
|
string
|
"Report"
"Import"
"PayRun"
|
|
name
The Job name, e.g. uploaded file for Import, or report display name for Report
|
string
|
"string"
|
|
outputFormat
The Job output format, e.g. json/csv/pdf for Report, or something else for other Job types.
|
string
|
"string"
|
|
status
|
string
|
"Queued"
"Executing"
"Completed"
"Failed"
"CompletedWithErrors"
|
|
executionStartTime
The Job excution start time.
|
string
date
|
"2024-11-03"
|
|
timeInQueue
The time the Job spent in the queue before execution in seconds.
|
integer
int32
|
0
|
|
executionTime
The time it took the Job to execute in seconds.
|
integer
int32
|
0
|
|
result
|
Contract.JobResultResponse
|
{Contract.JobResultResponse}
|
|
createdDate
Job Created date.
|
string
date
|
"2024-11-03"
|
|
updatedDate
Job Updated date where applicable.
|
string
date
|
"2024-11-03"
|
|
requestedByName
The name of the user that requested this job
|
string
|
"string"
|
{
"id": "string",
"employerId": "string",
"employerName": "string",
"type": "Report",
"name": "string",
"outputFormat": "string",
"status": "Queued",
"executionStartTime": "2024-11-03",
"timeInQueue": 0,
"executionTime": 0,
"result": {
"file": {
"fileName": "string",
"uri": "string"
},
"metadata": {},
"errors": [
"string"
]
},
"createdDate": "2024-11-03",
"updatedDate": "2024-11-03",
"requestedByName": "string"
}
- none -
- none -
Introduction | Async Jobs |