Enables scripted content fragments to use content conversion
Methods
Convert
Attempts to convert content across content types. Requires a matching IContentConverter plugin to be enabled.
Usage
#set($contentResponse = $core_v2_contentConversion.Convert($sourceContentTypeId, $sourceContentId, $targetContentTypeId, $targetApplicationId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
sourceContentTypeId | Guid | Source Content Type Id | Required | ||
sourceContentId | Guid | Source Content Id | Required | ||
targetContentTypeId | Guid | Target Content Type Id | Required | ||
targetApplicationId | Guid | Target Application Id | Required |
Return Type
DynamicFormXml
Obsolete. Use DynamicFormXml(Guid, Guid, Guid, Guid) instead.
Usage
#set($stringResponse = $core_v2_contentConversion.DynamicFormXml($sourceContentTypeId, $sourceContentId, $targetContentTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
sourceContentTypeId | Guid | Source Content Type Id | Required | ||
sourceContentId | Guid | Source Content Id | Required | ||
targetContentTypeId | Guid | Target Content Type Id | Required |
Return Type
string
DynamicFormXml
Get any the properties for a conversion session as defined by an IConfigurableContentConverter as Dynamic Configuration XML
Usage
#set($stringResponse = $core_v2_contentConversion.DynamicFormXml($sourceContentTypeId, $sourceContentId, $targetContentTypeId, $targetApplicationId, $targetApplicationTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
sourceContentTypeId | Guid | Source Content Type Id | Required | ||
sourceContentId | Guid | Source Content Id | Required | ||
targetContentTypeId | Guid | Target Content Type Id | Required | ||
targetApplicationId | Guid | Target Application Id | Required | ||
targetApplicationTypeId | Guid | Target Application Type Id | Required |
Return Type
string
ListTargetApplications
Lists applications that converted content can be created in
Usage
#set($apiListResponse = $core_v2_contentConversion.ListTargetApplications($sourceContentTypeId, $sourceContentId, $targetContentTypeId, $containerId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
sourceContentTypeId | Guid | Source Content Type Id | Required | ||
sourceContentId | Guid | Source Content Id | Required | ||
targetContentTypeId | Guid | Target Content Type Id | Required | ||
containerId | Guid | Container Id | Required |
Return Type
ListTargetApplications
Lists applications that converted content can be created in
Usage
#set($apiListResponse = $core_v2_contentConversion.ListTargetApplications($sourceContentTypeId, $sourceContentId, $targetContentTypeId, $containerId, $query))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
sourceContentTypeId | Guid | Source Content Type Id | Required | ||
sourceContentId | Guid | Source Content Id | Required | ||
targetContentTypeId | Guid | Target Content Type Id | Required | ||
containerId | Guid | Container Id | Required | ||
query | string | Query | Required |
Return Type
ListTargetContentTypes
Lists content types that source content can be converted to
Usage
#set($apiListResponse = $core_v2_contentConversion.ListTargetContentTypes($sourceContentTypeId, $sourceContentId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
sourceContentTypeId | Guid | Source Content Type Id | Required | ||
sourceContentId | Guid | Source Content Id | Required |