mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-06 15:59:59 +08:00
293 lines
16 KiB
JSON
293 lines
16 KiB
JSON
|
{
|
||
|
|
"sections": [
|
||
|
|
"title",
|
||
|
|
"description",
|
||
|
|
"fields",
|
||
|
|
"special_access_rules",
|
||
|
|
"usage",
|
||
|
|
"associated_objects",
|
||
|
|
"wsdl_segment",
|
||
|
|
"field_reference"
|
||
|
|
],
|
||
|
|
"title": "Shift - Data API",
|
||
|
|
"description": "Represents a shift for service resource scheduling. Available in API versions 46.0 and later.",
|
||
|
|
"fields_columns": [
|
||
|
|
"type",
|
||
|
|
"properties",
|
||
|
|
"description",
|
||
|
|
"relationship_name",
|
||
|
|
"relationship_type",
|
||
|
|
"refers_to"
|
||
|
|
],
|
||
|
|
"fields": {
|
||
|
|
"BackgroundColor": {
|
||
|
|
"type": "string",
|
||
|
|
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
|
|
"description": "Sets a background color when shifts are displayed in the UI. Use a 3- or 6-digit hexadecimal format, for example #FF00FF. Available in API version 54.0 and later."
|
||
|
|
},
|
||
|
|
"EndTime": {
|
||
|
|
"type": "dateTime",
|
||
|
|
"properties": "Create, Filter, Sort, Update",
|
||
|
|
"description": "The date and time that the shift ends."
|
||
|
|
},
|
||
|
|
"IsHolidayShift": {
|
||
|
|
"type": "boolean",
|
||
|
|
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
|
||
|
|
"description": "Indicates a shift that overlaps with holiday hours. The default value is false. Available in API version 55.0 and later."
|
||
|
|
},
|
||
|
|
"IsNonStandard": {
|
||
|
|
"type": "boolean",
|
||
|
|
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
|
||
|
|
"description": "Indicates whether the shift is nonstandard, such as overtime or on-call shifts. The default value is false. Available in API version 54.0 and later."
|
||
|
|
},
|
||
|
|
"JobProfileId": {
|
||
|
|
"type": "reference",
|
||
|
|
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
|
|
"description": "The job profile associated with the shift. Available in API versions 47.0 and later."
|
||
|
|
},
|
||
|
|
"Label": {
|
||
|
|
"type": "string",
|
||
|
|
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
|
|
"description": "The label that a shift is given."
|
||
|
|
},
|
||
|
|
"LastReferencedDate": {
|
||
|
|
"type": "dateTime",
|
||
|
|
"properties": "Filter, Nillable, Sort",
|
||
|
|
"description": "The date and time when the current user last viewed a related record."
|
||
|
|
},
|
||
|
|
"LastViewedDate": {
|
||
|
|
"type": "dateTime",
|
||
|
|
"properties": "Filter, Nillable, Sort",
|
||
|
|
"description": "The date and time when the current user last viewed this record."
|
||
|
|
},
|
||
|
|
"OwnerId": {
|
||
|
|
"type": "reference",
|
||
|
|
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
|
||
|
|
"description": "The owner of the shift. This is a polymorphic relationship field.",
|
||
|
|
"relationship_name": "Owner",
|
||
|
|
"relationship_type": "Lookup",
|
||
|
|
"refers_to": "Group, User"
|
||
|
|
},
|
||
|
|
"RecordsetFilterCriteriaId": {
|
||
|
|
"type": "reference",
|
||
|
|
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
|
|
"description": "The ID of the recordset filter criteria selected for the shift. Available in API version 49.0 and later. This is a relationship field.",
|
||
|
|
"relationship_name": "RecordsetFilterCriteria",
|
||
|
|
"relationship_type": "Lookup",
|
||
|
|
"refers_to": "RecordsetFilterCriteria"
|
||
|
|
},
|
||
|
|
"ServiceResourceId": {
|
||
|
|
"type": "reference",
|
||
|
|
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
|
|
"description": "The ID of the service resource the shift belongs to. Available in API versions 47.0 and later. This is a relationship field.",
|
||
|
|
"relationship_name": "ServiceResource",
|
||
|
|
"relationship_type": "Lookup",
|
||
|
|
"refers_to": "ServiceResource"
|
||
|
|
},
|
||
|
|
"ServiceTerritoryId": {
|
||
|
|
"type": "reference",
|
||
|
|
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
|
|
"description": "The ID of the service territory the shift belongs to. Available in API versions 47.0 and later. This is a relationship field.",
|
||
|
|
"relationship_name": "ServiceTerritory",
|
||
|
|
"relationship_type": "Lookup",
|
||
|
|
"refers_to": "ServiceTerritory"
|
||
|
|
},
|
||
|
|
"ShiftNumber": {
|
||
|
|
"type": "string",
|
||
|
|
"properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
|
||
|
|
"description": "The number automatically given to the shift upon creation."
|
||
|
|
},
|
||
|
|
"ShiftTemplateId": {
|
||
|
|
"type": "reference",
|
||
|
|
"properties": "Create, Filter, Group, Nillable, Sort",
|
||
|
|
"description": "The shift template ID, if the shift was created from a shift template. Available in API version 53.0 and later. This is a relationship field.",
|
||
|
|
"relationship_name": "ShiftTemplate",
|
||
|
|
"relationship_type": "Lookup",
|
||
|
|
"refers_to": "ShiftTemplate"
|
||
|
|
},
|
||
|
|
"StartTime": {
|
||
|
|
"type": "dateTime",
|
||
|
|
"properties": "Create, Filter, Sort, Update",
|
||
|
|
"description": "The date and time that the shift starts."
|
||
|
|
},
|
||
|
|
"Status": {
|
||
|
|
"type": "picklist",
|
||
|
|
"properties": "Create, Filter, Group, Sort, Update",
|
||
|
|
"description": "Describes the status of the shift. Users can create custom values. Default values are: Tentative Published Confirmed"
|
||
|
|
},
|
||
|
|
"StatusCategory": {
|
||
|
|
"type": "picklist",
|
||
|
|
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
|
||
|
|
"description": "Describes the status of the shift using static values. This field is derived from Status using the mapping defined in setup. Possible values are: Tentative Published Confirmed"
|
||
|
|
},
|
||
|
|
"TimeSlotType": {
|
||
|
|
"type": "picklist",
|
||
|
|
"properties": "Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update",
|
||
|
|
"description": "Type of time slot for the shift. The same setup values as the TimeSlot field in the OperatingHours object. Possible values are: Normal (default value) Extended"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"special_access_rules": "Field Service, Service Engagement, or Workforce Engagement must be enabled. For Field Service, users must have Field Service permissions. For Service Engagement, users must have the Service Engagement Planner permission set. For Workforce Engagement, users must have the Workforce Engagement Admin or Planner permission set.",
|
||
|
|
"usage": "Scheduling and dispatching service resources using shift data is not supported in API version 46.0, and is a pilot feature in API version 47.0.",
|
||
|
|
"associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **ShiftChangeEvent (API version 54.0)**: Change events are available for the object.\n\n- **ShiftFeed**: Feed tracking is available for the object.\n- **ShiftHistory**: History is available for tracked fields of the object.\n- **ShiftOwnerSharingRule**: Sharing rules are available for the object.\n- **ShiftShare**: Sharing is available for 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=\"Shift\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"ActivityHistories\" 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=\"AttachedContentDocuments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Attachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"BackgroundColor\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"CombinedAttachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ContentDocumentLinks\" 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=\"Emails\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"EndTime\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Events\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"FeedSubscriptionsForEntity\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Feeds\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\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=\"IsHolidayShift\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsNonStandard\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"JobProfile\" nillable=\"true\" minOccurs=\"0\" type=\"ens:JobProfile\"/>\n <element name=\"JobProfileId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"Label\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\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=\"LookedUpFromActivities\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Notes\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"NotesAndAttachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"OpenActivities\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element
|
||
|
|
"field_reference": {
|
||
|
|
"AppointmentCategoryId": {
|
||
|
|
"field_label": "Appointment Category ID",
|
||
|
|
"type": "reference",
|
||
|
|
"length": "18"
|
||
|
|
},
|
||
|
|
"BackgroundColor": {
|
||
|
|
"field_label": "Background Color",
|
||
|
|
"type": "string",
|
||
|
|
"length": "7"
|
||
|
|
},
|
||
|
|
"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"
|
||
|
|
},
|
||
|
|
"EndTime": {
|
||
|
|
"field_label": "End Time",
|
||
|
|
"type": "datetime"
|
||
|
|
},
|
||
|
|
"Id": {
|
||
|
|
"field_label": "Shift ID",
|
||
|
|
"type": "id",
|
||
|
|
"length": "18"
|
||
|
|
},
|
||
|
|
"IsDeleted": {
|
||
|
|
"field_label": "Deleted",
|
||
|
|
"type": "boolean"
|
||
|
|
},
|
||
|
|
"IsHolidayShift": {
|
||
|
|
"field_label": "Holiday Shift",
|
||
|
|
"type": "boolean"
|
||
|
|
},
|
||
|
|
"IsNonStandard": {
|
||
|
|
"field_label": "Non-Standard",
|
||
|
|
"type": "boolean"
|
||
|
|
},
|
||
|
|
"JobProfileId": {
|
||
|
|
"field_label": "Job Profile ID",
|
||
|
|
"type": "reference",
|
||
|
|
"length": "18"
|
||
|
|
},
|
||
|
|
"Label": {
|
||
|
|
"field_label": "Label",
|
||
|
|
"type": "string",
|
||
|
|
"length": "255"
|
||
|
|
},
|
||
|
|
"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"
|
||
|
|
},
|
||
|
|
"OwnerId": {
|
||
|
|
"field_label": "Owner ID",
|
||
|
|
"type": "reference",
|
||
|
|
"length": "18"
|
||
|
|
},
|
||
|
|
"RecordsetFilterCriteriaId": {
|
||
|
|
"field_label": "Recordset Filter Criteria ID",
|
||
|
|
"type": "reference",
|
||
|
|
"length": "18"
|
||
|
|
},
|
||
|
|
"RecurrenceEndDate": {
|
||
|
|
"field_label": "Recurrence End Date",
|
||
|
|
"type": "date"
|
||
|
|
},
|
||
|
|
"RecurrencePattern": {
|
||
|
|
"field_label": "Recurrence Pattern",
|
||
|
|
"type": "string",
|
||
|
|
"length": "255"
|
||
|
|
},
|
||
|
|
"RecurrenceStartDate": {
|
||
|
|
"field_label": "Recurrence Start Date",
|
||
|
|
"type": "date"
|
||
|
|
},
|
||
|
|
"ServiceResourceId": {
|
||
|
|
"field_label": "Service Resource ID",
|
||
|
|
"type": "reference",
|
||
|
|
"length": "18"
|
||
|
|
},
|
||
|
|
"ServiceTerritoryId": {
|
||
|
|
"field_label": "Service Territory ID",
|
||
|
|
"type": "reference",
|
||
|
|
"length": "18"
|
||
|
|
},
|
||
|
|
"ShiftNumber": {
|
||
|
|
"field_label": "Shift Number",
|
||
|
|
"type": "string",
|
||
|
|
"length": "255"
|
||
|
|
},
|
||
|
|
"ShiftTemplateId": {
|
||
|
|
"field_label": "Shift Template ID",
|
||
|
|
"type": "reference",
|
||
|
|
"length": "18"
|
||
|
|
},
|
||
|
|
"StartTime": {
|
||
|
|
"field_label": "Start Time",
|
||
|
|
"type": "datetime"
|
||
|
|
},
|
||
|
|
"Status": {
|
||
|
|
"field_label": "Status",
|
||
|
|
"type": "picklist",
|
||
|
|
"length": "40"
|
||
|
|
},
|
||
|
|
"StatusCategory": {
|
||
|
|
"field_label": "Status Category",
|
||
|
|
"type": "picklist",
|
||
|
|
"length": "255"
|
||
|
|
},
|
||
|
|
"SystemModstamp": {
|
||
|
|
"field_label": "System Modstamp",
|
||
|
|
"type": "datetime"
|
||
|
|
},
|
||
|
|
"TimeSlotType": {
|
||
|
|
"field_label": "Time Slot Type",
|
||
|
|
"type": "picklist",
|
||
|
|
"length": "255"
|
||
|
|
},
|
||
|
|
"Type": {
|
||
|
|
"field_label": "Type",
|
||
|
|
"type": "picklist",
|
||
|
|
"length": "255"
|
||
|
|
},
|
||
|
|
"WorkTypeGroupId": {
|
||
|
|
"field_label": "Work Type Group ID",
|
||
|
|
"type": "reference",
|
||
|
|
"length": "18"
|
||
|
|
},
|
||
|
|
"WorkTypeId": {
|
||
|
|
"field_label": "Work Type ID",
|
||
|
|
"type": "reference",
|
||
|
|
"length": "18"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"field_reference_columns": [
|
||
|
|
"field_label",
|
||
|
|
"type",
|
||
|
|
"length"
|
||
|
|
]
|
||
|
|
}
|