Enables scripted content fragments to use content conversion
Methods
Convert
Convert Overload 1
Obsolete. Use Convert(Guid, Guid, Guid, Guid, Guid, IDictionary) instead.
Velocity
#set($contentResponse = $core_v2_contentConversion.Convert($sourceContentTypeId, $sourceContentId, $targetContentTypeId, $targetApplicationId, "%{}"))JavaScript
var 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 | ||
| options | Options | Set of optional parameters including: | Required |
Convert Overload 2
Attempts to convert content across content types. Requires a matching IContentConverter plugin to be enabled.
Velocity
#set($contentResponse = $core_v2_contentConversion.Convert($sourceContentTypeId, $sourceContentId, $targetContentTypeId, $targetApplicationTypeId, $targetApplicationId, "%{}"))JavaScript
var contentResponse = core_v2_contentConversion.Convert(sourceContentTypeId, sourceContentId, targetContentTypeId, targetApplicationTypeId, 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 | ||
| targetApplicationTypeId | Guid | Target Application Type Id | Required | ||
| targetApplicationId | Guid | Target Application Id | Required | ||
| options | Options | Set of optional parameters including: | Required |
Returns
DynamicFormXml
DynamicFormXml Overload 1
Obsolete. Use DynamicFormXml(Guid, Guid, Guid, Guid) instead.
Velocity
#set($stringResponse = $core_v2_contentConversion.DynamicFormXml($sourceContentTypeId, $sourceContentId, $targetContentTypeId))
JavaScript
var 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 |
DynamicFormXml Overload 2
Get any the properties for a conversion session as defined by an IConfigurableContentConverter as Dynamic Configuration XML
Velocity
#set($stringResponse = $core_v2_contentConversion.DynamicFormXml($sourceContentTypeId, $sourceContentId, $targetContentTypeId, $targetApplicationId, $targetApplicationTypeId))
JavaScript
var 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 |
Returns
StringListTargetApplications
ListTargetApplications Overload 1
Lists applications that converted content can be created in
Velocity
#set($apiListResponse = $core_v2_contentConversion.ListTargetApplications($sourceContentTypeId, $sourceContentId, $targetContentTypeId, $containerId))
JavaScript
var 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 |
ListTargetApplications Overload 2
Lists applications that converted content can be created in
Velocity
#set($apiListResponse = $core_v2_contentConversion.ListTargetApplications($sourceContentTypeId, $sourceContentId, $targetContentTypeId, $containerId, $query))
JavaScript
var 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 |
Returns
ListTargetContentTypes
Lists content types that source content can be converted to
Velocity
#set($apiListResponse = $core_v2_contentConversion.ListTargetContentTypes($sourceContentTypeId, $sourceContentId))
JavaScript
var 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 |