Skip to main content

Get a List of Jobs

Retrieving jobs.

Query String Parameters

NameTypeDescriptionRequired
ActionStringJobsRequired
StartDateJobs data from. Format: yyyy-MM-dd HH:mm:ss.Required
EndDateJobs data to. Format: yyyy-MM-dd HH:mm:ss.Required
MyJobsBoolReturn only jobs for the current logged in user. Use 1 for true, 0 for false. Defaults to false.Optional
UnallocatedBoolReturn unallocated jobs in the results. Default = true.Optional
CompletedBoolReturn completed jobs in the results Default = true.Optional
OnlyCancelledBoolIf set, service will only return cancelled jobs. Default = false.Optional
StatusDateDateMinimum date of jobs current status. Can be used to retrieve only jobs that have changed status since the date supplied. Must be in format: yyyy-MM-dd HH:mm:ss.Optional
UseCreatedDateBoolWhen true, the creation date is used for the date filtering. When false, or not specified the job start/end date is used. Default = falseOptional
IncludeAssistantsBoolInclude assistant detail for the Job. Default is false.Optional
IncludeCustomFieldsBoolInclude custom fields for the Job. Default is false.Optional

note
  • RealStart, RealEnd, RealDuration, PrIntName, CustNote and ResNote are only returned if a job is completed

Response Codes

CodeMessageInformation
2start and end parameters expected

Example

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=jobs