mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-06 15:59:59 +08:00
212 lines
11 KiB
JSON
212 lines
11 KiB
JSON
{
|
||
"sections": [
|
||
"title",
|
||
"description",
|
||
"fields",
|
||
"special_access_rules",
|
||
"usage",
|
||
"wsdl_segment",
|
||
"field_reference"
|
||
],
|
||
"title": "Holiday - Data API",
|
||
"description": "Represents a period of time during which your customer support team is unavailable. Business hours and escalation rules associated with business hours are suspended during any holidays with which they are affiliated.",
|
||
"fields_columns": [
|
||
"type",
|
||
"properties",
|
||
"description"
|
||
],
|
||
"fields": {
|
||
"ActivityDate": {
|
||
"type": "date",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "If the Holiday IsAllDay flag is set to true (indicating that it is an all-day holiday), then the holiday due date information is contained in the ActivityDate field. This field is a date field with a timestamp that is always set to midnight in the Coordinated Universal Time (UTC) time zone. The timestamp is not relevant, and you should not attempt to alter it to account for any time zone differences."
|
||
},
|
||
"Description": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "Text description of the holiday."
|
||
},
|
||
"EndTimeInMinutes": {
|
||
"type": "int",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "The end time of the holiday in minutes."
|
||
},
|
||
"IsAllDay": {
|
||
"type": "boolean",
|
||
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
|
||
"description": "Indicates whether the duration of the holiday is all day (true) or not (false)."
|
||
},
|
||
"IsRecurrence": {
|
||
"type": "boolean",
|
||
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
|
||
"description": "Indicates whether the holiday is scheduled to repeat itself (true) or only occurs once (false). This is a read only field on update, but not on create. If this field value is true, then any recurrence fields associated with the given recurrence type must be populated."
|
||
},
|
||
"Name": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, idLookup, Sort, Update",
|
||
"description": "The name of the holiday."
|
||
},
|
||
"NextOccurrenceDate": {
|
||
"type": "date",
|
||
"properties": "Filter, Group, Nillable",
|
||
"description": "The next date of the holiday. Applies to recurring holidays only. Available in API version 58.0 and later. To access this field, you must have Field Service enabled and the Field Service Standard permission. This field isn't sortable. To compare this date to other dates, you must parse the string into a date value to compare it to other dates."
|
||
},
|
||
"RecurrenceDayOfMonth": {
|
||
"type": "int",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "The day of the month on which the holiday repeats."
|
||
},
|
||
"RecurrenceDayOfWeekMask": {
|
||
"type": "int",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "The day or days of the week on which the holiday repeats. This field contains a bitmask. For each day of the week, the values are as follows: Sunday = 1 Monday = 2 Tuesday = 4 Wednesday = 8 Thursday = 16 Friday = 32 Saturday = 64 Multiple days are represented as the sum of their numerical values. For example, Tuesday and Thursday = 4 + 16 = 20."
|
||
},
|
||
"RecurrenceEndDateOnly": {
|
||
"type": "date",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "The last date on which the holiday repeats. For multiday recurring events, this is the day on which the last occurrence starts."
|
||
},
|
||
"RecurrenceInstance": {
|
||
"type": "picklist",
|
||
"properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
|
||
"description": "The frequency of the recurring holiday. For example, 2nd or 3rd."
|
||
},
|
||
"RecurrenceInterval": {
|
||
"type": "int",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "The interval between recurring holidays."
|
||
},
|
||
"RecurrenceMonthOfYear": {
|
||
"type": "picklist",
|
||
"properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
|
||
"description": "The month of the year on which the event repeats."
|
||
},
|
||
"RecurrenceStartDate": {
|
||
"type": "date",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "The date when the recurring holiday begins. Must be a date and time before RecurrenceEndDateOnly."
|
||
},
|
||
"RecurrenceType": {
|
||
"type": "picklist",
|
||
"properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
|
||
"description": "Indicates how often the holiday repeats. For example, daily, weekly, or every Nth month (where “Nth” is defined in RecurrenceInstance)."
|
||
},
|
||
"StartTimeInMinutes": {
|
||
"type": "int",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "The start time of the holiday in minutes."
|
||
}
|
||
},
|
||
"special_access_rules": "Customer Portal users can’t access this object. All users, even those without the “View Setup and Configuration” user permission, can view holidays via the API.\n\nCustomer Portal users can’t access this object.\n\nAll users, even those without the “View Setup and Configuration” user permission, can view holidays via the API.",
|
||
"usage": "Use this object to view and update holidays, which specify dates and times at which associated business hours and escalation rules are suspended.",
|
||
"wsdl_segment": "```xml\n<complexType name=\"Holiday\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"ActivityDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:date\"/>\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=\"EndTimeInMinutes\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n <element name=\"IsAllDay\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsRecurrence\" 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=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"NextOccurrenceDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:date\"/>\n <element name=\"OperatingHoursHolidays\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"RecurrenceDayOfMonth\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n <element name=\"RecurrenceDayOfWeekMask\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n <element name=\"RecurrenceEndDateOnly\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:date\"/>\n <element name=\"RecurrenceInstance\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"RecurrenceInterval\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n <element name=\"RecurrenceMonthOfYear\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"RecurrenceStartDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:date\"/>\n <element name=\"RecurrenceType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"StartTimeInMinutes\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\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```",
|
||
"field_reference": {
|
||
"ActivityDate": {
|
||
"field_label": "Holiday Date",
|
||
"type": "date"
|
||
},
|
||
"CreatedById": {
|
||
"field_label": "Created By ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"CreatedDate": {
|
||
"field_label": "Created Date",
|
||
"type": "datetime"
|
||
},
|
||
"Description": {
|
||
"field_label": "Description",
|
||
"type": "string",
|
||
"length": "100"
|
||
},
|
||
"EndTimeInMinutes": {
|
||
"field_label": "End Time In Minutes From Midnight",
|
||
"type": "int",
|
||
"digits": "9"
|
||
},
|
||
"Id": {
|
||
"field_label": "Holiday ID",
|
||
"type": "id",
|
||
"length": "18"
|
||
},
|
||
"IsAllDay": {
|
||
"field_label": "All Day",
|
||
"type": "boolean"
|
||
},
|
||
"IsRecurrence": {
|
||
"field_label": "Recurring Holiday",
|
||
"type": "boolean"
|
||
},
|
||
"LastModifiedById": {
|
||
"field_label": "Last Modified By ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"LastModifiedDate": {
|
||
"field_label": "Last Modified Date",
|
||
"type": "datetime"
|
||
},
|
||
"Name": {
|
||
"field_label": "Holiday Name",
|
||
"type": "string",
|
||
"length": "80"
|
||
},
|
||
"NextOccurrenceDate": {
|
||
"field_label": "Next Occurrence Date",
|
||
"type": "date"
|
||
},
|
||
"RecurrenceDayOfMonth": {
|
||
"field_label": "Recurrence Day of Month",
|
||
"type": "int",
|
||
"digits": "9"
|
||
},
|
||
"RecurrenceDayOfWeekMask": {
|
||
"field_label": "Recurrence Day of Week Mask",
|
||
"type": "int",
|
||
"digits": "9"
|
||
},
|
||
"RecurrenceEndDateOnly": {
|
||
"field_label": "Recurrence End",
|
||
"type": "date"
|
||
},
|
||
"RecurrenceInstance": {
|
||
"field_label": "Recurrence Instance",
|
||
"type": "picklist",
|
||
"length": "40"
|
||
},
|
||
"RecurrenceInterval": {
|
||
"field_label": "Recurrence Interval",
|
||
"type": "int",
|
||
"digits": "9"
|
||
},
|
||
"RecurrenceMonthOfYear": {
|
||
"field_label": "Recurrence Month of Year",
|
||
"type": "picklist",
|
||
"length": "40"
|
||
},
|
||
"RecurrenceStartDate": {
|
||
"field_label": "Recurrence Start",
|
||
"type": "date"
|
||
},
|
||
"RecurrenceType": {
|
||
"field_label": "Recurrence Type",
|
||
"type": "picklist",
|
||
"length": "40"
|
||
},
|
||
"StartTimeInMinutes": {
|
||
"field_label": "Start Time In Minutes From Midnight",
|
||
"type": "int",
|
||
"digits": "9"
|
||
},
|
||
"SystemModstamp": {
|
||
"field_label": "System Modstamp",
|
||
"type": "datetime"
|
||
}
|
||
},
|
||
"field_reference_columns": [
|
||
"field_label",
|
||
"type",
|
||
"length",
|
||
"digits"
|
||
]
|
||
} |