{
"sections": [
"title",
"description",
"file_information",
"directory_location",
"fields",
"wsdl_segment",
"declarative_metadata_sample_definition"
],
"title": "TimelineObjectDefinition - Metadata API",
"description": "Represents the container that stores the details of a timeline configuration. You can use this resource with Salesforce objects to see their records' related events in a linear time-sorted view.",
"file_information": ".timelineObjectDefinition",
"directory_location": "timelineObjectDefinitions",
"fields_columns": [
"type",
"required",
"description"
],
"fields": {
"baseObject": {
"type": "string",
"required": true,
"description": "The object on which a timeline is based. Information displayed in a timeline comes from objects that are related to the base object. The base object can be a Salesforce object or custom object."
},
"definition": {
"type": "string",
"required": true,
"description": "The timeline definition in JSON format."
},
"isActive": {
"type": "boolean",
"description": "Indicates whether the timeline is active (true) or not (false)."
},
"masterLabel": {
"type": "string",
"required": true,
"description": "The user interface label of the timeline object definition record."
}
},
"wsdl_segment": "```xml\n\n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n\n```",
"declarative_metadata_sample_definition": [
{
"description": "The following is an example of a TimelineObjectDefinition component.",
"code": "\n\n\tAccount\n\t{"timeline":{"anchorObject":{"object":{"entity":"Account","label":"Account","source":"","icon":""}},"age":{"field":"EffectiveDate","label":"Effective Date","type":"DateTime"},"events":[{"oneToMany":{"eventObject":{"name":"Case","label":"Case","recordTypes":[],"fieldsToDisplay":[{"field":"Description","label":"Description","type":"StringPlusClob"},{"field":"Priority","label":"Priority","type":"DynamicEnum"},{"field":"Status","label":"Status","type":"DynamicEnum"},{"field":"Subject","label":"Subject","type":"Text"}],"relatedlistsToDisplay":[{"entity":"CaseComments","label":"Case Comments"},{"entity":"CombinedAttachments","label":"Attachments"},{"entity":"AttachedContentDocuments","label":"Files"}],"title":{"field":"CaseNumber","label":"Case Number","type":"AutoNumber"},"subTitle":{"field":"Comments","label":"Internal Comments","type":"MultiLineText"}},"filters":[{"field":{"field":"Status","label":"Status","type":"DynamicEnum"},"operator":"EQ","values":["New"],"order":1}],"sort":{"field":"CreatedDate","label":"Created Date","type":"DateTime"},"anchorReferenceField":{"field":"AccountId","label":"Account ID","type":"EntityId"}}},{"oneToMany":{"eventObject":{"name":"Event","label":"Event","recordTypes":[],"fieldsToDisplay":[{"field":"ActivityDate","label":"Due Date Only","type":"DueDate"},{"field":"Attendees","label":"Attendees","type":"StringPlusClob"}],"relatedlistsToDisplay":[],"title":{"field":"Description","label":"Description","type":"StringPlusClob"},"subTitle":{"field":"Location","label":"Location","type":"Text"}},"filters":[],"sort":{"field":"ActivityDate","label":"Due Date Only","type":"DueDate"},"anchorReferenceField":{"field":"WhatId","label":"Related To ID","type":"EntityId"}}},{"oneToMany":{"eventObject":{"name":"Task","label":"Task","recordTypes":[],"fieldsToDisplay":[{"field":"CallDisposition","label":"Call Result","type":"Text"},{"field":"CallObject","label":"Call Object Identifier","type":"Text"},{"field":"CallType","label":"Call Type","type":"StaticEnum"}],"relatedlistsToDisplay":[],"title":{"field":"Description","label":"Description","type":"StringPlusClob"},"subTitle":{"field":"Priority","label":"Priority","type":"DynamicEnum"}},"filters":[],"sort":{"field":"ActivityDate","label":"Due Date Only","type":"DueDate"},"anchorReferenceField":{"field":"WhatId","label":"Related To ID","type":"EntityId"}}}]}}\n\ttrue\n\tHealthTimeline\n"
}
]
}