core_v3_feature Script API

Former Member — Fri, 13 May 2022 19:25:14 GMT

Current Revision posted to API Documentation by Former Member on 05/13/2022 19:25:14

Enables scripted content fragments to use Features

CanFeature
Create
Delete
Get
List
SupportsFeatures
Update

Methods

CanFeature

CanFeature Overload 1

Identifies if the accessing user can feature the specified content

Velocity

#set($booleanResponse = $core_v3_feature.CanFeature($contentId, $contentTypeId))

JavaScript

var booleanResponse = core_v3_feature.CanFeature(contentId, contentTypeId);

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required

CanFeature Overload 2

Identifies if the accessing user can feature the specified external content

Velocity

#set($booleanResponse = $core_v3_feature.CanFeature($contentUrl, $oauthClientId))

JavaScript

var booleanResponse = core_v3_feature.CanFeature(contentUrl, oauthClientId);

Parameters

Name	Type	Description	Required	Default	Options
contentUrl	`String`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required

Returns

Boolean

Create

Create Overload 1

Velocity

#set($featureResponse = $core_v3_feature.Create($contentId, $contentTypeId, "%{ EndDate = $endDateArg, FeatureTargets = $featureTargetsArg, FileData = $fileDataArg, FileName = $fileNameArg, FileUploadContext = $fileUploadContextArg, StartDate = $startDateArg, TypeId = $typeIdArg }"))

JavaScript

