Dynamicweb Management API
Dynamicweb Management API
Dynamicweb.Application.UI.Commands
View SourceAddinInstallCommand
Request
POST /AddinInstall
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
AddinUninstallCommand
Request
POST /AddinUninstall
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ApiKeyDeleteCommand
Request
POST /ApiKeyDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ApiKeySaveCommand
Request
POST /ApiKeySave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
CacheClearingAddCommand
Request
POST /CacheClearingAdd
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
CacheClearingDeleteCommand
Request
POST /CacheClearingDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DatabaseDownloadCommand
Request
POST /DatabaseDownload
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DatabaseSettingsSaveCommand
Request
POST /DatabaseSettingsSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DeploymentDataGroupDeleteCommand
Request
POST /DeploymentDataGroupDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DeploymentDataGroupSaveCommand
Request
POST /DeploymentDataGroupSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DeploymentDataItemTypeDeleteCommand
Request
POST /DeploymentDataItemTypeDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DeploymentDataItemTypeSaveCommand
Request
POST /DeploymentDataItemTypeSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DeploymentDestinationDeleteCommand
Request
POST /DeploymentDestinationDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DeploymentDestinationExportCommand
Request
POST /DeploymentDestinationExport
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DeploymentDestinationSaveCommand
Request
POST /DeploymentDestinationSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DeploymentDestinationTransferCommand
Request
POST /DeploymentDestinationTransfer
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DeploymentDestinationVerifyCommand
Request
POST /DeploymentDestinationVerify
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
LicenseRefreshCommand
Request
POST /LicenseRefresh
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
LoadBalancingDeleteCommand
Request
POST /LoadBalancingDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
LoadBalancingSaveCommand
Request
POST /LoadBalancingSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ModuleDeleteCommand
Request
POST /ModuleDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ModuleSaveCommand
Request
POST /ModuleSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
SettingsSystemCDNSaveCommand
Request
POST /SettingsSystemCDNSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
SettingsSystemCustomizedURLsSaveCommand
Request
POST /SettingsSystemCustomizedURLsSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
SettingsSystemHTTPSaveCommand
Request
POST /SettingsSystemHTTPSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
SettingsSystemMailServerSaveCommand
Request
POST /SettingsSystemMailServerSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
SettingsSystemSecuritySaveCommand
Request
POST /SettingsSystemSecuritySave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
SettingsSystemTrackingSaveCommand
Request
POST /SettingsSystemTrackingSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
TranslationSaveCommand
Request
POST /TranslationSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
UnifiedPermissionSaveCommand
Request
POST /UnifiedPermissionSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ProductAttributeDifferentiationSaveCommand
Request
POST /ProductAttributeDifferentiationSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Application.UI.Commands.Repositories
View SourceBuildIndexCommand
Request
POST /BuildIndex
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
BuildIndexInstanceCommand
Request
POST /BuildIndexInstance
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
CopyFieldDefinitionSaveCommand
Request
POST /CopyFieldDefinitionSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ExtensionFieldDefinitionSaveCommand
Request
POST /ExtensionFieldDefinitionSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FacetDeleteCommand
Request
POST /FacetDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FacetGroupDeleteCommand
Request
POST /FacetGroupDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FacetGroupSaveCommand
Request
POST /FacetGroupSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FacetSaveCommand
Request
POST /FacetSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FacetSaveSortCommand
Request
POST /FacetSaveSort
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldDefinitionDeleteCommand
Request
POST /FieldDefinitionDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldDefinitionSaveCommand
Request
POST /FieldDefinitionSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldTypeDefinitionDeleteCommand
Request
POST /FieldTypeDefinitionDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldTypeDefinitionSaveCommand
Request
POST /FieldTypeDefinitionSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GroupingFieldDefinitionSaveCommand
Request
POST /GroupingFieldDefinitionSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GroupingFieldGroupDeleteCommand
Request
POST /GroupingFieldGroupDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GroupingFieldGroupSaveCommand
Request
POST /GroupingFieldGroupSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
IndexBuilderDeleteCommand
Request
POST /IndexBuilderDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
IndexBuilderSaveCommand
Request
POST /IndexBuilderSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
IndexDeleteCommand
Request
POST /IndexDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
IndexSaveCommand
Request
POST /IndexSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
IndexSearchConfigurationDeleteCommand
Request
POST /IndexSearchConfigurationDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
IndexSearchConfigurationRebuildIndexesCommand
Request
POST /IndexSearchConfigurationRebuildIndexes
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
IndexSearchConfigurationSaveCommand
Request
POST /IndexSearchConfigurationSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
InstanceDeleteCommand
Request
POST /InstanceDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
InstanceSaveCommand
Request
POST /InstanceSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
MyFavoriteQueryAddCommand
Request
POST /MyFavoriteQueryAdd
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
MyFavoriteQueryDetachCommand
Request
POST /MyFavoriteQueryDetach
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryCopyCommand
Request
POST /QueryCopy
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryDeleteCommand
Request
POST /QueryDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryExpressionDeleteCommand
Request
POST /QueryExpressionDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryExpressionSaveCommand
Request
POST /QueryExpressionSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryExpressionToggleDisabledCommand
Request
POST /QueryExpressionToggleDisabled
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryFolderDeleteCommand
Request
POST /QueryFolderDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryFolderSaveCommand
Request
POST /QueryFolderSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryGroupExpressionSaveCommand
Request
POST /QueryGroupExpressionSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryMoveCommand
Request
POST /QueryMove
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryParameterSaveCommand
Request
POST /QueryParameterSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryParametersDeleteCommand
Request
POST /QueryParametersDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QuerySaveCommand
Request
POST /QuerySave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QuerySortDeleteCommand
Request
POST /QuerySortDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QuerySortSaveCommand
Request
POST /QuerySortSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
RepositoryAddCommand
Request
POST /RepositoryAdd
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
RepositoryDeleteCommand
Request
POST /RepositoryDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
TaskDeleteCommand
Request
POST /TaskDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
TaskSaveCommand
Request
POST /TaskSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Application.UI.Commands.Settings
View SourceAssemblyDownloadCommand
Request
POST /AssemblyDownload
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GlobalSettingSaveCommand
Request
POST /GlobalSettingSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
SettingsSystemSolutionSettingsSaveCommand
Request
POST /SettingsSystemSolutionSettingsSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Application.UI.DynamicFields
View SourceDummyItemEntrySaveCommand
Request
POST /DummyItemEntrySave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Application.UI.Queries
View SourceAddinAllQuery
Request
GET /AddinAll[?AddinProvider&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AddinProvider | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
AddinByIdQuery
Request
GET /AddinById[?AddinName&AddinProvider&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AddinName | string | ||
AddinProvider | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
AddinInstalledQuery
Request
GET /AddinInstalled[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ApiKeyAllQuery
Request
GET /ApiKeyAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ApiKeyByIdQuery
Request
GET /ApiKeyById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
CommandByNameQuery
Request
GET /CommandByName[?Name&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Name | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
CommandLogAllQuery
Request
GET /CommandLogAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
CommandLogByIdQuery
Request
GET /CommandLogById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
CommandLogModelChangeByCommandLogIdQuery
Request
GET /CommandLogModelChangeByCommandLogId[?CommandLogId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
CommandLogId | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
CommandLogsByModelIdentifierAndModelTypeQuery
Request
GET /CommandLogsByModelIdentifierAndModelType[?ModelIdentifier&ModelTypeFullName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
ModelIdentifier | string | ||
ModelTypeFullName | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
CommandsAllQuery
Request
GET /CommandsAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ConfigurableAddInListQuery
Request
GET /ConfigurableAddInList[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ConfigurableAddInListByTypeQuery
Request
GET /ConfigurableAddInListByType[?AddInType&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AddInType | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ConfigurableAddInByTypeQuery
Request
GET /ConfigurableAddInByType[?AddInType&AddInParametersXml&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AddInType | string | ||
AddInParametersXml | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DatabaseFirehoseIndexByTableQuery
Request
GET /DatabaseFirehoseIndexByTable[?TableName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
TableName | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DatabaseFirehoseNewQuery
Request
GET /DatabaseFirehoseNew[?Query&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Query | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DatabaseFirehoseQuery
Request
GET /DatabaseFirehose[?ShadowEdit&Query&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
ShadowEdit | string | ||
Query | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DatabaseSettingsQuery
Request
GET /DatabaseSettings[?AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DeploymentComparisonDataItemByIdsQuery
Request
GET /DeploymentComparisonDataItemByIds[?DestinationId&DataGroupId&DataItemTypeId&DataItemId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
DestinationId | string | ||
DataGroupId | string | ||
DataItemTypeId | string | ||
DataItemId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DeploymentDataGroupByIdQuery
Request
GET /DeploymentDataGroupById[?Id&DestinationId&SelectedDataItemTypeIds&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
DestinationId | string | ||
SelectedDataItemTypeIds | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DeploymentDataGroupNewByParentIdQuery
Request
GET /DeploymentDataGroupNewByParentId[?ParentGroupId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
ParentGroupId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DeploymentDataGroupsQuery
Request
GET /DeploymentDataGroups[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DeploymentDataItemTypeByIdQuery
Request
GET /DeploymentDataItemTypeById[?DataItemTypeId&DataGroupId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
DataItemTypeId | string | ||
DataGroupId | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DeploymentDataItemTypeNewQuery
Request
GET /DeploymentDataItemTypeNew[?DataGroupId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
DataGroupId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DeploymentDataItemTypesByDataGroupIdQuery
Request
GET /DeploymentDataItemTypesByDataGroupId[?DataGroupId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
DataGroupId | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DeploymentDestinationByIdQuery
Request
GET /DeploymentDestinationById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DeploymentDestinationsQuery
Request
GET /DeploymentDestinations[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DeploymentDifferenceByIdsQuery
Request
GET /DeploymentDifferenceByIds[?DataGroupId&DestinationId&DataItemTypeId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
DataGroupId | string | ||
DestinationId | string | ||
DataItemTypeId | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DeploymentExportNewQuery
Request
GET /DeploymentExportNew[?Ids&DataGroupId&DataItemTypeId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Ids | string | ||
DataGroupId | string | ||
DataItemTypeId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GetMemoryCachesQuery
Request
GET /GetMemoryCaches[?PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GetServiceCachesByDataGroupIdQuery
Request
GET /GetServiceCachesByDataGroupId[?Id&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GetServiceCachesQuery
Request
GET /GetServiceCaches[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GetSessionCachesQuery
Request
GET /GetSessionCaches[?PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GetStaticTypeCachesQuery
Request
GET /GetStaticTypeCaches[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
LicenseFeaturesQuery
Request
GET /LicenseFeatures[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
LicenseLimitsQuery
Request
GET /LicenseLimits[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
LicenseQuery
Request
GET /License[?AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
LoadBalancingsByHostNameQuery
Request
GET /LoadBalancingsByHostName[?HostName&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
HostName | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
LoadBalancingsQuery
Request
GET /LoadBalancings[?PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
LogByFilePathQuery
Request
GET /LogByFilePath[?FilePath&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
FilePath | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
LogEventEntriesByFilePathQuery
Request
GET /LogEventEntriesByFilePath[?FilePath&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
FilePath | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
LogsByFilePathQuery
Request
GET /LogsByFilePath[?FilePath&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
FilePath | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ModuleByIdQuery
Request
GET /ModuleById[?ModuleId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
ModuleId | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ModuleNewQuery
Request
GET /ModuleNew[?AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ModulesAllQuery
Request
GET /ModulesAll[?SortColumnName&SortDirection&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
SortColumnName | string | ||
SortDirection | string | ||
PagingIndex | string | ||
PagingSize | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
PermissionByKeyQuery
Request
GET /PermissionByKey[?Key&Name&SubName&DisplayName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Key | string | ||
Name | string | ||
SubName | string | ||
DisplayName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueriesAllQuery
Request
GET /QueriesAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryByNameQuery
Request
GET /QueryByName[?Name&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Name | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ResultByShadowEditQuery
Request
GET /ResultByShadowEdit[?Command&ShadowEditId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Command | string | ||
ShadowEditId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ScreenConfigurationByUserQuery
Request
GET /ScreenConfigurationByUser[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
SelectorDataByProviderQuery
Request
GET /SelectorDataByProvider[?Provider&ProviderType&ColumnIndex&PreviousColumnValue&SelectedValues&MultiSelect&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Provider | string | ||
ProviderType | string | ||
ColumnIndex | string | ||
PreviousColumnValue | string | ||
SelectedValues | string | ||
MultiSelect | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
SettingsSystemCDNQuery
Request
GET /SettingsSystemCDN[?AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
SettingsSystemCustomizedURLsQuery
Request
GET /SettingsSystemCustomizedURLs[?AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
SettingsSystemHTTPQuery
Request
GET /SettingsSystemHTTP[?AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
SettingsSystemMailServerQuery
Request
GET /SettingsSystemMailServer[?AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
SettingsSystemSecurityQuery
Request
GET /SettingsSystemSecurity[?AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
SettingsSystemSolutionDetailsQuery
Request
GET /SettingsSystemSolutionDetails[?AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
SettingsSystemSolutionSettingsQuery
Request
GET /SettingsSystemSolutionSettings[?AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
SettingsSystemTrackingQuery
Request
GET /SettingsSystemTracking[?AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GlobalSettingsAllQuery
Request
GET /GlobalSettingsAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ShadowEditsQuery
Request
GET /ShadowEdits[?EditType&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
EditType | string | ||
PagingIndex | string | ||
PagingSize | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
TranslationsByDesignPathQuery
Request
GET /TranslationsByDesignPath[?DesignPath&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
DesignPath | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
TranslationsByKeyAndDesignPathQuery
Request
GET /TranslationsByKeyAndDesignPath[?DesignPath&Key&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
DesignPath | string | ||
Key | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
TranslationsGlobalQuery
Request
GET /TranslationsGlobal[?DesignPath&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
DesignPath | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
UnifiedPermissionByIdQuery
Request
GET /UnifiedPermissionById[?Key&Name&SubName&UserId&AvailableLevels&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Key | string | ||
Name | string | ||
SubName | string | ||
UserId | string | ||
AvailableLevels | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
UnifiedPermissionsByKeysQuery
Request
GET /UnifiedPermissionsByKeys[?PermissionKey&PermissionName&PermissionSubName&AvailableLevels&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
PermissionKey | string | ||
PermissionName | string | ||
PermissionSubName | string | ||
AvailableLevels | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
UnifiedPermissionsBySectionQuery
Request
GET /UnifiedPermissionsBySection[?GroupID&Section&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
GroupID | string | ||
Section | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Application.UI.Queries.Repositories
View SourceCopyFieldDefinitionNewQuery
Request
GET /CopyFieldDefinitionNew[?Repository&IndexName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ExtensionFieldDefinitionNewQuery
Request
GET /ExtensionFieldDefinitionNew[?Repository&IndexName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FacetByIdQuery
Request
GET /FacetById[?Repository&FacetGroupName&Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
FacetGroupName | string | ||
Id | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FacetGroupByNameQuery
Request
GET /FacetGroupByName[?Repository&Name&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
Name | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FacetGroupNewQuery
Request
GET /FacetGroupNew[?Repository&Query&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
Query | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FacetNewQuery
Request
GET /FacetNew[?Repository&FacetGroupName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
FacetGroupName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FacetsByGroupQuery
Request
GET /FacetsByGroup[?Repository&FacetGroupName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
FacetGroupName | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FacetSortListQuery
Request
GET /FacetSortList[?Repository&FacetGroupName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
FacetGroupName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FavoriteQueriesQuery
Request
GET /FavoriteQueries[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldDefinitionBasesByRepositoryAndIndexNameQuery
Request
GET /FieldDefinitionBasesByRepositoryAndIndexName[?Repository&IndexName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldDefinitionBySystemNameRepositoryAndIndexNameQuery
Request
GET /FieldDefinitionBySystemNameRepositoryAndIndexName[?Repository&IndexName&SystemName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
SystemName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
CopyFieldDefinitionBySystemNameRepositoryAndIndexNameQuery
Request
GET /CopyFieldDefinitionBySystemNameRepositoryAndIndexName[?Repository&IndexName&SystemName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
SystemName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GroupingFieldDefinitionBySystemNameRepositoryAndIndexNameQuery
Request
GET /GroupingFieldDefinitionBySystemNameRepositoryAndIndexName[?Repository&IndexName&SystemName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
SystemName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ExtensionFieldDefinitionBySystemNameRepositoryAndIndexNameQuery
Request
GET /ExtensionFieldDefinitionBySystemNameRepositoryAndIndexName[?Repository&IndexName&SystemName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
SystemName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldDefinitionNewQuery
Request
GET /FieldDefinitionNew[?Repository&IndexName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldDefinitionTypesQuery
Request
GET /FieldDefinitionTypes[?Repository&IndexName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldTypeDefinitionByIdRepositoryAndIndexNameQuery
Request
GET /FieldTypeDefinitionByIdRepositoryAndIndexName[?Id&Repository&IndexName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
Repository | string | ||
IndexName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldTypeDefinitionNewQuery
Request
GET /FieldTypeDefinitionNew[?Repository&IndexName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldTypeDefinitionsByRepositoryAndIndexNameQuery
Request
GET /FieldTypeDefinitionsByRepositoryAndIndexName[?Repository&IndexName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GroupingFieldDefinitionNewQuery
Request
GET /GroupingFieldDefinitionNew[?Repository&IndexName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GroupingFieldGroupByIdAndParentInfoQuery
Request
GET /GroupingFieldGroupByIdAndParentInfo[?Repository&IndexName&ParentFieldSystemName&Id&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
ParentFieldSystemName | string | ||
Id | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GroupingFieldGroupNewQuery
Request
GET /GroupingFieldGroupNew[?Repository&IndexName&ParentFieldSystemName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
ParentFieldSystemName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GroupingFieldGroupsByFieldSystemNameQuery
Request
GET /GroupingFieldGroupsByFieldSystemName[?Repository&IndexName&SystemName&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
SystemName | string | ||
PagingIndex | string | ||
PagingSize | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
IndexBuilderByNameQuery
Request
GET /IndexBuilderByName[?Repository&IndexName&Name&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
Name | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
IndexBuilderNewQuery
Request
GET /IndexBuilderNew[?Repository&IndexName&AssemblyQualifiedName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
AssemblyQualifiedName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
IndexBuildersByRepositoryAndIndexNameQuery
Request
GET /IndexBuildersByRepositoryAndIndexName[?Repository&IndexName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
IndexByRepositoryAndNameQuery
Request
GET /IndexByRepositoryAndName[?Repository&IndexName&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
IndexInstancesByRepositoryAndIndexQuery
Request
GET /IndexInstancesByRepositoryAndIndex[?RepositoryName&IndexName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
RepositoryName | string | ||
IndexName | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
IndexNewQuery
Request
GET /IndexNew[?Repository&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
IndexSearchConfigurationByNameQuery
Request
GET /IndexSearchConfigurationByName[?Name&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Name | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
IndexSearchConfigurationFieldsByConfigurationNameQuery
Request
GET /IndexSearchConfigurationFieldsByConfigurationName[?Name&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Name | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
IndexSearchConfigurationsQuery
Request
GET /IndexSearchConfigurations[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
IndexStatusByRepositoryAndIndexNameQuery
Request
GET /IndexStatusByRepositoryAndIndexName[?Repository&IndexName&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
IndexStatusesAllQuery
Request
GET /IndexStatusesAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
IndexStatusesByRepositoryQuery
Request
GET /IndexStatusesByRepository[?RepositoryName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
RepositoryName | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
InstanceByRepositoryIndexAndNameQuery
Request
GET /InstanceByRepositoryIndexAndName[?Repository&IndexName&InstanceName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
InstanceName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
InstanceNewQuery
Request
GET /InstanceNew[?Repository&IndexName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
InstanceStatusesByRepositoryAndIndexNameQuery
Request
GET /InstanceStatusesByRepositoryAndIndexName[?Repository&IndexName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
IndexName | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueriesByFolderQuery
Request
GET /QueriesByFolder[?FolderPath&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
FolderPath | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueriesByRepositoryAndIndexNameQuery
Request
GET /QueriesByRepositoryAndIndexName[?RepositoryName&IndexName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
RepositoryName | string | ||
IndexName | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueriesByRepositoryQuery
Request
GET /QueriesByRepository[?RepositoryName&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
RepositoryName | string | ||
PagingIndex | string | ||
PagingSize | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryByIdQuery
Request
GET /QueryById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryExpressionByQueryIdAndPathQuery
Request
GET /QueryExpressionByQueryIdAndPath[?QueryId&Path&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
QueryId | string | ||
Path | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryExpressionNewQuery
Request
GET /QueryExpressionNew[?QueryId&Path&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
QueryId | string | ||
Path | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryExpressionsByQueryIdQuery
Request
GET /QueryExpressionsByQueryId[?QueryId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
QueryId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryFolderByNameQuery
Request
GET /QueryFolderByName[?Name&ParentPath&IsSharedQueries&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Name | string | ||
ParentPath | string | ||
IsSharedQueries | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryGroupExpressionByQueryIdAndPathQuery
Request
GET /QueryGroupExpressionByQueryIdAndPath[?QueryId&Path&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
QueryId | string | ||
Path | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryGroupExpressionNewQuery
Request
GET /QueryGroupExpressionNew[?QueryId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
QueryId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryNewQuery
Request
GET /QueryNew[?FolderPath&Repository&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
FolderPath | string | ||
Repository | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryParameterByQueryIdAndNameQuery
Request
GET /QueryParameterByQueryIdAndName[?Id&Name&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
Name | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryParameterNewQuery
Request
GET /QueryParameterNew[?QueryId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
QueryId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QueryParametersByQueryIdQuery
Request
GET /QueryParametersByQueryId[?Id&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QuerySortByIndexSearchConfigurationNameAndFieldNameQuery
Request
GET /QuerySortByIndexSearchConfigurationNameAndFieldName[?Name&FieldName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Name | string | ||
FieldName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QuerySortByIndexSearchConfigurationNameQuery
Request
GET /QuerySortByIndexSearchConfigurationName[?Name&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Name | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QuerySortByQueryIdAndFieldNameQuery
Request
GET /QuerySortByQueryIdAndFieldName[?QueryId&FieldName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
QueryId | string | ||
FieldName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QuerySortByQueryIdQuery
Request
GET /QuerySortByQueryId[?QueryId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
QueryId | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
QuerySortNewQuery
Request
GET /QuerySortNew[?ParentId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
ParentId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
RepositoryInfoByNameQuery
Request
GET /RepositoryInfoByName[?RepositoryName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
RepositoryName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
TaskByRepositoryAndNameQuery
Request
GET /TaskByRepositoryAndName[?RepositoryName&Name&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
RepositoryName | string | ||
Name | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
TaskNewQuery
Request
GET /TaskNew[?Repository&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Repository | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
TasksByRepositoryAndIndexNameQuery
Request
GET /TasksByRepositoryAndIndexName[?RepositoryName&IndexName&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
RepositoryName | string | ||
IndexName | string | ||
PagingIndex | string | ||
PagingSize | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
TasksByRepositoryQuery
Request
GET /TasksByRepository[?RepositoryName&SortColumnName&SortDirection&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
RepositoryName | string | ||
SortColumnName | string | ||
SortDirection | string | ||
PagingIndex | string | ||
PagingSize | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Application.UI.Queries.Settings
View SourceAddInClassesByTypeQuery
Request
GET /AddInClassesByType[?AddInTypeName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AddInTypeName | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
AssembliesAllQuery
Request
GET /AssembliesAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GlobalSettingByKeyQuery
Request
GET /GlobalSettingByKey[?Key&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Key | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Application.UI.TreeNavigation
View SourceNavigationByPathQuery
Request
GET /NavigationByPath[?Path&OpenTo&DisplayState&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Path | string | ||
OpenTo | string | ||
DisplayState | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Apps.UI.Commands.DataPortability
View SourceDataDefinitionDeleteCommand
Request
POST /DataDefinitionDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DataDefinitionSaveCommand
Request
POST /DataDefinitionSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DataGroupDeleteCommand
Request
POST /DataGroupDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DataGroupSaveCommand
Request
POST /DataGroupSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DataItemTypeDeleteCommand
Request
POST /DataItemTypeDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DataItemTypeSaveCommand
Request
POST /DataItemTypeSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Apps.UI.Commands.DataProcessing
View SourceActivityDeleteCommand
Request
POST /ActivityDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ActivitySaveCommand
Request
POST /ActivitySave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ConsentDeleteCommand
Request
POST /ConsentDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Apps.UI.Commands.Forms
View SourceAreaTemplateSetSaveCommand
Request
POST /AreaTemplateSetSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldCopyCommand
Request
POST /FieldCopy
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldDeleteCommand
Request
POST /FieldDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldSaveCommand
Request
POST /FieldSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldToggleActiveCommand
Request
POST /FieldToggleActive
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldToggleRequiredCommand
Request
POST /FieldToggleRequired
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FormCopyCommand
Request
POST /FormCopy
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FormDeleteCommand
Request
POST /FormDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FormSettingsSaveCommand
Request
POST /FormSettingsSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
SubmitDeleteCommand
Request
POST /SubmitDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Apps.UI.Queries.DataPortability
View SourceDataDefinitionByIdQuery
Request
GET /DataDefinitionById[?Id&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DataDefinitionNewQuery
Request
GET /DataDefinitionNew[?AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DataGroupByIdAndDefinitionIdQuery
Request
GET /DataGroupByIdAndDefinitionId[?Id&DefinitionId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
DefinitionId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DataGroupNewQuery
Request
GET /DataGroupNew[?DefinitionId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
DefinitionId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DataItemTypeByIdAndParentInfoQuery
Request
GET /DataItemTypeByIdAndParentInfo[?DefinitionId&GroupId&Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
DefinitionId | string | ||
GroupId | string | ||
Id | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DataItemTypeNewQuery
Request
GET /DataItemTypeNew[?DefinitionId&GroupId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
DefinitionId | string | ||
GroupId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DataItemTypesByParentInfoQuery
Request
GET /DataItemTypesByParentInfo[?DefinitionId&GroupId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
DefinitionId | string | ||
GroupId | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Apps.UI.Queries.DataProcessing
View SourceActivitiesByFilterQuery
Request
GET /ActivitiesByFilter[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ActivityByIdQuery
Request
GET /ActivityById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ActivityNewQuery
Request
GET /ActivityNew[?AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ConsentByParameretsQuery
Request
GET /ConsentByParamerets[?ActivityId&SubjectId&SubjectType&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
ActivityId | string | ||
SubjectId | string | ||
SubjectType | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ConsentsByFilterQuery
Request
GET /ConsentsByFilter[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Apps.UI.Queries.Forms
View SourceAreaTemplateSetByAreaIdQuery
Request
GET /AreaTemplateSetByAreaId[?AreaId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AreaId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldByIdQuery
Request
GET /FieldById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldNewQuery
Request
GET /FieldNew[?FormId&FieldType&SortForNewField&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
FormId | string | ||
FieldType | string | ||
SortForNewField | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldsByFormIdQuery
Request
GET /FieldsByFormId[?FormId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
FormId | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldTypesQuery
Request
GET /FieldTypes[?FormId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
FormId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FormByIdQuery
Request
GET /FormById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FormNewQuery
Request
GET /FormNew[?AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FormsAllQuery
Request
GET /FormsAll[?PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
PagingIndex | string | ||
PagingSize | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
SubmitByIdQuery
Request
GET /SubmitById[?Id&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
SubmitDataBySubmitIdQuery
Request
GET /SubmitDataBySubmitId[?SubmitId&IncludeDebugInfo&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
SubmitId | string | ||
IncludeDebugInfo | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
SubmitDataDebugInfoBySubmitIdQuery
Request
GET /SubmitDataDebugInfoBySubmitId[?SubmitId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
SubmitId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
SubmitsByFormIdQuery
Request
GET /SubmitsByFormId[?FormId&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
FormId | string | ||
PagingIndex | string | ||
PagingSize | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Content.UI.Commands
View SourceAreaCopyCommand
Request
POST /AreaCopy
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
AreaDeleteCommand
Request
POST /AreaDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
AreaSaveCommand
Request
POST /AreaSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
AreasSaveSortCommand
Request
POST /AreasSaveSort
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
AreaToggleActiveCommand
Request
POST /AreaToggleActive
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ColorSwatchSaveCommand
Request
POST /ColorSwatchSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ExportSettingsSaveCommand
Request
POST /ExportSettingsSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FolderSaveCommand
Request
POST /FolderSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GridRowSaveSortCommand
Request
POST /GridRowSaveSort
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ImportSettingsSaveCommand
Request
POST /ImportSettingsSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
PageCopyCommand
Request
POST /PageCopy
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
PageCreateCommand
Request
POST /PageCreate
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
PageDeleteCommand
Request
POST /PageDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
PageMoveCommand
Request
POST /PageMove
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
PagePublicationStateChangeCommand
Request
POST /PagePublicationStateChange
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
PageSaveCommand
Request
POST /PageSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
PageTemplateSaveCommand
Request
POST /PageTemplateSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ParagraphBulkCopyCommand
Request
POST /ParagraphBulkCopy
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ParagraphChangeActiveCommand
Request
POST /ParagraphChangeActive
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ParagraphCopyCommand
Request
POST /ParagraphCopy
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ParagraphDeleteCommand
Request
POST /ParagraphDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ParagraphMoveCommand
Request
POST /ParagraphMove
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ParagraphSaveCommand
Request
POST /ParagraphSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ParagraphSaveSortCommand
Request
POST /ParagraphSaveSort
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ParagraphTemplateSaveCommand
Request
POST /ParagraphTemplateSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ShortcutCreateCommand
Request
POST /ShortcutCreate
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Content.UI.Commands.Settings
View SourceLanguageSettingsSaveCommand
Request
POST /LanguageSettingsSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Content.UI.Commands.Settings.Editing
View SourceInterfaceSettingsSaveCommand
Request
POST /InterfaceSettingsSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
WorkflowDeleteCommand
Request
POST /WorkflowDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
WorkflowSaveCommand
Request
POST /WorkflowSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
WorkflowUserDeleteCommand
Request
POST /WorkflowUserDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
WorkflowUserSaveCommand
Request
POST /WorkflowUserSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Content.UI.Commands.Settings.ItemTypes
View SourceItemCategoryDeleteCommand
Request
POST /ItemCategoryDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemFieldDeleteCommand
Request
POST /ItemFieldDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemFieldGroupDeleteCommand
Request
POST /ItemFieldGroupDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemFieldGroupSaveCommand
Request
POST /ItemFieldGroupSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemFieldGroupSaveSortCommand
Request
POST /ItemFieldGroupSaveSort
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemFieldSaveCommand
Request
POST /ItemFieldSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemFieldSaveSortCommand
Request
POST /ItemFieldSaveSort
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemTypeCopyCommand
Request
POST /ItemTypeCopy
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemTypeDeleteCommand
Request
POST /ItemTypeDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemTypeListReloadCommand
Request
POST /ItemTypeListReload
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemTypeSaveCommand
Request
POST /ItemTypeSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemTypeSettingsSaveCommand
Request
POST /ItemTypeSettingsSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Content.UI.Commands.Settings.ItemTypes.FieldOptions
View SourceFieldOptionMetadataCopyCommand
Request
POST /FieldOptionMetadataCopy
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldOptionMetadataDeleteCommand
Request
POST /FieldOptionMetadataDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldOptionMetadataSaveCommand
Request
POST /FieldOptionMetadataSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldOptionMetadataSaveSortCommand
Request
POST /FieldOptionMetadataSaveSort
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Content.UI.Commands.VisualEditor
View SourceGridColumnCreateCommand
Request
POST /GridColumnCreate
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GridColumnSortCommand
Request
POST /GridColumnSort
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GridColumnUnlinkCommand
Request
POST /GridColumnUnlink
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GridLinkSaveCommand
Request
POST /GridLinkSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GridRowCopyCommand
Request
POST /GridRowCopy
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GridRowCreateCommand
Request
POST /GridRowCreate
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GridRowDeleteCommand
Request
POST /GridRowDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GridRowPublishCommand
Request
POST /GridRowPublish
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GridRowSaveCommand
Request
POST /GridRowSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GridRowSortCommand
Request
POST /GridRowSort
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GridRowTemplateSaveCommand
Request
POST /GridRowTemplateSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Content.UI.Queries
View SourceAddinDependenciesQuery
Request
GET /AddinDependencies[?Package&Provider&Version&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Package | string | ||
Provider | string | ||
Version | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
AreasSortListQuery
Request
GET /AreasSortList[?MasterAreaId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
MasterAreaId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ColorSwatchByAreaIdQuery
Request
GET /ColorSwatchByAreaId[?AreaId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AreaId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GetAreaByIdQuery
Request
GET /GetAreaById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GetAreaSettingsByAreaQuery
Request
GET /GetAreaSettingsByArea[?AreaId&ItemType&FileName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AreaId | string | ||
ItemType | string | ||
FileName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GetAreasQuery
Request
GET /GetAreas[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GetFolderByIdQuery
Request
GET /GetFolderById[?Id&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GetPageByIdQuery
Request
GET /GetPageById[?Id&IsVisualEditor&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
IsVisualEditor | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GetPagesByAreaIdQuery
Request
GET /GetPagesByAreaId[?AreaId&ModifiedAfter&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AreaId | string | ||
ModifiedAfter | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GetPagesByParentQuery
Request
GET /GetPagesByParent[?ParentID&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
ParentID | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GetParagraphsByAreaIdQuery
Request
GET /GetParagraphsByAreaId[?AreaId&ModifiedAfter&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AreaId | string | ||
ModifiedAfter | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GetParagraphByIdQuery
Request
GET /GetParagraphById[?Id&IsVisualEditor&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
IsVisualEditor | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GetParagraphsByCreationUserQuery
Request
GET /GetParagraphsByCreationUser[?UserId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
UserId | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GetParagraphsByPageIdQuery
Request
GET /GetParagraphsByPageId[?PageId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
PageId | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GridRowByIdQuery
Request
GET /GridRowById[?Id&IsVisualEditor&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
IsVisualEditor | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GridRowSelectorByPageQuery
Request
GET /GridRowSelectorByPage[?PageId&SortIndex&Container&Category&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
PageId | string | ||
SortIndex | string | ||
Container | string | ||
Category | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GridRowSortListQuery
Request
GET /GridRowSortList[?PageId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
PageId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GridRowTemplateNewQuery
Request
GET /GridRowTemplateNew[?Id&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
NewAreaQuery
Request
GET /NewArea[?SourceAreaId&Name&AsWebsite&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
SourceAreaId | string | ||
Name | string | ||
AsWebsite | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
NewFolderQuery
Request
GET /NewFolder[?AreaId&ParentId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AreaId | string | ||
ParentId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
NewPageInfoForCopyQuery
Request
GET /NewPageInfoForCopy[?SourcePageId&DestinationParentPageId&DestinationAreaId&CopyHere&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
SourcePageId | string | ||
DestinationParentPageId | string | ||
DestinationAreaId | string | ||
CopyHere | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
NewPageInfoForMoveQuery
Request
GET /NewPageInfoForMove[?SourcePageId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
SourcePageId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
NewPageQuery
Request
GET /NewPage[?AreaId&ParentId&PageType&TemplateId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AreaId | string | ||
ParentId | string | ||
PageType | string | ||
TemplateId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
PageSelectorByPathQuery
Request
GET /PageSelectorByPath[?Path&OpenTo&DisplayState&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Path | string | ||
OpenTo | string | ||
DisplayState | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
PageTemplateNewQuery
Request
GET /PageTemplateNew[?PageId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
PageId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
PageTypeListByAreaAndParentQuery
Request
GET /PageTypeListByAreaAndParent[?AreaId&ParentId&Category&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AreaId | string | ||
ParentId | string | ||
Category | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ParagraphDefinitionsByPageQuery
Request
GET /ParagraphDefinitionsByPage[?PageId&RowId&Position&Category&Container&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
PageId | string | ||
RowId | string | ||
Position | string | ||
Category | string | ||
Container | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ParagraphNavigationByPathQuery
Request
GET /ParagraphNavigationByPath[?Path&OpenTo&DisplayState&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Path | string | ||
OpenTo | string | ||
DisplayState | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ParagraphNewQuery
Request
GET /ParagraphNew[?PageId&Container&ParagraphType&TemplateId&RowId&Position&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
PageId | string | ||
Container | string | ||
ParagraphType | string | ||
TemplateId | string | ||
RowId | string | ||
Position | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ParagraphSortListQuery
Request
GET /ParagraphSortList[?PageId&GridRowId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
PageId | string | ||
GridRowId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ParagraphTemplateByIdQuery
Request
GET /ParagraphTemplateById[?TemplateId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
TemplateId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ParagraphTemplateNewQuery
Request
GET /ParagraphTemplateNew[?ParagraphId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
ParagraphId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Content.UI.Queries.Settings
View SourceGetLanguageSettingsQuery
Request
GET /GetLanguageSettings[?AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Content.UI.Queries.Settings.Editing
View SourceGetInterfaceSettingsQuery
Request
GET /GetInterfaceSettings[?AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
WorkflowByIdQuery
Request
GET /WorkflowById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
WorkflowsAllQuery
Request
GET /WorkflowsAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
WorkflowUserByIdQuery
Request
GET /WorkflowUserById[?Id&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
WorkflowUserNewQuery
Request
GET /WorkflowUserNew[?WorkflowId&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
WorkflowId | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
WorkflowUsersByWorkflowIdQuery
Request
GET /WorkflowUsersByWorkflowId[?WorkflowId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
WorkflowId | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Content.UI.Queries.Settings.ItemTypes
View SourceItemFieldBySystemNameAndItemTypeQuery
Request
GET /ItemFieldBySystemNameAndItemType[?SystemName&ItemTypeSystemName&MakeCopy&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
SystemName | string | ||
ItemTypeSystemName | string | ||
MakeCopy | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemFieldGroupByItemTypeSystemNameAndSystemNameQuery
Request
GET /ItemFieldGroupByItemTypeSystemNameAndSystemName[?ItemTypeSystemName&SystemName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
ItemTypeSystemName | string | ||
SystemName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemFieldGroupNewQuery
Request
GET /ItemFieldGroupNew[?ItemTypeSystemName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
ItemTypeSystemName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemFieldGroupSortListQuery
Request
GET /ItemFieldGroupSortList[?ItemTypeSystemName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
ItemTypeSystemName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemFieldNewQuery
Request
GET /ItemFieldNew[?ItemTypeSystemName&ItemFieldGroupSystemName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
ItemTypeSystemName | string | ||
ItemFieldGroupSystemName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemFieldsByItemTypeSystemNameAndGroupSystemNameQuery
Request
GET /ItemFieldsByItemTypeSystemNameAndGroupSystemName[?SystemName&GroupSystemName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
SystemName | string | ||
GroupSystemName | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemFieldsByItemTypeSystemNameQuery
Request
GET /ItemFieldsByItemTypeSystemName[?SystemName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
SystemName | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemFieldSortListQuery
Request
GET /ItemFieldSortList[?ItemTypeSystemName&GroupSystemName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
ItemTypeSystemName | string | ||
GroupSystemName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemSettingsQuery
Request
GET /ItemSettings[?AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemTypeAllQuery
Request
GET /ItemTypeAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemTypeByCategoryQuery
Request
GET /ItemTypeByCategory[?Category&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Category | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemTypeByIdQuery
Request
GET /ItemTypeById[?SystemName&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
SystemName | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemTypeCopyInfoBySystemNameQuery
Request
GET /ItemTypeCopyInfoBySystemName[?SystemName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
SystemName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemTypeNewQuery
Request
GET /ItemTypeNew[?Category&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Category | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemTypeRestrictionsByIdQuery
Request
GET /ItemTypeRestrictionsById[?SystemName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
SystemName | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ItemTypeUsagesBySystemNameQuery
Request
GET /ItemTypeUsagesBySystemName[?SystemName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
SystemName | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Content.UI.Queries.Settings.ItemTypes.FieldOptions
View SourceFieldOptionMetadataByFieldIdAndSourceTypeQuery
Request
GET /FieldOptionMetadataByFieldIdAndSourceType[?ItemTypeSystemName&ItemFieldSystemName&OptionSourceType&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
ItemTypeSystemName | string | ||
ItemFieldSystemName | string | ||
OptionSourceType | string | ||
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldOptionMetadataByIdQuery
Request
GET /FieldOptionMetadataById[?ItemTypeSystemName&ItemFieldSystemName&Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
ItemTypeSystemName | string | ||
ItemFieldSystemName | string | ||
Id | string | ||
ModelIdentifier | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldOptionMetadataNewQuery
Request
GET /FieldOptionMetadataNew[?ItemTypeSystemName&ItemFieldSystemName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
ItemTypeSystemName | string | ||
ItemFieldSystemName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FieldOptionMetadataSortListQuery
Request
GET /FieldOptionMetadataSortList[?ItemTypeSystemName&ItemFieldSystemName&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
ItemTypeSystemName | string | ||
ItemFieldSystemName | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.CoreUI.Data.ScreenConfiguration
View SourceScreenConfigurationQuery
Request
GET /ScreenConfiguration[?ViewTypeName&ConfigurableScreenType&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
ViewTypeName | string | ||
ConfigurableScreenType | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ScreenConfigurationSaveCommand
Request
POST /ScreenConfigurationSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.CoreUI.Lists
View SourceListSelectionModelQuery
Request
GET /ListSelectionModel[?AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.CoreUI.Screens.Implementations
View SourceMultiEditByQueryQuery
Request
GET /MultiEditByQuery[?ScreenName&QueryName&QueryProperty&QueryValues&InfoBarQueryValue&UseInfoBarFromFirstScreen&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
ScreenName | string | ||
QueryName | string | ||
QueryProperty | string | ||
QueryValues | string | ||
InfoBarQueryValue | string | ||
UseInfoBarFromFirstScreen | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Demo.UI.Commands
View SourceTestListItemRenameCommand
Request
POST /TestListItemRename
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
TestListItemsDeleteCommand
Request
POST /TestListItemsDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Demo.UI.Implementations
View SourceScreenImplementationsAllQuery
Request
GET /ScreenImplementationsAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Demo.UI.Queries
View SourceIconsQuery
Request
GET /Icons[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
KnownIconsQuery
Request
GET /KnownIcons[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Filter | string | ||
Search | string | ||
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
TestListItemAllQuery
Request
GET /TestListItemAll[?PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
PagingIndex | string | ||
PagingSize | string | ||
SortColumnName | string | ||
SortDirection | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
TestListItemByIdQuery
Request
GET /TestListItemById[?Id&AccessLevel]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
Id | string | ||
AccessLevel | string | Permission level which is required to get models |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Ecommerce.UI.Commands
View SourceAddressValidatorDeleteCommand
Request
POST /AddressValidatorDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
AddressValidatorSaveCommand
Request
POST /AddressValidatorSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
AddressValidatorToggleActiveCommand
Request
POST /AddressValidatorToggleActive
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FeeDeleteCommand
Request
POST /FeeDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FeeRuleSaveCommand
Request
POST /FeeRuleSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FeeRuleToggleActiveCommand
Request
POST /FeeRuleToggleActive
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FeeSaveCommand
Request
POST /FeeSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FutureDeliveryCancelCommand
Request
POST /FutureDeliveryCancel
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
FutureDeliveryRestoreCommand
Request
POST /FutureDeliveryRestore
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderCancelRecurringCommand
Request
POST /OrderCancelRecurring
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderCaptureBulkCommand
Request
POST /OrderCaptureBulk
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderCaptureCommand
Request
POST /OrderCapture
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderChangeOrderStateCommand
Request
POST /OrderChangeOrderState
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderCreateShippingDocumentsCommand
Request
POST /OrderCreateShippingDocuments
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderDeleteCommand
Request
POST /OrderDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderFieldDeleteCommand
Request
POST /OrderFieldDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderFieldSaveCommand
Request
POST /OrderFieldSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderFlowDeleteCommand
Request
POST /OrderFlowDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderFlowSaveCommand
Request
POST /OrderFlowSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderAddDiscountCommand
Request
POST /OrderAddDiscount
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderLineAddProductCommand
Request
POST /OrderLineAddProduct
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderLineDeleteCommand
Request
POST /OrderLineDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderLineFieldDeleteCommand
Request
POST /OrderLineFieldDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderLineFieldSaveCommand
Request
POST /OrderLineFieldSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderLineSaveCommand
Request
POST /OrderLineSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderSaveCommand
Request
POST /OrderSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderStateDeleteCommand
Request
POST /OrderStateDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderStateSaveCommand
Request
POST /OrderStateSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
PaymentDeleteCommand
Request
POST /PaymentDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
PaymentSaveCommand
Request
POST /PaymentSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
PaymentToggleActiveCommand
Request
POST /PaymentToggleActive
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
RmaCloseCommand
Request
POST /RmaClose
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
RmaDeleteCommand
Request
POST /RmaDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
RmaEmailConfigurationDeleteCommand
Request
POST /RmaEmailConfigurationDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
RmaEmailConfigurationSaveCommand
Request
POST /RmaEmailConfigurationSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
RmaEventSaveCommand
Request
POST /RmaEventSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
RmaOrderLineSaveCommand
Request
POST /RmaOrderLineSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
RmaReplacementOrderCreateCommand
Request
POST /RmaReplacementOrderCreate
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
RmaSaveCommand
Request
POST /RmaSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
RmaStateDeleteCommand
Request
POST /RmaStateDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
RmaStateSaveCommand
Request
POST /RmaStateSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
RoundingDeleteCommand
Request
POST /RoundingDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
RoundingSaveCommand
Request
POST /RoundingSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ShippingCopyCommand
Request
POST /ShippingCopy
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ShippingDeleteCommand
Request
POST /ShippingDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ShippingSaveCommand
Request
POST /ShippingSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
ShippingToggleActiveCommand
Request
POST /ShippingToggleActive
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
StockGroupDeleteCommand
Request
POST /StockGroupDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
StockGroupSaveCommand
Request
POST /StockGroupSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
StockLocationCategoryDeleteCommand
Request
POST /StockLocationCategoryDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
StockLocationCategorySaveCommand
Request
POST /StockLocationCategorySave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
StockLocationCopyCommand
Request
POST /StockLocationCopy
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
StockLocationDeleteCommand
Request
POST /StockLocationDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
StockLocationSaveCommand
Request
POST /StockLocationSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
StockStatusDeleteCommand
Request
POST /StockStatusDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
StockStatusSaveCommand
Request
POST /StockStatusSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
TaxSettingCopyCommand
Request
POST /TaxSettingCopy
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
TaxSettingDeleteCommand
Request
POST /TaxSettingDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
TaxSettingSaveCommand
Request
POST /TaxSettingSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
TrackAndTraceDeleteCommand
Request
POST /TrackAndTraceDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
TrackAndTraceParameterDeleteCommand
Request
POST /TrackAndTraceParameterDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
TrackAndTraceParameterSaveCommand
Request
POST /TrackAndTraceParameterSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
TrackAndTraceSaveCommand
Request
POST /TrackAndTraceSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Ecommerce.UI.Commands.Discounts
View SourceCustomerProductListCopyListCommand
Request
POST /CustomerProductListCopyList
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
CustomerProductListDeleteCommand
Request
POST /CustomerProductListDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
CustomerProductListProductAddCommand
Request
POST /CustomerProductListProductAdd
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
CustomerProductListProductRemoveCommand
Request
POST /CustomerProductListProductRemove
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
CustomerProductListSaveCommand
Request
POST /CustomerProductListSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DiscountAddToVoucherListCommand
Request
POST /DiscountAddToVoucherList
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DiscountDeleteCommand
Request
POST /DiscountDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DiscountRuleDeleteCommand
Request
POST /DiscountRuleDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DiscountRuleSaveCommand
Request
POST /DiscountRuleSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
DiscountSaveCommand
Request
POST /DiscountSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
GiftCardCancelCommand
Request
POST /GiftCardCancel
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
LoyaltyPointRewardSaveCommand
Request
POST /LoyaltyPointRewardSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
LoyaltyPointsRewardDeleteCommand
Request
POST /LoyaltyPointsRewardDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
LoyaltyPointsRewardSpecificDeleteCommand
Request
POST /LoyaltyPointsRewardSpecificDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
RewardRuleConditionDeleteCommand
Request
POST /RewardRuleConditionDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
RewardRuleDeleteCommand
Request
POST /RewardRuleDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
RewardRuleSaveCommand
Request
POST /RewardRuleSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
VoucherListDeleteCommand
Request
POST /VoucherListDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
VoucherListDetachDiscountsCommand
Request
POST /VoucherListDetachDiscounts
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
VoucherListSaveCommand
Request
POST /VoucherListSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
VoucherListToggleActiveCommand
Request
POST /VoucherListToggleActive
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
VoucherRewardDeleteCommand
Request
POST /VoucherRewardDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
VoucherRewardGenerateCommand
Request
POST /VoucherRewardGenerate
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
VoucherRewardSaveCommand
Request
POST /VoucherRewardSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
VoucherRewardSendMailCommand
Request
POST /VoucherRewardSendMail
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
VoucherRewardToCsvCommand
Request
POST /VoucherRewardToCsv
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
Dynamicweb.Ecommerce.UI.Commands.Settings
View SourceGiftCardSettingsSaveCommand
Request
POST /GiftCardSettingsSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
LoyaltyPointsSettingsSaveCommand
Request
POST /LoyaltyPointsSettingsSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
NumberDeleteCommand
Request
POST /NumberDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
NumberSaveCommand
Request
POST /NumberSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderContextCopyCommand
Request
POST /OrderContextCopy
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderContextDeleteCommand
Request
POST /OrderContextDelete
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderContextSaveCommand
Request
POST /OrderContextSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
OrderDiscountsSettingsSaveCommand
Request
POST /OrderDiscountsSettingsSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
PaymentCopyCommand
Request
POST /PaymentCopy
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |
PriceSettingsSaveCommand
Request
POST /PriceSettingsSave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
body |
Responses
Status Code | Description | Samples |
---|---|---|
400 | Bad request |
|
401 | Forbidden |
|
200 | OK |