Console Resource API
{ http://soa.com/wsdl/consoleresource/1.0 } ConsoleResourceAPI
The Console Resource service provides operations that allow you to upload and manage platform resources such as platform CSS, customizable platform content pages, and platform help files. This service is used for any platform assets, stored in the /resources/ folder structure.
POSTuploadRoot
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
unpack
query
boolean
body
entity
base64Binary
Reponse
Status Code
Reason
Model
200
Success
any
GETgetRoot
Parameters
Name
Type
Description
Model
version
query
integer
If-Modified-Since
header
dynamic
query
boolean
download
query
boolean
Zip
query
boolean
Reponse
Status Code
Reason
Model
200
Success
any
POST/{path:.*}upload
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
path
path
string
unpack
query
boolean
body
entity
base64Binary
Reponse
Status Code
Reason
Model
200
Success
any
GET/resourceversionkeygetResourceVersionKey
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
POST/{path:.*}add
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
body
form
string
type
form
string
path
path
string
folder
form
boolean
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
GET/{path:.*}get
Parameters
Accepts */*
Name
Type
Description
Model
version
query
integer
path
path
string
If-Modified-Since
header
dynamic
query
boolean
download
query
boolean
Zip
query
boolean
ReturnDefault
query
boolean
Reponse
Produces */*
Status Code
Reason
Model
200
Success
any
DELETE/{path:.*}delete
Parameters
Name
Type
Description
Model
path
path
string
Reponse
Status Code
Reason
Model
200
Success
any
PUT/{path:.*}rename
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
nameTo
form
string
path
path
string
Reponse
Status Code
Reason
Model
200
Success
any
GET/{ResourceVersionKey}/settingsgetSettings
Parameters
Name
Type
Description
Model
If-Modified-Since
header
ResourceVersionKey
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
TenantSettings
TenantSettings {
LoginDomain {
FedMember {
Challenge {
TenantProperties {
Theme {
SupportedTheme {
PasswordPolicy {
BusinessSettings {
BusinessSecuritySettings {
BusinessDiscussionSettings {
ModelCategory {
TicketSettings {
BusinessAppSettings {
BusinessAPISettings {
CommentSettings {
BusinessReviewSettings {
AlertSettings {
BusinessGroupSettings {
BusinessUserSettings {
ConnectionWorkflowSetting {
LoginDomains( Collection of LoginDomain )
FedMembers( Collection of FedMember )
Challenges( Collection of Challenge )
TenantProperties( TenantProperties )
PasswordPolicy( PasswordPolicy )
BusinessSettings( BusinessSettings )
}
LoginDomain {
DisplayMode( string )
FedmemberId( string )
LogoAssigned( boolean )
DomainName( string )
IdSystemType( string )
Title( string )
Enabled( boolean )
LogoId( long )
LoginDomainID( string )
Sequence( int )
VirtualHost( Collection of string )
}
FedMember {
ProxyAddress( string )
Address( string )
CmApiVersion( string )
IsLocal( boolean )
FedMemberID( string )
ESIndexName( string )
}
Challenge {
MinimumLength( int )
MinimumUpperCaseLetterCount( int )
MaximumNumberCount( int )
IsCaseSensitive( boolean )
MaximumAlphaCount( int )
MinimumSpecialCharacterCount( int )
Active( boolean )
MaximumLength( int )
AllowedSpecialCharacters( Collection of string )
CanContainSpaces( boolean )
MinimumNumberCount( int )
ChallengeCode( string )
ChallengeQuestion( string )
MinimumAlphaCount( int )
}
TenantProperties {
DefaultTheme( string )
FromEmailAddress( string )
TenantBusinessKey( string )
TenantName( string )
ForwardProxyAllowedHosts( Collection of string )
Themes( Collection of Theme )
AnalyticsAccountID( string )
SupportedThemes( Collection of SupportedTheme )
SiteAdminGroupID( string )
BusinessAdminGroupID( string )
TenantID( string )
ContactEmailAddress( string )
LaaSIntegrationSupport( string )
ConsoleAddress( string )
ProxyApiUrl( string )
TenantBusinessID( string )
}
Theme {
TenantID( long )
FedmemberID( string )
Alias( string )
ConsoleAddress( string )
Theme( string )
SiteTitle( string )
SiteDescription( string )
VirtualHosts( Collection of string )
ThemeImpl( string )
}
SupportedTheme {
Theme( string )
Cloneable( boolean )
ThemeImpl( string )
}
PasswordPolicy {
MinLetterCount( int )
MinSpecialCharCount( int )
MaxPasswordLength( int )
CanMatchEmail( boolean )
PasswordChangeIntervalDays( int )
IsCaseSensitive( boolean )
NumbersOfLastPasswordCheckCount( int )
MinNumberCount( int )
CanMatchUserName( boolean )
AllowedSpecialCharacters( Collection of string )
MinUpperLetterCount( int )
MinPasswordLength( int )
CanContainSpaces( boolean )
}
BusinessSettings {
BusinessSecuritySettings( BusinessSecuritySettings )
BusinessDiscussionSettings( BusinessDiscussionSettings )
MaxFileSizeForUpload( int )
ModelCategories( Collection of ModelCategory )
TicketSettings( TicketSettings )
BusinessAppSettings( BusinessAppSettings )
BusinessAPISettings( BusinessAPISettings )
CommentSettings( CommentSettings )
BusinessReviewSettings( BusinessReviewSettings )
BusinessAdminMemberWorkflowDefKey( string )
ModelVersionWorkflowDefKey( string )
AlertSettings( AlertSettings )
BusinessGroupSettings( BusinessGroupSettings )
BusinessUserSettings( BusinessUserSettings )
ConnectionSettings( Collection of ConnectionWorkflowSetting )
}
BusinessSecuritySettings {
XssKeywords( string )
ChallengeCount( int )
UserModifyEmail( string )
CaptchaSiteSecret( string )
AllowedFileTypesStrictPolicy( string )
EncryptChallengeAnswers( string )
ExternalDocSupport( string )
WhiteListKeywordsSupport( string )
CaptchaSiteKey( string )
AllowedFileTypes( string )
AuthTokenCookieSameSite( string )
CaptchaSupport( string )
WhiteListKeywords( string )
WriteRequestCSRFSupport( string )
AuthTokenCookieDomain( string )
ReadRequestCSRFSupport( string )
SiteAdminModifyEmail( string )
AllowUserEnum( string )
}
BusinessDiscussionSettings {
AutoPublish( boolean )
DiscussionWorkflowDefKey( string )
DiscussionCommentWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
ModelCategory {
Description( string )
Deleted( boolean )
Name( string )
}
TicketSettings {
TicketSupport( string )
TicketWorkflowDefKey( string )
TicketCommentWorkflowDefKey( string )
Visibility( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
BusinessAppSettings {
SimultaneousSandboxProductAccessSupport( string )
PublicAppRatingsSupport( string )
PrivateAppReviewsSupport( string )
AppPromotionSupport( string )
PublicAppSupport( string )
RegisteredUsersAppRatingsSupport( string )
PrivateAppRatingsSupport( string )
RegisteredUsersAppReviewsSupport( string )
PublicAppBoardSupport( string )
AppVersionWorkflowDefKey( string )
PrivateAppBoardSupport( string )
PrivateAppSupport( string )
AppTeamMemberWorkflowDefKey( string )
ContractPoliciesSupport( string )
PublicAppReviewsSupport( string )
ReturnPlainTextSharedSecret( string )
UserDefinedIdentitySupport( string )
RegisteredUsersAppSupport( string )
}
BusinessAPISettings {
PrivateAPIBoardSupport( string )
PublicAPISandboxEndpointSupport( string )
PublicAPIRatingsSupport( string )
PrivateAPIResourceLevelPermissionsSupport( string )
PublicAPISandboxAutoApprovalSupport( string )
PublicAPIResourceLevelPermissionsSupport( string )
PrivateAPISupport( string )
PrivateAPISandboxAutoApprovalSupport( string )
PrivateAPIProductionEndpointSupport( string )
PublicAPIBoardSupport( string )
PrivateAPIReviewsSupport( string )
PublicAPIProductionEndpointSupport( string )
APIWithExistingServiceSupport( string )
PrivateAPIRatingsSupport( string )
PrivateAPIGroupTypeSupport( string )
PrivateAPIIndependentGroupSupport( string )
PublicAPIReviewsSupport( string )
ApiVersionWorkflowDefKey( string )
PublicAPIProductionAutoApprovalSupport( string )
APIWithAnonymousAccessSupport( string )
APIPromotionSupport( string )
ValidateUniqueContextPath( string )
PrivateAPISandboxEndpointSupport( string )
ApiAdminMemberWorkflowDefKey( string )
APIWithNewServiceSupport( string )
PublicAPISupport( string )
PrivateAPIProductionAutoApprovalSupport( string )
}
CommentSettings {
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
BusinessReviewSettings {
AutoPublish( boolean )
ReviewWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
AlertSettings {
AlertWorkflowDefKey( string )
AlertCommentWorkflowDefKey( string )
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
BusinessGroupSettings {
PrivateGroupReviewsSupport( string )
GroupMemberWorkflowDefKey( string )
PublicGroupSupport( string )
PublicGroupBoardSupport( string )
PrivateGroupSupport( string )
GroupCommentWorkflowDefKey( string )
GroupSupport( string )
PublicGroupRatingsSupport( string )
PrivateGroupRatingsSupport( string )
PublicGroupReviewsSupport( string )
PrivateGroupBoardSupport( string )
}
BusinessUserSettings {
UserWorkflowDefKey( string )
SelfSignup( string )
InviteUnregisteredUsers( string )
InvitedUserValidDays( int )
TopApisCountAllowed( int )
UpdateEmailValidCodeHours( int )
SignupUserValidDays( int )
NewsUpdateNotification( string )
AddedUserValidDays( int )
ResetValidCodeHours( int )
EnforceChallengesSetupOnLogin( string )
}
ConnectionWorkflowSetting {
WorkflowDefinitionKey( string )
Environment( string )
ConnectionCommentWorkflowDefKey( string )
}
POST/branding/generatestylesgenerateStyles
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
theme
form
string
Reponse
Produces application/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
any
POST/branding/scaffoldscaffold
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
theme
form
string
Reponse
Produces application/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.akana.v2020+json
Status Code
Reason
Model
200
Success
any
GET/v2/{ResourceVersionKey}/settingsgetPostLoginSettings
Parameters
Name
Type
Description
Model
If-Modified-Since
header
ResourceVersionKey
path
string
Reponse
Produces application/jsonapplication/vnd.akana.v2020+json
Status Code
Reason
Model
200
Success
TenantSettings
TenantSettings {
LoginDomain {
FedMember {
Challenge {
TenantProperties {
Theme {
SupportedTheme {
PasswordPolicy {
BusinessSettings {
BusinessSecuritySettings {
BusinessDiscussionSettings {
ModelCategory {
TicketSettings {
BusinessAppSettings {
BusinessAPISettings {
CommentSettings {
BusinessReviewSettings {
AlertSettings {
BusinessGroupSettings {
BusinessUserSettings {
ConnectionWorkflowSetting {
LoginDomains( Collection of LoginDomain )
FedMembers( Collection of FedMember )
Challenges( Collection of Challenge )
TenantProperties( TenantProperties )
PasswordPolicy( PasswordPolicy )
BusinessSettings( BusinessSettings )
}
LoginDomain {
DisplayMode( string )
FedmemberId( string )
LogoAssigned( boolean )
DomainName( string )
IdSystemType( string )
Title( string )
Enabled( boolean )
LogoId( long )
LoginDomainID( string )
Sequence( int )
VirtualHost( Collection of string )
}
FedMember {
ProxyAddress( string )
Address( string )
CmApiVersion( string )
IsLocal( boolean )
FedMemberID( string )
ESIndexName( string )
}
Challenge {
MinimumLength( int )
MinimumUpperCaseLetterCount( int )
MaximumNumberCount( int )
IsCaseSensitive( boolean )
MaximumAlphaCount( int )
MinimumSpecialCharacterCount( int )
Active( boolean )
MaximumLength( int )
AllowedSpecialCharacters( Collection of string )
CanContainSpaces( boolean )
MinimumNumberCount( int )
ChallengeCode( string )
ChallengeQuestion( string )
MinimumAlphaCount( int )
}
TenantProperties {
DefaultTheme( string )
FromEmailAddress( string )
TenantBusinessKey( string )
TenantName( string )
ForwardProxyAllowedHosts( Collection of string )
Themes( Collection of Theme )
AnalyticsAccountID( string )
SupportedThemes( Collection of SupportedTheme )
SiteAdminGroupID( string )
BusinessAdminGroupID( string )
TenantID( string )
ContactEmailAddress( string )
LaaSIntegrationSupport( string )
ConsoleAddress( string )
ProxyApiUrl( string )
TenantBusinessID( string )
}
Theme {
TenantID( long )
FedmemberID( string )
Alias( string )
ConsoleAddress( string )
Theme( string )
SiteTitle( string )
SiteDescription( string )
VirtualHosts( Collection of string )
ThemeImpl( string )
}
SupportedTheme {
Theme( string )
Cloneable( boolean )
ThemeImpl( string )
}
PasswordPolicy {
MinLetterCount( int )
MinSpecialCharCount( int )
MaxPasswordLength( int )
CanMatchEmail( boolean )
PasswordChangeIntervalDays( int )
IsCaseSensitive( boolean )
NumbersOfLastPasswordCheckCount( int )
MinNumberCount( int )
CanMatchUserName( boolean )
AllowedSpecialCharacters( Collection of string )
MinUpperLetterCount( int )
MinPasswordLength( int )
CanContainSpaces( boolean )
}
BusinessSettings {
BusinessSecuritySettings( BusinessSecuritySettings )
BusinessDiscussionSettings( BusinessDiscussionSettings )
MaxFileSizeForUpload( int )
ModelCategories( Collection of ModelCategory )
TicketSettings( TicketSettings )
BusinessAppSettings( BusinessAppSettings )
BusinessAPISettings( BusinessAPISettings )
CommentSettings( CommentSettings )
BusinessReviewSettings( BusinessReviewSettings )
BusinessAdminMemberWorkflowDefKey( string )
ModelVersionWorkflowDefKey( string )
AlertSettings( AlertSettings )
BusinessGroupSettings( BusinessGroupSettings )
BusinessUserSettings( BusinessUserSettings )
ConnectionSettings( Collection of ConnectionWorkflowSetting )
}
BusinessSecuritySettings {
XssKeywords( string )
ChallengeCount( int )
UserModifyEmail( string )
CaptchaSiteSecret( string )
AllowedFileTypesStrictPolicy( string )
EncryptChallengeAnswers( string )
ExternalDocSupport( string )
WhiteListKeywordsSupport( string )
CaptchaSiteKey( string )
AllowedFileTypes( string )
AuthTokenCookieSameSite( string )
CaptchaSupport( string )
WhiteListKeywords( string )
WriteRequestCSRFSupport( string )
AuthTokenCookieDomain( string )
ReadRequestCSRFSupport( string )
SiteAdminModifyEmail( string )
AllowUserEnum( string )
}
BusinessDiscussionSettings {
AutoPublish( boolean )
DiscussionWorkflowDefKey( string )
DiscussionCommentWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
ModelCategory {
Description( string )
Deleted( boolean )
Name( string )
}
TicketSettings {
TicketSupport( string )
TicketWorkflowDefKey( string )
TicketCommentWorkflowDefKey( string )
Visibility( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
BusinessAppSettings {
SimultaneousSandboxProductAccessSupport( string )
PublicAppRatingsSupport( string )
PrivateAppReviewsSupport( string )
AppPromotionSupport( string )
PublicAppSupport( string )
RegisteredUsersAppRatingsSupport( string )
PrivateAppRatingsSupport( string )
RegisteredUsersAppReviewsSupport( string )
PublicAppBoardSupport( string )
AppVersionWorkflowDefKey( string )
PrivateAppBoardSupport( string )
PrivateAppSupport( string )
AppTeamMemberWorkflowDefKey( string )
ContractPoliciesSupport( string )
PublicAppReviewsSupport( string )
ReturnPlainTextSharedSecret( string )
UserDefinedIdentitySupport( string )
RegisteredUsersAppSupport( string )
}
BusinessAPISettings {
PrivateAPIBoardSupport( string )
PublicAPISandboxEndpointSupport( string )
PublicAPIRatingsSupport( string )
PrivateAPIResourceLevelPermissionsSupport( string )
PublicAPISandboxAutoApprovalSupport( string )
PublicAPIResourceLevelPermissionsSupport( string )
PrivateAPISupport( string )
PrivateAPISandboxAutoApprovalSupport( string )
PrivateAPIProductionEndpointSupport( string )
PublicAPIBoardSupport( string )
PrivateAPIReviewsSupport( string )
PublicAPIProductionEndpointSupport( string )
APIWithExistingServiceSupport( string )
PrivateAPIRatingsSupport( string )
PrivateAPIGroupTypeSupport( string )
PrivateAPIIndependentGroupSupport( string )
PublicAPIReviewsSupport( string )
ApiVersionWorkflowDefKey( string )
PublicAPIProductionAutoApprovalSupport( string )
APIWithAnonymousAccessSupport( string )
APIPromotionSupport( string )
ValidateUniqueContextPath( string )
PrivateAPISandboxEndpointSupport( string )
ApiAdminMemberWorkflowDefKey( string )
APIWithNewServiceSupport( string )
PublicAPISupport( string )
PrivateAPIProductionAutoApprovalSupport( string )
}
CommentSettings {
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
BusinessReviewSettings {
AutoPublish( boolean )
ReviewWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
AlertSettings {
AlertWorkflowDefKey( string )
AlertCommentWorkflowDefKey( string )
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
BusinessGroupSettings {
PrivateGroupReviewsSupport( string )
GroupMemberWorkflowDefKey( string )
PublicGroupSupport( string )
PublicGroupBoardSupport( string )
PrivateGroupSupport( string )
GroupCommentWorkflowDefKey( string )
GroupSupport( string )
PublicGroupRatingsSupport( string )
PrivateGroupRatingsSupport( string )
PublicGroupReviewsSupport( string )
PrivateGroupBoardSupport( string )
}
BusinessUserSettings {
UserWorkflowDefKey( string )
SelfSignup( string )
InviteUnregisteredUsers( string )
InvitedUserValidDays( int )
TopApisCountAllowed( int )
UpdateEmailValidCodeHours( int )
SignupUserValidDays( int )
NewsUpdateNotification( string )
AddedUserValidDays( int )
ResetValidCodeHours( int )
EnforceChallengesSetupOnLogin( string )
}
ConnectionWorkflowSetting {
WorkflowDefinitionKey( string )
Environment( string )
ConnectionCommentWorkflowDefKey( string )
}
