Dynamicweb Management API

Dynamicweb.Application.UI.Commands

AddinInstallCommand

Request

POST /AddinInstall

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

AddinUninstallCommand

Request

POST /AddinUninstall

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ApiKeyDeleteCommand

Request

POST /ApiKeyDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ApiKeySaveCommand

Request

POST /ApiKeySave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

CacheClearingAddCommand

Request

POST /CacheClearingAdd

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

CacheClearingDeleteCommand

Request

POST /CacheClearingDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DatabaseDownloadCommand

Request

POST /DatabaseDownload

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DatabaseSettingsSaveCommand

Request

POST /DatabaseSettingsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DeploymentDataGroupDeleteCommand

Request

POST /DeploymentDataGroupDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DeploymentDataGroupSaveCommand

Request

POST /DeploymentDataGroupSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DeploymentDataItemTypeDeleteCommand

Request

POST /DeploymentDataItemTypeDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DeploymentDataItemTypeSaveCommand

Request

POST /DeploymentDataItemTypeSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DeploymentDestinationDeleteCommand

Request

POST /DeploymentDestinationDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DeploymentDestinationExportCommand

Request

POST /DeploymentDestinationExport

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DeploymentDestinationSaveCommand

Request

POST /DeploymentDestinationSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DeploymentDestinationTransferCommand

Request

POST /DeploymentDestinationTransfer

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DeploymentDestinationVerifyCommand

Request

POST /DeploymentDestinationVerify

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

LicenseRefreshCommand

Request

POST /LicenseRefresh

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

LoadBalancingDeleteCommand

Request

POST /LoadBalancingDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

LoadBalancingSaveCommand

Request

POST /LoadBalancingSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ModuleDeleteCommand

Request

POST /ModuleDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ModuleSaveCommand

Request

POST /ModuleSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsSystemCDNSaveCommand

Request

POST /SettingsSystemCDNSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsSystemCustomizedURLsSaveCommand

Request

POST /SettingsSystemCustomizedURLsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsSystemHTTPSaveCommand

Request

POST /SettingsSystemHTTPSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsSystemMailServerSaveCommand

Request

POST /SettingsSystemMailServerSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsSystemSecuritySaveCommand

Request

POST /SettingsSystemSecuritySave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsSystemTrackingSaveCommand

Request

POST /SettingsSystemTrackingSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

TranslationSaveCommand

Request

POST /TranslationSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

UnifiedPermissionSaveCommand

Request

POST /UnifiedPermissionSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductAttributeDifferentiationSaveCommand

Request

POST /ProductAttributeDifferentiationSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Application.UI.Commands.Repositories

View Source

BuildIndexCommand

Request

POST /BuildIndex

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

BuildIndexInstanceCommand

Request

POST /BuildIndexInstance

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

CopyFieldDefinitionSaveCommand

Request

POST /CopyFieldDefinitionSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ExtensionFieldDefinitionSaveCommand

Request

POST /ExtensionFieldDefinitionSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FacetDeleteCommand

Request

POST /FacetDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FacetGroupDeleteCommand

Request

POST /FacetGroupDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FacetGroupSaveCommand

Request

POST /FacetGroupSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FacetSaveCommand

Request

POST /FacetSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FacetSaveSortCommand

Request

POST /FacetSaveSort

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FieldDefinitionDeleteCommand

Request

POST /FieldDefinitionDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FieldDefinitionSaveCommand

Request

POST /FieldDefinitionSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FieldTypeDefinitionDeleteCommand

Request

POST /FieldTypeDefinitionDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FieldTypeDefinitionSaveCommand

Request

POST /FieldTypeDefinitionSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GroupingFieldDefinitionSaveCommand

Request

POST /GroupingFieldDefinitionSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GroupingFieldGroupDeleteCommand

Request

POST /GroupingFieldGroupDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GroupingFieldGroupSaveCommand

Request

POST /GroupingFieldGroupSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

IndexBuilderDeleteCommand

Request

POST /IndexBuilderDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

IndexBuilderSaveCommand

Request

POST /IndexBuilderSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

IndexDeleteCommand

Request

POST /IndexDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

IndexSaveCommand

Request

POST /IndexSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

IndexSearchConfigurationDeleteCommand

Request

POST /IndexSearchConfigurationDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

IndexSearchConfigurationRebuildIndexesCommand

Request

POST /IndexSearchConfigurationRebuildIndexes

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

IndexSearchConfigurationSaveCommand

Request

POST /IndexSearchConfigurationSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

InstanceDeleteCommand

Request

POST /InstanceDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

InstanceSaveCommand

Request

POST /InstanceSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

MyFavoriteQueryAddCommand

Request

POST /MyFavoriteQueryAdd

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

MyFavoriteQueryDetachCommand

Request

POST /MyFavoriteQueryDetach

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

QueryCopyCommand

Request

POST /QueryCopy

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

QueryDeleteCommand

Request

POST /QueryDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

QueryExpressionDeleteCommand

Request

POST /QueryExpressionDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

QueryExpressionSaveCommand

Request

POST /QueryExpressionSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

QueryExpressionToggleDisabledCommand

Request

POST /QueryExpressionToggleDisabled

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

QueryFolderDeleteCommand

Request

POST /QueryFolderDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

QueryFolderSaveCommand

Request

POST /QueryFolderSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

QueryGroupExpressionSaveCommand

Request

POST /QueryGroupExpressionSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

QueryMoveCommand

Request

POST /QueryMove

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

QueryParameterSaveCommand

Request

POST /QueryParameterSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

QueryParametersDeleteCommand

Request

POST /QueryParametersDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

QuerySaveCommand

Request

POST /QuerySave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

QuerySortDeleteCommand

Request

POST /QuerySortDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

QuerySortSaveCommand

Request

POST /QuerySortSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RepositoryAddCommand

Request

POST /RepositoryAdd

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RepositoryDeleteCommand

Request

POST /RepositoryDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

TaskDeleteCommand

Request

POST /TaskDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

TaskSaveCommand

Request

POST /TaskSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Application.UI.Commands.Settings

View Source

AssemblyDownloadCommand

Request

POST /AssemblyDownload

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GlobalSettingSaveCommand

Request

POST /GlobalSettingSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsSystemSolutionSettingsSaveCommand

Request

POST /SettingsSystemSolutionSettingsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Application.UI.DynamicFields

View Source

DummyItemEntrySaveCommand

Request

POST /DummyItemEntrySave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Application.UI.Queries

View Source

AddinAllQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

DatabaseSettingsQuery

Request

