--- schema_version: "1" id: 294a87a9165e5e3e4a138542ce29580aa55c3178dfb8aee1ebdc5277cebb09c4 title: TimelineObjectDefinition collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_timelineobjectdefinition.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_timelineobjectdefinition.htm source_site: developer.salesforce.com content_type: documentation content_hash: e787fcff53006c12af312548aa6dccc0990bf009c1f18366f06ee0673da8c4df 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. --- # TimelineObjectDefinition 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. ![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Parent Type This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field. ## File Suffix and Directory Location TimelineObjectDefinition components have the suffix .timelineObjectDefinition and are stored in the timelineObjectDefinitions folder. ## Version TimelineObjectDefinition components are available in API version 55.0 and later. ## Special Access Rules TimelineObjectDefinition is available in any org that has the Timeline org preference enabled. ## Fields | Field Name | Description | | --- | --- | | baseObject | Field Type string Description Required. 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 | Field Type string Description Required. The timeline definition in JSON format. | | isActive | Field Type boolean Description Indicates whether the timeline is active (true) or not (false). | | masterLabel | Field Type string Description Required. The user interface label of the timeline object definition record. | ## Declarative Metadata Sample Definition The following is an example of a TimelineObjectDefinition component. Account {"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"}}}\]}} true HealthTimeline The following is an example package.xml that references the previous definition. \* TimelineObjectDefinition 55.0 ## Wildcard Support in the Manifest File This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").