Table of Contents

Dynamicweb Management API

Dynamicweb Management API

Dynamicweb.Application.UI.Commands

View Source

AddinInstallCommand

Request
POST /AddinInstall
Parameters
Name Type Default Notes
body object
Responses
Status Code Type Description Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
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 Samples
400

Bad request

401

Forbidden

200 object

OK

View Source

CustomerProductListProductAddCommand

Request
POST /CustomerProductListProductAdd
Parameters
Name Type Default Notes
body object
Responses
Status Code