GET /DatabaseSettings[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

LicenseQuery

Request

GET /License[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

ModuleNewQuery

Request

GET /ModuleNew[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsSystemCDNQuery

Request

GET /SettingsSystemCDN[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsSystemCustomizedURLsQuery

Request

GET /SettingsSystemCustomizedURLs[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsSystemHTTPQuery

Request

GET /SettingsSystemHTTP[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsSystemMailServerQuery

Request

GET /SettingsSystemMailServer[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsSystemSecurityQuery

Request

GET /SettingsSystemSecurity[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsSystemSolutionDetailsQuery

Request

GET /SettingsSystemSolutionDetails[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsSystemSolutionSettingsQuery

Request

GET /SettingsSystemSolutionSettings[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsSystemTrackingQuery

Request

GET /SettingsSystemTracking[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Application.UI.Queries.Repositories

View Source

CopyFieldDefinitionNewQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Application.UI.Queries.Settings

View Source

AddInClassesByTypeQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Application.UI.TreeNavigation

View Source

NavigationByPathQuery

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Apps.UI.Commands.DataPortability

View Source

DataDefinitionDeleteCommand

Request

POST /DataDefinitionDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DataDefinitionSaveCommand

Request

POST /DataDefinitionSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DataGroupDeleteCommand

Request

POST /DataGroupDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DataGroupSaveCommand

Request

POST /DataGroupSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DataItemTypeDeleteCommand

Request

POST /DataItemTypeDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DataItemTypeSaveCommand

Request

POST /DataItemTypeSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Apps.UI.Commands.DataProcessing

View Source

ActivityDeleteCommand

Request

POST /ActivityDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ActivitySaveCommand

Request

POST /ActivitySave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ConsentDeleteCommand

Request

POST /ConsentDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Apps.UI.Commands.Forms

View Source

AreaTemplateSetSaveCommand

Request

POST /AreaTemplateSetSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FieldCopyCommand

Request

POST /FieldCopy

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FieldDeleteCommand

Request

POST /FieldDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FieldSaveCommand

Request

POST /FieldSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FieldToggleActiveCommand

Request

POST /FieldToggleActive

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FieldToggleRequiredCommand

Request

POST /FieldToggleRequired

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FormCopyCommand

Request

POST /FormCopy

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FormDeleteCommand

Request

POST /FormDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FormSettingsSaveCommand

Request

POST /FormSettingsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SubmitDeleteCommand

Request

POST /SubmitDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Apps.UI.Queries.DataPortability

View Source

DataDefinitionByIdQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

DataDefinitionNewQuery

Request

GET /DataDefinitionNew[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Apps.UI.Queries.DataProcessing

View Source

ActivitiesByFilterQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

ActivityNewQuery

Request

GET /ActivityNew[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Apps.UI.Queries.Forms

View Source

AreaTemplateSetByAreaIdQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

FormNewQuery

Request

GET /FormNew[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Content.UI.Commands

View Source

AreaCopyCommand

Request

POST /AreaCopy

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

AreaDeleteCommand

Request

POST /AreaDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

AreaSaveCommand

Request

POST /AreaSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

AreasSaveSortCommand

Request

POST /AreasSaveSort

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

AreaToggleActiveCommand

Request

POST /AreaToggleActive

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ColorSwatchSaveCommand

Request

POST /ColorSwatchSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ExportSettingsSaveCommand

Request

POST /ExportSettingsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FolderSaveCommand

Request

POST /FolderSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GridRowSaveSortCommand

Request

POST /GridRowSaveSort

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ImportSettingsSaveCommand

Request

POST /ImportSettingsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PageCopyCommand

Request

POST /PageCopy

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PageCreateCommand

Request

POST /PageCreate

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PageDeleteCommand

Request

POST /PageDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PageMoveCommand

Request

POST /PageMove

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PagePublicationStateChangeCommand

Request

POST /PagePublicationStateChange

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PageSaveCommand

Request

POST /PageSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PageTemplateSaveCommand

Request

POST /PageTemplateSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ParagraphBulkCopyCommand

Request

POST /ParagraphBulkCopy

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ParagraphChangeActiveCommand

Request

POST /ParagraphChangeActive

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ParagraphCopyCommand

Request

POST /ParagraphCopy

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ParagraphDeleteCommand

Request

POST /ParagraphDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ParagraphMoveCommand

Request

POST /ParagraphMove

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ParagraphSaveCommand

Request

POST /ParagraphSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ParagraphSaveSortCommand

Request

POST /ParagraphSaveSort

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ParagraphTemplateSaveCommand

Request

POST /ParagraphTemplateSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ShortcutCreateCommand

Request

POST /ShortcutCreate

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Content.UI.Commands.Settings

View Source

LanguageSettingsSaveCommand

Request

POST /LanguageSettingsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Content.UI.Commands.Settings.Editing

View Source

InterfaceSettingsSaveCommand

Request

POST /InterfaceSettingsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

WorkflowDeleteCommand

Request

POST /WorkflowDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

WorkflowSaveCommand

Request

POST /WorkflowSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

WorkflowUserDeleteCommand

Request

POST /WorkflowUserDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

WorkflowUserSaveCommand

Request

POST /WorkflowUserSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Content.UI.Commands.Settings.ItemTypes

View Source

ItemCategoryDeleteCommand

Request

POST /ItemCategoryDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ItemFieldDeleteCommand

Request

POST /ItemFieldDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ItemFieldGroupDeleteCommand

Request

POST /ItemFieldGroupDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ItemFieldGroupSaveCommand

Request

POST /ItemFieldGroupSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ItemFieldGroupSaveSortCommand

Request

POST /ItemFieldGroupSaveSort

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ItemFieldSaveCommand

Request

POST /ItemFieldSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ItemFieldSaveSortCommand

Request

POST /ItemFieldSaveSort

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ItemTypeCopyCommand

Request

POST /ItemTypeCopy

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ItemTypeDeleteCommand

Request

POST /ItemTypeDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ItemTypeListReloadCommand

Request

POST /ItemTypeListReload

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ItemTypeSaveCommand

Request

POST /ItemTypeSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ItemTypeSettingsSaveCommand

Request

POST /ItemTypeSettingsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Content.UI.Commands.Settings.ItemTypes.FieldOptions

View Source

FieldOptionMetadataCopyCommand

Request

POST /FieldOptionMetadataCopy

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FieldOptionMetadataDeleteCommand

Request

POST /FieldOptionMetadataDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FieldOptionMetadataSaveCommand

Request

POST /FieldOptionMetadataSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FieldOptionMetadataSaveSortCommand

Request

POST /FieldOptionMetadataSaveSort

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Content.UI.Commands.VisualEditor

View Source

GridColumnCreateCommand

Request

POST /GridColumnCreate

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GridColumnSortCommand

Request

POST /GridColumnSort

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GridColumnUnlinkCommand

Request

POST /GridColumnUnlink

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GridLinkSaveCommand

Request

POST /GridLinkSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GridRowCopyCommand

Request

POST /GridRowCopy

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GridRowCreateCommand

Request

POST /GridRowCreate

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GridRowDeleteCommand

Request

POST /GridRowDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GridRowPublishCommand

Request

POST /GridRowPublish

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GridRowSaveCommand

Request

POST /GridRowSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GridRowSortCommand

Request

POST /GridRowSort

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GridRowTemplateSaveCommand

Request

POST /GridRowTemplateSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Content.UI.Queries

View Source

AddinDependenciesQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Content.UI.Queries.Settings

View Source

GetLanguageSettingsQuery

Request

GET /GetLanguageSettings[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Content.UI.Queries.Settings.Editing

View Source

GetInterfaceSettingsQuery

Request

GET /GetInterfaceSettings[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Content.UI.Queries.Settings.ItemTypes

View Source

ItemFieldBySystemNameAndItemTypeQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

ItemSettingsQuery

Request

GET /ItemSettings[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Content.UI.Queries.Settings.ItemTypes.FieldOptions

View Source

FieldOptionMetadataByFieldIdAndSourceTypeQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.CoreUI.Data.ScreenConfiguration

View Source

ScreenConfigurationQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

ScreenConfigurationSaveCommand

Request

POST /ScreenConfigurationSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.CoreUI.Lists

View Source

ListSelectionModelQuery

Request

GET /ListSelectionModel[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.CoreUI.Screens.Implementations

View Source

MultiEditByQueryQuery

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Demo.UI.Commands

View Source

TestListItemRenameCommand

Request

POST /TestListItemRename

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

TestListItemsDeleteCommand

Request

POST /TestListItemsDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Demo.UI.Implementations

View Source

ScreenImplementationsAllQuery

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Demo.UI.Queries

View Source

IconsQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Ecommerce.UI.Commands

View Source

AddressValidatorDeleteCommand

Request

POST /AddressValidatorDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

AddressValidatorSaveCommand

Request

POST /AddressValidatorSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

AddressValidatorToggleActiveCommand

Request

POST /AddressValidatorToggleActive

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FeeDeleteCommand

Request

POST /FeeDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FeeRuleSaveCommand

Request

POST /FeeRuleSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FeeRuleToggleActiveCommand

Request

POST /FeeRuleToggleActive

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FeeSaveCommand

Request

POST /FeeSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FutureDeliveryCancelCommand

Request

POST /FutureDeliveryCancel

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FutureDeliveryRestoreCommand

Request

POST /FutureDeliveryRestore

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderCancelRecurringCommand

Request

POST /OrderCancelRecurring

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderCaptureBulkCommand

Request

POST /OrderCaptureBulk

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderCaptureCommand

Request

POST /OrderCapture

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderChangeOrderStateCommand

Request

POST /OrderChangeOrderState

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderCreateShippingDocumentsCommand

Request

POST /OrderCreateShippingDocuments

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderDeleteCommand

Request

POST /OrderDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderFieldDeleteCommand

Request

POST /OrderFieldDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderFieldSaveCommand

Request

POST /OrderFieldSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderFlowDeleteCommand

Request

POST /OrderFlowDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderFlowSaveCommand

Request

POST /OrderFlowSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderAddDiscountCommand

Request

POST /OrderAddDiscount

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderLineAddProductCommand

Request

POST /OrderLineAddProduct

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderLineDeleteCommand

Request

POST /OrderLineDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderLineFieldDeleteCommand

Request

POST /OrderLineFieldDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderLineFieldSaveCommand

Request

POST /OrderLineFieldSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderLineSaveCommand

Request

POST /OrderLineSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderSaveCommand

Request

POST /OrderSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderStateDeleteCommand

Request

POST /OrderStateDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderStateSaveCommand

Request

POST /OrderStateSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PaymentDeleteCommand

Request

POST /PaymentDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PaymentSaveCommand

Request

POST /PaymentSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PaymentToggleActiveCommand

Request

POST /PaymentToggleActive

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RmaCloseCommand

Request

POST /RmaClose

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RmaDeleteCommand

Request

POST /RmaDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RmaEmailConfigurationDeleteCommand

Request

POST /RmaEmailConfigurationDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RmaEmailConfigurationSaveCommand

Request

POST /RmaEmailConfigurationSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RmaEventSaveCommand

Request

POST /RmaEventSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RmaOrderLineSaveCommand

Request

POST /RmaOrderLineSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RmaReplacementOrderCreateCommand

Request

POST /RmaReplacementOrderCreate

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RmaSaveCommand

Request

POST /RmaSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RmaStateDeleteCommand

Request

POST /RmaStateDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RmaStateSaveCommand

Request

POST /RmaStateSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RoundingDeleteCommand

Request

POST /RoundingDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RoundingSaveCommand

Request

POST /RoundingSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ShippingCopyCommand

Request

POST /ShippingCopy

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ShippingDeleteCommand

Request

POST /ShippingDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ShippingSaveCommand

Request

POST /ShippingSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ShippingToggleActiveCommand

Request

POST /ShippingToggleActive

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

StockGroupDeleteCommand

Request

POST /StockGroupDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

StockGroupSaveCommand

Request

POST /StockGroupSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

StockLocationCategoryDeleteCommand

Request

POST /StockLocationCategoryDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

StockLocationCategorySaveCommand

Request

POST /StockLocationCategorySave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

StockLocationCopyCommand

Request

POST /StockLocationCopy

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

StockLocationDeleteCommand

Request

POST /StockLocationDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

StockLocationSaveCommand

Request

POST /StockLocationSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

StockStatusDeleteCommand

Request

POST /StockStatusDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

StockStatusSaveCommand

Request

POST /StockStatusSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

TaxSettingCopyCommand

Request

POST /TaxSettingCopy

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

TaxSettingDeleteCommand

Request

POST /TaxSettingDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

TaxSettingSaveCommand

Request

POST /TaxSettingSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

TrackAndTraceDeleteCommand

Request

POST /TrackAndTraceDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

TrackAndTraceParameterDeleteCommand

Request

POST /TrackAndTraceParameterDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

TrackAndTraceParameterSaveCommand

Request

POST /TrackAndTraceParameterSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

TrackAndTraceSaveCommand

Request

POST /TrackAndTraceSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Ecommerce.UI.Commands.Discounts

View Source

CustomerProductListCopyListCommand

Request

POST /CustomerProductListCopyList

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

CustomerProductListDeleteCommand

Request

POST /CustomerProductListDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

CustomerProductListProductAddCommand

Request

POST /CustomerProductListProductAdd

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

CustomerProductListProductRemoveCommand

Request

POST /CustomerProductListProductRemove

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

CustomerProductListSaveCommand

Request

POST /CustomerProductListSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DiscountAddToVoucherListCommand

Request

POST /DiscountAddToVoucherList

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DiscountDeleteCommand

Request

POST /DiscountDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DiscountRuleDeleteCommand

Request

POST /DiscountRuleDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DiscountRuleSaveCommand

Request

POST /DiscountRuleSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DiscountSaveCommand

Request

POST /DiscountSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GiftCardCancelCommand

Request

POST /GiftCardCancel

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

LoyaltyPointRewardSaveCommand

Request

POST /LoyaltyPointRewardSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

LoyaltyPointsRewardDeleteCommand

Request

POST /LoyaltyPointsRewardDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

LoyaltyPointsRewardSpecificDeleteCommand

Request

POST /LoyaltyPointsRewardSpecificDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RewardRuleConditionDeleteCommand

Request

POST /RewardRuleConditionDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RewardRuleDeleteCommand

Request

POST /RewardRuleDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RewardRuleSaveCommand

Request

POST /RewardRuleSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VoucherListDeleteCommand

Request

POST /VoucherListDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VoucherListDetachDiscountsCommand

Request

POST /VoucherListDetachDiscounts

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VoucherListSaveCommand

Request

POST /VoucherListSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VoucherListToggleActiveCommand

Request

POST /VoucherListToggleActive

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VoucherRewardDeleteCommand

Request

POST /VoucherRewardDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VoucherRewardGenerateCommand

Request

POST /VoucherRewardGenerate

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VoucherRewardSaveCommand

Request

POST /VoucherRewardSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VoucherRewardSendMailCommand

Request

POST /VoucherRewardSendMail

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VoucherRewardToCsvCommand

Request

POST /VoucherRewardToCsv

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Ecommerce.UI.Commands.Settings

View Source

GiftCardSettingsSaveCommand

Request

POST /GiftCardSettingsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

LoyaltyPointsSettingsSaveCommand

Request

POST /LoyaltyPointsSettingsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

NumberDeleteCommand

Request

POST /NumberDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

NumberSaveCommand

Request

POST /NumberSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderContextCopyCommand

Request

POST /OrderContextCopy

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderContextDeleteCommand

Request

POST /OrderContextDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderContextSaveCommand

Request

POST /OrderContextSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderDiscountsSettingsSaveCommand

Request

POST /OrderDiscountsSettingsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PaymentCopyCommand

Request

POST /PaymentCopy

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PriceSettingsSaveCommand

Request

POST /PriceSettingsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsOrdersSaveCommand

Request

POST /SettingsOrdersSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ShoppingCartSettingsSaveCommand

Request

POST /ShoppingCartSettingsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ValidationDeleteCommand

Request

POST /ValidationDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ValidationGroupDeleteCommand

Request

POST /ValidationGroupDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ValidationGroupSaveCommand

Request

POST /ValidationGroupSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ValidationRuleDeleteCommand

Request

POST /ValidationRuleDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ValidationRuleSaveCommand

Request

POST /ValidationRuleSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ValidationSaveCommand

Request

POST /ValidationSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Ecommerce.UI.Queries

View Source

AddressValidatorByIdQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

GetGiftCardSettingsQuery

Request

GET /GetGiftCardSettings[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

GetRmaEmailNotificationsQuery

Request

GET /GetRmaEmailNotifications[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

RmaStateNewQuery

Request

GET /RmaStateNew[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

StockLocationNewQuery

Request

GET /StockLocationNew[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

TrackAndTraceNewQuery

Request

GET /TrackAndTraceNew[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Ecommerce.UI.Queries.Discounts

View Source

CustomerProductListByIdQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

DiscountsLatestQuery

Request

GET /DiscountsLatest[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

LoyaltyPointsRewardNewQuery

Request

GET /LoyaltyPointsRewardNew[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Ecommerce.UI.Queries.Settings

View Source

GetNumberByIdQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

LoyaltyPointsSettingsQuery

Request

GET /LoyaltyPointsSettings[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderDiscountsSettingsQuery

Request

GET /OrderDiscountsSettings[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PriceSettingsQuery

Request

GET /PriceSettings[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsOrdersQuery

Request

GET /SettingsOrders[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ShoppingCartSettingsQuery

Request

GET /ShoppingCartSettings[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Files.UI.Commands

View Source

ImageSettingsSaveCommand

Request

POST /ImageSettingsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsCustomFoldersSaveCommand

Request

POST /SettingsCustomFoldersSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsFileManagerSaveCommand

Request

POST /SettingsFileManagerSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ThumbnailSettingsDeleteCommand

Request

POST /ThumbnailSettingsDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ThumbnailSettingsSaveCommand

Request

POST /ThumbnailSettingsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Files.UI.Commands.Directories

View Source

DirectoryCopyCommand

Request

POST /DirectoryCopy

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DirectoryDeleteCommand

Request

POST /DirectoryDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DirectoryDownloadCommand

Request

POST /DirectoryDownload

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DirectoryEmptyCommand

Request

POST /DirectoryEmpty

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DirectoryMoveCommand

Request

POST /DirectoryMove

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DirectorySaveCommand

Request

POST /DirectorySave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Files.UI.Commands.Files

View Source

ContentFileSaveCommand

Request

POST /ContentFileSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FileCopyCommand

Request

POST /FileCopy

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FileCopyMultiCommand

Request

POST /FileCopyMulti

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FileCreateRenameCommand

Request

POST /FileCreateRename

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FileDeleteCommand

Request

POST /FileDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FileDownloadCommand

Request

POST /FileDownload

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FileMoveCommand

Request

POST /FileMove

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FileMoveMultiCommand

Request

POST /FileMoveMulti

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Files.UI.Commands.Metadata

View Source

MetadataFieldDeleteCommand

Request

POST /MetadataFieldDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

MetadataFieldOptionDeleteCommand

Request

POST /MetadataFieldOptionDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

MetadataFieldOptionSaveCommand

Request

POST /MetadataFieldOptionSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

MetadataFieldSaveCommand

Request

POST /MetadataFieldSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Files.UI.Queries

View Source

ContentFileByNameQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsCustomFoldersQuery

Request

GET /SettingsCustomFolders[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsFileManagerQuery

Request

GET /SettingsFileManager[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Files.UI.Queries.Metadata

View Source

MetadataFieldByPathAndIdQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Files.UI.Selectors

View Source

FileSelectorProviderQuery

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Insights.UI.Commands

View Source

LogEventNotificationDeleteCommand

Request

POST /LogEventNotificationDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

LogEventNotificationSaveCommand

Request

POST /LogEventNotificationSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Insights.UI.Queries

View Source

HealthProviderChecksByProviderNameQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

IntegrationJobsAllQuery

Request

GET /IntegrationJobsAll[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

LogEventNotificationAllQuery

Request

GET /LogEventNotificationAll[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

ScheduledTaskAllQuery

Request

GET /ScheduledTaskAll[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Integration.UI.Commands

View Source

ActivityCopyCommand

Request

POST /ActivityCopy

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ActivityDeleteCommand2

Request

POST /Dynamicweb.Integration.UI.Commands.ActivityDeleteCommand

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ActivityInstallPackageCommand

Request

POST /ActivityInstallPackage

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ActivityRunCommand

Request

POST /ActivityRun

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ActivitySaveCommand2

Request

POST /Dynamicweb.Integration.UI.Commands.ActivitySaveCommand

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ActivitySchemaUpdateCommand

Request

POST /ActivitySchemaUpdate

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ColumnMappingDeleteCommand

Request

POST /ColumnMappingDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ColumnMappingSaveCommand

Request

POST /ColumnMappingSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ColumnMappingsDeleteCommand

Request

POST /ColumnMappingsDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ColumnMappingsSaveSortCommand

Request

POST /ColumnMappingsSaveSort

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ColumnMappingsSetActiveStateCommand

Request

POST /ColumnMappingsSetActiveState

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

EndpointCollectionDeleteCommand

Request

POST /EndpointCollectionDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

EndpointCollectionSaveCommand

Request

POST /EndpointCollectionSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

EndpointCopyCommand

Request

POST /EndpointCopy

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

EndpointDeleteCommand

Request

POST /EndpointDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

EndpointDownloadResponseCommand

Request

POST /EndpointDownloadResponse

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

EndpointMoveCommand

Request

POST /EndpointMove

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

EndpointRequestSaveCommand

Request

POST /EndpointRequestSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

EndpointSaveCommand

Request

POST /EndpointSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

EndpointSaveSortCommand

Request

POST /EndpointSaveSort

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

EndpointTestSaveCommand

Request

POST /EndpointTestSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

LiveIntegrationDeleteCommand

Request

POST /LiveIntegrationDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

LiveIntegrationSaveCommand

Request

POST /LiveIntegrationSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ScheduleTaskAddCommand

Request

POST /ScheduleTaskAdd

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ScheduleTaskRemoveCommand

Request

POST /ScheduleTaskRemove

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

TableMappingConditionalsDeleteCommand

Request

POST /TableMappingConditionalsDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

TableMappingConditionalsSaveCommand

Request

POST /TableMappingConditionalsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

TableMappingDeleteCommand

Request

POST /TableMappingDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

TableMappingSaveCommand

Request

POST /TableMappingSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

TaskDeleteCommand2

Request

POST /Dynamicweb.Integration.UI.Commands.TaskDeleteCommand

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

TaskSaveCommand2

Request

POST /Dynamicweb.Integration.UI.Commands.TaskSaveCommand

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Integration.UI.Commands.DataImport

View Source

DataImportClearSourceParametersCommand

Request

POST /DataImportClearSourceParameters

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DataImportUpdateSourceParametersCommand

Request

POST /DataImportUpdateSourceParameters

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Integration.UI.Commands.Settings

View Source

ExportOrdersSettingsSaveCommand

Request

POST /ExportOrdersSettingsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Integration.UI.Queries

View Source

ActivitiesQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Integration.UI.Queries.DataImport

View Source

DataImportQuery

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Integration.UI.Queries.Settings

View Source

ExportOrdersSettingsQuery

Request

GET /ExportOrdersSettings[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Marketing.UI.Commands

View Source

EmailFolderDeleteCommand

Request

POST /EmailFolderDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

EmailFolderSaveCommand

Request

POST /EmailFolderSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

EmailSaveCommand

Request

POST /EmailSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

EmailSendCommand

Request

POST /EmailSend

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FlowFolderDeleteCommand

Request

POST /FlowFolderDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FlowFolderSaveCommand

Request

POST /FlowFolderSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FlowSaveCommand

Request

POST /FlowSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

TopFolderDeleteCommand

Request

POST /TopFolderDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

TopFolderSaveCommand

Request

POST /TopFolderSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Marketing.UI.Commands.Settings

View Source

EmailMarketingSettingsSaveCommand

Request

POST /EmailMarketingSettingsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PersonalizationSettingsSaveCommand

Request

POST /PersonalizationSettingsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Marketing.UI.Queries

View Source

EmailByIdQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

TopFolderNewQuery

Request

GET /TopFolderNew[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

TopLevelFlowsQuery

Request

GET /TopLevelFlows[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Marketing.UI.Queries.Settings

View Source

EmailMarketingSettingsQuery

Request

GET /EmailMarketingSettings[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PersonalizationSettingsQuery

Request

GET /PersonalizationSettings[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Products.UI.Commands

View Source

CommentCopyCommand

Request

POST /CommentCopy

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

LanguageDeleteCommand

Request

POST /LanguageDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

LanguageSaveCommand

Request

POST /LanguageSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

OrderLineFieldGroupRelationSaveCommand

Request

POST /OrderLineFieldGroupRelationSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PeriodDeleteCommand

Request

POST /PeriodDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PeriodSaveCommand

Request

POST /PeriodSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PeriodToggleActiveCommand

Request

POST /PeriodToggleActive

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductAssetAddCommand

Request

POST /ProductAssetAdd

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductAssetChangeCategoryCommand

Request

POST /ProductAssetChangeCategory

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductAssetDeleteCommand

Request

POST /ProductAssetDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductAssetGroupSaveSortCommand

Request

POST /ProductAssetGroupSaveSort

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductAssetMetadataSaveCommand

Request

POST /ProductAssetMetadataSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductAssetUpdateDefaultCommand

Request

POST /ProductAssetUpdateDefault

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductAttachCommand

Request

POST /ProductAttach

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCatalogRelatedGroupAttachCommand

Request

POST /ProductCatalogRelatedGroupAttach

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCatalogRelatedGroupDeleteCommand

Request

POST /ProductCatalogRelatedGroupDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCombineRemoveCommand

Request

POST /ProductCombineRemove

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductDeleteCommand

Request

POST /ProductDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductDetachCommand

Request

POST /ProductDetach

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductDuplicateCommand

Request

POST /ProductDuplicate

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductGroupRelationDeleteCommand

Request

POST /ProductGroupRelationDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductGroupRelationSaveCommand

Request

POST /ProductGroupRelationSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductGroupRelationTogglePrimaryCommand

Request

POST /ProductGroupRelationTogglePrimary

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductItemAddCommand

Request

POST /ProductItemAdd

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductItemDeleteCommand

Request

POST /ProductItemDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductMoveCommand

Request

POST /ProductMove

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductSaveCommand

Request

POST /ProductSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductSetLanguagesCommand

Request

POST /ProductSetLanguages

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductUpdateGroupShopIndexesCommand

Request

POST /ProductUpdateGroupShopIndexes

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductUpdateQueryIndexCommand

Request

POST /ProductUpdateQueryIndex

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductVatGroupDeleteCommand

Request

POST /ProductVatGroupDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductVatGroupSaveCommand

Request

POST /ProductVatGroupSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductVersionRollbackCommand

Request

POST /ProductVersionRollback

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VatGroupCountryRelationDeleteCommand

Request

POST /VatGroupCountryRelationDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VatGroupCountryRelationSaveCommand

Request

POST /VatGroupCountryRelationSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VatGroupDeleteCommand

Request

POST /VatGroupDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VatGroupSaveCommand

Request

POST /VatGroupSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

StockUnitDeleteCommand

Request

POST /StockUnitDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

StockUnitSaveCommand

Request

POST /StockUnitSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

UnitOfMeasureDeleteCommand

Request

POST /UnitOfMeasureDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

UnitOfMeasureSaveCommand

Request

POST /UnitOfMeasureSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Products.UI.Commands.Assortments

View Source

AssortmentAttachCommand

Request

POST /AssortmentAttach

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

AssortmentDeleteCommand

Request

POST /AssortmentDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

AssortmentGroupRelationAttachCommand

Request

POST /AssortmentGroupRelationAttach

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

AssortmentGroupRelationDetachCommand

Request

POST /AssortmentGroupRelationDetach

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

AssortmentProductGroupDeleteCommand

Request

POST /AssortmentProductGroupDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

AssortmentProductRelationAttachCommand

Request

POST /AssortmentProductRelationAttach

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

AssortmentProductRelationDetachCommand

Request

POST /AssortmentProductRelationDetach

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

AssortmentRebuildCommand

Request

POST /AssortmentRebuild

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

AssortmentSaveCommand

Request

POST /AssortmentSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

AssortmentShopRelationAttachCommand

Request

POST /AssortmentShopRelationAttach

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

AssortmentShopRelationDetachCommand

Request

POST /AssortmentShopRelationDetach

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

AssortmentUserDeleteCommand

Request

POST /AssortmentUserDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Products.UI.Commands.Comments

View Source

CommentDeleteCommand

Request

POST /CommentDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

CommentSaveCommand

Request

POST /CommentSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Products.UI.Commands.Feeds

View Source

FeedDeleteCommand

Request

POST /FeedDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FeedSaveCommand

Request

POST /FeedSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

QueryParameterSaveCommand2

Request

POST /Dynamicweb.Products.UI.Commands.Feeds.QueryParameterSaveCommand

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

QuerySortInfoDeleteCommand

Request

POST /QuerySortInfoDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

QuerySortInfoSaveCommand

Request

POST /QuerySortInfoSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Products.UI.Commands.Prices

View Source

PriceCopyCommand

Request

POST /PriceCopy

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PriceDeleteCommand

Request

POST /PriceDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PriceSaveCommand

Request

POST /PriceSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Products.UI.Commands.ProductCatalogs

View Source

CompletionLanguageRemoveFromGroupCommand

Request

POST /CompletionLanguageRemoveFromGroup

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

CompletionRuleRemoveFromGroupCommand

Request

POST /CompletionRuleRemoveFromGroup

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

CompletionRuleRemoveFromShopCommand

Request

POST /CompletionRuleRemoveFromShop

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DataModelGroupDeleteCommand

Request

POST /DataModelGroupDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DataModelGroupSaveCommand

Request

POST /DataModelGroupSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DynamicStructureDeleteCommand

Request

POST /DynamicStructureDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DynamicStructureLevelDeleteCommand

Request

POST /DynamicStructureLevelDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DynamicStructureLevelSaveCommand

Request

POST /DynamicStructureLevelSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

DynamicStructureSaveCommand

Request

POST /DynamicStructureSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GroupProductRelationRuleDeleteCommand

Request

POST /GroupProductRelationRuleDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GroupProductRelationRuleSaveCommand

Request

POST /GroupProductRelationRuleSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCatalogAttachCommand

Request

POST /ProductCatalogAttach

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCatalogAttachGroupSubGroupsCommand

Request

POST /ProductCatalogAttachGroupSubGroups

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCatalogDetachGroupSubGroupsCommand

Request

POST /ProductCatalogDetachGroupSubGroups

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCatalogGroupAttachProductsCommand

Request

POST /ProductCatalogGroupAttachProducts

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCatalogGroupDeleteCommand

Request

POST /ProductCatalogGroupDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCatalogGroupFacetSaveCommand

Request

POST /ProductCatalogGroupFacetSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCatalogGroupMoveCommand

Request

POST /ProductCatalogGroupMove

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCatalogGroupRelationDetachCommand

Request

POST /ProductCatalogGroupRelationDetach

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCatalogGroupSaveCommand

Request

POST /ProductCatalogGroupSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCatalogGroupsSaveSortCommand

Request

POST /ProductCatalogGroupsSaveSort

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCatalogProductsSaveSortCommand

Request

POST /ProductCatalogProductsSaveSort

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VariantCombinationCreateCommand

Request

POST /VariantCombinationCreate

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VariantCombinationDeleteCommand

Request

POST /VariantCombinationDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VariantCombinationSaveCommand

Request

POST /VariantCombinationSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VariantCombinationUpdateCommand

Request

POST /VariantCombinationUpdate

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VariantGroupAddCommand

Request

POST /VariantGroupAdd

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VariantGroupDeleteCommand2

Request

POST /Dynamicweb.Products.UI.Commands.ProductCatalogs.VariantGroupDeleteCommand

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCombineAddProductsCommand

Request

POST /ProductCombineAddProducts

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCombineProductsAsFamilyCommand

Request

POST /ProductCombineProductsAsFamily

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Products.UI.Commands.ProductExport

View Source

ProductExportFileDownloadCommand

Request

POST /ProductExportFileDownload

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductExportPresetSaveCommand

Request

POST /ProductExportPresetSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductExportSetProductIdsCommand

Request

POST /ProductExportSetProductIds

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Products.UI.Commands.RelatedProducts

View Source

GroupRelatedProductAttachCommand

Request

POST /GroupRelatedProductAttach

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GroupRelatedProductAttachNewGroupCommand

Request

POST /GroupRelatedProductAttachNewGroup

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GroupRelatedProductDeleteCommand

Request

POST /GroupRelatedProductDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductRelatedDeleteCommand

Request

POST /ProductRelatedDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductRelatedMakeTwoWayRelationCommand

Request

POST /ProductRelatedMakeTwoWayRelation

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductRelatedRemoveTwoWayRelationCommand

Request

POST /ProductRelatedRemoveTwoWayRelation

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductRelatedSaveCommand

Request

POST /ProductRelatedSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RelatedProductAttachCommand

Request

POST /RelatedProductAttach

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Products.UI.Commands.Settings

View Source

ProductCategoryFieldConvertToReferenceCommand

Request

POST /ProductCategoryFieldConvertToReference

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

AssetCategoryDeleteCommand

Request

POST /AssetCategoryDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

AssetCategorySaveCommand

Request

POST /AssetCategorySave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

AuditToCsvCommand

Request

POST /AuditToCsv

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

CompletionRuleDeleteCommand

Request

POST /CompletionRuleDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

CompletionRuleSaveCommand

Request

POST /CompletionRuleSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

CountryCreateAllCommand

Request

POST /CountryCreateAll

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

CountryDeleteCommand

Request

POST /CountryDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

CountrySaveCommand

Request

POST /CountrySave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

CurrencyDeleteCommand

Request

POST /CurrencyDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

CurrencySaveCommand

Request

POST /CurrencySave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FieldDisplayGroupDeleteCommand

Request

POST /FieldDisplayGroupDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FieldDisplayGroupSaveCommand

Request

POST /FieldDisplayGroupSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FieldDisplayGroupTranslationSaveCommand

Request

POST /FieldDisplayGroupTranslationSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FieldTypeDeleteCommand

Request

POST /FieldTypeDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

FieldTypeSaveCommand

Request

POST /FieldTypeSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ImagePatternDeleteCommand

Request

POST /ImagePatternDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ImagePatternSaveCommand

Request

POST /ImagePatternSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ManufacturerDeleteCommand

Request

POST /ManufacturerDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ManufacturerSaveCommand

Request

POST /ManufacturerSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductAssignmentRuleDeleteCommand

Request

POST /ProductAssignmentRuleDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductAssignmentRuleMappingDeleteCommand

Request

POST /ProductAssignmentRuleMappingDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductAssignmentRuleMappingSaveCommand

Request

POST /ProductAssignmentRuleMappingSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductAssignmentRuleSaveCommand

Request

POST /ProductAssignmentRuleSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductAttachPropertyFieldsCommand

Request

POST /ProductAttachPropertyFields

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductAttributeFieldOptionSaveSortCommand

Request

POST /ProductAttributeFieldOptionSaveSort

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCategoryDeleteCommand

Request

POST /ProductCategoryDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCategoryFieldDeleteCommand

Request

POST /ProductCategoryFieldDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCategoryFieldForceValuesCommand

Request

POST /ProductCategoryFieldForceValues

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCategoryFieldReferenceSaveCommand

Request

POST /ProductCategoryFieldReferenceSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCategoryFieldSaveCommand

Request

POST /ProductCategoryFieldSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCategoryFieldSaveSortCommand

Request

POST /ProductCategoryFieldSaveSort

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCategoryFieldTranslationSaveCommand

Request

POST /ProductCategoryFieldTranslationSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCategorySaveCommand

Request

POST /ProductCategorySave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductCategoryTranslationSaveCommand

Request

POST /ProductCategoryTranslationSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductDetachPropertyFieldsCommand

Request

POST /ProductDetachPropertyFields

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductFieldDeleteCommand

Request

POST /ProductFieldDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductFieldOptionDeleteCommand

Request

POST /ProductFieldOptionDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductFieldOptionSaveCommand

Request

POST /ProductFieldOptionSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductFieldOptionsDeleteCommand

Request

POST /ProductFieldOptionsDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductFieldSaveCommand

Request

POST /ProductFieldSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductFieldSaveSortCommand

Request

POST /ProductFieldSaveSort

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductFieldTranslationSaveCommand

Request

POST /ProductFieldTranslationSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductGroupFieldDeleteCommand

Request

POST /ProductGroupFieldDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductGroupFieldSaveCommand

Request

POST /ProductGroupFieldSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductItemsSaveSortCommand

Request

POST /ProductItemsSaveSort

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductUnitDeleteCommand

Request

POST /ProductUnitDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductUnitSaveCommand

Request

POST /ProductUnitSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RegionDeleteCommand

Request

POST /RegionDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RegionSaveCommand

Request

POST /RegionSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RelationGroupDeleteCommand

Request

POST /RelationGroupDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RelationGroupSaveCommand

Request

POST /RelationGroupSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

RelationGroupSaveSortCommand

Request

POST /RelationGroupSaveSort

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsAdvancedEcommerceAndChannelsDataModelSaveCommand

Request

POST /SettingsAdvancedEcommerceAndChannelsDataModelSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsAdvancedGeneralSaveCommand

Request

POST /SettingsAdvancedGeneralSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsImageOptionsSaveCommand

Request

POST /SettingsImageOptionsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ShopDeleteCommand

Request

POST /ShopDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ShopSaveCommand

Request

POST /ShopSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VariantGroupDeleteCommand

Request

POST /VariantGroupDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VariantGroupSaveCommand

Request

POST /VariantGroupSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VariantOptionDeleteCommand

Request

POST /VariantOptionDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VariantOptionSaveCommand

Request

POST /VariantOptionSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VariantOptionSaveSortCommand

Request

POST /VariantOptionSaveSort

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VariantPropertyDeleteCommand

Request

POST /VariantPropertyDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

VariantPropertySaveCommand

Request

POST /VariantPropertySave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

WorkflowDeleteCommand2

Request

POST /Dynamicweb.Products.UI.Commands.Settings.WorkflowDeleteCommand

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

WorkflowNotificationDeleteCommand

Request

POST /WorkflowNotificationDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

WorkflowNotificationSaveCommand

Request

POST /WorkflowNotificationSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

WorkflowSaveCommand2

Request

POST /Dynamicweb.Products.UI.Commands.Settings.WorkflowSaveCommand

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

WorkflowStateDeleteCommand

Request

POST /WorkflowStateDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

WorkflowStateSaveCommand

Request

POST /WorkflowStateSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Products.UI.Queries

View Source

GetVatGroupsQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

PeriodNewQuery

Request

GET /PeriodNew[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Products.UI.Queries.Assortments

View Source

AssortmentByIdQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Products.UI.Queries.Comments

View Source

CommentByIdQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Products.UI.Queries.Feeds

View Source

FeedByIdQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Products.UI.Queries.Prices

View Source

PriceByIdQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Products.UI.Queries.ProductCatalogs

View Source

DataModelByParentQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Products.UI.Queries.ProductExport

View Source

ProductExportQuery

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Products.UI.Queries.RelatedProducts

View Source

ProductRelatedByIdAndProductIdAndGroupIdQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Products.UI.Queries.Settings

View Source

AssetCategoryAllQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

ProductFieldsSortListQuery

Request

GET /ProductFieldsSortList[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

RelationGroupSortListQuery

Request

GET /RelationGroupSortList[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsAdvancedEcommerceAndChannelsQuery

Request

GET /SettingsAdvancedEcommerceAndChannels[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsAdvancedGeneralQuery

Request

GET /SettingsAdvancedGeneral[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsFieldDifferentiationQuery

Request

GET /SettingsFieldDifferentiation[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingsImageOptionsQuery

Request

GET /SettingsImageOptions[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Users.UI.Commands

View Source

GroupDeleteCommand

Request

POST /GroupDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GroupMoveCommand

Request

POST /GroupMove

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

GroupSaveCommand

Request

POST /GroupSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PermissionSettingSaveCommand

Request

POST /PermissionSettingSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SmartSearchDeleteCommand

Request

POST /SmartSearchDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SmartSearchSaveCommand

Request

POST /SmartSearchSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

UserAddressDeleteCommand

Request

POST /UserAddressDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

UserAddressMakeDefaultCommand

Request

POST /UserAddressMakeDefault

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

UserAddressSaveCommand

Request

POST /UserAddressSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

UserChangeTypeCommand

Request

POST /UserChangeType

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

UserDeleteCommand

Request

POST /UserDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

UserGroupRelationDeleteCommand

Request

POST /UserGroupRelationDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

UserGroupRelationSaveCommand

Request

POST /UserGroupRelationSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

UserImpersonateAddCommand

Request

POST /UserImpersonateAdd

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

UserImpersonateDeleteCommand

Request

POST /UserImpersonateDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

UserSaveCommand

Request

POST /UserSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

UserSaveSortCommand

Request

POST /UserSaveSort

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

UserToggleActivationCommand

Request

POST /UserToggleActivation

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Users.UI.Commands.Settings

View Source

CustomFieldDeleteCommand

Request

POST /CustomFieldDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

CustomFieldOptionDeleteCommand

Request

POST /CustomFieldOptionDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

CustomFieldOptionSaveCommand

Request

POST /CustomFieldOptionSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

CustomFieldSaveCommand

Request

POST /CustomFieldSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

ExtranetSettingsSaveCommand

Request

POST /ExtranetSettingsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PasswordSecuritySaveCommand

Request

POST /PasswordSecuritySave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingPresetDeleteCommand

Request

POST /SettingPresetDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

SettingPresetSaveCommand

Request

POST /SettingPresetSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

TokenDeleteCommand

Request

POST /TokenDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

UserAndGroupFieldSaveCommand

Request

POST /UserAndGroupFieldSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

UserAndGroupTypeDeleteCommand

Request

POST /UserAndGroupTypeDelete

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

UserAndGroupTypeSaveCommand

Request

POST /UserAndGroupTypeSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

UserSettingsSaveCommand

Request

POST /UserSettingsSave

Parameters

Name	Type	Default	Notes
body	object

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Users.UI.Queries

View Source

GroupByIdQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

Dynamicweb.Users.UI.Queries.Settings

View Source

CustomFieldByNameQuery

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

ExtranetSettingsQuery

Request

GET /ExtranetSettings[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

PasswordSecurityQuery

Request

GET /PasswordSecurity[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

UserAndGroupTypeNewQuery

Request

GET /UserAndGroupTypeNew[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

View Source

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
400		Bad request
401		Forbidden
200	object	OK

View Source

UserSettingsQuery

Request

GET /UserSettings[?AccessLevel]

Parameters

Name	Type	Default	Notes
AccessLevel			Permission level which is required to get models

Responses

Status Code	Type	Description
400		Bad request
401		Forbidden
200	object	OK

Table of Contents

Dynamicweb Management API

Dynamicweb Management API

Dynamicweb.Application.UI.Commands

AddinInstallCommand

Request

Parameters

Responses

AddinUninstallCommand

Request

Parameters

Responses

ApiKeyDeleteCommand

Request

Parameters

Responses

ApiKeySaveCommand

Request

Parameters

Responses

CacheClearingAddCommand

Request

Parameters

Responses

CacheClearingDeleteCommand

Request

Parameters

Responses

DatabaseDownloadCommand

Request

Parameters

Responses

DatabaseSettingsSaveCommand

Request

Parameters

Responses

DeploymentDataGroupDeleteCommand

Request

Parameters

Responses

DeploymentDataGroupSaveCommand

Request

Parameters

Responses

DeploymentDataItemTypeDeleteCommand

Request

Parameters

Responses

DeploymentDataItemTypeSaveCommand

Request

Parameters

Responses

DeploymentDestinationDeleteCommand

Request

Parameters

Responses

DeploymentDestinationExportCommand

Request

Parameters

Responses

DeploymentDestinationSaveCommand

Request

Parameters

Responses

DeploymentDestinationTransferCommand

Request

Parameters

Responses

DeploymentDestinationVerifyCommand

Request

Parameters

Responses

LicenseRefreshCommand

Request

Parameters

Responses

LoadBalancingDeleteCommand

Request

Parameters

Responses