Job API Object
Property | Type | R/W | Description |
---|---|---|---|
id | TEXT | R | Job unique ID |
uidSecondary | TEXT | RW | Secondary unique identifier (custom external ID) |
type | INT | RW | Job Type: 0=Work , 1=Pickup , 2=Dropoff |
teamId | INT | RW | Team Id 0-n (the number of the team). Defaults to 0 (no specific team). |
destinationName | TEXT | RW | Title of this job (1-line description) |
destinationLat | DOUBLE | RW | Latitude |
destinationLng | DOUBLE | RW | Longitude |
destinationText | TEXT | RW | Location Address |
destinationUrl | TEXT | R | Location map URL |
textDispatcher | TEXT | RW | Dispatcher additional info text (multi-line). Can also use notes field. |
notes | TEXT | RW | Alias for textDispatcher - dispatcher notes/instructions |
textReceiver | TEXT | RW | Worker’s reply text |
contactName | TEXT | RW | Name of contact at job’s location |
contactPhone | TEXT | RW | Phone number of contact at job’s location |
contactEmail | TEXT | RW | Email of contact at job’s location |
fileNumber | TEXT | RW | File number or reference code |
day | INT | RW | Date for job as YYYYMMDD or 0 (e.g. 20150530) |
priority | INT | RW | Priority min:0-max:10 |
number | INT | RW | Sequence number for ordering |
onSiteSeconds | INT | RW | The assumed onsite-time in seconds (e.g. 10min on site: 600) |
windowStart | INT | RW | Format: HHMM or 0 (e.g 704 = 7:04am) |
windowEnd | INT | RW | Format: HHMM or 0 (e.g 1724 = 5:24pm) |
orderId | LONG | RW | Optional Order ID as a long integer number |
dispatcherUid | TEXT | RW | UID of dispatcher account |
dispatcherName | TEXT | R | Name of Dispatcher |
dispatcherUrl | TEXT | R | URL for dispatcher icon image |
placeUid | TEXT | RW | UID of place to visit or "" |
placeName | TEXT | R | Name of place/location |
placeUrl | TEXT | R | URL for place icon image |
radius | INT | R | Radius for check-in/out in meter (place-radius or default-radius) |
worker | TEXT | RW | User name of assigned worker |
receiverUid | TEXT | RW | UID of assigned worker (alternative to worker ) |
workerName | TEXT | R | Full name of assigned worker |
workerEmail | TEXT | R | Email address of assigned worker |
workerPhone | TEXT | R | Phone number of assigned worker |
assigneeName | TEXT | R | Legacy alias for workerName (deprecated, use workerName ) |
assigneeUsername | TEXT | R | Legacy alias for worker (deprecated, use worker ) |
itemsToDropoff | INT | RW | Number of items to drop off |
itemsToPickup | INT | RW | Number of items to pick up |
carryOver | INT | RW | Days left to carry over (use 1 for default carry-over days) |
labels | TEXT | RW | Comma-separated labels for categorization |
zipcode | INT | RW | Zip/postal code for the job location |
status | TEXT | R | Set to archived if job is archived, omitted otherwise |
Job Status attributes (progress)
The job status attributes hold the timestamp when an event has occurred or0
if it does not apply.
Note: Timestamps are milliseconds, between the current time and midnight, January 1, 1970 UTC (Java timestamps)
E.g.: 1430580377000
= Sat, 02 May 2015 15:26:17 GMT
Property | Type | R/W | Description |
---|---|---|---|
tsCreated | LONG | RW | Timestamp in millis for job creation |
tsSaved | LONG | R | Timestamp in millis when job was last saved |
tsAssigned | LONG | R | Timestamp in millis for job assigned to worker |
tsAccepted | LONG | RW | Timestamp in millis for job accepted by worker |
tsRejected | LONG | RW | Timestamp in millis for job rejected by worker |
tsScheduled | LONG | RW | Timestamp in millis for job scheduled |
tsDoneSuccess | LONG | RW | Timestamp in millis for job marked as success by worker |
tsDoneFailed | LONG | RW | Timestamp in millis for job marked as issue by worker |
tsCheckIn | LONG | RW | Timestamp in millis for auto check-in by worker |
tsCheckOut | LONG | RW | Timestamp in millis for auto check-out by worker |
tsCheckNFC1 | LONG | R | Timestamp in millis for first check with NFC |
tsCheckNFC2 | LONG | R | Timestamp in millis for second check with NFC |
tsTripStarted | LONG | R | Timestamp in millis when trip to job location started |
tsSignature | LONG | RW | Timestamp in millis when signature was captured |
Scheduling & Windows:
Property | Type | R/W | Description |
---|---|---|---|
scheduledStart | INT | R | Scheduled start time calculated by route optimizer |
scheduledEnd | INT | R | Scheduled end time calculated by route optimizer |
Signature & Digital Forms:
Property | Type | R/W | Description |
---|---|---|---|
signatureName | TEXT | RW | Name of person who signed |
signatureSvg | TEXT | RW | SVG data for signature (clears signaturePdf) |
signaturePdf | TEXT | RW | PDF data for signature (clears signatureSvg) |
keymap | TEXT | RW | Key mapping configuration |
manualChecks | TEXT | RW | Manual check data |
linkedZones | TEXT | RW | Linked zone IDs |
linkedForms | TEXT | RW | Linked form IDs |
submittedForms | TEXT | R | Submitted form data (read-only) |
inputFormConfig | TEXT | RW | Input form configuration |
formConfig | TEXT | R | Complete form configuration (compact mode only) |
confirmationEmails | TEXT | RW | Confirmation email addresses |
comments | TEXT | RW | Job comments data |
associatedJobId | TEXT | RW | Associated job identifier |
requiredSkills | TEXT | RW | Required skills for this job |
requiredEquipment | TEXT | RW | Required equipment for this job |
History & Tracking:
Property | Type | R/W | Description |
---|---|---|---|
createdBy | TEXT | R | UID of user who created this job |
createdVia | TEXT | R | Source of job creation (web, mobile, api) |
assigneeHistory | TEXT | R | History of worker assignments |
progressStatusHistory | TEXT | R | History of status changes |
tripId | TEXT | R | Associated trip identifier |
Template & Sequence Metadata:
Property | Type | R/W | Description |
---|---|---|---|
isTemplate | BOOLEAN | R | True if this is a job template |
isPartOfSequence | BOOLEAN | R | True if job belongs to a sequence |
sequenceId | TEXT | R | ID of the sequence this job belongs to |
jobType | TEXT | R | Human-readable job type name |
Customizable Attributes:
Property | Type | R/W | Description |
---|---|---|---|
custom_$ | TEXT | RW | Custom field where $ is the desired field name |
customFields | ARRAY | RW | Array of custom field key-value pairs |
extra_number_$_key | TEXT | R | Worker input number field label where $ is 1-10 |
extra_number_$_val | INT | RW | Worker input number value where $ is 1-10 |
extra_text_$_key | TEXT | R | Worker input text field label where $ is 1-20 |
extra_text_$_val | TEXT | RW | Worker input text value where $ is 1-20 |
extra_number_types | TEXT | R | JSON metadata describing number field types |
extra_text_types | TEXT | R | JSON metadata describing text field types |
url_$ | TEXT | RW | URL field where $ is 1-n (multiple URLs supported) |
- Field labels (extra_number__key, extra_text__key) are read-only and configured via
inputFormConfig
- If a field name starts with
*
, it indicates a required field - Types metadata contains JSON like
{"2":"bool","4":"decimal"}
to specify special input types - Supported types:
bool
(checkbox),decimal
,number
(default),text
(default)