This function prepares Job data for export.
There are two stages to the process. In the first stage, the required parameter _ids is passed with a value of 1, along with optional parameters (see below) representing search constraints. This returns a list of IDs of matching items. In the second stage, the client machine retrieves data for items by sending the fields parameter to say what fields are needed, and an _ids parameter to say which items to read. The client machine should make multiple requests such that the _ids array contains at most 100 IDs at a time, to avoid timeouts or closed connections caused by too-high resource usage on the server.
Required Parameters
_ids (required)
Either 1 or an array of ids representing the jobs for which the export data will be retrieved.
fields(required)
Array. The names of the fields for which export data is required. (See list of accepted fields below).
Note: arrays should be JSON encoded.
Optional Parameters
Used to apply constraints to the query.
integer
text. all or part of the job customer/asset name
integer. used to indicate date range.
integer. used to indicate date range.
integer
integer
text
integer > 0 to return jobs where an invoice has been sent to the customer.
text
array
integer
integer. value of 1 to return only jobs that have synced to the user device.
text. value should be "overdue" to return jobs where is_complete=0 and due_date is prior to today.
integer. id of parent customer where job is for a customer (not an asset)
integer.
integer > 0 to return jobs where a report has been sent to the customer.
integer. job status, aka is_complete
integer
Accepted Fields
The following values can be used in the fields array (required parameter):
integer. job id
text. email address(es) of job attendees
datetime of the job
integer. datetime of the job in epoch time
integer
integer. user id.
current_user_id
integer
integer
integer. customer type id
datetime of the job completion (predicted or actual)
date_completed_e
integer. dateime of job completion in epoch time
datetime when job was first marked "in progress"
integer. epoch time.
integer. deletion date in epoch time.
integer. deletion status. value of 1 if job has been deleted
integer
date
integer. job due_date in epoch time.
text
text
integer. id of job form.
integer
integer. id of form type. default 0 for job forms.
json
float
float
integer. job id.
integer. job status.
varchar
datetime
integer.
text
datetime of job
integer. job datetime in epoch time.
meeting_time_flexible
integer. value of 1 if job time is marked flexible.
text
float
float
text
integer. indicates whether job has synced to user device
float
decimal (13,4)
integer. job priority id.
schedule_of_rates
text
float
text
text
text
integer. job type id
integer
integer
integer. value of 1 if job has been outsourced to another company
integer
The results will include the job id and is_complete status of each job, followed by the values for the fields requested, in the sequence requested.