var featureResponse = core_v3_feature.Create(contentId, contentTypeId, { EndDate: endDateArg, FeatureTargets: featureTargetsArg, FileData: fileDataArg, FileName: fileNameArg, FileUploadContext: fileUploadContextArg, StartDate: startDateArg, TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
options	Options	Set of optional parameters including:	Required
EndDate	`DateTime`	End Date	Optional
FeatureTargets	`String`	Feature Targets	Optional
FileData	`String`	File Data. When adding an image either FileData or FileUploadContext is required.	Optional
FileName	`String`	File Name. Required when updating featured item using FileUploadContext. Optional parameter	Optional
FileUploadContext	`String`	File Upload Context. When adding an image either FileData or FileUploadContext is required. Optional parameter	Optional
StartDate	`DateTime`	Start Date	Optional
TypeId	`Int32`	Type Id	Optional

Create Overload 2

Velocity

#set($featureResponse = $core_v3_feature.Create($contentUrl, $oauthClientId, "%{ EndDate = $endDateArg, FeatureTargets = $featureTargetsArg, FileData = $fileDataArg, FileName = $fileNameArg, FileUploadContext = $fileUploadContextArg, StartDate = $startDateArg, TypeId = $typeIdArg }"))

JavaScript

var featureResponse = core_v3_feature.Create(contentUrl, oauthClientId, { EndDate: endDateArg, FeatureTargets: featureTargetsArg, FileData: fileDataArg, FileName: fileNameArg, FileUploadContext: fileUploadContextArg, StartDate: startDateArg, TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
contentUrl	`String`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required
options	Options	Set of optional parameters including:	Required
EndDate	`DateTime`	End Date	Optional
FeatureTargets	`String`	Feature Targets	Optional
FileData	`Array of Byte`	File Data. When adding an image either FileData or FileUploadContext is required. OBSOLETE in 12: Use FileUploadContext instead.	Optional
FileName	`String`	File Name. Required when updating featured item using FileUploadContext. Optional parameter	Optional
FileUploadContext	`String`	File Upload Context. When adding an image either FileData or FileUploadContext is required. Optional parameter	Optional
StartDate	`DateTime`	Start Date	Optional
TypeId	`Int32`	Type Id	Optional

Returns

[[Feature Script API Type|Feature]]

Delete

Delete Overload 1

Velocity

#set($additionalInfoResponse = $core_v3_feature.Delete($contentId, $contentTypeId, "%{}"))

JavaScript

var additionalInfoResponse = core_v3_feature.Delete(contentId, contentTypeId, {});

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
options	Options	Set of optional parameters including:	Required

Delete Overload 2

Velocity

#set($additionalInfoResponse = $core_v3_feature.Delete($contentUrl, $oauthClientId, "%{ TypeId = $typeIdArg }"))

JavaScript

var additionalInfoResponse = core_v3_feature.Delete(contentUrl, oauthClientId, { TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
contentUrl	`String`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required
options	Options	Set of optional parameters including:	Required
TypeId	`Int32`	Type Id	Optional

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

Get

Get Overload 1

Velocity

#set($featureResponse = $core_v3_feature.Get($contentId, $contentTypeId, "%{ TypeId = $typeIdArg }"))

JavaScript

var featureResponse = core_v3_feature.Get(contentId, contentTypeId, { TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
options	Options	Set of optional parameters including:	Required
TypeId	`Int32`	Type Id	Optional

Get Overload 2

Velocity

#set($featureResponse = $core_v3_feature.Get($contentUrl, $oauthClientId, "%{ TypeId = $typeIdArg }"))

JavaScript

var featureResponse = core_v3_feature.Get(contentUrl, oauthClientId, { TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
contentUrl	`String`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required
options	Options	Set of optional parameters including:	Required
TypeId	`Int32`	Type Id	Optional

Returns

[[Feature Script API Type|Feature]]

List

Velocity

#set($pagedListResponse = $core_v3_feature.List("%{ ApplicationId = $applicationIdArg, ContainerId = $containerIdArg, ContentId = $contentIdArg, ContentTypeIds = $contentTypeIdsArg, ContentUrl = $contentUrlArg, IncludeFutureDatedItems = $includeFutureDatedItemsArg, IncludeSubContainers = $includeSubContainersArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, TargetContainerId = $targetContainerIdArg, TypeId = $typeIdArg }"))

JavaScript

var pagedListResponse = core_v3_feature.List({ ApplicationId: applicationIdArg, ContainerId: containerIdArg, ContentId: contentIdArg, ContentTypeIds: contentTypeIdsArg, ContentUrl: contentUrlArg, IncludeFutureDatedItems: includeFutureDatedItemsArg, IncludeSubContainers: includeSubContainersArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, SortBy: sortByArg, SortOrder: sortOrderArg, TargetContainerId: targetContainerIdArg, TypeId: typeIdArg });

Parameters

Name	Type	Description	Required	Default	Options
options	Options	Set of optional parameters including:	Required
ApplicationId	`Guid`	Filter by content's application	Optional
ContainerId	`Guid`	Filter by content's group	Optional
ContentId	`Guid`	Content Id	Optional
ContentTypeIds	`String`	Comma delimited list of Content Type Ids to return	Optional
ContentUrl	`String`	Content Url	Optional
IncludeFutureDatedItems	`Boolean`	Include Future Dated Items	Optional
IncludeSubContainers	`Boolean`	Include sub container's of provided containerId	Optional	False
PageIndex	`Int32`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageSize	`Int32`	Specify the number of results to return per page.	Optional	5
SortBy	`String`	Sort By	Optional	FeatureDate	EndDate, FeatureDate, StartDate
SortOrder	`String`	Sort Order	Optional	Ascending	Ascending, Descending
TargetContainerId	`Guid`	Filter by container Feature will be displayed in	Optional
TypeId	`Guid`	Type Id	Optional

Returns

[[PagedList Script API Type|PagedList]] of [[Feature Script API Type|Feature]]

SupportsFeatures

Identifies if featuring is supported by the specified content type

Velocity

#set($booleanResponse = $core_v3_feature.SupportsFeatures($contentTypeId))

JavaScript

var booleanResponse = core_v3_feature.SupportsFeatures(contentTypeId);

Parameters

Name	Type	Description	Required	Default	Options
contentTypeId	`Guid`	Content Type Id	Required

Returns

Boolean

Update

Update Overload 1

Velocity

#set($featureResponse = $core_v3_feature.Update($contentId, $contentTypeId, "%{ EndDate = $endDateArg, FeatureTargets = $featureTargetsArg, FileData = $fileDataArg, FileName = $fileNameArg, FileUploadContext = $fileUploadContextArg, RemoveFeatureImage = $removeFeatureImageArg, StartDate = $startDateArg, TypeId = $typeIdArg }"))

JavaScript

var featureResponse = core_v3_feature.Update(contentId, contentTypeId, { EndDate: endDateArg, FeatureTargets: featureTargetsArg, FileData: fileDataArg, FileName: fileNameArg, FileUploadContext: fileUploadContextArg, RemoveFeatureImage: removeFeatureImageArg, StartDate: startDateArg, TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
options	Options	Set of optional parameters including:	Required
EndDate	`DateTime`	End Date	Optional
FeatureTargets	`String`	Feature Targets	Optional
FileData	`String`	File Data. When adding an image either FileData or FileUploadContext is required.	Optional
FileName	`String`	File Name. Required when updating featured item using FileUploadContext. Optional parameter	Optional
FileUploadContext	`String`	File Upload Context. When adding an image either FileData or FileUploadContext is required. Optional parameter	Optional
RemoveFeatureImage	`Boolean`	If, true existing featured image will be removed.	Optional
StartDate	`DateTime`	Start Date	Optional
TypeId	`Int32`	Type Id	Optional

Update Overload 2

Velocity

#set($featureResponse = $core_v3_feature.Update($contentUrl, $oauthClientId, "%{ EndDate = $endDateArg, FeatureTargets = $featureTargetsArg, FileData = $fileDataArg, FileName = $fileNameArg, FileUploadContext = $fileUploadContextArg, StartDate = $startDateArg, TypeId = $typeIdArg }"))

JavaScript

var featureResponse = core_v3_feature.Update(contentUrl, oauthClientId, { EndDate: endDateArg, FeatureTargets: featureTargetsArg, FileData: fileDataArg, FileName: fileNameArg, FileUploadContext: fileUploadContextArg, StartDate: startDateArg, TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
contentUrl	`String`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required
options	Options	Set of optional parameters including:	Required
EndDate	`DateTime`	End Date	Optional
FeatureTargets	`String`	Feature Targets	Optional
FileData	`Array of Byte`	File Data. When adding an image either FileData or FileUploadContext is required. OBSOLETE in 12: Use FileUploadContext instead.	Optional
FileName	`String`	File Name. Required when updating featured item using FileUploadContext. Optional parameter	Optional
FileUploadContext	`String`	File Upload Context. When adding an image either FileData or FileUploadContext is required. Optional parameter	Optional
StartDate	`DateTime`	Start Date	Optional
TypeId	`Int32`	Type Id	Optional

Returns

[[Feature Script API Type|Feature]]