Enables scripted content fragments to use applications
Properties
Name | Access | Type | Description |
---|---|---|---|
Current | Read | Application | The current contextual application |
CurrentInclusive | Read | Application | The current contextual application. Includes containers that are also applications if a strict application is not available contextually. |
Methods
Get
Get Overload 1
Retrieve a specific application
Velocity
#set($applicationResponse = $core_v2_application.Get($applicationId))
JavaScript
var applicationResponse = core_v2_application.Get(applicationId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
applicationId | Guid | Application Id | Required |
Get Overload 2
Retrieve a specific application
Velocity
#set($applicationResponse = $core_v2_application.Get($applicationId, $applicationTypeId))
JavaScript
var applicationResponse = core_v2_application.Get(applicationId, applicationTypeId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
applicationId | Guid | Application Id | Required | ||
applicationTypeId | Guid | Application Type Id | Required |
Returns
List
List Overload 1
Retrieves the first 50 applications within a container.
Velocity
#set($apiListResponse = $core_v2_application.List($containerTypeId, $containerId))
JavaScript
var apiListResponse = core_v2_application.List(containerTypeId, containerId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
containerTypeId | Guid | Container Type Id | Required | ||
containerId | Guid | Container Id | Required |
List Overload 2
Retrieves the first 50 applications within a container.
Velocity
#set($apiListResponse = $core_v2_application.List($containerTypeId, $containerId, "%{ IsDeleted = $isDeletedArg, SearchText = $searchTextArg }"))
JavaScript
var apiListResponse = core_v2_application.List(containerTypeId, containerId, { IsDeleted: isDeletedArg, SearchText: searchTextArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
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 |
Returns
Search
Retrieves applications within a container via searching.
Velocity
#set($apiListResponse = $core_v2_application.Search($containerTypeId, $containerId, $searchText))
JavaScript
var apiListResponse = core_v2_application.Search(containerTypeId, containerId, searchText);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
containerTypeId | Guid | Container Type Id | Required | ||
containerId | Guid | Container Id | Required | ||
searchText | String | Search Text | Required |