mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-08 00:10:29 +08:00
185 lines
10 KiB
JSON
185 lines
10 KiB
JSON
{
|
||
"sections": [
|
||
"title",
|
||
"description",
|
||
"fields",
|
||
"usage",
|
||
"associated_objects",
|
||
"wsdl_segment",
|
||
"field_reference"
|
||
],
|
||
"title": "TimeSlot - Data API",
|
||
"description": "Represents a period of time on a specified day of the week during which work can be performed in Field Service, Salesforce Scheduler, or Workforce Engagement. Operating hours consist of one or more time slots. This object is available in API version 38.0 and later.",
|
||
"fields_columns": [
|
||
"type",
|
||
"properties",
|
||
"description",
|
||
"relationship_name",
|
||
"relationship_type",
|
||
"refers_to"
|
||
],
|
||
"fields": {
|
||
"DayOfWeek": {
|
||
"type": "picklist",
|
||
"properties": "Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update",
|
||
"description": "The day of the week when the time slot takes place."
|
||
},
|
||
"EndTime": {
|
||
"type": "time",
|
||
"properties": "Create, Filter, Sort, Update",
|
||
"description": "The time when the time slot ends."
|
||
},
|
||
"LastReferencedDate": {
|
||
"type": "dateTime",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "The timestamp for when the current user last viewed a record related to this record."
|
||
},
|
||
"LastViewedDate": {
|
||
"type": "dateTime",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed."
|
||
},
|
||
"MaxAppointments": {
|
||
"type": "int",
|
||
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "Maximum number of appointments for a single time slot. Available in API version 47.0 and later."
|
||
},
|
||
"OperatingHoursId": {
|
||
"type": "reference",
|
||
"properties": "Create, Filter, Group, Sort",
|
||
"description": "The operating hours that the time slot belongs to. An operating hours’ time slots appear in the Operating Hours related list. This is a relationship field.",
|
||
"relationship_name": "OperatingHours",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "OperatingHours"
|
||
},
|
||
"StartTime": {
|
||
"type": "time",
|
||
"properties": "Create, Filter, Sort, Update",
|
||
"description": "The time when the time slot starts."
|
||
},
|
||
"RecordSetFilterCriteriaId": {
|
||
"type": "reference",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "The ID of the recordset filter criteria selected for the time slot. This is a relationship field.",
|
||
"relationship_name": "RecordsetFilterCriteria",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "RecordsetFilterCriteria"
|
||
},
|
||
"TimeSlotNumber": {
|
||
"type": "string",
|
||
"properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
|
||
"description": "The name of the time slot. The name is auto-populated to a day and time format—for example, Monday 9:00 AM - 10:00 PM—but you can manually update it if you wish."
|
||
},
|
||
"Type": {
|
||
"type": "picklist",
|
||
"properties": "Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update",
|
||
"description": "The type of time slot. Possible values are Normal and Extended. You may choose to use Extended to represent overtime shifts."
|
||
},
|
||
"WorkTypeGroupId": {
|
||
"type": "reference",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "Work type group assigned to the time slot. Available in API version 47.0 and later. This is a relationship field.",
|
||
"relationship_name": "WorkTypeGroup",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "WorkTypeGroup"
|
||
}
|
||
},
|
||
"usage": "Operating hours are composed of time slots, which indicate the hours of operation for a particular day. After you create operating hours, create time slots for each day. For example, if the operating hours should be 8 AM to 5 PM Monday through Friday, create five time slots, one per day. To reflect breaks such as lunch hours, create multiple time slots in a day: for example, Monday 8:00 AM – 12:00 PM and Monday 1:00 PM – 5:00 PM.\n\nTime slots don’t come with any built-in rules, but you can create Apex triggers\n that limit time slot settings in your org. For example, you may want to restrict the start and\n end times on time slots to half-hour increments, or to prohibit end times later than 8\n PM.",
|
||
"associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **TimeSlotChangeEvent (API version 54.0)**: Change events are available for the object.\n- **TimeSlotHistory (API version 62.0)**: History is available for tracked fields of the object.",
|
||
"wsdl_segment": "```xml\n<simpleType name=\"ID\">\n <restriction base=\"xsd:string\">\n <length value=\"18\"/>\n <pattern value=\"[a-zA-Z0-9]{18}\"/>\n </restriction>\n</simpleType>\n<simpleType name=\"QueryLocator\">\n <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n <sequence>\n <element name=\"done\" type=\"xsd:boolean\"/>\n <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n <element name=\"size\" type=\"xsd:int\"/>\n </sequence>\n</complexType>\n<complexType name=\"TimeSlot\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"AppointmentTopicTimeSlots\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ApprovalSubmissions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ApprovalWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"DayOfWeek\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"EndTime\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:time\"/>\n <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Histories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"OperatingHours\" nillable=\"true\" minOccurs=\"0\" type=\"ens:OperatingHours\"/>\n <element name=\"OperatingHoursId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"RecordActionHistories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"RecordActions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"RecordsetFilterCriteria\" nillable=\"true\" minOccurs=\"0\" type=\"ens:RecordsetFilterCriteria\"/>\n <element name=\"RecordsetFilterCriteriaId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"StartTime\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:time\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"TimeSlotNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Type\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\n```",
|
||
"field_reference": {
|
||
"CreatedById": {
|
||
"field_label": "Created By ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"CreatedDate": {
|
||
"field_label": "Created Date",
|
||
"type": "datetime"
|
||
},
|
||
"CurrencyIsoCode": {
|
||
"field_label": "Currency ISO Code",
|
||
"type": "picklist",
|
||
"length": "3"
|
||
},
|
||
"DayOfWeek": {
|
||
"field_label": "Day of Week",
|
||
"type": "picklist",
|
||
"length": "255"
|
||
},
|
||
"EndTime": {
|
||
"field_label": "End Time",
|
||
"type": "time"
|
||
},
|
||
"Id": {
|
||
"field_label": "Time Slot ID",
|
||
"type": "id",
|
||
"length": "18"
|
||
},
|
||
"IsDeleted": {
|
||
"field_label": "Deleted",
|
||
"type": "boolean"
|
||
},
|
||
"LastModifiedById": {
|
||
"field_label": "Last Modified By ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"LastModifiedDate": {
|
||
"field_label": "Last Modified Date",
|
||
"type": "datetime"
|
||
},
|
||
"LastReferencedDate": {
|
||
"field_label": "Last Referenced Date",
|
||
"type": "datetime"
|
||
},
|
||
"LastViewedDate": {
|
||
"field_label": "Last Viewed Date",
|
||
"type": "datetime"
|
||
},
|
||
"MaxAppointments": {
|
||
"field_label": "Maximum Appointments",
|
||
"type": "int",
|
||
"digits": "9"
|
||
},
|
||
"OperatingHoursId": {
|
||
"field_label": "Operating Hour ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"RecordsetFilterCriteriaId": {
|
||
"field_label": "Recordset Filter Criteria ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"StartTime": {
|
||
"field_label": "Start Time",
|
||
"type": "time"
|
||
},
|
||
"SystemModstamp": {
|
||
"field_label": "System Modstamp",
|
||
"type": "datetime"
|
||
},
|
||
"TimeSlotNumber": {
|
||
"field_label": "Name",
|
||
"type": "string",
|
||
"length": "255"
|
||
},
|
||
"Type": {
|
||
"field_label": "Type",
|
||
"type": "picklist",
|
||
"length": "255"
|
||
},
|
||
"WorkTypeGroupId": {
|
||
"field_label": "Work Type Group ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
}
|
||
},
|
||
"field_reference_columns": [
|
||
"field_label",
|
||
"type",
|
||
"length",
|
||
"digits"
|
||
]
|
||
} |