ContentAsset

Represents the metadata for creating an asset file. Asset files enable a Salesforce file to be used for org setup and configuration purposes.

This type extends MetadataWithContent and inherits its fields.

ContentAsset components have the suffix .asset and are stored in the contentassets folder.

Introduced in API version 38.0.

The system prevents metadata retrieval if the total size of the asset’s file content exceeds 30 MB. All pre-existing limits for packaging apply to asset files.

• Type: ContentAssetFormat (enumeration of type string)
• Required: No
• Description: Describes the format of the asset file.
• Possible values:
  • Original — A single asset file version.
  • ZippedVersions — Contains multiple versions of the asset file.

• Type: boolean
• Required: No
• Introduced: API version 44.0
• Description: Indicates whether unauthenticated users can see the asset file (true) or not (false). If not specified, the default value is false.

• Type: string
• Required: Yes
• Description: Required. The language of the asset file label.

• Type: string
• Required: Yes
• Description: Required. The label for the asset file record, which displays in Setup.

• Type: string
• Required: No
• Description: For deploys, the name of the Experience Cloud site the file is assigned upon creation. For retrievals, the name of the Experience Cloud site the file is assigned to appears in the field value. If null, the file wasn’t assigned to an Experience Cloud site.

• Type: ContentAssetRelationships
• Required: No
• Description: The list of ContentAssetLinks that describe whether the asset file can be shared with the org.

• Type: ContentAssetVersions
• Required: Yes
• Description: Required. Captures basic information about the file version included the asset metadata. Typically the file has only one version.

Represents a relationship link for an asset file, and includes details about the level of access for the link.

• Type: ContentAssetAccess (enumeration of type string)
• Required: Yes
• Description: Required. The permission granted to the user of the shared file, determined by the permission the user already has.
• Possible values:
  • VIEWER
  • COLLABORATOR
  • INFERRED

• Type: boolean
• Required: No
• Introduced: API version 39.0
• Description: Indicates whether the content asset resides in the workspace or not. When true, the content asset resides in the workspace. If not specified, the default value is false.

• Type: string
• Required: No
• Description: Reserved for future use.

Represents the relationships between an asset file and the locations it’s linked with.

• Type: ContentAssetLink[]
• Required: No
• Introduced: API version 51.0
• Description: An array of email templates the content asset is related to.

• Type: ContentAssetLink[]
• Required: No
• Introduced: API version 39.0
• Description: An array of the insights applications that use the content asset.

• Type: ContentAssetLink[]
• Required: No
• Introduced: API version 39.0
• Description: An array of networks that use the content asset.

• Type: ContentAssetLink
• Required: No
• Introduced: API version 39.0
• Description: Stores information about sharing the asset file with the org. Maps to ContentDocumentLink.

• Type: ContentAssetLink[]
• Required: No
• Introduced: API version 39.0
• Description: An array of workspaces and libraries that own or share the content asset.

Represents information about one file version included in the asset metadata.

• Type: string
• Required: Yes
• Description: Required. The version number. This field is based on, or sets, the ContentVersion.

• Type: string
• Required: Yes
• Description: Required. Describes the original filename of the file. This field maps to ContentVersion.PathOnClient. It provides the data for the ContentVersion Title field.

• Type: string
• Required: No
• Description: If the asset file has more than one version, format is ZippedVersions. In this case, zipEntry is the name of the file within the zip. If the asset file has only one version, this field is empty.

Represents information about all file versions included in the asset metadata.

• Type: ContentAssetVersion[]
• Required: No
• Description: A list of file versions for the asset.

The following is an example of a ContentAsset component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ContentAsset xmlns="http://soap.sforce.com/2006/04/metadata">
3    <masterLabel>some asset</masterLabel>
4    <relationships>
5        <organization>
6            <access>VIEWER</access>
7        </organization>
8    </relationships>
9    <versions>
10        <version>
11            <number>1</number>
12            <pathOnClient>some asset.txt</pathOnClient>
13        </version>
14    </versions>
15</ContentAsset>

For assets that include just one version, the format field can be omitted or specified with the value as Original. File assets with more than one version have versions wrapped in a zip file.

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>MyAsset</members>
5        <name>ContentAsset</name>
6    </types>
7    <version>68.0</version>
8</Package>

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.