Skip to main content

Job Object

Description​

Represents a background job for processing tasks like exports, imports, or bulk operations.

Declaration​

type Job {
_id: ID!
type: String!
created: Date
user: UserReference
task: JobTask
options: JSON
optionsAsString: String
status: JobStatus!
hidden: Boolean
results: JobResults
completion: Float
}

Fields​

NameTypeDescription
_idID!Internal database identifier.
typeString!Job type identifier (task name).
createdDateDate when the job was created.
userUserReferenceUser who initiated the job.
taskJobTaskTask information including path and name.
optionsJSONJob options as JSON data.
optionsAsStringStringHuman-readable string representation of job options.
statusJobStatus!Current status of the job.
hiddenBooleanWhether the job is hidden from the default view.
resultsJobResultsJob results (available when status is complete or failed).
completionFloatCompletion percentage (0-100).