mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-08 00:10:29 +08:00
196 lines
11 KiB
JSON
196 lines
11 KiB
JSON
{
|
||
"sections": [
|
||
"title",
|
||
"description",
|
||
"fields",
|
||
"special_access_rules",
|
||
"usage",
|
||
"associated_objects",
|
||
"wsdl_segment",
|
||
"field_reference"
|
||
],
|
||
"title": "CalendarView - Data API",
|
||
"description": "These calendars can be created and assigned to users other than the creator. Available calendars include object, shared, public, resource, and user list calendars. Object calendars represent a calendar based on a Salesforce object, either standard or custom. This object is available in API version 51.0 and later.",
|
||
"fields_columns": [
|
||
"type",
|
||
"properties",
|
||
"description",
|
||
"relationship_name",
|
||
"relationship_type",
|
||
"refers_to"
|
||
],
|
||
"fields": {
|
||
"Color": {
|
||
"type": "string",
|
||
"properties": "Create, Defaulted on create, Filter, Nillable, Sort, Update",
|
||
"description": "Represents the color used in the background for records displayed in a user’s calendar view within the user interface."
|
||
},
|
||
"CurrencyIsoCode": {
|
||
"type": "picklist",
|
||
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
|
||
"description": "Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization."
|
||
},
|
||
"DateHandlingType": {
|
||
"type": "picklist",
|
||
"properties": "Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort",
|
||
"description": "Determined by the data type of the StartField. Valid values include:"
|
||
},
|
||
"DisplayField": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, Sort, Update",
|
||
"description": "Represents the SobjectType field used as the subject for records displayed in a user’s calendar view within the user interface."
|
||
},
|
||
"EndField": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "An optional field that represents the sObjectType field used as the end time for records displayed in a user’s calendar view within the user interface. Must be a date or dateTime field that matches the type in StartField."
|
||
},
|
||
"FillPattern": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "Represents the pattern displayed as the background for records displayed in a user’s calendar view within the user interface. Valid values include: verticalStripes ascDiagonalStripes descDiagonalStripes"
|
||
},
|
||
"IsDisplayed": {
|
||
"type": "boolean",
|
||
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
|
||
"description": "Defines whether users can see a calendar’s records in their calendar view in the user interface. When true, records are visible in the user’s calendar view. When false, records are hidden from the user’s calendar view. The default is true. IsDisplayed can be true for up to 50 calendars."
|
||
},
|
||
"ListViewFilterId": {
|
||
"type": "reference",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "References the ListView used to filter records represented by the CalendarView. ListView must have the same sObjectType. If no ListViewFilterId is defined, the calendar displays only records with the same owner as the CalendarView. This is a relationship field.",
|
||
"relationship_name": "ListViewFilter",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "ListView"
|
||
},
|
||
"Name": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, idLookup, Sort, Update",
|
||
"description": "A user-provided name that identifies the calendar. This isn’t an enumerated field; it can be any string to a maximum length of 80 characters."
|
||
},
|
||
"OwnerId": {
|
||
"type": "reference",
|
||
"properties": "Create, Filter, Group, Sort",
|
||
"description": "Represents the owner of the CalendarView. This is a polymorphic relationship field.",
|
||
"relationship_name": "Owner",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "Group, User"
|
||
},
|
||
"SobjectType": {
|
||
"type": "picklist",
|
||
"properties": "Create, Filter, Group, Restricted picklist, Sort",
|
||
"description": "The type of standard or custom Salesforce object that is used to create records for the CalendarView. Use the API name of the desired SobjectType."
|
||
},
|
||
"StartField": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, Sort, Update",
|
||
"description": "Represents the SobjectType field used as the start time for records displayed in a user’s calendar view within the user interface. Must be a date or dateTime field type."
|
||
}
|
||
},
|
||
"special_access_rules": "All fields and entities referenced by field values must be accessible by the CalendarView creator even if the creator isn’t the CalendarView owner.",
|
||
"usage": "To distribute a CalendarView to multiple users, IDs can be pulled from a group, user list, or profile. For this example, a CalendarView based on opportunity close dates is being distributed to a sales team in a public group, Sales Group:\n\n'Sales Group'\n\nGroupMember\n\ngroupMembers\n\nUserOrGroupId\n\nGroupMember\n\nCalendarView\n\ncalendarViews\n\nCalendarView\n\nGroupMember\n\ngroupMember\n\ngroupMembers\n\nCalendarView\n\ncalendarView\n\nCalendarView\n\n'Opportunity Close Dates’\n\nSobjectType\n\n'Opportunity'\n\n'CloseDate'\n\nDisplayField\n\ngroupMember\n\nUserOrGroupId\n\ncalendarViews\n\ncalendarView\n\ncalendarViews",
|
||
"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- **CalendarViewChangeEvent (API version 62.0)**: Change events are available for the object.",
|
||
"wsdl_segment": "```xml\n<complexType name=\"CalendarView\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"Color\" 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=\"DateHandlingType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"DisplayField\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"EndField\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"FillPattern\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsDisplayed\" 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=\"ListViewFilter\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ListView\"/>\n <element name=\"ListViewFilterId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\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=\"Publisher\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n <element name=\"PublisherId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"Shares\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"SobjectType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"StartField\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\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": {
|
||
"Color": {
|
||
"field_label": "Color",
|
||
"type": "string",
|
||
"length": "6"
|
||
},
|
||
"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"
|
||
},
|
||
"DateHandlingType": {
|
||
"field_label": "Date Handling Type",
|
||
"type": "picklist",
|
||
"length": "255"
|
||
},
|
||
"DisplayField": {
|
||
"field_label": "Display Field",
|
||
"type": "string",
|
||
"length": "255"
|
||
},
|
||
"EndField": {
|
||
"field_label": "End Field",
|
||
"type": "string",
|
||
"length": "255"
|
||
},
|
||
"FillPattern": {
|
||
"field_label": "Fill Pattern",
|
||
"type": "string",
|
||
"length": "50"
|
||
},
|
||
"Id": {
|
||
"field_label": "Calendar ID",
|
||
"type": "id",
|
||
"length": "18"
|
||
},
|
||
"IsDeleted": {
|
||
"field_label": "Deleted",
|
||
"type": "boolean"
|
||
},
|
||
"IsDisplayed": {
|
||
"field_label": "Is Displayed",
|
||
"type": "boolean"
|
||
},
|
||
"LastModifiedById": {
|
||
"field_label": "Last Modified By ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"LastModifiedDate": {
|
||
"field_label": "Last Modified Date",
|
||
"type": "datetime"
|
||
},
|
||
"ListViewFilterId": {
|
||
"field_label": "List View ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"Name": {
|
||
"field_label": "Calendar Name",
|
||
"type": "string",
|
||
"length": "255"
|
||
},
|
||
"OwnerId": {
|
||
"field_label": "Owner ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"PublisherId": {
|
||
"field_label": "Publisher ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"SobjectType": {
|
||
"field_label": "sObject Type",
|
||
"type": "picklist",
|
||
"length": "255"
|
||
},
|
||
"StartField": {
|
||
"field_label": "Start Field",
|
||
"type": "string",
|
||
"length": "255"
|
||
},
|
||
"SystemModstamp": {
|
||
"field_label": "System Modstamp",
|
||
"type": "datetime"
|
||
}
|
||
},
|
||
"field_reference_columns": [
|
||
"field_label",
|
||
"type",
|
||
"length"
|
||
]
|
||
} |