Dynamicweb Management API
Dynamicweb Management API
Dynamicweb.Application.UI.Commands
View SourceAddinInstallCommand
Request
POST /AddinInstall
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AddinUninstallCommand
Request
POST /AddinUninstall
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ApiKeyDeleteCommand
Request
POST /ApiKeyDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ApiKeySaveCommand
Request
POST /ApiKeySave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CacheClearingAddCommand
Request
POST /CacheClearingAdd
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CacheClearingDeleteCommand
Request
POST /CacheClearingDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DatabaseDownloadCommand
Request
POST /DatabaseDownload
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DatabaseSettingsSaveCommand
Request
POST /DatabaseSettingsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DeploymentDataGroupDeleteCommand
Request
POST /DeploymentDataGroupDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DeploymentDataGroupSaveCommand
Request
POST /DeploymentDataGroupSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DeploymentDataItemTypeDeleteCommand
Request
POST /DeploymentDataItemTypeDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DeploymentDataItemTypeSaveCommand
Request
POST /DeploymentDataItemTypeSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DeploymentDestinationDeleteCommand
Request
POST /DeploymentDestinationDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DeploymentDestinationExportCommand
Request
POST /DeploymentDestinationExport
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DeploymentDestinationSaveCommand
Request
POST /DeploymentDestinationSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DeploymentDestinationTransferCommand
Request
POST /DeploymentDestinationTransfer
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DeploymentDestinationVerifyCommand
Request
POST /DeploymentDestinationVerify
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LicenseRefreshCommand
Request
POST /LicenseRefresh
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LoadBalancingDeleteCommand
Request
POST /LoadBalancingDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LoadBalancingSaveCommand
Request
POST /LoadBalancingSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ModuleDeleteCommand
Request
POST /ModuleDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ModuleSaveCommand
Request
POST /ModuleSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsSystemCDNSaveCommand
Request
POST /SettingsSystemCDNSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsSystemCustomizedURLsSaveCommand
Request
POST /SettingsSystemCustomizedURLsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsSystemHTTPSaveCommand
Request
POST /SettingsSystemHTTPSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsSystemMailServerSaveCommand
Request
POST /SettingsSystemMailServerSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsSystemSecuritySaveCommand
Request
POST /SettingsSystemSecuritySave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsSystemTrackingSaveCommand
Request
POST /SettingsSystemTrackingSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TranslationSaveCommand
Request
POST /TranslationSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UnifiedPermissionSaveCommand
Request
POST /UnifiedPermissionSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAttributeDifferentiationSaveCommand
Request
POST /ProductAttributeDifferentiationSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Application.UI.Commands.Repositories
View SourceBuildIndexCommand
Request
POST /BuildIndex
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
BuildIndexInstanceCommand
Request
POST /BuildIndexInstance
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CopyFieldDefinitionSaveCommand
Request
POST /CopyFieldDefinitionSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ExtensionFieldDefinitionSaveCommand
Request
POST /ExtensionFieldDefinitionSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FacetDeleteCommand
Request
POST /FacetDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FacetGroupDeleteCommand
Request
POST /FacetGroupDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FacetGroupSaveCommand
Request
POST /FacetGroupSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FacetSaveCommand
Request
POST /FacetSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FacetSaveSortCommand
Request
POST /FacetSaveSort
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldDefinitionDeleteCommand
Request
POST /FieldDefinitionDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldDefinitionSaveCommand
Request
POST /FieldDefinitionSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldTypeDefinitionDeleteCommand
Request
POST /FieldTypeDefinitionDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldTypeDefinitionSaveCommand
Request
POST /FieldTypeDefinitionSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupingFieldDefinitionSaveCommand
Request
POST /GroupingFieldDefinitionSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupingFieldGroupDeleteCommand
Request
POST /GroupingFieldGroupDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupingFieldGroupSaveCommand
Request
POST /GroupingFieldGroupSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
IndexBuilderDeleteCommand
Request
POST /IndexBuilderDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
IndexBuilderSaveCommand
Request
POST /IndexBuilderSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
IndexDeleteCommand
Request
POST /IndexDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
IndexSaveCommand
Request
POST /IndexSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
IndexSearchConfigurationDeleteCommand
Request
POST /IndexSearchConfigurationDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
IndexSearchConfigurationRebuildIndexesCommand
Request
POST /IndexSearchConfigurationRebuildIndexes
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
IndexSearchConfigurationSaveCommand
Request
POST /IndexSearchConfigurationSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
InstanceDeleteCommand
Request
POST /InstanceDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
InstanceSaveCommand
Request
POST /InstanceSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
MyFavoriteQueryAddCommand
Request
POST /MyFavoriteQueryAdd
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
MyFavoriteQueryDetachCommand
Request
POST /MyFavoriteQueryDetach
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryCopyCommand
Request
POST /QueryCopy
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryDeleteCommand
Request
POST /QueryDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryExpressionDeleteCommand
Request
POST /QueryExpressionDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryExpressionSaveCommand
Request
POST /QueryExpressionSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryExpressionToggleDisabledCommand
Request
POST /QueryExpressionToggleDisabled
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryFolderDeleteCommand
Request
POST /QueryFolderDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryFolderSaveCommand
Request
POST /QueryFolderSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryGroupExpressionSaveCommand
Request
POST /QueryGroupExpressionSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryMoveCommand
Request
POST /QueryMove
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryParameterSaveCommand
Request
POST /QueryParameterSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryParametersDeleteCommand
Request
POST /QueryParametersDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QuerySaveCommand
Request
POST /QuerySave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QuerySortDeleteCommand
Request
POST /QuerySortDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QuerySortSaveCommand
Request
POST /QuerySortSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RepositoryAddCommand
Request
POST /RepositoryAdd
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RepositoryDeleteCommand
Request
POST /RepositoryDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TaskDeleteCommand
Request
POST /TaskDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TaskSaveCommand
Request
POST /TaskSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Application.UI.Commands.Settings
View SourceAssemblyDownloadCommand
Request
POST /AssemblyDownload
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GlobalSettingSaveCommand
Request
POST /GlobalSettingSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsSystemSolutionSettingsSaveCommand
Request
POST /SettingsSystemSolutionSettingsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Application.UI.DynamicFields
View SourceDummyItemEntrySaveCommand
Request
POST /DummyItemEntrySave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Application.UI.Queries
View SourceAddinAllQuery
Request
GET /AddinAll[?AddinProvider&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AddinProvider | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AddinByIdQuery
Request
GET /AddinById[?AddinName&AddinProvider&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AddinName | |||
AddinProvider | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AddinInstalledQuery
Request
GET /AddinInstalled[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ApiKeyAllQuery
Request
GET /ApiKeyAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ApiKeyByIdQuery
Request
GET /ApiKeyById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CommandByNameQuery
Request
GET /CommandByName[?Name&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Name | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CommandLogAllQuery
Request
GET /CommandLogAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CommandLogByIdQuery
Request
GET /CommandLogById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CommandLogModelChangeByCommandLogIdQuery
Request
GET /CommandLogModelChangeByCommandLogId[?CommandLogId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CommandLogId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CommandLogsByModelIdentifierAndModelTypeQuery
Request
GET /CommandLogsByModelIdentifierAndModelType[?ModelIdentifier&ModelTypeFullName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ModelIdentifier | |||
ModelTypeFullName | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CommandsAllQuery
Request
GET /CommandsAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ConfigurableAddInListQuery
Request
GET /ConfigurableAddInList[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ConfigurableAddInListByTypeQuery
Request
GET /ConfigurableAddInListByType[?AddInType&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AddInType | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ConfigurableAddInByTypeQuery
Request
GET /ConfigurableAddInByType[?AddInType&AddInParametersXml&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AddInType | |||
AddInParametersXml | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DatabaseFirehoseIndexByTableQuery
Request
GET /DatabaseFirehoseIndexByTable[?TableName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
TableName | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DatabaseFirehoseNewQuery
Request
GET /DatabaseFirehoseNew[?Query&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Query | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DatabaseFirehoseQuery
Request
GET /DatabaseFirehose[?ShadowEdit&Query&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ShadowEdit | |||
Query | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DatabaseSettingsQuery
Request
GET /DatabaseSettings[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DeploymentComparisonDataItemByIdsQuery
Request
GET /DeploymentComparisonDataItemByIds[?DestinationId&DataGroupId&DataItemTypeId&DataItemId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DestinationId | |||
DataGroupId | |||
DataItemTypeId | |||
DataItemId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DeploymentDataGroupByIdQuery
Request
GET /DeploymentDataGroupById[?Id&DestinationId&SelectedDataItemTypeIds&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
DestinationId | |||
SelectedDataItemTypeIds | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DeploymentDataGroupNewByParentIdQuery
Request
GET /DeploymentDataGroupNewByParentId[?ParentGroupId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ParentGroupId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DeploymentDataGroupsQuery
Request
GET /DeploymentDataGroups[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DeploymentDataItemTypeByIdQuery
Request
GET /DeploymentDataItemTypeById[?DataItemTypeId&DataGroupId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DataItemTypeId | |||
DataGroupId | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DeploymentDataItemTypeNewQuery
Request
GET /DeploymentDataItemTypeNew[?DataGroupId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DataGroupId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DeploymentDataItemTypesByDataGroupIdQuery
Request
GET /DeploymentDataItemTypesByDataGroupId[?DataGroupId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DataGroupId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DeploymentDestinationByIdQuery
Request
GET /DeploymentDestinationById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DeploymentDestinationsQuery
Request
GET /DeploymentDestinations[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DeploymentDifferenceByIdsQuery
Request
GET /DeploymentDifferenceByIds[?DataGroupId&DestinationId&DataItemTypeId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DataGroupId | |||
DestinationId | |||
DataItemTypeId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DeploymentExportNewQuery
Request
GET /DeploymentExportNew[?Ids&DataGroupId&DataItemTypeId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Ids | |||
DataGroupId | |||
DataItemTypeId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetMemoryCachesQuery
Request
GET /GetMemoryCaches[?PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetServiceCachesByDataGroupIdQuery
Request
GET /GetServiceCachesByDataGroupId[?Id&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetServiceCachesQuery
Request
GET /GetServiceCaches[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetSessionCachesQuery
Request
GET /GetSessionCaches[?PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetStaticTypeCachesQuery
Request
GET /GetStaticTypeCaches[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LicenseFeaturesQuery
Request
GET /LicenseFeatures[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LicenseLimitsQuery
Request
GET /LicenseLimits[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LicenseQuery
Request
GET /License[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LoadBalancingsByHostNameQuery
Request
GET /LoadBalancingsByHostName[?HostName&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
HostName | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LoadBalancingsQuery
Request
GET /LoadBalancings[?PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LogByFilePathQuery
Request
GET /LogByFilePath[?FilePath&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FilePath | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LogEventEntriesByFilePathQuery
Request
GET /LogEventEntriesByFilePath[?FilePath&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FilePath | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LogsByFilePathQuery
Request
GET /LogsByFilePath[?FilePath&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FilePath | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ModuleByIdQuery
Request
GET /ModuleById[?ModuleId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ModuleId | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ModuleNewQuery
Request
GET /ModuleNew[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ModulesAllQuery
Request
GET /ModulesAll[?SortColumnName&SortDirection&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SortColumnName | |||
SortDirection | |||
PagingIndex | |||
PagingSize | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PermissionByKeyQuery
Request
GET /PermissionByKey[?Key&Name&SubName&DisplayName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Key | |||
Name | |||
SubName | |||
DisplayName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueriesAllQuery
Request
GET /QueriesAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryByNameQuery
Request
GET /QueryByName[?Name&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Name | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ResultByShadowEditQuery
Request
GET /ResultByShadowEdit[?Command&ShadowEditId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Command | |||
ShadowEditId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ScreenConfigurationByUserQuery
Request
GET /ScreenConfigurationByUser[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SelectorDataByProviderQuery
Request
GET /SelectorDataByProvider[?Provider&ProviderType&ColumnIndex&PreviousColumnValue&SelectedValues&MultiSelect&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Provider | |||
ProviderType | |||
ColumnIndex | |||
PreviousColumnValue | |||
SelectedValues | |||
MultiSelect | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsSystemCDNQuery
Request
GET /SettingsSystemCDN[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsSystemCustomizedURLsQuery
Request
GET /SettingsSystemCustomizedURLs[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsSystemHTTPQuery
Request
GET /SettingsSystemHTTP[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsSystemMailServerQuery
Request
GET /SettingsSystemMailServer[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsSystemSecurityQuery
Request
GET /SettingsSystemSecurity[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsSystemSolutionDetailsQuery
Request
GET /SettingsSystemSolutionDetails[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsSystemSolutionSettingsQuery
Request
GET /SettingsSystemSolutionSettings[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsSystemTrackingQuery
Request
GET /SettingsSystemTracking[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GlobalSettingsAllQuery
Request
GET /GlobalSettingsAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ShadowEditsQuery
Request
GET /ShadowEdits[?EditType&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
EditType | |||
PagingIndex | |||
PagingSize | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TranslationsByDesignPathQuery
Request
GET /TranslationsByDesignPath[?DesignPath&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DesignPath | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TranslationsByKeyAndDesignPathQuery
Request
GET /TranslationsByKeyAndDesignPath[?DesignPath&Key&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DesignPath | |||
Key | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TranslationsGlobalQuery
Request
GET /TranslationsGlobal[?DesignPath&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DesignPath | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UnifiedPermissionByIdQuery
Request
GET /UnifiedPermissionById[?Key&Name&SubName&UserId&AvailableLevels&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Key | |||
Name | |||
SubName | |||
UserId | |||
AvailableLevels | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UnifiedPermissionsByKeysQuery
Request
GET /UnifiedPermissionsByKeys[?PermissionKey&PermissionName&PermissionSubName&AvailableLevels&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PermissionKey | |||
PermissionName | |||
PermissionSubName | |||
AvailableLevels | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UnifiedPermissionsBySectionQuery
Request
GET /UnifiedPermissionsBySection[?GroupID&Section&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupID | |||
Section | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Application.UI.Queries.Repositories
View SourceCopyFieldDefinitionNewQuery
Request
GET /CopyFieldDefinitionNew[?Repository&IndexName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ExtensionFieldDefinitionNewQuery
Request
GET /ExtensionFieldDefinitionNew[?Repository&IndexName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FacetByIdQuery
Request
GET /FacetById[?Repository&FacetGroupName&Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
FacetGroupName | |||
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FacetGroupByNameQuery
Request
GET /FacetGroupByName[?Repository&Name&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
Name | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FacetGroupNewQuery
Request
GET /FacetGroupNew[?Repository&Query&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
Query | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FacetNewQuery
Request
GET /FacetNew[?Repository&FacetGroupName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
FacetGroupName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FacetsByGroupQuery
Request
GET /FacetsByGroup[?Repository&FacetGroupName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
FacetGroupName | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FacetSortListQuery
Request
GET /FacetSortList[?Repository&FacetGroupName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
FacetGroupName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FavoriteQueriesQuery
Request
GET /FavoriteQueries[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldDefinitionBasesByRepositoryAndIndexNameQuery
Request
GET /FieldDefinitionBasesByRepositoryAndIndexName[?Repository&IndexName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldDefinitionBySystemNameRepositoryAndIndexNameQuery
Request
GET /FieldDefinitionBySystemNameRepositoryAndIndexName[?Repository&IndexName&SystemName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
SystemName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CopyFieldDefinitionBySystemNameRepositoryAndIndexNameQuery
Request
GET /CopyFieldDefinitionBySystemNameRepositoryAndIndexName[?Repository&IndexName&SystemName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
SystemName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupingFieldDefinitionBySystemNameRepositoryAndIndexNameQuery
Request
GET /GroupingFieldDefinitionBySystemNameRepositoryAndIndexName[?Repository&IndexName&SystemName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
SystemName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ExtensionFieldDefinitionBySystemNameRepositoryAndIndexNameQuery
Request
GET /ExtensionFieldDefinitionBySystemNameRepositoryAndIndexName[?Repository&IndexName&SystemName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
SystemName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldDefinitionNewQuery
Request
GET /FieldDefinitionNew[?Repository&IndexName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldDefinitionTypesQuery
Request
GET /FieldDefinitionTypes[?Repository&IndexName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldTypeDefinitionByIdRepositoryAndIndexNameQuery
Request
GET /FieldTypeDefinitionByIdRepositoryAndIndexName[?Id&Repository&IndexName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
Repository | |||
IndexName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldTypeDefinitionNewQuery
Request
GET /FieldTypeDefinitionNew[?Repository&IndexName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldTypeDefinitionsByRepositoryAndIndexNameQuery
Request
GET /FieldTypeDefinitionsByRepositoryAndIndexName[?Repository&IndexName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupingFieldDefinitionNewQuery
Request
GET /GroupingFieldDefinitionNew[?Repository&IndexName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupingFieldGroupByIdAndParentInfoQuery
Request
GET /GroupingFieldGroupByIdAndParentInfo[?Repository&IndexName&ParentFieldSystemName&Id&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
ParentFieldSystemName | |||
Id | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupingFieldGroupNewQuery
Request
GET /GroupingFieldGroupNew[?Repository&IndexName&ParentFieldSystemName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
ParentFieldSystemName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupingFieldGroupsByFieldSystemNameQuery
Request
GET /GroupingFieldGroupsByFieldSystemName[?Repository&IndexName&SystemName&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
SystemName | |||
PagingIndex | |||
PagingSize | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
IndexBuilderByNameQuery
Request
GET /IndexBuilderByName[?Repository&IndexName&Name&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
Name | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
IndexBuilderNewQuery
Request
GET /IndexBuilderNew[?Repository&IndexName&AssemblyQualifiedName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
AssemblyQualifiedName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
IndexBuildersByRepositoryAndIndexNameQuery
Request
GET /IndexBuildersByRepositoryAndIndexName[?Repository&IndexName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
IndexByRepositoryAndNameQuery
Request
GET /IndexByRepositoryAndName[?Repository&IndexName&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
IndexInstancesByRepositoryAndIndexQuery
Request
GET /IndexInstancesByRepositoryAndIndex[?RepositoryName&IndexName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
RepositoryName | |||
IndexName | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
IndexNewQuery
Request
GET /IndexNew[?Repository&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
IndexSearchConfigurationByNameQuery
Request
GET /IndexSearchConfigurationByName[?Name&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Name | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
IndexSearchConfigurationFieldsByConfigurationNameQuery
Request
GET /IndexSearchConfigurationFieldsByConfigurationName[?Name&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Name | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
IndexSearchConfigurationsQuery
Request
GET /IndexSearchConfigurations[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
IndexStatusByRepositoryAndIndexNameQuery
Request
GET /IndexStatusByRepositoryAndIndexName[?Repository&IndexName&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
IndexStatusesAllQuery
Request
GET /IndexStatusesAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
IndexStatusesByRepositoryQuery
Request
GET /IndexStatusesByRepository[?RepositoryName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
RepositoryName | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
InstanceByRepositoryIndexAndNameQuery
Request
GET /InstanceByRepositoryIndexAndName[?Repository&IndexName&InstanceName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
InstanceName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
InstanceNewQuery
Request
GET /InstanceNew[?Repository&IndexName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
InstanceStatusesByRepositoryAndIndexNameQuery
Request
GET /InstanceStatusesByRepositoryAndIndexName[?Repository&IndexName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
IndexName | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueriesByFolderQuery
Request
GET /QueriesByFolder[?FolderPath&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FolderPath | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueriesByRepositoryAndIndexNameQuery
Request
GET /QueriesByRepositoryAndIndexName[?RepositoryName&IndexName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
RepositoryName | |||
IndexName | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueriesByRepositoryQuery
Request
GET /QueriesByRepository[?RepositoryName&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
RepositoryName | |||
PagingIndex | |||
PagingSize | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryByIdQuery
Request
GET /QueryById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryExpressionByQueryIdAndPathQuery
Request
GET /QueryExpressionByQueryIdAndPath[?QueryId&Path&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
QueryId | |||
Path | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryExpressionNewQuery
Request
GET /QueryExpressionNew[?QueryId&Path&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
QueryId | |||
Path | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryExpressionsByQueryIdQuery
Request
GET /QueryExpressionsByQueryId[?QueryId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
QueryId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryFolderByNameQuery
Request
GET /QueryFolderByName[?Name&ParentPath&IsSharedQueries&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Name | |||
ParentPath | |||
IsSharedQueries | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryGroupExpressionByQueryIdAndPathQuery
Request
GET /QueryGroupExpressionByQueryIdAndPath[?QueryId&Path&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
QueryId | |||
Path | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryGroupExpressionNewQuery
Request
GET /QueryGroupExpressionNew[?QueryId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
QueryId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryNewQuery
Request
GET /QueryNew[?FolderPath&Repository&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FolderPath | |||
Repository | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryParameterByQueryIdAndNameQuery
Request
GET /QueryParameterByQueryIdAndName[?Id&Name&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
Name | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryParameterNewQuery
Request
GET /QueryParameterNew[?QueryId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
QueryId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryParametersByQueryIdQuery
Request
GET /QueryParametersByQueryId[?Id&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QuerySortByIndexSearchConfigurationNameAndFieldNameQuery
Request
GET /QuerySortByIndexSearchConfigurationNameAndFieldName[?Name&FieldName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Name | |||
FieldName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QuerySortByIndexSearchConfigurationNameQuery
Request
GET /QuerySortByIndexSearchConfigurationName[?Name&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Name | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QuerySortByQueryIdAndFieldNameQuery
Request
GET /QuerySortByQueryIdAndFieldName[?QueryId&FieldName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
QueryId | |||
FieldName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QuerySortByQueryIdQuery
Request
GET /QuerySortByQueryId[?QueryId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
QueryId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QuerySortNewQuery
Request
GET /QuerySortNew[?ParentId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ParentId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RepositoryInfoByNameQuery
Request
GET /RepositoryInfoByName[?RepositoryName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
RepositoryName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TaskByRepositoryAndNameQuery
Request
GET /TaskByRepositoryAndName[?RepositoryName&Name&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
RepositoryName | |||
Name | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TaskNewQuery
Request
GET /TaskNew[?Repository&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Repository | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TasksByRepositoryAndIndexNameQuery
Request
GET /TasksByRepositoryAndIndexName[?RepositoryName&IndexName&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
RepositoryName | |||
IndexName | |||
PagingIndex | |||
PagingSize | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TasksByRepositoryQuery
Request
GET /TasksByRepository[?RepositoryName&SortColumnName&SortDirection&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
RepositoryName | |||
SortColumnName | |||
SortDirection | |||
PagingIndex | |||
PagingSize | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Application.UI.Queries.Settings
View SourceAddInClassesByTypeQuery
Request
GET /AddInClassesByType[?AddInTypeName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AddInTypeName | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AssembliesAllQuery
Request
GET /AssembliesAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GlobalSettingByKeyQuery
Request
GET /GlobalSettingByKey[?Key&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Key | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Application.UI.TreeNavigation
View SourceNavigationByPathQuery
Request
GET /NavigationByPath[?Path&OpenTo&DisplayState&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Path | |||
OpenTo | |||
DisplayState | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Apps.UI.Commands.DataPortability
View SourceDataDefinitionDeleteCommand
Request
POST /DataDefinitionDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DataDefinitionSaveCommand
Request
POST /DataDefinitionSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DataGroupDeleteCommand
Request
POST /DataGroupDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DataGroupSaveCommand
Request
POST /DataGroupSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DataItemTypeDeleteCommand
Request
POST /DataItemTypeDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DataItemTypeSaveCommand
Request
POST /DataItemTypeSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Apps.UI.Commands.DataProcessing
View SourceActivityDeleteCommand
Request
POST /ActivityDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ActivitySaveCommand
Request
POST /ActivitySave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ConsentDeleteCommand
Request
POST /ConsentDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Apps.UI.Commands.Forms
View SourceAreaTemplateSetSaveCommand
Request
POST /AreaTemplateSetSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldCopyCommand
Request
POST /FieldCopy
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldDeleteCommand
Request
POST /FieldDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldSaveCommand
Request
POST /FieldSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldToggleActiveCommand
Request
POST /FieldToggleActive
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldToggleRequiredCommand
Request
POST /FieldToggleRequired
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FormCopyCommand
Request
POST /FormCopy
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FormDeleteCommand
Request
POST /FormDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FormSettingsSaveCommand
Request
POST /FormSettingsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SubmitDeleteCommand
Request
POST /SubmitDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Apps.UI.Queries.DataPortability
View SourceDataDefinitionByIdQuery
Request
GET /DataDefinitionById[?Id&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DataDefinitionNewQuery
Request
GET /DataDefinitionNew[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DataGroupByIdAndDefinitionIdQuery
Request
GET /DataGroupByIdAndDefinitionId[?Id&DefinitionId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
DefinitionId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DataGroupNewQuery
Request
GET /DataGroupNew[?DefinitionId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DefinitionId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DataItemTypeByIdAndParentInfoQuery
Request
GET /DataItemTypeByIdAndParentInfo[?DefinitionId&GroupId&Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DefinitionId | |||
GroupId | |||
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DataItemTypeNewQuery
Request
GET /DataItemTypeNew[?DefinitionId&GroupId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DefinitionId | |||
GroupId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DataItemTypesByParentInfoQuery
Request
GET /DataItemTypesByParentInfo[?DefinitionId&GroupId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DefinitionId | |||
GroupId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Apps.UI.Queries.DataProcessing
View SourceActivitiesByFilterQuery
Request
GET /ActivitiesByFilter[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ActivityByIdQuery
Request
GET /ActivityById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ActivityNewQuery
Request
GET /ActivityNew[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ConsentByParameretsQuery
Request
GET /ConsentByParamerets[?ActivityId&SubjectId&SubjectType&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ActivityId | |||
SubjectId | |||
SubjectType | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ConsentsByFilterQuery
Request
GET /ConsentsByFilter[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Apps.UI.Queries.Forms
View SourceAreaTemplateSetByAreaIdQuery
Request
GET /AreaTemplateSetByAreaId[?AreaId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AreaId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldByIdQuery
Request
GET /FieldById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldNewQuery
Request
GET /FieldNew[?FormId&FieldType&SortForNewField&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FormId | |||
FieldType | |||
SortForNewField | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldsByFormIdQuery
Request
GET /FieldsByFormId[?FormId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FormId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldTypesQuery
Request
GET /FieldTypes[?FormId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FormId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FormByIdQuery
Request
GET /FormById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FormNewQuery
Request
GET /FormNew[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FormsAllQuery
Request
GET /FormsAll[?PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PagingIndex | |||
PagingSize | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SubmitByIdQuery
Request
GET /SubmitById[?Id&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SubmitDataBySubmitIdQuery
Request
GET /SubmitDataBySubmitId[?SubmitId&IncludeDebugInfo&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SubmitId | |||
IncludeDebugInfo | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SubmitDataDebugInfoBySubmitIdQuery
Request
GET /SubmitDataDebugInfoBySubmitId[?SubmitId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SubmitId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SubmitsByFormIdQuery
Request
GET /SubmitsByFormId[?FormId&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FormId | |||
PagingIndex | |||
PagingSize | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Content.UI.Commands
View SourceAreaCopyCommand
Request
POST /AreaCopy
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AreaDeleteCommand
Request
POST /AreaDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AreaSaveCommand
Request
POST /AreaSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AreasSaveSortCommand
Request
POST /AreasSaveSort
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AreaToggleActiveCommand
Request
POST /AreaToggleActive
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ColorSwatchSaveCommand
Request
POST /ColorSwatchSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ExportSettingsSaveCommand
Request
POST /ExportSettingsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FolderSaveCommand
Request
POST /FolderSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GridRowSaveSortCommand
Request
POST /GridRowSaveSort
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ImportSettingsSaveCommand
Request
POST /ImportSettingsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PageCopyCommand
Request
POST /PageCopy
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PageCreateCommand
Request
POST /PageCreate
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PageDeleteCommand
Request
POST /PageDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PageMoveCommand
Request
POST /PageMove
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PagePublicationStateChangeCommand
Request
POST /PagePublicationStateChange
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PageSaveCommand
Request
POST /PageSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PageTemplateSaveCommand
Request
POST /PageTemplateSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ParagraphBulkCopyCommand
Request
POST /ParagraphBulkCopy
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ParagraphChangeActiveCommand
Request
POST /ParagraphChangeActive
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ParagraphCopyCommand
Request
POST /ParagraphCopy
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ParagraphDeleteCommand
Request
POST /ParagraphDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ParagraphMoveCommand
Request
POST /ParagraphMove
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ParagraphSaveCommand
Request
POST /ParagraphSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ParagraphSaveSortCommand
Request
POST /ParagraphSaveSort
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ParagraphTemplateSaveCommand
Request
POST /ParagraphTemplateSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ShortcutCreateCommand
Request
POST /ShortcutCreate
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Content.UI.Commands.Settings
View SourceLanguageSettingsSaveCommand
Request
POST /LanguageSettingsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Content.UI.Commands.Settings.Editing
View SourceInterfaceSettingsSaveCommand
Request
POST /InterfaceSettingsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowDeleteCommand
Request
POST /WorkflowDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowSaveCommand
Request
POST /WorkflowSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowUserDeleteCommand
Request
POST /WorkflowUserDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowUserSaveCommand
Request
POST /WorkflowUserSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Content.UI.Commands.Settings.ItemTypes
View SourceItemCategoryDeleteCommand
Request
POST /ItemCategoryDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemFieldDeleteCommand
Request
POST /ItemFieldDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemFieldGroupDeleteCommand
Request
POST /ItemFieldGroupDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemFieldGroupSaveCommand
Request
POST /ItemFieldGroupSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemFieldGroupSaveSortCommand
Request
POST /ItemFieldGroupSaveSort
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemFieldSaveCommand
Request
POST /ItemFieldSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemFieldSaveSortCommand
Request
POST /ItemFieldSaveSort
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemTypeCopyCommand
Request
POST /ItemTypeCopy
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemTypeDeleteCommand
Request
POST /ItemTypeDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemTypeListReloadCommand
Request
POST /ItemTypeListReload
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemTypeSaveCommand
Request
POST /ItemTypeSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemTypeSettingsSaveCommand
Request
POST /ItemTypeSettingsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Content.UI.Commands.Settings.ItemTypes.FieldOptions
View SourceFieldOptionMetadataCopyCommand
Request
POST /FieldOptionMetadataCopy
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldOptionMetadataDeleteCommand
Request
POST /FieldOptionMetadataDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldOptionMetadataSaveCommand
Request
POST /FieldOptionMetadataSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldOptionMetadataSaveSortCommand
Request
POST /FieldOptionMetadataSaveSort
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Content.UI.Commands.VisualEditor
View SourceGridColumnCreateCommand
Request
POST /GridColumnCreate
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GridColumnSortCommand
Request
POST /GridColumnSort
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GridColumnUnlinkCommand
Request
POST /GridColumnUnlink
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GridLinkSaveCommand
Request
POST /GridLinkSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GridRowCopyCommand
Request
POST /GridRowCopy
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GridRowCreateCommand
Request
POST /GridRowCreate
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GridRowDeleteCommand
Request
POST /GridRowDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GridRowPublishCommand
Request
POST /GridRowPublish
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GridRowSaveCommand
Request
POST /GridRowSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GridRowSortCommand
Request
POST /GridRowSort
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GridRowTemplateSaveCommand
Request
POST /GridRowTemplateSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Content.UI.Queries
View SourceAddinDependenciesQuery
Request
GET /AddinDependencies[?Package&Provider&Version&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Package | |||
Provider | |||
Version | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AreasSortListQuery
Request
GET /AreasSortList[?MasterAreaId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
MasterAreaId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ColorSwatchByAreaIdQuery
Request
GET /ColorSwatchByAreaId[?AreaId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AreaId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetAreaByIdQuery
Request
GET /GetAreaById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetAreaSettingsByAreaQuery
Request
GET /GetAreaSettingsByArea[?AreaId&ItemType&FileName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AreaId | |||
ItemType | |||
FileName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetAreasQuery
Request
GET /GetAreas[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetFolderByIdQuery
Request
GET /GetFolderById[?Id&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetPageByIdQuery
Request
GET /GetPageById[?Id&IsVisualEditor&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
IsVisualEditor | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetPagesByAreaIdQuery
Request
GET /GetPagesByAreaId[?AreaId&ModifiedAfter&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AreaId | |||
ModifiedAfter | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetPagesByParentQuery
Request
GET /GetPagesByParent[?ParentID&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ParentID | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetParagraphsByAreaIdQuery
Request
GET /GetParagraphsByAreaId[?AreaId&ModifiedAfter&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AreaId | |||
ModifiedAfter | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetParagraphByIdQuery
Request
GET /GetParagraphById[?Id&IsVisualEditor&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
IsVisualEditor | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetParagraphsByCreationUserQuery
Request
GET /GetParagraphsByCreationUser[?UserId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
UserId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetParagraphsByPageIdQuery
Request
GET /GetParagraphsByPageId[?PageId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PageId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GridRowByIdQuery
Request
GET /GridRowById[?Id&IsVisualEditor&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
IsVisualEditor | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GridRowSelectorByPageQuery
Request
GET /GridRowSelectorByPage[?PageId&SortIndex&Container&Category&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PageId | |||
SortIndex | |||
Container | |||
Category | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GridRowSortListQuery
Request
GET /GridRowSortList[?PageId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PageId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GridRowTemplateNewQuery
Request
GET /GridRowTemplateNew[?Id&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
NewAreaQuery
Request
GET /NewArea[?SourceAreaId&Name&AsWebsite&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SourceAreaId | |||
Name | |||
AsWebsite | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
NewFolderQuery
Request
GET /NewFolder[?AreaId&ParentId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AreaId | |||
ParentId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
NewPageInfoForCopyQuery
Request
GET /NewPageInfoForCopy[?SourcePageId&DestinationParentPageId&DestinationAreaId&CopyHere&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SourcePageId | |||
DestinationParentPageId | |||
DestinationAreaId | |||
CopyHere | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
NewPageInfoForMoveQuery
Request
GET /NewPageInfoForMove[?SourcePageId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SourcePageId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
NewPageQuery
Request
GET /NewPage[?AreaId&ParentId&PageType&TemplateId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AreaId | |||
ParentId | |||
PageType | |||
TemplateId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PageSelectorByPathQuery
Request
GET /PageSelectorByPath[?Path&OpenTo&DisplayState&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Path | |||
OpenTo | |||
DisplayState | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PageTemplateNewQuery
Request
GET /PageTemplateNew[?PageId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PageId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PageTypeListByAreaAndParentQuery
Request
GET /PageTypeListByAreaAndParent[?AreaId&ParentId&Category&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AreaId | |||
ParentId | |||
Category | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ParagraphDefinitionsByPageQuery
Request
GET /ParagraphDefinitionsByPage[?PageId&RowId&Position&Category&Container&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PageId | |||
RowId | |||
Position | |||
Category | |||
Container | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ParagraphNavigationByPathQuery
Request
GET /ParagraphNavigationByPath[?Path&OpenTo&DisplayState&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Path | |||
OpenTo | |||
DisplayState | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ParagraphNewQuery
Request
GET /ParagraphNew[?PageId&Container&ParagraphType&TemplateId&RowId&Position&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PageId | |||
Container | |||
ParagraphType | |||
TemplateId | |||
RowId | |||
Position | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ParagraphSortListQuery
Request
GET /ParagraphSortList[?PageId&GridRowId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PageId | |||
GridRowId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ParagraphTemplateByIdQuery
Request
GET /ParagraphTemplateById[?TemplateId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
TemplateId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ParagraphTemplateNewQuery
Request
GET /ParagraphTemplateNew[?ParagraphId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ParagraphId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Content.UI.Queries.Settings
View SourceGetLanguageSettingsQuery
Request
GET /GetLanguageSettings[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Content.UI.Queries.Settings.Editing
View SourceGetInterfaceSettingsQuery
Request
GET /GetInterfaceSettings[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowByIdQuery
Request
GET /WorkflowById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowsAllQuery
Request
GET /WorkflowsAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowUserByIdQuery
Request
GET /WorkflowUserById[?Id&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowUserNewQuery
Request
GET /WorkflowUserNew[?WorkflowId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
WorkflowId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowUsersByWorkflowIdQuery
Request
GET /WorkflowUsersByWorkflowId[?WorkflowId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
WorkflowId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Content.UI.Queries.Settings.ItemTypes
View SourceItemFieldBySystemNameAndItemTypeQuery
Request
GET /ItemFieldBySystemNameAndItemType[?SystemName&ItemTypeSystemName&MakeCopy&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SystemName | |||
ItemTypeSystemName | |||
MakeCopy | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemFieldGroupByItemTypeSystemNameAndSystemNameQuery
Request
GET /ItemFieldGroupByItemTypeSystemNameAndSystemName[?ItemTypeSystemName&SystemName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ItemTypeSystemName | |||
SystemName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemFieldGroupNewQuery
Request
GET /ItemFieldGroupNew[?ItemTypeSystemName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ItemTypeSystemName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemFieldGroupSortListQuery
Request
GET /ItemFieldGroupSortList[?ItemTypeSystemName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ItemTypeSystemName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemFieldNewQuery
Request
GET /ItemFieldNew[?ItemTypeSystemName&ItemFieldGroupSystemName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ItemTypeSystemName | |||
ItemFieldGroupSystemName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemFieldsByItemTypeSystemNameAndGroupSystemNameQuery
Request
GET /ItemFieldsByItemTypeSystemNameAndGroupSystemName[?SystemName&GroupSystemName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SystemName | |||
GroupSystemName | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemFieldsByItemTypeSystemNameQuery
Request
GET /ItemFieldsByItemTypeSystemName[?SystemName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SystemName | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemFieldSortListQuery
Request
GET /ItemFieldSortList[?ItemTypeSystemName&GroupSystemName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ItemTypeSystemName | |||
GroupSystemName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemSettingsQuery
Request
GET /ItemSettings[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemTypeAllQuery
Request
GET /ItemTypeAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemTypeByCategoryQuery
Request
GET /ItemTypeByCategory[?Category&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Category | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemTypeByIdQuery
Request
GET /ItemTypeById[?SystemName&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SystemName | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemTypeCopyInfoBySystemNameQuery
Request
GET /ItemTypeCopyInfoBySystemName[?SystemName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SystemName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemTypeNewQuery
Request
GET /ItemTypeNew[?Category&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Category | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemTypeRestrictionsByIdQuery
Request
GET /ItemTypeRestrictionsById[?SystemName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SystemName | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ItemTypeUsagesBySystemNameQuery
Request
GET /ItemTypeUsagesBySystemName[?SystemName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SystemName | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | 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 | Default | Notes |
---|---|---|---|
ItemTypeSystemName | |||
ItemFieldSystemName | |||
OptionSourceType | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldOptionMetadataByIdQuery
Request
GET /FieldOptionMetadataById[?ItemTypeSystemName&ItemFieldSystemName&Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ItemTypeSystemName | |||
ItemFieldSystemName | |||
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldOptionMetadataNewQuery
Request
GET /FieldOptionMetadataNew[?ItemTypeSystemName&ItemFieldSystemName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ItemTypeSystemName | |||
ItemFieldSystemName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldOptionMetadataSortListQuery
Request
GET /FieldOptionMetadataSortList[?ItemTypeSystemName&ItemFieldSystemName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ItemTypeSystemName | |||
ItemFieldSystemName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.CoreUI.Data.ScreenConfiguration
View SourceScreenConfigurationQuery
Request
GET /ScreenConfiguration[?ViewTypeName&ConfigurableScreenType&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ViewTypeName | |||
ConfigurableScreenType | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ScreenConfigurationSaveCommand
Request
POST /ScreenConfigurationSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.CoreUI.Lists
View SourceListSelectionModelQuery
Request
GET /ListSelectionModel[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.CoreUI.Screens.Implementations
View SourceMultiEditByQueryQuery
Request
GET /MultiEditByQuery[?ScreenName&QueryName&QueryProperty&QueryValues&InfoBarQueryValue&UseInfoBarFromFirstScreen&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ScreenName | |||
QueryName | |||
QueryProperty | |||
QueryValues | |||
InfoBarQueryValue | |||
UseInfoBarFromFirstScreen | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Demo.UI.Commands
View SourceTestListItemRenameCommand
Request
POST /TestListItemRename
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TestListItemsDeleteCommand
Request
POST /TestListItemsDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Demo.UI.Implementations
View SourceScreenImplementationsAllQuery
Request
GET /ScreenImplementationsAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Demo.UI.Queries
View SourceIconsQuery
Request
GET /Icons[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
KnownIconsQuery
Request
GET /KnownIcons[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TestListItemAllQuery
Request
GET /TestListItemAll[?PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TestListItemByIdQuery
Request
GET /TestListItemById[?Id&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Ecommerce.UI.Commands
View SourceAddressValidatorDeleteCommand
Request
POST /AddressValidatorDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AddressValidatorSaveCommand
Request
POST /AddressValidatorSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AddressValidatorToggleActiveCommand
Request
POST /AddressValidatorToggleActive
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FeeDeleteCommand
Request
POST /FeeDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FeeRuleSaveCommand
Request
POST /FeeRuleSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FeeRuleToggleActiveCommand
Request
POST /FeeRuleToggleActive
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FeeSaveCommand
Request
POST /FeeSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FutureDeliveryCancelCommand
Request
POST /FutureDeliveryCancel
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FutureDeliveryRestoreCommand
Request
POST /FutureDeliveryRestore
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderCancelRecurringCommand
Request
POST /OrderCancelRecurring
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderCaptureBulkCommand
Request
POST /OrderCaptureBulk
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderCaptureCommand
Request
POST /OrderCapture
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderChangeOrderStateCommand
Request
POST /OrderChangeOrderState
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderCreateShippingDocumentsCommand
Request
POST /OrderCreateShippingDocuments
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderDeleteCommand
Request
POST /OrderDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderFieldDeleteCommand
Request
POST /OrderFieldDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderFieldSaveCommand
Request
POST /OrderFieldSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderFlowDeleteCommand
Request
POST /OrderFlowDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderFlowSaveCommand
Request
POST /OrderFlowSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderAddDiscountCommand
Request
POST /OrderAddDiscount
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderLineAddProductCommand
Request
POST /OrderLineAddProduct
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderLineDeleteCommand
Request
POST /OrderLineDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderLineFieldDeleteCommand
Request
POST /OrderLineFieldDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderLineFieldSaveCommand
Request
POST /OrderLineFieldSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderLineSaveCommand
Request
POST /OrderLineSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderSaveCommand
Request
POST /OrderSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderStateDeleteCommand
Request
POST /OrderStateDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderStateSaveCommand
Request
POST /OrderStateSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PaymentDeleteCommand
Request
POST /PaymentDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PaymentSaveCommand
Request
POST /PaymentSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PaymentToggleActiveCommand
Request
POST /PaymentToggleActive
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RmaCloseCommand
Request
POST /RmaClose
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RmaDeleteCommand
Request
POST /RmaDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RmaEmailConfigurationDeleteCommand
Request
POST /RmaEmailConfigurationDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RmaEmailConfigurationSaveCommand
Request
POST /RmaEmailConfigurationSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RmaEventSaveCommand
Request
POST /RmaEventSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RmaOrderLineSaveCommand
Request
POST /RmaOrderLineSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RmaReplacementOrderCreateCommand
Request
POST /RmaReplacementOrderCreate
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RmaSaveCommand
Request
POST /RmaSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RmaStateDeleteCommand
Request
POST /RmaStateDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RmaStateSaveCommand
Request
POST /RmaStateSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RoundingDeleteCommand
Request
POST /RoundingDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RoundingSaveCommand
Request
POST /RoundingSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ShippingCopyCommand
Request
POST /ShippingCopy
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ShippingDeleteCommand
Request
POST /ShippingDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ShippingSaveCommand
Request
POST /ShippingSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ShippingToggleActiveCommand
Request
POST /ShippingToggleActive
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
StockGroupDeleteCommand
Request
POST /StockGroupDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
StockGroupSaveCommand
Request
POST /StockGroupSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
StockLocationCategoryDeleteCommand
Request
POST /StockLocationCategoryDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
StockLocationCategorySaveCommand
Request
POST /StockLocationCategorySave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
StockLocationCopyCommand
Request
POST /StockLocationCopy
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
StockLocationDeleteCommand
Request
POST /StockLocationDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
StockLocationSaveCommand
Request
POST /StockLocationSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
StockStatusDeleteCommand
Request
POST /StockStatusDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
StockStatusSaveCommand
Request
POST /StockStatusSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TaxSettingCopyCommand
Request
POST /TaxSettingCopy
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TaxSettingDeleteCommand
Request
POST /TaxSettingDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TaxSettingSaveCommand
Request
POST /TaxSettingSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TrackAndTraceDeleteCommand
Request
POST /TrackAndTraceDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TrackAndTraceParameterDeleteCommand
Request
POST /TrackAndTraceParameterDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TrackAndTraceParameterSaveCommand
Request
POST /TrackAndTraceParameterSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TrackAndTraceSaveCommand
Request
POST /TrackAndTraceSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Ecommerce.UI.Commands.Discounts
View SourceCustomerProductListCopyListCommand
Request
POST /CustomerProductListCopyList
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CustomerProductListDeleteCommand
Request
POST /CustomerProductListDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CustomerProductListProductAddCommand
Request
POST /CustomerProductListProductAdd
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CustomerProductListProductRemoveCommand
Request
POST /CustomerProductListProductRemove
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CustomerProductListSaveCommand
Request
POST /CustomerProductListSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DiscountAddToVoucherListCommand
Request
POST /DiscountAddToVoucherList
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DiscountDeleteCommand
Request
POST /DiscountDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DiscountRuleDeleteCommand
Request
POST /DiscountRuleDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DiscountRuleSaveCommand
Request
POST /DiscountRuleSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DiscountSaveCommand
Request
POST /DiscountSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GiftCardCancelCommand
Request
POST /GiftCardCancel
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LoyaltyPointRewardSaveCommand
Request
POST /LoyaltyPointRewardSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LoyaltyPointsRewardDeleteCommand
Request
POST /LoyaltyPointsRewardDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LoyaltyPointsRewardSpecificDeleteCommand
Request
POST /LoyaltyPointsRewardSpecificDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RewardRuleConditionDeleteCommand
Request
POST /RewardRuleConditionDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RewardRuleDeleteCommand
Request
POST /RewardRuleDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RewardRuleSaveCommand
Request
POST /RewardRuleSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VoucherListDeleteCommand
Request
POST /VoucherListDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VoucherListDetachDiscountsCommand
Request
POST /VoucherListDetachDiscounts
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VoucherListSaveCommand
Request
POST /VoucherListSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VoucherListToggleActiveCommand
Request
POST /VoucherListToggleActive
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VoucherRewardDeleteCommand
Request
POST /VoucherRewardDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VoucherRewardGenerateCommand
Request
POST /VoucherRewardGenerate
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VoucherRewardSaveCommand
Request
POST /VoucherRewardSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VoucherRewardSendMailCommand
Request
POST /VoucherRewardSendMail
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VoucherRewardToCsvCommand
Request
POST /VoucherRewardToCsv
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Ecommerce.UI.Commands.Settings
View SourceGiftCardSettingsSaveCommand
Request
POST /GiftCardSettingsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LoyaltyPointsSettingsSaveCommand
Request
POST /LoyaltyPointsSettingsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
NumberDeleteCommand
Request
POST /NumberDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
NumberSaveCommand
Request
POST /NumberSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderContextCopyCommand
Request
POST /OrderContextCopy
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderContextDeleteCommand
Request
POST /OrderContextDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderContextSaveCommand
Request
POST /OrderContextSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderDiscountsSettingsSaveCommand
Request
POST /OrderDiscountsSettingsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PaymentCopyCommand
Request
POST /PaymentCopy
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PriceSettingsSaveCommand
Request
POST /PriceSettingsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsOrdersSaveCommand
Request
POST /SettingsOrdersSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ShoppingCartSettingsSaveCommand
Request
POST /ShoppingCartSettingsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ValidationDeleteCommand
Request
POST /ValidationDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ValidationGroupDeleteCommand
Request
POST /ValidationGroupDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ValidationGroupSaveCommand
Request
POST /ValidationGroupSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ValidationRuleDeleteCommand
Request
POST /ValidationRuleDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ValidationRuleSaveCommand
Request
POST /ValidationRuleSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ValidationSaveCommand
Request
POST /ValidationSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Ecommerce.UI.Queries
View SourceAddressValidatorByIdQuery
Request
GET /AddressValidatorById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AddressValidatorsAllQuery
Request
GET /AddressValidatorsAll[?PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CaptureLogsByOrderIdQuery
Request
GET /CaptureLogsByOrderId[?OrderId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
OrderId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FeeByIdQuery
Request
GET /FeeById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FeeNewQuery
Request
GET /FeeNew[?PaymentId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PaymentId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FeeRuleByIdQuery
Request
GET /FeeRuleById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FeeRuleNewQuery
Request
GET /FeeRuleNew[?ShippingId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ShippingId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FeeRulesByShippingIdQuery
Request
GET /FeeRulesByShippingId[?ShippingId&CountryId&RegionId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ShippingId | |||
CountryId | |||
RegionId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FeesByPaymentIdQuery
Request
GET /FeesByPaymentId[?PaymentId&CountryId&RegionId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PaymentId | |||
CountryId | |||
RegionId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FutureDeliveriesByRecurringOrderIdQuery
Request
GET /FutureDeliveriesByRecurringOrderId[?RecurringOrderId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
RecurringOrderId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetGiftCardSettingsQuery
Request
GET /GetGiftCardSettings[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetOrderByIdQuery
Request
GET /GetOrderById[?OrderId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
OrderId | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetOrderFieldByIdQuery
Request
GET /GetOrderFieldById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetOrderFieldsQuery
Request
GET /GetOrderFields[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetOrderFlowByIdQuery
Request
GET /GetOrderFlowById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetOrderFlowListQuery
Request
GET /GetOrderFlowList[?OrderType&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
OrderType | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetOrderLineByIdQuery
Request
GET /GetOrderLineById[?OrderLineId&OrderId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
OrderLineId | |||
OrderId | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetOrderLineByOrderIdQuery
Request
GET /GetOrderLineByOrderId[?OrderId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
OrderId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetOrderLineFieldBySystemNameQuery
Request
GET /GetOrderLineFieldBySystemName[?SystemName&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SystemName | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetOrderLineFieldsQuery
Request
GET /GetOrderLineFields[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetOrderListQuery
Request
GET /GetOrderList[?OrderType&RecurringOrderId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
OrderType | |||
RecurringOrderId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetOrderStateByIdQuery
Request
GET /GetOrderStateById[?Id&OrderType&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
OrderType | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetOrderStateListQuery
Request
GET /GetOrderStateList[?OrderFlowId&OrderType&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
OrderFlowId | |||
OrderType | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetRmaEmailConfigurationByIdQuery
Request
GET /GetRmaEmailConfigurationById[?Id&TypeId&RmaType&ScreenHeader&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
TypeId | |||
RmaType | |||
ScreenHeader | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetRmaEmailNotificationsQuery
Request
GET /GetRmaEmailNotifications[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetRmaEventByTypeQuery
Request
GET /GetRmaEventByType[?EventType&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
EventType | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetRmaEventEmailConfigurationsQuery
Request
GET /GetRmaEventEmailConfigurations[?Id&ConfigurationName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ConfigurationName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetRmaEventsQuery
Request
GET /GetRmaEvents[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetRmaReplacementOrderProviderEmailConfigurationsQuery
Request
GET /GetRmaReplacementOrderProviderEmailConfigurations[?Id&ConfigurationName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ConfigurationName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetRmaStateByIdQuery
Request
GET /GetRmaStateById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetRmaStateEmailConfigurationsQuery
Request
GET /GetRmaStateEmailConfigurations[?Id&ConfigurationName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ConfigurationName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetShopByIdQuery
Request
GET /GetShopById[?Id&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetStockGroupByIdQuery
Request
GET /GetStockGroupById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetStockGroupsQuery
Request
GET /GetStockGroups[?OrderBy&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
OrderBy | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetStockLocationCategoriesQuery
Request
GET /GetStockLocationCategories[?PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetStockLocationCategoryByIdQuery
Request
GET /GetStockLocationCategoryById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetStockStatusByIdQuery
Request
GET /GetStockStatusById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetStockStatusListQuery
Request
GET /GetStockStatusList[?StockGroupId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
StockGroupId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GiftCardByIdQuery
Request
GET /GiftCardById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderFlowNewQuery
Request
GET /OrderFlowNew[?OrderType&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
OrderType | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderLineFieldsByShopIdQuery
Request
GET /OrderLineFieldsByShopId[?ShopId&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ShopId | |||
PagingIndex | |||
PagingSize | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderStateNewQuery
Request
GET /OrderStateNew[?OrderFlowId&OrderType&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
OrderFlowId | |||
OrderType | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PaymentByIdQuery
Request
GET /PaymentById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PaymentsAllQuery
Request
GET /PaymentsAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RmaByIdQuery
Request
GET /RmaById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RmaCommentsQuery
Request
GET /RmaComments[?Id&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RmaEmailConfigurationNewQuery
Request
GET /RmaEmailConfigurationNew[?RmaType&TypeId&ScreenHeader&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
RmaType | |||
TypeId | |||
ScreenHeader | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RmaListQuery
Request
GET /RmaList[?ShopId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ShopId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RmaNewQuery
Request
GET /RmaNew[?OrderId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
OrderId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RmaOrderLineByIdQuery
Request
GET /RmaOrderLineById[?RmaId&Id&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
RmaId | |||
Id | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RmaOrderLinesQuery
Request
GET /RmaOrderLines[?Id&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RmaReplacementOrderNewQuery
Request
GET /RmaReplacementOrderNew[?RmaId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
RmaId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RmasByOrderIdQuery
Request
GET /RmasByOrderId[?OrderId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
OrderId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RmaStateNewQuery
Request
GET /RmaStateNew[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RoundingByIdQuery
Request
GET /RoundingById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RoundingsAllQuery
Request
GET /RoundingsAll[?Id&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ShippingByldQuery
Request
GET /ShippingByld[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ShippingsAllQuery
Request
GET /ShippingsAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
StockLocationByIdQuery
Request
GET /StockLocationById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
StockLocationNewQuery
Request
GET /StockLocationNew[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
StockLocationsAllQuery
Request
GET /StockLocationsAll[?SortColumnName&SortDirection&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SortColumnName | |||
SortDirection | |||
PagingIndex | |||
PagingSize | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
StockLocationsByShopIdQuery
Request
GET /StockLocationsByShopId[?ShopId&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ShopId | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
StockStatusNewQuery
Request
GET /StockStatusNew[?StockGroupId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
StockGroupId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TaxSettingByIdQuery
Request
GET /TaxSettingById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TaxSettingsAllQuery
Request
GET /TaxSettingsAll[?SortColumnName&SortDirection&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SortColumnName | |||
SortDirection | |||
PagingIndex | |||
PagingSize | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TrackAndTraceAllQuery
Request
GET /TrackAndTraceAll[?SortColumnName&SortDirection&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SortColumnName | |||
SortDirection | |||
PagingIndex | |||
PagingSize | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TrackAndTraceByIdQuery
Request
GET /TrackAndTraceById[?TrackAndTraceId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
TrackAndTraceId | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TrackAndTraceNewQuery
Request
GET /TrackAndTraceNew[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TrackAndTraceParameterByIdAndParentIdQuery
Request
GET /TrackAndTraceParameterByIdAndParentId[?ParameterId&TrackAndTraceId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ParameterId | |||
TrackAndTraceId | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TrackAndTraceParameterNewQuery
Request
GET /TrackAndTraceParameterNew[?TrackAndTraceId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
TrackAndTraceId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TrackAndTraceParametersByParentIdQuery
Request
GET /TrackAndTraceParametersByParentId[?TrackAndTraceId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
TrackAndTraceId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Ecommerce.UI.Queries.Discounts
View SourceCustomerProductListByIdQuery
Request
GET /CustomerProductListById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CustomerProductListCopyByIdQuery
Request
GET /CustomerProductListCopyById[?Id&Name&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
Name | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CustomerProductListNewQuery
Request
GET /CustomerProductListNew[?IsShared&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
IsShared | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CustomerProductListProductsByListIdQuery
Request
GET /CustomerProductListProductsByListId[?Id&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CustomerProductListsByIsSharedQuery
Request
GET /CustomerProductListsByIsShared[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CustomOrderDiscountNewQuery
Request
GET /CustomOrderDiscountNew[?OrderId&OrderLineId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
OrderId | |||
OrderLineId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DiscountByIdQuery
Request
GET /DiscountById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DiscountByVoucherIdQuery
Request
GET /DiscountByVoucherId[?Id&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DiscountNewQuery
Request
GET /DiscountNew[?CopyId&VoucherListId&DiscountType&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CopyId | |||
VoucherListId | |||
DiscountType | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DiscountRuleByTypeQuery
Request
GET /DiscountRuleByType[?DiscountId&RuleType&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DiscountId | |||
RuleType | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DiscountRulesQuery
Request
GET /DiscountRules[?DiscountId&IsNew&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DiscountId | |||
IsNew | |||
PagingIndex | |||
PagingSize | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DiscountsAllQuery
Request
GET /DiscountsAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DiscountsByGroupIdQuery
Request
GET /DiscountsByGroupId[?GroupId&ExcludingDiscounts&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
ExcludingDiscounts | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DiscountsLatestQuery
Request
GET /DiscountsLatest[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DiscountTypesQuery
Request
GET /DiscountTypes[?VoucherListId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
VoucherListId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GiftCardsAllQuery
Request
GET /GiftCardsAll[?Id&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GiftCardTransactionsByIdQuery
Request
GET /GiftCardTransactionsById[?Id&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LoyaltyPointsRewardAllQuery
Request
GET /LoyaltyPointsRewardAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LoyaltyPointsRewardByIdQuery
Request
GET /LoyaltyPointsRewardById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LoyaltyPointsRewardNewQuery
Request
GET /LoyaltyPointsRewardNew[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RewardRuleByIdQuery
Request
GET /RewardRuleById[?RewardId&RuleId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
RewardId | |||
RuleId | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RewardRuleConditionByTypeQuery
Request
GET /RewardRuleConditionByType[?RewardId&RuleId&RuleType&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
RewardId | |||
RuleId | |||
RuleType | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RewardRuleConditionsQuery
Request
GET /RewardRuleConditions[?RewardId&RuleId&IsNew&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
RewardId | |||
RuleId | |||
IsNew | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RewardRuleNewQuery
Request
GET /RewardRuleNew[?RewardId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
RewardId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RewardRulesQuery
Request
GET /RewardRules[?RewardId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
RewardId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VoucherGeneratorNewQuery
Request
GET /VoucherGeneratorNew[?ListId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ListId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VoucherListByIdQuery
Request
GET /VoucherListById[?ListId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ListId | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VoucherListsAllQuery
Request
GET /VoucherListsAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VoucherRewardNewQuery
Request
GET /VoucherRewardNew[?ListId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ListId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VoucherRewardsByListIdQuery
Request
GET /VoucherRewardsByListId[?ListId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ListId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VoucherSendMailNewQuery
Request
GET /VoucherSendMailNew[?ListId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ListId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Ecommerce.UI.Queries.Settings
View SourceGetNumberByIdQuery
Request
GET /GetNumberById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetNumbersQuery
Request
GET /GetNumbers[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LoyaltyPointsSettingsQuery
Request
GET /LoyaltyPointsSettings[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderContextByIdQuery
Request
GET /OrderContextById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderContextsAllQuery
Request
GET /OrderContextsAll[?SortColumnName&SortDirection&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SortColumnName | |||
SortDirection | |||
PagingIndex | |||
PagingSize | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderDiscountsSettingsQuery
Request
GET /OrderDiscountsSettings[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PriceSettingsQuery
Request
GET /PriceSettings[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsOrdersQuery
Request
GET /SettingsOrders[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ShoppingCartSettingsQuery
Request
GET /ShoppingCartSettings[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ValidationByIdQuery
Request
GET /ValidationById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ValidationFieldsQuery
Request
GET /ValidationFields[?GroupId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ValidationGroupByIdQuery
Request
GET /ValidationGroupById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ValidationGroupsAllQuery
Request
GET /ValidationGroupsAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ValidationNewQuery
Request
GET /ValidationNew[?GroupId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ValidationRuleByIdQuery
Request
GET /ValidationRuleById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ValidationRuleNewQuery
Request
GET /ValidationRuleNew[?ValidationId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ValidationId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ValidationRulesQuery
Request
GET /ValidationRules[?ValidationId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ValidationId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Files.UI.Commands
View SourceImageSettingsSaveCommand
Request
POST /ImageSettingsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsCustomFoldersSaveCommand
Request
POST /SettingsCustomFoldersSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsFileManagerSaveCommand
Request
POST /SettingsFileManagerSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ThumbnailSettingsDeleteCommand
Request
POST /ThumbnailSettingsDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ThumbnailSettingsSaveCommand
Request
POST /ThumbnailSettingsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Files.UI.Commands.Directories
View SourceDirectoryCopyCommand
Request
POST /DirectoryCopy
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DirectoryDeleteCommand
Request
POST /DirectoryDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DirectoryDownloadCommand
Request
POST /DirectoryDownload
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DirectoryEmptyCommand
Request
POST /DirectoryEmpty
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DirectoryMoveCommand
Request
POST /DirectoryMove
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DirectorySaveCommand
Request
POST /DirectorySave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Files.UI.Commands.Files
View SourceContentFileSaveCommand
Request
POST /ContentFileSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FileCopyCommand
Request
POST /FileCopy
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FileCopyMultiCommand
Request
POST /FileCopyMulti
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FileCreateRenameCommand
Request
POST /FileCreateRename
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FileDeleteCommand
Request
POST /FileDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FileDownloadCommand
Request
POST /FileDownload
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FileMoveCommand
Request
POST /FileMove
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FileMoveMultiCommand
Request
POST /FileMoveMulti
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Files.UI.Commands.Metadata
View SourceMetadataFieldDeleteCommand
Request
POST /MetadataFieldDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
MetadataFieldOptionDeleteCommand
Request
POST /MetadataFieldOptionDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
MetadataFieldOptionSaveCommand
Request
POST /MetadataFieldOptionSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
MetadataFieldSaveCommand
Request
POST /MetadataFieldSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Files.UI.Queries
View SourceContentFileByNameQuery
Request
GET /ContentFileByName[?FilePath&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FilePath | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DirectoryAllQuery
Request
GET /DirectoryAll[?DirectoryPath&IncludeFiles&Recursive&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DirectoryPath | |||
IncludeFiles | |||
Recursive | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DirectoryByNameQuery
Request
GET /DirectoryByName[?Name&ParentPath&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Name | |||
ParentPath | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FileByNameQuery
Request
GET /FileByName[?Name&DirectoryPath&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Name | |||
DirectoryPath | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FilesByDirectoryQuery
Request
GET /FilesByDirectory[?DirectoryPath&Extensions&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DirectoryPath | |||
Extensions | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FolderSelectorProviderQuery
Request
GET /FolderSelectorProvider[?Section&Path&OpenTo&DisplayState&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Section | |||
Path | |||
OpenTo | |||
DisplayState | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ImageFileByNameQuery
Request
GET /ImageFileByName[?Name&DirectoryPath&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Name | |||
DirectoryPath | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ImageSettingsByPathQuery
Request
GET /ImageSettingsByPath[?DirectoryPath&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DirectoryPath | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsCustomFoldersQuery
Request
GET /SettingsCustomFolders[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsFileManagerQuery
Request
GET /SettingsFileManager[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ThumbnailSettingsByPathAndIdQuery
Request
GET /ThumbnailSettingsByPathAndId[?Id&DirectoryPath&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
DirectoryPath | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ThumbnailSettingsByPathQuery
Request
GET /ThumbnailSettingsByPath[?DirectoryPath&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DirectoryPath | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Files.UI.Queries.Metadata
View SourceMetadataFieldByPathAndIdQuery
Request
GET /MetadataFieldByPathAndId[?Id&DirectoryPath&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
DirectoryPath | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
MetadataFieldOptionByFieldAndIdQuery
Request
GET /MetadataFieldOptionByFieldAndId[?FieldId&OptionValue&DirectoryPath&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FieldId | |||
OptionValue | |||
DirectoryPath | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
MetadataFieldOptionsByFieldQuery
Request
GET /MetadataFieldOptionsByField[?FieldId&DirectoryPath&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FieldId | |||
DirectoryPath | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
MetadataFieldsByPathQuery
Request
GET /MetadataFieldsByPath[?DirectoryPath&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DirectoryPath | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Files.UI.Selectors
View SourceFileSelectorProviderQuery
Request
GET /FileSelectorProvider[?Section&Path&OpenTo&DisplayState&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Section | |||
Path | |||
OpenTo | |||
DisplayState | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Insights.UI.Commands
View SourceLogEventNotificationDeleteCommand
Request
POST /LogEventNotificationDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LogEventNotificationSaveCommand
Request
POST /LogEventNotificationSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Insights.UI.Queries
View SourceHealthProviderChecksByProviderNameQuery
Request
GET /HealthProviderChecksByProviderName[?ProviderName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProviderName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
IntegrationJobsAllQuery
Request
GET /IntegrationJobsAll[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LogEventByFiltersQuery
Request
GET /LogEventByFilters[?QueryAction&QueryCategory&Level&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
QueryAction | |||
QueryCategory | |||
Level | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LogEventByIdQuery
Request
GET /LogEventById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LogEventNotificationAllQuery
Request
GET /LogEventNotificationAll[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LogEventNotificationBySystemNameQuery
Request
GET /LogEventNotificationBySystemName[?SystemName&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SystemName | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ScheduledTaskAllQuery
Request
GET /ScheduledTaskAll[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Integration.UI.Commands
View SourceActivityCopyCommand
Request
POST /ActivityCopy
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ActivityDeleteCommand2
Request
POST /Dynamicweb.Integration.UI.Commands.ActivityDeleteCommand
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ActivityInstallPackageCommand
Request
POST /ActivityInstallPackage
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ActivityRunCommand
Request
POST /ActivityRun
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ActivitySaveCommand2
Request
POST /Dynamicweb.Integration.UI.Commands.ActivitySaveCommand
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ActivitySchemaUpdateCommand
Request
POST /ActivitySchemaUpdate
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ColumnMappingDeleteCommand
Request
POST /ColumnMappingDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ColumnMappingSaveCommand
Request
POST /ColumnMappingSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ColumnMappingsDeleteCommand
Request
POST /ColumnMappingsDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ColumnMappingsSaveSortCommand
Request
POST /ColumnMappingsSaveSort
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ColumnMappingsSetActiveStateCommand
Request
POST /ColumnMappingsSetActiveState
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EndpointCollectionDeleteCommand
Request
POST /EndpointCollectionDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EndpointCollectionSaveCommand
Request
POST /EndpointCollectionSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EndpointCopyCommand
Request
POST /EndpointCopy
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EndpointDeleteCommand
Request
POST /EndpointDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EndpointDownloadResponseCommand
Request
POST /EndpointDownloadResponse
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EndpointMoveCommand
Request
POST /EndpointMove
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EndpointRequestSaveCommand
Request
POST /EndpointRequestSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EndpointSaveCommand
Request
POST /EndpointSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EndpointSaveSortCommand
Request
POST /EndpointSaveSort
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EndpointTestSaveCommand
Request
POST /EndpointTestSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LiveIntegrationDeleteCommand
Request
POST /LiveIntegrationDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LiveIntegrationSaveCommand
Request
POST /LiveIntegrationSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ScheduleTaskAddCommand
Request
POST /ScheduleTaskAdd
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ScheduleTaskRemoveCommand
Request
POST /ScheduleTaskRemove
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TableMappingConditionalsDeleteCommand
Request
POST /TableMappingConditionalsDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TableMappingConditionalsSaveCommand
Request
POST /TableMappingConditionalsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TableMappingDeleteCommand
Request
POST /TableMappingDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TableMappingSaveCommand
Request
POST /TableMappingSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TaskDeleteCommand2
Request
POST /Dynamicweb.Integration.UI.Commands.TaskDeleteCommand
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TaskSaveCommand2
Request
POST /Dynamicweb.Integration.UI.Commands.TaskSaveCommand
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Integration.UI.Commands.DataImport
View SourceDataImportClearSourceParametersCommand
Request
POST /DataImportClearSourceParameters
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DataImportUpdateSourceParametersCommand
Request
POST /DataImportUpdateSourceParameters
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Integration.UI.Commands.Settings
View SourceExportOrdersSettingsSaveCommand
Request
POST /ExportOrdersSettingsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Integration.UI.Queries
View SourceActivitiesQuery
Request
GET /Activities[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ActivityByNameQuery
Request
GET /ActivityByName[?Name&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Name | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ActivityColumnMappingsByTableMappingQuery
Request
GET /ActivityColumnMappingsByTableMapping[?ActivityName&SourceProviderLabel&DestinationProviderLabel&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ActivityName | |||
SourceProviderLabel | |||
DestinationProviderLabel | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ActivityTypeListQuery
Request
GET /ActivityTypeList[?Category&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Category | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CheckTableSchemaByActivityNameQuery
Request
GET /CheckTableSchemaByActivityName[?Name&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Name | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ColumnMappingByIdsQuery
Request
GET /ColumnMappingByIds[?ActivityName&TableMappingId&ColumnMappingId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ActivityName | |||
TableMappingId | |||
ColumnMappingId | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ColumnMappingNewQuery
Request
GET /ColumnMappingNew[?ActivityName&TableMappingId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ActivityName | |||
TableMappingId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ColumnMappingsByTableMappingQuery
Request
GET /ColumnMappingsByTableMapping[?TableMappingId&ActivityName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
TableMappingId | |||
ActivityName | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ColumnMappingsSortListQuery
Request
GET /ColumnMappingsSortList[?Id&ActivityName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ActivityName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ConditionalsByTableMappingAndIdQuery
Request
GET /ConditionalsByTableMappingAndId[?Id&TableMappingId&ActivityName&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
TableMappingId | |||
ActivityName | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ConditionalsByTableMappingQuery
Request
GET /ConditionalsByTableMapping[?Id&ActivityName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ActivityName | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ConditionalsNewQuery
Request
GET /ConditionalsNew[?TableMappingId&ActivityName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
TableMappingId | |||
ActivityName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EndpointByIdQuery
Request
GET /EndpointById[?Id&CollectionId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
CollectionId | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EndpointCollectionByIdQuery
Request
GET /EndpointCollectionById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EndpointCollectionsQuery
Request
GET /EndpointCollections[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EndpointGetResponseQuery
Request
GET /EndpointGetResponse[?ShadowEditId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ShadowEditId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EndpointSortListQuery
Request
GET /EndpointSortList[?CollectionId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CollectionId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EndpointsQuery
Request
GET /Endpoints[?CollectionId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CollectionId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LiveIntegrationByInstanceIdQuery
Request
GET /LiveIntegrationByInstanceId[?DynamicwebLiveIntegrationInstanceId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DynamicwebLiveIntegrationInstanceId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LiveIntegrationsQuery
Request
GET /LiveIntegrations[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LogHistoryByActivityNameQuery
Request
GET /LogHistoryByActivityName[?Name&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Name | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LogsByActivityNameQuery
Request
GET /LogsByActivityName[?Name&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Name | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SchedulesQuery
Request
GET /Schedules[?PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TableMappingByIdQuery
Request
GET /TableMappingById[?Id&ActivityName&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ActivityName | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TableMappingNewQuery
Request
GET /TableMappingNew[?ActivityName&IsNew&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ActivityName | |||
IsNew | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TableMappingsByActivityNameQuery
Request
GET /TableMappingsByActivityName[?ActivityName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ActivityName | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TaskByIdQuery
Request
GET /TaskById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TaskByNameQuery
Request
GET /TaskByName[?Name&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Name | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TaskNewQuery2
Request
GET /Dynamicweb.Integration.UI.Queries.TaskNewQuery[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TasksQuery
Request
GET /Tasks[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UnitOfMeasureByProductIdAndAutoIdQuery
Request
GET /UnitOfMeasureByProductIdAndAutoId[?AutoId&ProductId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AutoId | |||
ProductId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Integration.UI.Queries.DataImport
View SourceDataImportQuery
Request
GET /DataImport[?ImportArea&DestinationId&ImportScreenTypeName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ImportArea | |||
DestinationId | |||
ImportScreenTypeName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Integration.UI.Queries.Settings
View SourceExportOrdersSettingsQuery
Request
GET /ExportOrdersSettings[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Marketing.UI.Commands
View SourceEmailFolderDeleteCommand
Request
POST /EmailFolderDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EmailFolderSaveCommand
Request
POST /EmailFolderSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EmailSaveCommand
Request
POST /EmailSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EmailSendCommand
Request
POST /EmailSend
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FlowFolderDeleteCommand
Request
POST /FlowFolderDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FlowFolderSaveCommand
Request
POST /FlowFolderSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FlowSaveCommand
Request
POST /FlowSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TopFolderDeleteCommand
Request
POST /TopFolderDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TopFolderSaveCommand
Request
POST /TopFolderSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Marketing.UI.Commands.Settings
View SourceEmailMarketingSettingsSaveCommand
Request
POST /EmailMarketingSettingsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PersonalizationSettingsSaveCommand
Request
POST /PersonalizationSettingsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Marketing.UI.Queries
View SourceEmailByIdQuery
Request
GET /EmailById[?Id&TopFolderType&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
TopFolderType | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EmailFolderByIdQuery
Request
GET /EmailFolderById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EmailFolderParentInformationQuery
The query is used to provide information about parents for a new EmailFolder.
Request
GET /EmailFolderParentInformation[?TopFolderId&ParentFolderId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
TopFolderId | |||
ParentFolderId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EmailNewQuery
Request
GET /EmailNew[?TopFolderID&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
TopFolderID | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
EmailsByFiltersQuery
Request
GET /EmailsByFilters[?IsAutomationList&ShowActiveAutomations&EmailFolderId&TopFolderId&IsShowTopFolderEmails&StateFilter&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
IsAutomationList | |||
ShowActiveAutomations | |||
EmailFolderId | |||
TopFolderId | |||
IsShowTopFolderEmails | |||
StateFilter | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FlowByIdQuery
Request
GET /FlowById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FlowFolderByIdQuery
Request
GET /FlowFolderById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FlowFolderParentInformationQuery
The query is used to provide information about parents for a new FlowFolder.
Request
GET /FlowFolderParentInformation[?ParentId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ParentId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FlowsByFolderIdQuery
Request
GET /FlowsByFolderId[?FolderId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FolderId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LinkClicksByEmailQuery
Request
GET /LinkClicksByEmail[?PagingIndex&PagingSize&SortColumnName&SortDirection&EmailId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
EmailId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LinkClicksByTopFolderQuery
Request
GET /LinkClicksByTopFolder[?PagingIndex&PagingSize&SortColumnName&SortDirection&TopFolderId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
TopFolderId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RecipientStatisticsByEmailQuery
Request
GET /RecipientStatisticsByEmail[?EmailId&RecipientType&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
EmailId | |||
RecipientType | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TopFolderByIdQuery
Request
GET /TopFolderById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TopFolderNewQuery
Request
GET /TopFolderNew[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TopLevelFlowsQuery
Request
GET /TopLevelFlows[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Marketing.UI.Queries.Settings
View SourceEmailMarketingSettingsQuery
Request
GET /EmailMarketingSettings[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PersonalizationSettingsQuery
Request
GET /PersonalizationSettings[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Products.UI.Commands
View SourceCommentCopyCommand
Request
POST /CommentCopy
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LanguageDeleteCommand
Request
POST /LanguageDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
LanguageSaveCommand
Request
POST /LanguageSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
OrderLineFieldGroupRelationSaveCommand
Request
POST /OrderLineFieldGroupRelationSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PeriodDeleteCommand
Request
POST /PeriodDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PeriodSaveCommand
Request
POST /PeriodSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PeriodToggleActiveCommand
Request
POST /PeriodToggleActive
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAssetAddCommand
Request
POST /ProductAssetAdd
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAssetChangeCategoryCommand
Request
POST /ProductAssetChangeCategory
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAssetDeleteCommand
Request
POST /ProductAssetDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAssetGroupSaveSortCommand
Request
POST /ProductAssetGroupSaveSort
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAssetMetadataSaveCommand
Request
POST /ProductAssetMetadataSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAssetUpdateDefaultCommand
Request
POST /ProductAssetUpdateDefault
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAttachCommand
Request
POST /ProductAttach
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogRelatedGroupAttachCommand
Request
POST /ProductCatalogRelatedGroupAttach
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogRelatedGroupDeleteCommand
Request
POST /ProductCatalogRelatedGroupDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCombineRemoveCommand
Request
POST /ProductCombineRemove
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductDeleteCommand
Request
POST /ProductDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductDetachCommand
Request
POST /ProductDetach
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductDuplicateCommand
Request
POST /ProductDuplicate
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductGroupRelationDeleteCommand
Request
POST /ProductGroupRelationDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductGroupRelationSaveCommand
Request
POST /ProductGroupRelationSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductGroupRelationTogglePrimaryCommand
Request
POST /ProductGroupRelationTogglePrimary
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductItemAddCommand
Request
POST /ProductItemAdd
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductItemDeleteCommand
Request
POST /ProductItemDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductMoveCommand
Request
POST /ProductMove
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductSaveCommand
Request
POST /ProductSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductSetLanguagesCommand
Request
POST /ProductSetLanguages
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductUpdateGroupShopIndexesCommand
Request
POST /ProductUpdateGroupShopIndexes
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductUpdateQueryIndexCommand
Request
POST /ProductUpdateQueryIndex
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductVatGroupDeleteCommand
Request
POST /ProductVatGroupDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductVatGroupSaveCommand
Request
POST /ProductVatGroupSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductVersionRollbackCommand
Request
POST /ProductVersionRollback
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VatGroupCountryRelationDeleteCommand
Request
POST /VatGroupCountryRelationDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VatGroupCountryRelationSaveCommand
Request
POST /VatGroupCountryRelationSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VatGroupDeleteCommand
Request
POST /VatGroupDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VatGroupSaveCommand
Request
POST /VatGroupSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
StockUnitDeleteCommand
Request
POST /StockUnitDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
StockUnitSaveCommand
Request
POST /StockUnitSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UnitOfMeasureDeleteCommand
Request
POST /UnitOfMeasureDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UnitOfMeasureSaveCommand
Request
POST /UnitOfMeasureSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Products.UI.Commands.Assortments
View SourceAssortmentAttachCommand
Request
POST /AssortmentAttach
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AssortmentDeleteCommand
Request
POST /AssortmentDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AssortmentGroupRelationAttachCommand
Request
POST /AssortmentGroupRelationAttach
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AssortmentGroupRelationDetachCommand
Request
POST /AssortmentGroupRelationDetach
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AssortmentProductGroupDeleteCommand
Request
POST /AssortmentProductGroupDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AssortmentProductRelationAttachCommand
Request
POST /AssortmentProductRelationAttach
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AssortmentProductRelationDetachCommand
Request
POST /AssortmentProductRelationDetach
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AssortmentRebuildCommand
Request
POST /AssortmentRebuild
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AssortmentSaveCommand
Request
POST /AssortmentSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AssortmentShopRelationAttachCommand
Request
POST /AssortmentShopRelationAttach
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AssortmentShopRelationDetachCommand
Request
POST /AssortmentShopRelationDetach
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AssortmentUserDeleteCommand
Request
POST /AssortmentUserDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Products.UI.Commands.Comments
View SourceCommentDeleteCommand
Request
POST /CommentDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CommentSaveCommand
Request
POST /CommentSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Products.UI.Commands.Feeds
View SourceFeedDeleteCommand
Request
POST /FeedDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FeedSaveCommand
Request
POST /FeedSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryParameterSaveCommand2
Request
POST /Dynamicweb.Products.UI.Commands.Feeds.QueryParameterSaveCommand
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QuerySortInfoDeleteCommand
Request
POST /QuerySortInfoDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QuerySortInfoSaveCommand
Request
POST /QuerySortInfoSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Products.UI.Commands.Prices
View SourcePriceCopyCommand
Request
POST /PriceCopy
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PriceDeleteCommand
Request
POST /PriceDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PriceSaveCommand
Request
POST /PriceSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Products.UI.Commands.ProductCatalogs
View SourceCompletionLanguageRemoveFromGroupCommand
Request
POST /CompletionLanguageRemoveFromGroup
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CompletionRuleRemoveFromGroupCommand
Request
POST /CompletionRuleRemoveFromGroup
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CompletionRuleRemoveFromShopCommand
Request
POST /CompletionRuleRemoveFromShop
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DataModelGroupDeleteCommand
Request
POST /DataModelGroupDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DataModelGroupSaveCommand
Request
POST /DataModelGroupSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DynamicStructureDeleteCommand
Request
POST /DynamicStructureDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DynamicStructureLevelDeleteCommand
Request
POST /DynamicStructureLevelDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DynamicStructureLevelSaveCommand
Request
POST /DynamicStructureLevelSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DynamicStructureSaveCommand
Request
POST /DynamicStructureSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupProductRelationRuleDeleteCommand
Request
POST /GroupProductRelationRuleDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupProductRelationRuleSaveCommand
Request
POST /GroupProductRelationRuleSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogAttachCommand
Request
POST /ProductCatalogAttach
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogAttachGroupSubGroupsCommand
Request
POST /ProductCatalogAttachGroupSubGroups
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogDetachGroupSubGroupsCommand
Request
POST /ProductCatalogDetachGroupSubGroups
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogGroupAttachProductsCommand
Request
POST /ProductCatalogGroupAttachProducts
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogGroupDeleteCommand
Request
POST /ProductCatalogGroupDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogGroupFacetSaveCommand
Request
POST /ProductCatalogGroupFacetSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogGroupMoveCommand
Request
POST /ProductCatalogGroupMove
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogGroupRelationDetachCommand
Request
POST /ProductCatalogGroupRelationDetach
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogGroupSaveCommand
Request
POST /ProductCatalogGroupSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogGroupsSaveSortCommand
Request
POST /ProductCatalogGroupsSaveSort
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogProductsSaveSortCommand
Request
POST /ProductCatalogProductsSaveSort
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantCombinationCreateCommand
Request
POST /VariantCombinationCreate
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantCombinationDeleteCommand
Request
POST /VariantCombinationDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantCombinationSaveCommand
Request
POST /VariantCombinationSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantCombinationUpdateCommand
Request
POST /VariantCombinationUpdate
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantGroupAddCommand
Request
POST /VariantGroupAdd
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantGroupDeleteCommand2
Request
POST /Dynamicweb.Products.UI.Commands.ProductCatalogs.VariantGroupDeleteCommand
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCombineAddProductsCommand
Request
POST /ProductCombineAddProducts
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCombineProductsAsFamilyCommand
Request
POST /ProductCombineProductsAsFamily
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Products.UI.Commands.ProductExport
View SourceProductExportFileDownloadCommand
Request
POST /ProductExportFileDownload
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductExportPresetSaveCommand
Request
POST /ProductExportPresetSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductExportSetProductIdsCommand
Request
POST /ProductExportSetProductIds
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Products.UI.Commands.RelatedProducts
View SourceGroupRelatedProductAttachCommand
Request
POST /GroupRelatedProductAttach
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupRelatedProductAttachNewGroupCommand
Request
POST /GroupRelatedProductAttachNewGroup
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupRelatedProductDeleteCommand
Request
POST /GroupRelatedProductDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductRelatedDeleteCommand
Request
POST /ProductRelatedDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductRelatedMakeTwoWayRelationCommand
Request
POST /ProductRelatedMakeTwoWayRelation
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductRelatedRemoveTwoWayRelationCommand
Request
POST /ProductRelatedRemoveTwoWayRelation
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductRelatedSaveCommand
Request
POST /ProductRelatedSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RelatedProductAttachCommand
Request
POST /RelatedProductAttach
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Products.UI.Commands.Settings
View SourceProductCategoryFieldConvertToReferenceCommand
Request
POST /ProductCategoryFieldConvertToReference
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AssetCategoryDeleteCommand
Request
POST /AssetCategoryDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AssetCategorySaveCommand
Request
POST /AssetCategorySave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AuditToCsvCommand
Request
POST /AuditToCsv
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CompletionRuleDeleteCommand
Request
POST /CompletionRuleDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CompletionRuleSaveCommand
Request
POST /CompletionRuleSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CountryCreateAllCommand
Request
POST /CountryCreateAll
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CountryDeleteCommand
Request
POST /CountryDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CountrySaveCommand
Request
POST /CountrySave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CurrencyDeleteCommand
Request
POST /CurrencyDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CurrencySaveCommand
Request
POST /CurrencySave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldDisplayGroupDeleteCommand
Request
POST /FieldDisplayGroupDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldDisplayGroupSaveCommand
Request
POST /FieldDisplayGroupSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldDisplayGroupTranslationSaveCommand
Request
POST /FieldDisplayGroupTranslationSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldTypeDeleteCommand
Request
POST /FieldTypeDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldTypeSaveCommand
Request
POST /FieldTypeSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ImagePatternDeleteCommand
Request
POST /ImagePatternDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ImagePatternSaveCommand
Request
POST /ImagePatternSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ManufacturerDeleteCommand
Request
POST /ManufacturerDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ManufacturerSaveCommand
Request
POST /ManufacturerSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAssignmentRuleDeleteCommand
Request
POST /ProductAssignmentRuleDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAssignmentRuleMappingDeleteCommand
Request
POST /ProductAssignmentRuleMappingDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAssignmentRuleMappingSaveCommand
Request
POST /ProductAssignmentRuleMappingSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAssignmentRuleSaveCommand
Request
POST /ProductAssignmentRuleSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAttachPropertyFieldsCommand
Request
POST /ProductAttachPropertyFields
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAttributeFieldOptionSaveSortCommand
Request
POST /ProductAttributeFieldOptionSaveSort
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoryDeleteCommand
Request
POST /ProductCategoryDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoryFieldDeleteCommand
Request
POST /ProductCategoryFieldDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoryFieldForceValuesCommand
Request
POST /ProductCategoryFieldForceValues
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoryFieldReferenceSaveCommand
Request
POST /ProductCategoryFieldReferenceSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoryFieldSaveCommand
Request
POST /ProductCategoryFieldSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoryFieldSaveSortCommand
Request
POST /ProductCategoryFieldSaveSort
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoryFieldTranslationSaveCommand
Request
POST /ProductCategoryFieldTranslationSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategorySaveCommand
Request
POST /ProductCategorySave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoryTranslationSaveCommand
Request
POST /ProductCategoryTranslationSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductDetachPropertyFieldsCommand
Request
POST /ProductDetachPropertyFields
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductFieldDeleteCommand
Request
POST /ProductFieldDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductFieldOptionDeleteCommand
Request
POST /ProductFieldOptionDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductFieldOptionSaveCommand
Request
POST /ProductFieldOptionSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductFieldOptionsDeleteCommand
Request
POST /ProductFieldOptionsDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductFieldSaveCommand
Request
POST /ProductFieldSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductFieldSaveSortCommand
Request
POST /ProductFieldSaveSort
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductFieldTranslationSaveCommand
Request
POST /ProductFieldTranslationSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductGroupFieldDeleteCommand
Request
POST /ProductGroupFieldDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductGroupFieldSaveCommand
Request
POST /ProductGroupFieldSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductItemsSaveSortCommand
Request
POST /ProductItemsSaveSort
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductUnitDeleteCommand
Request
POST /ProductUnitDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductUnitSaveCommand
Request
POST /ProductUnitSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RegionDeleteCommand
Request
POST /RegionDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RegionSaveCommand
Request
POST /RegionSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RelationGroupDeleteCommand
Request
POST /RelationGroupDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RelationGroupSaveCommand
Request
POST /RelationGroupSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RelationGroupSaveSortCommand
Request
POST /RelationGroupSaveSort
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsAdvancedEcommerceAndChannelsDataModelSaveCommand
Request
POST /SettingsAdvancedEcommerceAndChannelsDataModelSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsAdvancedGeneralSaveCommand
Request
POST /SettingsAdvancedGeneralSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsImageOptionsSaveCommand
Request
POST /SettingsImageOptionsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ShopDeleteCommand
Request
POST /ShopDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ShopSaveCommand
Request
POST /ShopSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantGroupDeleteCommand
Request
POST /VariantGroupDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantGroupSaveCommand
Request
POST /VariantGroupSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantOptionDeleteCommand
Request
POST /VariantOptionDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantOptionSaveCommand
Request
POST /VariantOptionSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantOptionSaveSortCommand
Request
POST /VariantOptionSaveSort
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantPropertyDeleteCommand
Request
POST /VariantPropertyDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantPropertySaveCommand
Request
POST /VariantPropertySave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowDeleteCommand2
Request
POST /Dynamicweb.Products.UI.Commands.Settings.WorkflowDeleteCommand
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowNotificationDeleteCommand
Request
POST /WorkflowNotificationDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowNotificationSaveCommand
Request
POST /WorkflowNotificationSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowSaveCommand2
Request
POST /Dynamicweb.Products.UI.Commands.Settings.WorkflowSaveCommand
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowStateDeleteCommand
Request
POST /WorkflowStateDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowStateSaveCommand
Request
POST /WorkflowStateSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Products.UI.Queries
View SourceGetVatGroupsQuery
Request
GET /GetVatGroups[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DataModelNavigationByPathQuery
Request
GET /DataModelNavigationByPath[?Path&OpenTo&DisplayState&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Path | |||
OpenTo | |||
DisplayState | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetAllProductsQuery
Request
GET /GetAllProducts[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetLanguageByIdQuery
Request
GET /GetLanguageById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetLanguagesQuery
Request
GET /GetLanguages[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetProductByIdQuery
Request
GET /GetProductById[?Id&VariantId&LanguageId&GroupId&QueryId&DynamicStructureNavigationNodePath&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
VariantId | |||
LanguageId | |||
GroupId | |||
QueryId | |||
DynamicStructureNavigationNodePath | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetProductDetailsByProductQuery
Request
GET /GetProductDetailsByProduct[?ProductId&ProductVariantId&ProductLanguageId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
ProductVariantId | |||
ProductLanguageId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupedAssetsByProductIdQuery
Request
GET /GroupedAssetsByProductId[?ProductId&ProductVariantId&ProductLanguageId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
ProductVariantId | |||
ProductLanguageId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupNavigationByPathQuery
Request
GET /GroupNavigationByPath[?ShowShops&ShowChannels&ShowWarehouses&AllowShopSelection&Path&OpenTo&DisplayState&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ShowShops | |||
ShowChannels | |||
ShowWarehouses | |||
AllowShopSelection | |||
Path | |||
OpenTo | |||
DisplayState | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PeriodByIdQuery
Request
GET /PeriodById[?PeriodId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PeriodId | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PeriodNewQuery
Request
GET /PeriodNew[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PeriodsAllQuery
Request
GET /PeriodsAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAssetByIdQuery
Request
GET /ProductAssetById[?Id&QueryId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
QueryId | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAssetByProductIdQuery
Request
GET /ProductAssetByProductId[?ProductId&ProductVariantId&ProductLanguageId&DetailType&QueryId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
ProductVariantId | |||
ProductLanguageId | |||
DetailType | |||
QueryId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAssetGroupSortListQuery
Request
GET /ProductAssetGroupSortList[?ProductId&ProductVariantId&ProductLanguageId&GroupId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
ProductVariantId | |||
ProductLanguageId | |||
GroupId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAssetNewQuery
Request
GET /ProductAssetNew[?GroupId&ProductId&ProductVariantId&ProductLanguageId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
ProductId | |||
ProductVariantId | |||
ProductLanguageId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductFieldCompletionByProductIdQuery
Request
GET /ProductFieldCompletionByProductId[?ProductId&ProductVariantId&ProductLanguageId&StructureGroupIds&GroupId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
ProductVariantId | |||
ProductLanguageId | |||
StructureGroupIds | |||
GroupId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductGroupRelationNewQuery
Request
GET /ProductGroupRelationNew[?ProductId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductGroupRelationsByProductIdQuery
Request
GET /ProductGroupRelationsByProductId[?ProductId&ProductVariantId&ProductLanguageId&IsWarehouseRelations&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
ProductVariantId | |||
ProductLanguageId | |||
IsWarehouseRelations | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductItemByIdQuery
Request
GET /ProductItemById[?ProductId&Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductItemNewQuery
Request
GET /ProductItemNew[?ProductId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductItemsByProductIdQuery
Request
GET /ProductItemsByProductId[?ProductId&ProductLanguageId&ProductVariantId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
ProductLanguageId | |||
ProductVariantId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductLanguageCompletionByProductIdQuery
Request
GET /ProductLanguageCompletionByProductId[?ProductId&StructureGroupIds&GroupId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
StructureGroupIds | |||
GroupId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductManageLanguageQuery
Request
GET /ProductManageLanguage[?ProductId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductNavigationByPathQuery
Request
GET /ProductNavigationByPath[?ShowChannels&ShowWarehouses&Path&OpenTo&DisplayState&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ShowChannels | |||
ShowWarehouses | |||
Path | |||
OpenTo | |||
DisplayState | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductNewQuery
Request
GET /ProductNew[?GroupId&QueryId&DynamicStructureNavigationNodePath&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
QueryId | |||
DynamicStructureNavigationNodePath | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductPropertyFieldsByProductIdAndVariantIdAndLanguageIdQuery
Request
GET /ProductPropertyFieldsByProductIdAndVariantIdAndLanguageId[?ProductId&VariantId&LanguageId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
VariantId | |||
LanguageId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductsByIndexQueryQuery
Request
GET /ProductsByIndexQuery[?QueryId&FullTextSearch&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
QueryId | |||
FullTextSearch | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductsByVariantGroupIdQuery
Request
GET /ProductsByVariantGroupId[?GroupId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductVatGroupByProductIdAndVariantIdAndVatGroupIdQuery
Request
GET /ProductVatGroupByProductIdAndVariantIdAndVatGroupId[?ProductId&VariantId&VatGroupId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
VariantId | |||
VatGroupId | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductVatGroupNewQuery
Request
GET /ProductVatGroupNew[?ProductId&VariantId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
VariantId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductVatGroupsByProductIdAndVariantIdAndLanguageIdQuery
Request
GET /ProductVatGroupsByProductIdAndVariantIdAndLanguageId[?ProductId&VariantId&LanguageId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
VariantId | |||
LanguageId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductVersionsByIdQuery
Request
GET /ProductVersionsById[?ProductId&ProductVariantId&ProductLanguageId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
ProductVariantId | |||
ProductLanguageId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryLocationByPathQuery
Request
GET /QueryLocationByPath[?Path&OpenTo&DisplayState&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Path | |||
OpenTo | |||
DisplayState | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetVatGroupByIdQuery
Request
GET /GetVatGroupById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetVatGroupCountryRelationsQuery
Request
GET /GetVatGroupCountryRelations[?VatGroupId&ShowOnlyUsed&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
VatGroupId | |||
ShowOnlyUsed | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetVatGroupCountryRelationNewQuery
Request
GET /GetVatGroupCountryRelationNew[?VatGroupId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
VatGroupId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VatGroupCountryRelationQuery
Request
GET /VatGroupCountryRelation[?GroupId&CountryId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
CountryId | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
StockUnitByIdentifierDataQuery
Request
GET /StockUnitByIdentifierData[?ProductId&VariantId&UnitId&StockLocationId&ProductNumber&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
VariantId | |||
UnitId | |||
StockLocationId | |||
ProductNumber | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
StockUnitNewQuery
Request
GET /StockUnitNew[?ProductId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
StockUnitsByProductIdQuery
Request
GET /StockUnitsByProductId[?ProductId&ProductVariantId&ProductLanguageId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
ProductVariantId | |||
ProductLanguageId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UnitOfMeasureNewQuery
Request
GET /UnitOfMeasureNew[?ProductId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UnitsOfMeasureByProductIdQuery
Request
GET /UnitsOfMeasureByProductId[?ProductId&ProductVariantId&ProductLanguageId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
ProductVariantId | |||
ProductLanguageId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Products.UI.Queries.Assortments
View SourceAssortmentByIdQuery
Request
GET /AssortmentById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AssortmentGroupRelationsByAssortmentIdQuery
Request
GET /AssortmentGroupRelationsByAssortmentId[?AssortmentId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AssortmentId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AssortmentProductRelationsByAssortmentIdQuery
Request
GET /AssortmentProductRelationsByAssortmentId[?AssortmentId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AssortmentId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AssortmentShopRelationsByAssortmentIdQuery
Request
GET /AssortmentShopRelationsByAssortmentId[?AssortmentId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AssortmentId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetAssortmentsQuery
Request
GET /GetAssortments[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Products.UI.Queries.Comments
View SourceCommentByIdQuery
Request
GET /CommentById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CommentByProductIdQuery
Request
GET /CommentByProductId[?ProductId&ProductVariantId&ProductLanguageId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
ProductVariantId | |||
ProductLanguageId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CommentNewQuery
Request
GET /CommentNew[?ProductId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CommentRepliesByProductIdQuery
Request
GET /CommentRepliesByProductId[?ParentCommentId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ParentCommentId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Products.UI.Queries.Feeds
View SourceFeedByIdQuery
Request
GET /FeedById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FeedNewQuery
Request
GET /FeedNew[?ParentId&IsFolder&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ParentId | |||
IsFolder | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FeedsByParentIdQuery
Request
GET /FeedsByParentId[?ParentId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ParentId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryParameterByIdQuery
Request
GET /QueryParameterById[?FeedId&Name&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FeedId | |||
Name | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QueryParametersByFeedIdAnQueryIdQuery
Request
GET /QueryParametersByFeedIdAnQueryId[?FeedId&QueryId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FeedId | |||
QueryId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QuerySortInfoByIdQuery
Request
GET /QuerySortInfoById[?FeedId&Field&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FeedId | |||
Field | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QuerySortInfoNewQuery
Request
GET /QuerySortInfoNew[?FeedId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FeedId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
QuerySortInfosByFeedIdQuery
Request
GET /QuerySortInfosByFeedId[?FeedId&QueryId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FeedId | |||
QueryId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Products.UI.Queries.Prices
View SourcePriceByIdQuery
Request
GET /PriceById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PriceNewQuery
Request
GET /PriceNew[?ProductId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PricesByProductIdQuery
Request
GET /PricesByProductId[?ProductId&ProductVariantId&ProductLanguageId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
ProductVariantId | |||
ProductLanguageId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Products.UI.Queries.ProductCatalogs
View SourceDataModelByParentQuery
Request
GET /DataModelByParent[?ShopId&LanguageId&ParentGroupId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ShopId | |||
LanguageId | |||
ParentGroupId | Ther query gets top level groups when property is null |
||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DataModelGroupByIdQuery
Request
GET /DataModelGroupById[?Id&LanguageId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
LanguageId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DataModelGroupNewQuery
Request
GET /DataModelGroupNew[?ParentId&ShopId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ParentId | |||
ShopId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DataSetByDataModelIdQuery
Request
GET /DataSetByDataModelId[?LanguageId&ParentGroupId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
LanguageId | |||
ParentGroupId | Ther query gets top level groups when property is null |
||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DynamicStructureLevelByIdQuery
Request
GET /DynamicStructureLevelById[?StructureId&Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
StructureId | |||
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DynamicStructureLevelNewQuery
Request
GET /DynamicStructureLevelNew[?StructureId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
StructureId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DynamicStructureLevelResultsQuery
Request
GET /DynamicStructureLevelResults[?StructureId&StructureValues&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
StructureId | |||
StructureValues | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
DynamicStructureLevelsByDynamicStructureIdQuery
Request
GET /DynamicStructureLevelsByDynamicStructureId[?StructureId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
StructureId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetCatalogGroupProductsQuery
Request
GET /GetCatalogGroupProducts[?GroupId&LanguageId&IncludeVariants&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
LanguageId | |||
IncludeVariants | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetDynamicStructureByIdQuery
Request
GET /GetDynamicStructureById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupProductRelationRuleByGroupIdQuery
Request
GET /GroupProductRelationRuleByGroupId[?GroupId&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
PagingIndex | |||
PagingSize | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupProductRelationRuleByIdAndGroupIdQuery
Request
GET /GroupProductRelationRuleByIdAndGroupId[?Id&GroupId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
GroupId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogGroupByIdQuery
Request
GET /ProductCatalogGroupById[?Id&LanguageId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
LanguageId | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogGroupByParentQuery
Request
GET /ProductCatalogGroupByParent[?ShopId&ParentGroupId&LanguageId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ShopId | |||
ParentGroupId | The query gets top level groups when property is null |
||
LanguageId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogGroupFacetByGroupIdAndRepositoryNameAndFacetGroupNameQuery
Request
GET /ProductCatalogGroupFacetByGroupIdAndRepositoryNameAndFacetGroupName[?GroupId&Repository&FacetGroupName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
Repository | |||
FacetGroupName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogGroupFacetsByGroupIdQuery
Request
GET /ProductCatalogGroupFacetsByGroupId[?GroupId&LanguageId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
LanguageId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogGroupNewQuery
Request
GET /ProductCatalogGroupNew[?ParentId&ShopId&LanguageId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ParentId | |||
ShopId | |||
LanguageId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogGroupRelationsByGroupIdQuery
Request
GET /ProductCatalogGroupRelationsByGroupId[?GroupId&LanguageId&GetRelationsByChild&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
LanguageId | |||
GetRelationsByChild | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogGroupsByAssortmentIdQuery
Request
GET /ProductCatalogGroupsByAssortmentId[?AssortmentId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AssortmentId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogGroupsSortListQuery
Request
GET /ProductCatalogGroupsSortList[?ShopId&ParentGroupId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ShopId | |||
ParentGroupId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogProductsSortListQuery
Request
GET /ProductCatalogProductsSortList[?GroupId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCatalogRelatedGroupsByIdQuery
Request
GET /ProductCatalogRelatedGroupsById[?GroupId&LanguageId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
LanguageId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductsByDynamicStructureLevelQuery
Request
GET /ProductsByDynamicStructureLevel[?QueryId&Path&FullTextSearch&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
QueryId | |||
Path | |||
FullTextSearch | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantCombinationCreationSetupQuery
Request
GET /VariantCombinationCreationSetup[?ProductId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantCombinationEditQuery
Request
GET /VariantCombinationEdit[?ProductId&ProductVariantId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
ProductVariantId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantCombinationsByProductIdQuery
Request
GET /VariantCombinationsByProductId[?ProductId&VariantCombinationSelectionCacheKey&ProductLanguageId&ProductVariantId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
VariantCombinationSelectionCacheKey | |||
ProductLanguageId | |||
ProductVariantId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantGroupsByProductIdQuery
Request
GET /VariantGroupsByProductId[?ProductId&ProductVariantId&ProductLanguageId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
ProductVariantId | |||
ProductLanguageId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantGroupsToAddByProductIdQuery
Request
GET /VariantGroupsToAddByProductId[?ProductId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCombineByFamilyIdQuery
Request
GET /ProductCombineByFamilyId[?MasterProductId&ProductCombineSelectionCacheKey&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
MasterProductId | |||
ProductCombineSelectionCacheKey | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RelatedProductsByGroupIdQuery
Request
GET /RelatedProductsByGroupId[?GroupId&RelatedGroupId&LanguageId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
RelatedGroupId | |||
LanguageId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CompletionRuleByIdQuery
Request
GET /CompletionRuleById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Products.UI.Queries.ProductExport
View SourceProductExportQuery
Request
GET /ProductExport[?GroupId&QueryId&PresetId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
QueryId | |||
PresetId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Products.UI.Queries.RelatedProducts
View SourceProductRelatedByIdAndProductIdAndGroupIdQuery
Request
GET /ProductRelatedByIdAndProductIdAndGroupId[?ProductId&RelatedGroupId&ProductRelatedId&ProductRelatedVariantId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
RelatedGroupId | |||
ProductRelatedId | |||
ProductRelatedVariantId | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductsRelatedByProductIdQuery
Request
GET /ProductsRelatedByProductId[?ProductId&ProductVariantId&ProductLanguageId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
ProductVariantId | |||
ProductLanguageId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RelatedGroupsByGroupIdQuery
Request
GET /RelatedGroupsByGroupId[?GroupId&LanguageId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
LanguageId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RelatedGroupsByProductIdQuery
Request
GET /RelatedGroupsByProductId[?ProductId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RelatedProductsByGroupIdsAndProductIdQuery
Request
GET /RelatedProductsByGroupIdsAndProductId[?RelatedGroupId&ProductId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
RelatedGroupId | |||
ProductId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RelatedProductsByIdQuery
Request
GET /RelatedProductsById[?ProductId&ProductVariantId&ProductLanguageId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
ProductVariantId | |||
ProductLanguageId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RelatedProductsSortListQuery
Request
GET /RelatedProductsSortList[?ProductId&GroupId&LanguageId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
GroupId | |||
LanguageId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Products.UI.Queries.Settings
View SourceAssetCategoryAllQuery
Request
GET /AssetCategoryAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AssetCategoryByIdQuery
Request
GET /AssetCategoryById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AuditByIdQuery
Request
GET /AuditById[?AuditId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AuditId | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AuditDetailsByParentQuery
Request
GET /AuditDetailsByParent[?AuditId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AuditId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
AuditsByQuery
Request
GET /AuditsBy[?DetailedView&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DetailedView | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CompletionRuleAllQuery
Request
GET /CompletionRuleAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CompletionSettingsSourceByIdQuery
Request
GET /CompletionSettingsSourceById[?Id&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CountriesQuery
Request
GET /Countries[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CountryByCodeQuery
Request
GET /CountryByCode[?CountryCode&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CountryCode | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CountryNewQuery
Request
GET /CountryNew[?CountryCode&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CountryCode | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CurrenciesAllQuery
Request
GET /CurrenciesAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CurrencyByCodeQuery
Request
GET /CurrencyByCode[?CurrencyCode&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CurrencyCode | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CurrencyNewQuery
Request
GET /CurrencyNew[?CurrencyCode&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CurrencyCode | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldDisplayGroupAllQuery
Request
GET /FieldDisplayGroupAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldDisplayGroupByIdQuery
Request
GET /FieldDisplayGroupById[?Id&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldDisplayGroupTranslationByIdQuery
Request
GET /FieldDisplayGroupTranslationById[?SystemName&LanguageId&CombinedId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SystemName | |||
LanguageId | |||
CombinedId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldPermissionByShopQuery
Request
GET /FieldPermissionByShop[?ShopId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ShopId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldTypeAllQuery
Request
GET /FieldTypeAll[?SystemTypes&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SystemTypes | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
FieldTypeByIdQuery
Request
GET /FieldTypeById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GetShopByIdQuery2
Request
GET /Dynamicweb.Products.UI.Queries.Settings.GetShopByIdQuery[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ImagePatternByIdQuery
Request
GET /ImagePatternById[?ShopId&Name&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ShopId | |||
Name | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ImagePatternNewQuery
Request
GET /ImagePatternNew[?ShopId&Name&Pattern&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ShopId | |||
Name | |||
Pattern | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ImagePatternsByShopIdQuery
Request
GET /ImagePatternsByShopId[?ShopId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ShopId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ManufacturerAllQuery
Request
GET /ManufacturerAll[?Id&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ManufacturerByIdQuery
Request
GET /ManufacturerById[?Id&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAssignmentRuleAllQuery
Request
GET /ProductAssignmentRuleAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAssignmentRuleByIdQuery
Request
GET /ProductAssignmentRuleById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAssignmentRuleMappingByIdQuery
Request
GET /ProductAssignmentRuleMappingById[?Id&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAssignmentRuleMappingNewQuery
Request
GET /ProductAssignmentRuleMappingNew[?RuleId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
RuleId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAssignmentRuleMappingsQuery
Request
GET /ProductAssignmentRuleMappings[?RuleId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
RuleId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductAttributeFieldOptionSortListQuery
Request
GET /ProductAttributeFieldOptionSortList[?FieldId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FieldId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoriesAllQuery
Request
GET /ProductCategoriesAll[?CategoryType&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CategoryType | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoriesByCategoryTypeQuery
Request
GET /ProductCategoriesByCategoryType[?CategoryType&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CategoryType | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoryByIdQuery
Request
GET /ProductCategoryById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoryFieldByIdAndCategoryIdQuery
Request
GET /ProductCategoryFieldByIdAndCategoryId[?Id&CategoryId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
CategoryId | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoryFieldConvertToReferenceQuery
Request
GET /ProductCategoryFieldConvertToReference[?Id&CategoryId&CalledFromEdit&SystemName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
CategoryId | |||
CalledFromEdit | |||
SystemName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoryFieldNewQuery
Request
GET /ProductCategoryFieldNew[?CategoryId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CategoryId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoryFieldsAllQuery
Request
GET /ProductCategoryFieldsAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoryFieldsByCategoryIdQuery
Request
GET /ProductCategoryFieldsByCategoryId[?CategoryId&CategoryName&ExcludeFields&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CategoryId | |||
CategoryName | |||
ExcludeFields | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoryFieldSortListQuery
Request
GET /ProductCategoryFieldSortList[?CategoryId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CategoryId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoryFieldTranslationByIdQuery
Request
GET /ProductCategoryFieldTranslationById[?CategoryId&FieldId&LanguageId&CombinedId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CategoryId | |||
FieldId | |||
LanguageId | |||
CombinedId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoryFieldUsageByCategoryIdAndFieldIdQuery
Request
GET /ProductCategoryFieldUsageByCategoryIdAndFieldId[?CategoryId&CategoryFieldId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CategoryId | |||
CategoryFieldId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoryNewQuery
Request
GET /ProductCategoryNew[?CategoryType&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CategoryType | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoryTranslationByIdQuery
Request
GET /ProductCategoryTranslationById[?CategoryId&LanguageId&CombinedId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CategoryId | |||
LanguageId | |||
CombinedId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductCategoryUsageByCategoryIdQuery
Request
GET /ProductCategoryUsageByCategoryId[?CategoryId&ProductUsages&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CategoryId | |||
ProductUsages | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductFieldAllQuery
Request
GET /ProductFieldAll[?StandardFields&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
StandardFields | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductFieldByCategoryIdQuery
Request
GET /ProductFieldByCategoryId[?CategoryIds&CategoryType&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CategoryIds | |||
CategoryType | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductFieldByCompletionRuleIdQuery
Request
GET /ProductFieldByCompletionRuleId[?Id&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductFieldByIdQuery
Request
GET /ProductFieldById[?FieldId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FieldId | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductFieldOptionByIdQuery
Request
GET /ProductFieldOptionById[?Id&FieldId&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
FieldId | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductFieldOptionNewQuery
Request
GET /ProductFieldOptionNew[?FieldId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FieldId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductFieldOptionsByFieldIdQuery
Request
GET /ProductFieldOptionsByFieldId[?FieldId&FieldName&HasForeginCategory&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FieldId | |||
FieldName | |||
HasForeginCategory | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductFieldsSortListQuery
Request
GET /ProductFieldsSortList[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductFieldTranslationByFieldIdAndLanguageIdQuery
Request
GET /ProductFieldTranslationByFieldIdAndLanguageId[?FieldId&LanguageId&CombinedId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
FieldId | |||
LanguageId | |||
CombinedId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductGroupFieldAllQuery
Request
GET /ProductGroupFieldAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductGroupFieldByIdQuery
Request
GET /ProductGroupFieldById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductItemsSortListQuery
Request
GET /ProductItemsSortList[?ProductId&VariantId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ProductId | |||
VariantId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductUnitByIdQuery
Request
GET /ProductUnitById[?Id&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ProductUnitsAllQuery
Request
GET /ProductUnitsAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RegionByCodeQuery
Request
GET /RegionByCode[?CountryCode&RegionCode&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CountryCode | |||
RegionCode | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RegionInfoNewCountryQuery
Request
GET /RegionInfoNewCountry[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RegionInfoNewCurrencyQuery
Request
GET /RegionInfoNewCurrency[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RegionNewQuery
Request
GET /RegionNew[?CountryCode&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CountryCode | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RegionsByCountryCodeQuery
Request
GET /RegionsByCountryCode[?CountryCode&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
CountryCode | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RelationGroupAllQuery
Request
GET /RelationGroupAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RelationGroupByIdQuery
Request
GET /RelationGroupById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
RelationGroupSortListQuery
Request
GET /RelationGroupSortList[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsAdvancedEcommerceAndChannelsQuery
Request
GET /SettingsAdvancedEcommerceAndChannels[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsAdvancedGeneralQuery
Request
GET /SettingsAdvancedGeneral[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsFieldDifferentiationQuery
Request
GET /SettingsFieldDifferentiation[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingsImageOptionsQuery
Request
GET /SettingsImageOptions[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ShopAllQuery
Request
GET /ShopAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ShopNewQuery
Request
GET /ShopNew[?UsageType&DisabledUsageTypes&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
UsageType | |||
DisabledUsageTypes | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ShopsAsWarehouseQuery
Request
GET /ShopsAsWarehouse[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ShopsByAssortmentIdQuery
Request
GET /ShopsByAssortmentId[?AssortmentId&UsageType&DisabledUsageTypes&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AssortmentId | |||
UsageType | |||
DisabledUsageTypes | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantGroupAllQuery
Request
GET /VariantGroupAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantGroupByIdQuery
Request
GET /VariantGroupById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantOptionByIdQuery
Request
GET /VariantOptionById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantOptionNewQuery
Request
GET /VariantOptionNew[?GroupId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantOptionsByGroupIdQuery
Request
GET /VariantOptionsByGroupId[?GroupId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantOptionSortListQuery
Request
GET /VariantOptionSortList[?GroupId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantPropertiesByGroupIdQuery
Request
GET /VariantPropertiesByGroupId[?GroupId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantPropertyByIdQuery
Request
GET /VariantPropertyById[?GroupId&Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
VariantPropertyNewQuery
Request
GET /VariantPropertyNew[?GroupId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowAllQuery
Request
GET /WorkflowAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowByIdQuery2
Request
GET /Dynamicweb.Products.UI.Queries.Settings.WorkflowByIdQuery[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowNotificationByIdQuery
Request
GET /WorkflowNotificationById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowNotificationByWorkflowIdAndStateIdQuery
Request
GET /WorkflowNotificationByWorkflowIdAndStateId[?WorkflowId&WorkflowStateId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
WorkflowId | |||
WorkflowStateId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowNotificationNewQuery
Request
GET /WorkflowNotificationNew[?WorkflowId&WorkflowStateId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
WorkflowId | |||
WorkflowStateId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowStateByIdQuery
Request
GET /WorkflowStateById[?Id&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowStateNewQuery
Request
GET /WorkflowStateNew[?WorkflowId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
WorkflowId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
WorkflowStatesByWorkflowIdQuery
Request
GET /WorkflowStatesByWorkflowId[?WorkflowId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
WorkflowId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Users.UI.Commands
View SourceGroupDeleteCommand
Request
POST /GroupDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupMoveCommand
Request
POST /GroupMove
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupSaveCommand
Request
POST /GroupSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PermissionSettingSaveCommand
Request
POST /PermissionSettingSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SmartSearchDeleteCommand
Request
POST /SmartSearchDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SmartSearchSaveCommand
Request
POST /SmartSearchSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserAddressDeleteCommand
Request
POST /UserAddressDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserAddressMakeDefaultCommand
Request
POST /UserAddressMakeDefault
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserAddressSaveCommand
Request
POST /UserAddressSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserChangeTypeCommand
Request
POST /UserChangeType
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserDeleteCommand
Request
POST /UserDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserGroupRelationDeleteCommand
Request
POST /UserGroupRelationDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserGroupRelationSaveCommand
Request
POST /UserGroupRelationSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserImpersonateAddCommand
Request
POST /UserImpersonateAdd
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserImpersonateDeleteCommand
Request
POST /UserImpersonateDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserSaveCommand
Request
POST /UserSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserSaveSortCommand
Request
POST /UserSaveSort
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserToggleActivationCommand
Request
POST /UserToggleActivation
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Users.UI.Commands.Settings
View SourceCustomFieldDeleteCommand
Request
POST /CustomFieldDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CustomFieldOptionDeleteCommand
Request
POST /CustomFieldOptionDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CustomFieldOptionSaveCommand
Request
POST /CustomFieldOptionSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CustomFieldSaveCommand
Request
POST /CustomFieldSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ExtranetSettingsSaveCommand
Request
POST /ExtranetSettingsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PasswordSecuritySaveCommand
Request
POST /PasswordSecuritySave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingPresetDeleteCommand
Request
POST /SettingPresetDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingPresetSaveCommand
Request
POST /SettingPresetSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TokenDeleteCommand
Request
POST /TokenDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserAndGroupFieldSaveCommand
Request
POST /UserAndGroupFieldSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserAndGroupTypeDeleteCommand
Request
POST /UserAndGroupTypeDelete
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserAndGroupTypeSaveCommand
Request
POST /UserAndGroupTypeSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserSettingsSaveCommand
Request
POST /UserSettingsSave
Parameters
Name | Type | Default | Notes |
---|---|---|---|
body | object |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Users.UI.Queries
View SourceGroupByIdQuery
Request
GET /GroupById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupNavigationByPathQuery2
Request
GET /Dynamicweb.Users.UI.Queries.GroupNavigationByPathQuery[?Path&OpenTo&DisplayState&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Path | |||
OpenTo | |||
DisplayState | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupNewQuery
Query to initialize data model for new group
Request
GET /GroupNew[?ParentGroupId&TreeSection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
ParentGroupId | Parent group ID |
||
TreeSection | Tree Section for the group |
||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupsICanImpersonateByGroupIdQuery
Request
GET /GroupsICanImpersonateByGroupId[?GroupId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupsICanImpersonateByUserIdQuery
Request
GET /GroupsICanImpersonateByUserId[?UserId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
UserId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupsThatCanImpersonateMeByGroupIdQuery
Request
GET /GroupsThatCanImpersonateMeByGroupId[?GroupId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
GroupsThatCanImpersonateMeByUserIdQuery
Request
GET /GroupsThatCanImpersonateMeByUserId[?UserId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
UserId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PermissionSettingNewQuery
Request
GET /PermissionSettingNew[?GroupId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SmartSearchByIdQuery
Request
GET /SmartSearchById[?Id&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SmartSearchNewQuery
Request
GET /SmartSearchNew[?DataProviderTypeName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
DataProviderTypeName | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SmartSearchRulesByIdQuery
Request
GET /SmartSearchRulesById[?Id&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | Smart search ID |
||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserAddressByIdQuery
Request
GET /UserAddressById[?Id&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserAddressesByUserQuery
Request
GET /UserAddressesByUser[?UserId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
UserId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserAddressNewQuery
Request
GET /UserAddressNew[?UserId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
UserId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserByIdQuery
Request
GET /UserById[?Id&Source&ModelIdentifier&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
Source | |||
ModelIdentifier | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserNavigationByPathQuery
Request
GET /UserNavigationByPath[?Path&OpenTo&DisplayState&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Path | |||
OpenTo | |||
DisplayState | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserNewQuery
Query to initialize data model for new user
Request
GET /UserNew[?GroupId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | ID of the group in which user will be created |
||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UsersByAdminNamesQuery
Request
GET /UsersByAdminNames[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UsersByGroupQuery
Request
GET /UsersByGroup[?GroupId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UsersByRepositoryQuery
Request
GET /UsersByRepository[?RepositoryName&QueryName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
RepositoryName | |||
QueryName | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UsersBySmartSearchQuery
Request
GET /UsersBySmartSearch[?Id&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UsersICanImpersonateByGroupIdQuery
Request
GET /UsersICanImpersonateByGroupId[?GroupId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UsersICanImpersonateByUserIdQuery
Request
GET /UsersICanImpersonateByUserId[?UserId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
UserId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserSortListQuery
Request
GET /UserSortList[?GroupId&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UsersThatCanImpersonateMeByGroupIdQuery
Request
GET /UsersThatCanImpersonateMeByGroupId[?GroupId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
GroupId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UsersThatCanImpersonateMeByUserIdQuery
Request
GET /UsersThatCanImpersonateMeByUserId[?UserId&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
UserId | |||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
Dynamicweb.Users.UI.Queries.Settings
View SourceCustomFieldByNameQuery
Request
GET /CustomFieldByName[?TableName&SystemName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
TableName | Custom field table name |
||
SystemName | Custom field system name |
||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CustomFieldNewQuery
Request
GET /CustomFieldNew[?TableName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
TableName | Custom field table name |
||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CustomFieldOptionByIndexQuery
Request
GET /CustomFieldOptionByIndex[?TableName&SystemName&OptionIndex&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
TableName | Custom field table name |
||
SystemName | Custom field system name |
||
OptionIndex | Option index in the options collection |
||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CustomFieldOptionNewQuery
Request
GET /CustomFieldOptionNew[?TableName&SystemName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
TableName | Custom field table name |
||
SystemName | Custom field system name |
||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CustomFieldOptionsByFieldQuery
Request
GET /CustomFieldOptionsByField[?TableName&SystemName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
TableName | Custom field table name |
||
SystemName | Custom field system name |
||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
CustomFieldsByTableQuery
Request
GET /CustomFieldsByTable[?TableName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
TableName | Custom field table name |
||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
ExtranetSettingsQuery
Request
GET /ExtranetSettings[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
PasswordSecurityQuery
Request
GET /PasswordSecurity[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingPresetsAllQuery
Request
GET /SettingPresetsAll[?SortColumnName&SortDirection&PagingIndex&PagingSize&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SortColumnName | |||
SortDirection | |||
PagingIndex | |||
PagingSize | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
SettingPresetsByIdQuery
Request
GET /SettingPresetsById[?Id&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Id | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
TokensQuery
Request
GET /Tokens[?PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserAndGroupFieldByNameQuery
Request
GET /UserAndGroupFieldByName[?TypeSystemName&FieldSystemName&Label&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
TypeSystemName | User and group type system name |
||
FieldSystemName | User and group field system name |
||
Label | Field label |
||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserAndGroupFieldsByTypeNameQuery
Request
GET /UserAndGroupFieldsByTypeName[?SystemName&Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SystemName | User and group type system name |
||
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserAndGroupTypeByNameQuery
Request
GET /UserAndGroupTypeByName[?SystemName&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
SystemName | User and group type system name |
||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserAndGroupTypeNewQuery
Request
GET /UserAndGroupTypeNew[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserAndGroupTypesAllQuery
Request
GET /UserAndGroupTypesAll[?Filter&Search&PagingIndex&PagingSize&SortColumnName&SortDirection&AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
Filter | |||
Search | |||
PagingIndex | |||
PagingSize | |||
SortColumnName | |||
SortDirection | |||
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |
UserSettingsQuery
Request
GET /UserSettings[?AccessLevel]
Parameters
Name | Type | Default | Notes |
---|---|---|---|
AccessLevel | Permission level which is required to get models |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
400 | Bad request |
||
401 | Forbidden |
||
200 | object | OK |