-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathfieldService.json
More file actions
5955 lines (5955 loc) · 211 KB
/
fieldService.json
File metadata and controls
5955 lines (5955 loc) · 211 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"nodes": [
{
"position": {
"x": -1107.6787066530733,
"y": -150.93211511598344
},
"id": "filter",
"type": "input",
"data": {
"label": "",
"schema": {
"properties": {
"filter": {
"title": "Filter",
"type": "string"
},
"onlyRef": {
"title": "Reference only",
"type": "boolean",
"default": true
},
"onlyCustom": {
"title": "Custom only",
"type": "boolean",
"default": false
},
"showLabel": {
"title": "Show Label",
"type": "boolean",
"default": true
},
"showData": {
"title": "Show Data",
"type": "boolean",
"default": false
},
"showChildRelation": {
"title": "Child Relations",
"type": "boolean",
"default": false
},
"nbFields": {
"title": "Nb Fields",
"type": "integer",
"default": 20
}
}
}
},
"width": 250,
"height": 308
},
{
"id": "ServiceCrew",
"data": {
"Id": "EntityDefinition/ServiceCrew",
"table": {
"name": "ServiceCrew"
},
"schema": {
"type": "object",
"description": "[Field Service Lightning Config] ",
"properties": {
"Id": {
"type": "string",
"title": "Service Crew ID",
"readOnly": true,
"description": "Globally unique string that identifies a record."
},
"Name": {
"type": "string",
"title": "Name",
"description": ""
},
"CurrencyIsoCode": {
"type": "string",
"title": "Currency ISO Code",
"enum": [
"USD",
null
],
"enumNames": [
"U.S. Dollar",
null
],
"description": ""
},
"LastModifiedDate": {
"type": "string",
"title": "Last Modified Date",
"format": "date-time",
"readOnly": true,
"description": "Date and time when a user last modified this record."
},
"CrewSize": {
"type": "integer",
"title": "Crew Size",
"description": ""
},
"FSL__GanttColor__c": {
"type": "string",
"title": "Gantt Color",
"description": ""
},
"External_Id__c": {
"type": "string",
"title": "External Id",
"description": ""
}
}
},
"label": "Service Crew",
"icon": "standard:service_crew",
"description": "[Field Service Lightning Config] ",
"color": "#95A5A6",
"category": "Field Service Lightning Config"
},
"type": "table",
"position": {
"x": 476.7099875700268,
"y": -126.3139065025054
}
},
{
"id": "EntityDefinition/AssignedResource",
"type": "table",
"position": {
"x": 1210.3438347420945,
"y": -274.1605830744025
},
"data": {
"Id": "EntityDefinition/AssignedResource",
"schema": {
"type": "object",
"description": "[Core] Represents a service resource who is assigned to a service appointment in Field Service and Lightning Scheduler. Assigned resources appear in the Assigned Resources related list on service appointments.",
"properties": {
"Id": {
"type": "string",
"title": "Assigned Resource ID",
"readOnly": true,
"description": "Globally unique string that identifies a record."
},
"AssignedResourceNumber": {
"type": "string",
"title": "Assigned Resource Number",
"readOnly": true,
"description": ""
},
"LastModifiedDate": {
"type": "string",
"title": "Last Modified Date",
"format": "date-time",
"readOnly": true,
"description": "Date and time when a user last modified this record."
},
"ServiceAppointmentId": {
"type": "string",
"title": "Service Appointment ID",
"x-target": "ServiceAppointment",
"readOnly": true,
"description": ""
},
"ServiceResourceId": {
"type": "string",
"title": "Service Resource ID",
"x-target": "ServiceResource",
"description": ""
},
"EstimatedTravelTime": {
"type": "number",
"title": "Estimated Travel Time (Minutes)",
"description": "The estimated number of minutes needed for the service resource to travel to the service appointment they’re assigned to. You can enter a value with up to two decimal places."
},
"ActualTravelTime": {
"type": "number",
"title": "Actual Travel Time (Minutes)",
"description": "The number of minutes that the service resource needs to travel to the assigned service appointment. You can enter a value with up to two decimal places."
},
"ServiceCrewId": {
"type": "string",
"title": "Service Crew ID",
"x-target": "ServiceCrew",
"description": ""
},
"IsRequiredResource": {
"type": "boolean",
"title": "Required Resource",
"description": ""
},
"Role": {
"type": "string",
"title": "Role",
"enum": [
null
],
"enumNames": [
null
],
"description": ""
},
"EventId": {
"type": "string",
"title": "Activity ID",
"x-target": "Event",
"readOnly": true,
"description": ""
},
"IsPrimaryResource": {
"type": "boolean",
"title": "Primary Resource",
"description": "Indicates whether the service resource is a primary resource or not. The default value is false. Available in API version 47.0 and later."
},
"LocationStatus": {
"type": "string",
"title": "Location Status",
"enum": [
"EnRoute",
"LastMile",
null
],
"enumNames": [
"En Route",
"Last Mile",
null
],
"description": "The status of the mobile worker approaching the service appointment. When the location status changes to one of these values, a status update containing ApptAssistantInfoUrl is sent to the customer. Available in version 51.0 and later."
},
"ApptAssistantInfoUrl": {
"type": "string",
"title": "Appointment Assistant Info Url",
"description": "The URL that contains the status of the mobile worker approaching the service appointment, the Community URL, and the expiry of the URL. Available in version 51.0 and later."
},
"Transaction": {
"type": "string",
"title": "Transaction",
"description": ""
},
"TravelTimeBuffer": {
"type": "integer",
"title": "Travel Time Buffer (in minutes)",
"description": ""
},
"FSL__EstimatedTravelDistanceFrom__c": {
"type": "number",
"title": "Approximate Travel Distance From",
"description": ""
},
"FSL__EstimatedTravelDistanceTo__c": {
"type": "number",
"title": "Approximate Travel Distance To",
"description": ""
},
"FSL__EstimatedTravelTimeFrom__c": {
"type": "number",
"title": "Approximate Travel Time From (Minutes)",
"description": ""
},
"FSL__Estimated_Travel_Time_From_Source__c": {
"type": "string",
"title": "Estimated Travel Time From Source",
"enum": [
"None",
"Aerial",
"SLR",
"Predictive",
null
],
"enumNames": [
"None",
"Aerial",
"SLR",
"Predictive",
null
],
"description": ""
},
"FSL__Estimated_Travel_Time_To_Source__c": {
"type": "string",
"title": "Estimated Travel Time To Source",
"enum": [
"None",
"Aerial",
"SLR",
"Predictive",
null
],
"enumNames": [
"None",
"Aerial",
"SLR",
"Predictive",
null
],
"description": ""
},
"FSL__Last_Updated_Epoch__c": {
"type": "number",
"title": "Last Updated Epoch",
"description": ""
},
"FSL__UpdatedByOptimization__c": {
"type": "boolean",
"title": "UpdatedByOptimization",
"description": ""
},
"FSL__calculated_duration__c": {
"type": "number",
"title": "calculated duration (Minutes)",
"description": ""
},
"External_ID__c": {
"type": "string",
"title": "External ID",
"description": ""
},
"Customer_Name__c": {
"type": "string",
"title": "Customer Name",
"readOnly": true,
"description": ""
}
}
},
"description": "[Core] Represents a service resource who is assigned to a service appointment in Field Service and Lightning Scheduler. Assigned resources appear in the Assigned Resources related list on service appointments.",
"icon": "utility:standard_objects",
"label": "Assigned Resource",
"color": "#0070D2",
"category": "Core"
}
},
{
"id": "EntityDefinition/ServiceResource",
"type": "table",
"position": {
"x": 864.5216447143089,
"y": 226.37744616767006
},
"data": {
"Id": "EntityDefinition/ServiceResource",
"schema": {
"type": "object",
"description": "[Field Service Lightning] Represents a service technician or service crew in Field Service and Salesforce Scheduler, or an agent in Workforce Engagement.",
"properties": {
"Id": {
"type": "string",
"title": "Resource ID",
"readOnly": true,
"description": "Globally unique string that identifies a record."
},
"Name": {
"type": "string",
"title": "Name",
"description": "The resource’s name, for example the name or title of the associated user or service crew."
},
"CurrencyIsoCode": {
"type": "string",
"title": "Currency ISO Code",
"enum": [
"USD",
null
],
"enumNames": [
"U.S. Dollar",
null
],
"description": ""
},
"LastModifiedDate": {
"type": "string",
"title": "Last Modified Date",
"format": "date-time",
"readOnly": true,
"description": "Date and time when a user last modified this record."
},
"RelatedRecordId": {
"type": "string",
"title": "User ID",
"x-target": "User",
"description": ""
},
"ResourceType": {
"type": "string",
"title": "Resource Type",
"enum": [
"T",
"D",
"C",
"A",
"S",
"P",
null
],
"enumNames": [
"Technician",
"Dispatcher",
"Crew",
"Agent",
"Asset",
"Planner",
null
],
"description": "Indicates whether the resource is a Technician (T), Dispatcher (D), Crew (C), Asset (S), Agent (A), or Planner (P). The default value is Technician (T). Resources who are dispatchers can’t be capacity-based or included in scheduling optimization. Only users with the Field Service Dispatcher permission-set license can be dispatchers. You can’t add additional resource types. To create a dependent lookup filter with ServiceResource.ResourceType, use only the first letter of the picklist value, for example T for Technician."
},
"Description": {
"type": "string",
"title": "Description",
"description": "The description of the resource."
},
"IsActive": {
"type": "boolean",
"title": "Active",
"description": "When selected, this option means that the resource can be assigned to work orders. For service tracking purposes, resources can’t be deleted, so deactivating a resource is the best way to send them into retirement.Deactivating a user doesn’t deactivate the related service resource. You can’t create a service resource that is linked to an inactive user."
},
"IsCapacityBased": {
"type": "boolean",
"title": "Capacity-Based",
"description": "Capacity-based resources are limited to a certain number of hours or appointments in a specified time period. Tip The Capacities related list shows a resource’s capacity."
},
"IsOptimizationCapable": {
"type": "boolean",
"title": "Include in Scheduling Optimization",
"description": "This field is reserved for Field Service and the managed package. Create a custom field instead of using this field to include a service resource in optimization."
},
"LastKnownLatitude": {
"type": "number",
"title": "Last Known Latitude",
"description": "The service resource’s last known location. You can configure this field to display data collected from a custom mobile app. This field isn’t visible in the user interface, but you can expose it on service resource page layouts or set up field tracking to be able to view a resource’s location history."
},
"LastKnownLongitude": {
"type": "number",
"title": "Last Known Longitude",
"description": "The service resource’s last known location. You can configure this field to display data collected from a custom mobile app. This field isn’t visible in the user interface, but you can expose it on service resource page layouts or set up field tracking to be able to view a resource’s location history."
},
"LastKnownLocation": {
"type": "string",
"title": "Last Known Location",
"readOnly": true,
"description": "The service resource’s last known location. You can configure this field to display data collected from a custom mobile app. This field isn’t visible in the user interface, but you can expose it on service resource page layouts or set up field tracking to be able to view a resource’s location history."
},
"LastKnownLocationDate": {
"type": "string",
"title": "Last Known Location Date",
"format": "date-time",
"description": "The date and time of the last known location."
},
"LocationId": {
"type": "string",
"title": "Location ID",
"x-target": "Location",
"description": ""
},
"ServiceCrewId": {
"type": "string",
"title": "Service Crew ID",
"x-target": "ServiceCrew",
"description": ""
},
"AccountId": {
"type": "string",
"title": "Account ID",
"x-target": "Account",
"description": ""
},
"AssetId": {
"type": "string",
"title": "Asset ID",
"x-target": "Asset",
"description": ""
},
"SchedulingConstraintId": {
"type": "string",
"title": "Constraint ID",
"x-target": "SchedulingConstraint",
"description": ""
},
"IsPrimary": {
"type": "boolean",
"title": "Main",
"description": ""
},
"PayGradeId": {
"type": "string",
"title": "Pay Grade ID",
"x-target": "PayGrade",
"description": ""
},
"FSL__Efficiency__c": {
"type": "number",
"title": "Efficiency",
"description": ""
},
"FSL__GanttLabel__c": {
"type": "string",
"title": "Gantt Label",
"description": ""
},
"FSL__Online_Offset__c": {
"type": "number",
"title": "Online Offset",
"description": ""
},
"FSL__Picture_Link__c": {
"type": "string",
"title": "Picture Link",
"description": ""
},
"FSL__Priority__c": {
"type": "number",
"title": "Priority",
"description": ""
},
"FSL__Travel_Speed__c": {
"type": "number",
"title": "Travel Speed",
"description": ""
},
"External_ID__c": {
"type": "string",
"title": "External ID",
"description": ""
},
"Contractor_s_Service_Territory__c": {
"type": "string",
"title": "Contractor's Service Territory",
"x-target": "ServiceTerritory",
"description": ""
},
"Cost_Per_Mile__c": {
"type": "number",
"title": "Cost Per Mile",
"description": ""
},
"En_Route_Location__Latitude__s": {
"type": "number",
"title": "En Route Location (Latitude)",
"description": ""
},
"En_Route_Location__Longitude__s": {
"type": "number",
"title": "En Route Location (Longitude)",
"description": ""
},
"En_Route_Location__c": {
"type": "string",
"title": "En Route Location",
"readOnly": true,
"description": ""
},
"Gantt_Color__c": {
"type": "string",
"title": "Gantt Color",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"None",
null
],
"enumNames": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"None",
null
],
"description": ""
},
"Is_Contractor__c": {
"type": "boolean",
"title": "Is Contractor",
"description": ""
},
"Last_Mile_Location__Latitude__s": {
"type": "number",
"title": "Last Mile Location (Latitude)",
"description": ""
},
"Last_Mile_Location__Longitude__s": {
"type": "number",
"title": "Last Mile Location (Longitude)",
"description": ""
},
"Last_Mile_Location__c": {
"type": "string",
"title": "Last Mile Location",
"readOnly": true,
"description": ""
},
"Number_of_Jobs_Optimized__c": {
"type": "number",
"title": "Number of Jobs Optimized",
"description": ""
},
"Number_of_Jobs_Scheduled__c": {
"type": "number",
"title": "Number of Jobs Scheduled",
"description": ""
},
"Opt_KPI_Reset__c": {
"type": "boolean",
"title": "Opt KPI Reset",
"description": ""
},
"Optimization_KPI__c": {
"type": "boolean",
"title": "Optimization KPI",
"description": ""
},
"Original_Travel_Time__c": {
"type": "number",
"title": "Original Travel Time",
"description": ""
},
"Role__c": {
"type": "string",
"title": "Role",
"description": ""
},
"Updated_Travel_Time__c": {
"type": "number",
"title": "Updated Travel Time",
"description": ""
},
"User_Type__c": {
"type": "string",
"title": "User Type",
"enum": [
"Field Service Lightning (FSL)",
"Lightning Scheduler (LS)",
"Service Cloud",
"Workforce Engagement",
null
],
"enumNames": [
"Salesforce Field Service (SFS)",
"Lightning Scheduler (LS)",
"Service Cloud",
"Workforce Engagement",
null
],
"description": ""
},
"Additional_Job_Revenue__c": {
"type": "number",
"title": "Additional Job Revenue",
"readOnly": true,
"description": ""
},
"Additional_Jobs_Scheduled__c": {
"type": "number",
"title": "Additional Jobs Scheduled",
"readOnly": true,
"description": ""
},
"Optimization_Revenue__c": {
"type": "number",
"title": "Optimization Revenue",
"readOnly": true,
"description": ""
},
"Travel_Delta__c": {
"type": "number",
"title": "Travel Delta",
"readOnly": true,
"description": ""
},
"Travel_Savings__c": {
"type": "number",
"title": "Travel Savings",
"readOnly": true,
"description": ""
},
"SDO_SFS_Tracker_Contact__c": {
"type": "string",
"title": "Tracker Contact",
"x-target": "Contact",
"description": ""
}
}
},
"description": "[Field Service Lightning] Represents a service technician or service crew in Field Service and Salesforce Scheduler, or an agent in Workforce Engagement.",
"icon": "standard:service_crew_member",
"label": "Service Resource",
"color": "#3498DB",
"category": "Field Service Lightning"
}
},
{
"id": "EntityDefinition/ServiceAppointment",
"type": "table",
"position": {
"x": 287.19738353021074,
"y": -618.9262129433396
},
"data": {
"Id": "EntityDefinition/ServiceAppointment",
"schema": {
"type": "object",
"description": "[Field Service Lightning] Represents an appointment to complete work for a customer in Field Service, Lightning Scheduler,Intelligent Appointment Management, and Virtual Care.",
"properties": {
"Id": {
"type": "string",
"title": "Service Appointment ID",
"readOnly": true,
"description": "Globally unique string that identifies a record."
},
"AppointmentNumber": {
"type": "string",
"title": "Appointment Number",
"readOnly": true,
"description": ""
},
"CurrencyIsoCode": {
"type": "string",
"title": "Currency ISO Code",
"enum": [
"USD",
null
],
"enumNames": [
"U.S. Dollar",
null
],
"description": ""
},
"LastModifiedDate": {
"type": "string",
"title": "Last Modified Date",
"format": "date-time",
"readOnly": true,
"description": "Date and time when a user last modified this record."
},
"ParentRecordId": {
"type": "string",
"title": "Parent Record ID",
"x-target": "Account",
"readOnly": true,
"description": ""
},
"ParentRecordType": {
"type": "string",
"title": "Parent Record Type",
"readOnly": true,
"description": "(Read only) The type of parent record: Account, Asset, Lead, Opportunity, Work Order, or Work Order Line Item."
},
"AccountId": {
"type": "string",
"title": "Account ID",
"x-target": "Account",
"readOnly": true,
"description": ""
},
"WorkTypeId": {
"type": "string",
"title": "Work Type ID",
"x-target": "WorkType",
"description": ""
},
"ContactId": {
"type": "string",
"title": "Contact ID",
"x-target": "Contact",
"description": ""
},
"Street": {
"type": "string",
"title": "Street",
"description": "The address where the appointment is taking place. The address is inherited from the parent record if the parent record is a work order or work order line item."
},
"City": {
"type": "string",
"title": "City",
"description": "The address where the appointment is taking place. The address is inherited from the parent record if the parent record is a work order or work order line item."
},
"State": {
"type": "string",
"title": "State/Province",
"description": "The address where the appointment is taking place. The address is inherited from the parent record if the parent record is a work order or work order line item."
},
"PostalCode": {
"type": "string",
"title": "Zip/Postal Code",
"description": "The address where the appointment is taking place. The address is inherited from the parent record if the parent record is a work order or work order line item."
},
"Country": {
"type": "string",
"title": "Country",
"description": "The address where the appointment is taking place. The address is inherited from the parent record if the parent record is a work order or work order line item."
},
"Latitude": {
"type": "number",
"title": "Latitude",
"description": "The address where the appointment is taking place. The address is inherited from the parent record if the parent record is a work order or work order line item."
},
"Longitude": {
"type": "number",
"title": "Longitude",
"description": "The address where the appointment is taking place. The address is inherited from the parent record if the parent record is a work order or work order line item."
},
"GeocodeAccuracy": {
"type": "string",
"title": "Geocode Accuracy",
"enum": [
"Address",
"NearAddress",
"Block",
"Street",
"ExtendedZip",
"Zip",
"Neighborhood",
"City",
"County",
"State",
"Unknown",
null
],
"enumNames": [
"Address",
"Near Address",
"Block",
"Street",
"Extended Zip",
"Zip",
"Neighborhood",
"City",
"County",
"State",
"Unknown",
null
],
"description": "The address where the appointment is taking place. The address is inherited from the parent record if the parent record is a work order or work order line item."
},
"Address": {
"type": "string",
"title": "Address",
"readOnly": true,
"description": "The address where the appointment is taking place. The address is inherited from the parent record if the parent record is a work order or work order line item."
},
"Description": {
"type": "string",
"title": "Description",
"description": "The description of the appointment."
},
"EarliestStartTime": {
"type": "string",
"title": "Earliest Start Permitted",
"format": "date-time",
"description": "The date after which the appointment must be completed. Earliest Start Permitted and Due Date typically reflect terms in the customer’s service-level agreement."
},
"DueDate": {
"type": "string",
"title": "Due Date",
"format": "date-time",
"description": "The date by which the appointment must be completed. Earliest Start Permitted and Due Date typically reflect terms in the customer’s service-level agreement."
},
"Duration": {
"type": "number",
"title": "Duration",
"description": "The estimated length of the appointment. If the parent record is work order or work order line item, the appointment inherits its parent’s duration, but it can be manually updated. The duration is in minutes or hours based on the value selected in the Duration Type field."
},
"ArrivalWindowStartTime": {
"type": "string",
"title": "Arrival Window Start",
"format": "date-time",
"description": "The beginning of the window of time in which the technician is scheduled to arrive at the site. This window is typically larger than the Scheduled Start and End window to allow time for delays and scheduling changes. You may choose to share the Arrival Window Start and End with the customer, but keep the Scheduled Start and End internal-only."
},
"ArrivalWindowEndTime": {
"type": "string",
"title": "Arrival Window End",
"format": "date-time",
"description": "The end of the window of time in which the technician is scheduled to arrive at the site. This window is typically larger than the Scheduled Start and End window to allow time for delays and scheduling changes. You may choose to share the Arrival Window Start and End with the customer, but keep the Scheduled Start and End internal-only."
},
"Status": {
"type": "string",
"title": "Status",
"enum": [
"None",
"Scheduled",
"Dispatched",
"Travel",
"In Progress",
"Cannot Complete",
"Completed",
"Canceled",
"Approaching",
null
],
"enumNames": [
"None",
"Scheduled",
"Dispatched",
"Travel",
"In Progress",
"Cannot Complete",
"Completed",
"Canceled",
"Approaching",
null
],
"description": "The status of the appointment. The picklist includes the following values, which can be customized: None—Default value. Scheduled—Appointment has been assigned to a service resource. Dispatched—Assigned service resource has been notified about their assignment. In Progress—Work has begun. Completed—Work is complete. Cannot Complete—Work could not be completed. Canceled—Work is canceled, typically before any work began"
},
"SchedStartTime": {
"type": "string",
"title": "Scheduled Start",
"format": "date-time",
"description": "The time at which the appointment is scheduled to start. If you are using the Field Service managed package with the scheduling optimizer, this field is populated once the appointment is assigned to a resource."
},
"SchedEndTime": {
"type": "string",
"title": "Scheduled End",
"format": "date-time",
"description": "The time at which the appointment is scheduled to end. If you are using the Field Service managed package with the scheduling optimizer, this field is populated once the appointment is assigned to a resource. Scheduled End – Scheduled Start = Estimated Duration."
},
"ActualStartTime": {
"type": "string",
"title": "Actual Start",
"format": "date-time",
"description": "The actual date and time the appointment started."
},
"ActualEndTime": {
"type": "string",
"title": "Actual End",
"format": "date-time",
"description": "The actual date and time the appointment ended."
},
"ActualDuration": {
"type": "number",
"title": "Actual Duration (Minutes)",
"description": "The number of minutes that it took the resource to complete the appointment after arriving at the address. When values are first added to the Actual Start and Actual End fields, the Actual Duration is automatically populated to list the difference between the Actual Start and Actual End. If the Actual Start and Actual End fields are subsequently updated, the Actual Duration field doesn’t re-update, but you can manually update it."
},
"DurationType": {
"type": "string",
"title": "Duration Type",
"enum": [
"Hours",
"Minutes",
null
],
"enumNames": [
"Hours",
"Minutes",
null
],
"description": "The unit of the Duration: Minutes or Hours."
},
"DurationInMinutes": {
"type": "number",
"title": "Duration in Minutes",
"readOnly": true,
"description": ""
},
"ServiceTerritoryId": {
"type": "string",
"title": "Territory ID",
"x-target": "ServiceTerritory",
"description": ""
},
"Subject": {
"type": "string",
"title": "Subject",
"description": "A short phrase describing the appointment."
},
"ParentRecordStatusCategory": {
"type": "string",
"title": "Parent Record Status Category",
"enum": [
"New",
"InProgress",
"OnHold",
"Completed",
"Closed",
"None",
"CannotComplete",
"Canceled",
null
],
"enumNames": [
"New",
"In Progress",
"On Hold",
"Completed",