Input fields

alignRequestStatusWithAppointment : Boolean default: True

When true, automatically updates the request status to match its appointments. Defaults to true.
appointmentStatus : OnSiteJobsAppointmentStatus! required

The current status of the appointment.
assets : [OnSiteJobsAssetInput!]

List of assets associated with the appointment.
cancellationCategory : OnSiteJobsAppointmentCancellationCategory

The cancellation reason for this appointment.
comments : String

Appointment related comments.
commsStrategy : OnSiteJobsCommsStrategy! required

The comms strategy.
endAt : DateTime

The end date/time of this appointment.
externalReference : String! required

The external reference provided by the vendor/contractor for the appointment.
jobDetails : OnSiteJobsAppointmentJobDetailsInput! required

Appointment job details.
jobNotes : JSONString

The job notes.
jobType : NonEmptyString! required

The type of job this appointment is for.
requestId : UUID! required

The UUID of the On-Site Jobs request appointment is for.
resolutionReasonCode : String

The resolution reason code for the appointment status.
runActionsBasedOnStatus : Boolean default: True

Whether to run the side-effect action based on the new appointment status. Only applicable if a value was provided in the status field. Defaults to true.
startAt : DateTime! required

The start date/time of this appointment.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "alignRequestStatusWithAppointment": true, "appointmentStatus": "PENDING_KRAKEN_TIMESLOT_SELECTION", "assets": OnSiteJobsAssetInput, "cancellationCategory": "CANCELLED_BY_CUSTOMER___COMPLAINT", "comments": "protect-month-central-body-trouble", "commsStrategy": "SEND_ALL", "endAt": "1990-02-19T22:41:28.620903+00:00", "externalReference": "challenge-I-less-TV-source", "jobDetails": OnSiteJobsAppointmentJobDetailsInput, "jobNotes": {"key": "value"}, "jobType": "serve-wonder-lay-argue-light", "requestId": "6ce5a1a0-0fe1-423f-b418-4c701850382c", "resolutionReasonCode": "identify-inside-it-threat-no", "runActionsBasedOnStatus": true, "startAt": "1999-09-30T19:46:53.973167+00:00" }