core_v2_application Script API

Former Member — Thu, 02 Jun 2022 15:13:25 GMT

Current Revision posted to API Documentation by Former Member on 06/02/2022 15:13:25

Enables scripted content fragments to use applications

Properties

Name	Access	Type	Description
Current	Read	`[[Application Script API Type\|Application]]`	The current contextual application
CurrentInclusive	Read	`[[Application Script API Type\|Application]]`	The current contextual application. Includes containers that are also applications if a strict application is not available contextually.

Retrieve a specific application

#set($applicationResponse = $core_v2_application.Get($applicationId))

var applicationResponse = core_v2_application.Get(applicationId);

Name	Type	Description	Required	Default	Options
applicationId	`Guid`	Application Id	Required

Retrieve a specific application

#set($applicationResponse = $core_v2_application.Get($applicationId, $applicationTypeId))

var applicationResponse = core_v2_application.Get(applicationId, applicationTypeId);

Name	Type	Description	Required	Default	Options
applicationId	`Guid`	Application Id	Required
applicationTypeId	`Guid`	Application Type Id	Required

[[Application Script API Type|Application]]

Retrieves the first 50 applications within a container.

#set($apiListResponse = $core_v2_application.List($containerTypeId, $containerId))

var apiListResponse = core_v2_application.List(containerTypeId, containerId);

Name	Type	Description	Required	Default	Options
containerTypeId	`Guid`	Container Type Id	Required
containerId	`Guid`	Container Id	Required

Retrieves the first 50 applications within a container.

#set($apiListResponse = $core_v2_application.List($containerTypeId, $containerId, "%{ IsDeleted = $isDeletedArg, SearchText = $searchTextArg }"))

var apiListResponse = core_v2_application.List(containerTypeId, containerId, { IsDeleted: isDeletedArg, SearchText: searchTextArg });

Name	Type	Description	Required	Default
containerTypeId	`Guid`	Container Type Id	Required
containerId	`Guid`	Container Id	Required
options	Options	Set of optional parameters including:	Required
IsDeleted	`Boolean`	Return applications that are deleted	Optional	False
SearchText	`String`	Only return applications matching this text.	Optional

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

Retrieves applications within a container via searching.

#set($apiListResponse = $core_v2_application.Search($containerTypeId, $containerId, $searchText))

var apiListResponse = core_v2_application.Search(containerTypeId, containerId, searchText);

Name	Type	Description	Required
containerTypeId	`Guid`	Container Type Id	Required
containerId	`Guid`	Container Id	Required
searchText	`String`	Search Text	Required

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