Get Extension Applications
post
/config/sim/v2/setup/getExtensionApplications
Gets Extension Applications.
Request
Supported Media Types
- multipart/form-data
- application/json
The input body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, extensionAppId, name -
includeAll:
string
If this value is specified, the include parameter is ignored.
Value Description basic Forces the response to include all fields except option string details detailed Forces the response to include all fields including option string details Example:detailed -
langIds:
string
If specified, limits translated strings returned.Example:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index.Example:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order. Sorting is not supported for allowedAccessPaths.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria. Search is not supported for allowedAccessPaths.Example:
where equals(hierUnitId, 3599)
Response
Supported Media Types
- application/json
200 Response
A collection of Extension Applications.
Root Schema : schema
Type:
Show Source
object-
count:
integer
Current response record count.Example:
10 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Extension Application objects.
-
limit:
integer
Server page size.Example:
10 -
offset:
integer
Starting resource record index.Example:
0 -
totalResults:
integer
Total number of rows.Example:
100
Nested Schema : items
Type:
arrayArray of Extension Application objects.
Show Source
-
Array of:
object items
Extension Application record.
Nested Schema : items
Type:
objectExtension Application record.
Show Source
-
allowedAccessPaths:
array allowedAccessPaths
Allowed access paths for the Extension Application. Supported from Simphony 19.10.1 onwards. Search and orderBy are not supported for this field.
-
dataLevel:
integer
Default Value:
2Data level. Valid range is 0 to 2.Example:2 -
description:
object description
A group of string objects representing the description in configured languages.
-
extensionAppId:
integer
Unique reference of the Extension Application.Example:
101 -
hierUnitId:
integer
Unique hierarchy unit value.Example:
3599 -
interfaceId:
integer
Interface identifier.Example:
10 -
maxChars:
integer
Default Value:
200Maximum characters allowed. Valid range is 1 to 2000.Example:200 -
maxItems:
integer
Default Value:
1Maximum items allowed. Valid range is 1 to 100.Example:1 -
name:
string
Name of the Extension Application. Must be 1-200 characters and unique within the hierarchy unit.Example:
Loyalty Extension -
options:
string
Bit string of length 64 representing the Extension Application options.Example:
0000000000000000000000000000000000000000000000000000000000000000 -
optionsExt:
object optionsExt
Read-only object containing descriptive Extension Application options.
-
type:
integer
Type of the Extension Application. Valid range is 0 to 2.Example:
0
Nested Schema : allowedAccessPaths
Type:
arrayAllowed access paths for the Extension Application. Supported from Simphony 19.10.1 onwards. Search and orderBy are not supported for this field.
Show Source
Example:
[
"C://Simphony"
]Nested Schema : description
Type:
objectA group of string objects representing the description in configured languages.
Example:
{
"1":"Loyalty Extension",
"2":"Loyalty Extension"
}Nested Schema : optionsExt
Type:
objectRead-only object containing descriptive Extension Application options.
Show Source
-
allowReloadOfScriptsIfDllsArePresent:
boolean
Bit position 3. Indicates whether scripts can be reloaded when DLLs are present. For development only.
-
allowRemoteDebuggingOutput:
boolean
Bit position 4. Indicates whether remote debugging output is enabled.
-
allowRunningExtAppsOnApplicationServers:
boolean
Bit position 2. Indicates whether extension applications can run on application servers.
-
disableApplication:
boolean
Bit position 1. Indicates whether the application is disabled.
-
postExtAppDataToReportingAndAnalytics:
boolean
Bit position 5. Indicates whether extension application data is posted to Reporting and Analytics.