core_v2_contentConversion Script API

Ben Tiedt — Wed, 20 Nov 2019 14:53:32 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 14:53:32

Enables scripted content fragments to use content conversion

Convert
DynamicFormXml
ListTargetApplications
ListTargetContentTypes

Methods

Convert

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, $targetApplicationId, "%{  }"))

JavaScript

var contentResponse = core_v2_contentConversion.Convert(sourceContentTypeId, sourceContentId, targetContentTypeId, targetApplicationId, {  });

Parameters

Name	Type	Description	Required
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

Returns

[[Content Script API Type|Content]]

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
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
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

String

ListTargetApplications

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
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
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

[[ApiList Script API Type|ApiList]] of [[Application Script API Type|Application]]

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

Returns

[[ApiList Script API Type|ApiList]] of [[ContentType Script API Type|ContentType]]