GuidesRecipesAPI ReferenceChangelogDiscussions
Log In

client.jobs.get

Retrieve the job information

client.jobs.get(job)

Return the Job details, including the status, total, completed, and failed number of items.

Parameters

ParameterTypeDescriptionExample
jobstr
Job
Result
Job identifier as a string or a previusly loaded Job or Result object'14856eb1-0ad8-49e7-9da3-887acb80fea5'

Returns

A Job object with the status from the server

{
  "job_identifier": "string",
  "status",
  "account_identifier": "string",        
  "explain": "boolean",        
  "created_at": "date-time",
  "updated_at": "date-time",
  "submitted_at": "date-time",
  "submitted_by": "string",        
  "pending": "integer",
  "completed": "integer",    
  "failed": "integer",
  "total": "integer",    
  "model": {
    "identifier": "string",
    "version": "string",
    "name": "string"
  },
  "job_inputs": ["string"],
  "user": {
    "identifier": "string",
    "external_identifier": "string",
    "email": "string",
    "firstName": "string",      
    "lastName": "string",
    "status": "string",
    "title": "string"
    "access_keys": [
    	{
    		"prefix": "string",
        "is_default": "boolean"
  		}
    ]                        
  }
}

Examples

>>>job = client.jobs.get('14856eb1-0ad8-49e7-9da3-887acb80fea5')
>>>job.status
'SUBMITTED'

You can also refresh a Job or Result object

>>>job.identifier
'14856eb1-0ad8-49e7-9da3-887acb80fea5'
>>>job = client.jobs.get(job)
>>>job.status
'SUBMITTED'

Also, you can refresh the job information by using the job.sync method

>>>job.identifier
'14856eb1-0ad8-49e7-9da3-887acb80fea5'
>>>job.sync()
>>>job.status
'SUBMITTED'