mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-07 00:02:34 +08:00
211 lines
11 KiB
JSON
211 lines
11 KiB
JSON
{
|
||
"sections": [
|
||
"title",
|
||
"description",
|
||
"fields",
|
||
"special_access_rules",
|
||
"associated_objects",
|
||
"wsdl_segment",
|
||
"field_reference"
|
||
],
|
||
"title": "ShiftTemplate - Data API",
|
||
"description": "Represents a template for creating shifts. This object is available in API version 51.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."
|
||
},
|
||
"Description": {
|
||
"type": "textarea",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "Additional information about the shift like number of breaks or activities."
|
||
},
|
||
"Duration": {
|
||
"type": "double",
|
||
"properties": "Create, Filter, Sort, Update",
|
||
"description": "How long the shift lasts. The unit of measurement for this field is determined by ShiftTemplateDurationType."
|
||
},
|
||
"IsActive": {
|
||
"type": "boolean",
|
||
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
|
||
"description": "Indicates whether the shift is active or inactive."
|
||
},
|
||
"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 record. This field is optional. This is a relationship field.",
|
||
"relationship_name": "JobProfile",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "JobProfile"
|
||
},
|
||
"LastReferencedDate": {
|
||
"type": "dateTime",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "The date when the shift template was last modified. Its label in the user interface is Last Modified Date."
|
||
},
|
||
"LastViewedDate": {
|
||
"type": "dateTime",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "The date when the shift template was last viewed."
|
||
},
|
||
"Name": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, idLookup, Sort, Update",
|
||
"description": "The shift template record name."
|
||
},
|
||
"OwnerId": {
|
||
"type": "reference",
|
||
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
|
||
"description": "The owner of the shift template. 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 template. Available in API version 53.0 and later. This is a relationship field.",
|
||
"relationship_name": "RecordsetFilterCriteria",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "RecordsetFilterCriteria"
|
||
},
|
||
"ShiftTemplateDurationType": {
|
||
"type": "picklist",
|
||
"properties": "Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update",
|
||
"description": "The unit of measurement for the shift template duration. Possible values are: H—Hours M—Minutes The default value is H."
|
||
},
|
||
"StartTime": {
|
||
"type": "time",
|
||
"properties": "Create, Filter, Sort, Update",
|
||
"description": "The time of day when the shift starts."
|
||
},
|
||
"TimeSlotType": {
|
||
"type": "picklist",
|
||
"properties": "Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update",
|
||
"description": "The type of time slot. Possible values are: Normal Extended You can use Extended to represent overtime shifts. Available in API version 55.0 and later."
|
||
}
|
||
},
|
||
"special_access_rules": "Field Service or Workforce Engagement must be enabled. For Field Service, users must have Field Service permission. For Workforce Engagement, the user needs to have a Workforce Engagement Admin or Planner permission set.\n\nField Service or Workforce Engagement must be\n enabled. For Field Service, users must have Field Service permission. For Workforce\n Engagement, the user needs to have a Workforce Engagement Admin or Planner permission set.",
|
||
"associated_objects": "This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.\n\n- **ShiftTemplateOwnerSharingRule**: Sharing rules are available for the object.\n- **ShiftTemplateShare**: Sharing is available for the object.\n- **ShiftTemplateChangeEvent**: Change Data Capture events are available for the object. Available in API version 54.0 and later.",
|
||
"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=\"ShiftTemplate\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"BackgroundColor\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\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=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Duration\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n <element name=\"IsActive\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsDeleted\" 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=\"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=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Owner\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n <element name=\"OwnerId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\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=\"Shares\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ShiftPatternEntries\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ShiftTemplateDurationType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Shifts\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\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=\"TimeSlotType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\n```",
|
||
"field_reference": {
|
||
"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"
|
||
},
|
||
"Description": {
|
||
"field_label": "Description",
|
||
"type": "textarea",
|
||
"length": "255"
|
||
},
|
||
"Duration": {
|
||
"field_label": "Work Duration (Hours)",
|
||
"type": "double",
|
||
"precision": "6",
|
||
"scale": "2"
|
||
},
|
||
"Id": {
|
||
"field_label": "Shift Template ID",
|
||
"type": "id",
|
||
"length": "18"
|
||
},
|
||
"IsActive": {
|
||
"field_label": "Active",
|
||
"type": "boolean"
|
||
},
|
||
"IsDeleted": {
|
||
"field_label": "Deleted",
|
||
"type": "boolean"
|
||
},
|
||
"IsNonStandard": {
|
||
"field_label": "Non-Standard",
|
||
"type": "boolean"
|
||
},
|
||
"JobProfileId": {
|
||
"field_label": "Job Profile ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"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"
|
||
},
|
||
"Name": {
|
||
"field_label": "Shift Template Name",
|
||
"type": "string",
|
||
"length": "50"
|
||
},
|
||
"OwnerId": {
|
||
"field_label": "Owner ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"RecordsetFilterCriteriaId": {
|
||
"field_label": "Recordset Filter Criteria ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"ShiftTemplateDurationType": {
|
||
"field_label": "Duration Type",
|
||
"type": "picklist",
|
||
"length": "255"
|
||
},
|
||
"StartTime": {
|
||
"field_label": "Start Time",
|
||
"type": "time"
|
||
},
|
||
"SystemModstamp": {
|
||
"field_label": "System Modstamp",
|
||
"type": "datetime"
|
||
},
|
||
"TimeSlotType": {
|
||
"field_label": "Time Slot Type",
|
||
"type": "picklist",
|
||
"length": "255"
|
||
}
|
||
},
|
||
"field_reference_columns": [
|
||
"field_label",
|
||
"type",
|
||
"length",
|
||
"precision",
|
||
"scale"
|
||
]
|
||
} |