Tenant Management API
{ urn:com.soa.tenant.admin.impl } TenantManagementAPI
This API provides access to the tenant state and usage statistics.
POST/subscriptionsaddNewTenant
Parameters
Accepts application/xml application/json application/vnd.soa.v80+json application/vnd.soa.v80+xml
Name
Type
Description
Model
body
entity
TenantRegistrationRequest
TenantRegistrationRequest {
TenantUserAccount {
DefaultTheme( string )
DeploymentZoneContainerKey( string )
TenantName( string )
ApiEndpointCName( string )
AdminUserPassword( string )
AnalyticsAccountID( string )
DefaultUserAccounts( Collection of TenantUserAccount )
ESIndexName( string, required )
FwdProxyAllowedHosts( Collection of string )
SupportEmailAddress( string )
TenantID( string, required )
CDNRoot( string )
LaaSIntegrationSupport( string )
DefaultThemeImpl( string )
AdminUserEmail( string )
NotificationsSenderEmailAddress( string )
ApiAddress( string, required )
PortalAddress( string, required )
DocumentDomain( string )
AdditionalVirtualHosts( Collection of string )
TenantOrgKey( string )
}
TenantUserAccount {
Role( Collection of string, required )
Email( string, required )
FirstName( string )
LastName( string )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v80+xml
Status Code
Reason
Model
200
Success
Tenant
Tenant {
Theme {
Business {
BusinessDiscussionSettings {
ModelCategory {
TicketSettings {
BusinessAppSettings {
BusinessAPISettings {
BusinessReviewSettings {
BusinessUserSettings {
ConnectionWorkflowSetting {
CommentSettings {
TargetResource {
Image {
AlertSettings {
BusinessGroupSettings {
PlatformApiContractExists( boolean )
FromEmailAddress( string )
IndexTargets( Collection of string )
Description( string )
Address( string )
TenantName( string )
ForwardProxyAllowedHosts( Collection of string )
AnalyticsAccountID( string )
Themes( Collection of Theme )
ESIndexName( string )
SearchSource( string )
AvatarURL( anyURI )
ContactEmailAddress( string )
LaaSIntegrationSupport( string )
AdminGroupID( string )
State( string )
ConsoleAddress( string )
FedMemberID( string )
PlatformApiClientID( string )
Business( Business )
}
Theme {
TenantID( long )
FedmemberID( string )
Alias( string )
ConsoleAddress( string )
Theme( string )
SiteTitle( string )
SiteDescription( string )
VirtualHosts( Collection of string )
ThemeImpl( string )
}
Business {
Description( string )
BusinessDiscussionSettings( BusinessDiscussionSettings )
ModelCategories( Collection of ModelCategory )
BusinessType( string )
TicketSettings( TicketSettings )
BusinessAppSettings( BusinessAppSettings )
BusinessAPISettings( BusinessAPISettings )
Name( string )
Created( dateTime )
BusinessReviewSettings( BusinessReviewSettings )
AvatarURL( anyURI )
AdminGroupID( string )
BusinessAdminMemberWorkflowDefKey( string )
Picture( anyURI )
ModelVersionWorkflowDefKey( string )
BusinessUserSettings( BusinessUserSettings )
ConnectionSettings( Collection of ConnectionWorkflowSetting )
Updated( dateTime )
MaxFileSizeForUpload( int )
PictureID( long )
ParentBusinessID( string )
CommentSettings( CommentSettings )
BusinessKey( string )
Contact( string )
TargetResources( Collection of TargetResource )
Visibility( string )
AlertSettings( AlertSettings )
IsFollowed( boolean )
BusinessID( string )
Link( anyURI )
BusinessGroupSettings( BusinessGroupSettings )
}
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 )
}
BusinessReviewSettings {
AutoPublish( boolean )
ReviewWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( 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 )
}
CommentSettings {
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
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 )
}
GET/subscriptions/{SubscriptionID}getTenant
Parameters
Name
Type
Description
Model
SubscriptionID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
Tenant
Tenant {
Theme {
Business {
BusinessDiscussionSettings {
ModelCategory {
TicketSettings {
BusinessAppSettings {
BusinessAPISettings {
BusinessReviewSettings {
BusinessUserSettings {
ConnectionWorkflowSetting {
CommentSettings {
TargetResource {
Image {
AlertSettings {
BusinessGroupSettings {
PlatformApiContractExists( boolean )
FromEmailAddress( string )
IndexTargets( Collection of string )
Description( string )
Address( string )
TenantName( string )
ForwardProxyAllowedHosts( Collection of string )
AnalyticsAccountID( string )
Themes( Collection of Theme )
ESIndexName( string )
SearchSource( string )
AvatarURL( anyURI )
ContactEmailAddress( string )
LaaSIntegrationSupport( string )
AdminGroupID( string )
State( string )
ConsoleAddress( string )
FedMemberID( string )
PlatformApiClientID( string )
Business( Business )
}
Theme {
TenantID( long )
FedmemberID( string )
Alias( string )
ConsoleAddress( string )
Theme( string )
SiteTitle( string )
SiteDescription( string )
VirtualHosts( Collection of string )
ThemeImpl( string )
}
Business {
Description( string )
BusinessDiscussionSettings( BusinessDiscussionSettings )
ModelCategories( Collection of ModelCategory )
BusinessType( string )
TicketSettings( TicketSettings )
BusinessAppSettings( BusinessAppSettings )
BusinessAPISettings( BusinessAPISettings )
Name( string )
Created( dateTime )
BusinessReviewSettings( BusinessReviewSettings )
AvatarURL( anyURI )
AdminGroupID( string )
BusinessAdminMemberWorkflowDefKey( string )
Picture( anyURI )
ModelVersionWorkflowDefKey( string )
BusinessUserSettings( BusinessUserSettings )
ConnectionSettings( Collection of ConnectionWorkflowSetting )
Updated( dateTime )
MaxFileSizeForUpload( int )
PictureID( long )
ParentBusinessID( string )
CommentSettings( CommentSettings )
BusinessKey( string )
Contact( string )
TargetResources( Collection of TargetResource )
Visibility( string )
AlertSettings( AlertSettings )
IsFollowed( boolean )
BusinessID( string )
Link( anyURI )
BusinessGroupSettings( BusinessGroupSettings )
}
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 )
}
BusinessReviewSettings {
AutoPublish( boolean )
ReviewWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( 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 )
}
CommentSettings {
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
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 )
}
DELETE/subscriptions/{SubscriptionID}removeTenant
Parameters
Name
Type
Description
Model
SubscriptionID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v80+xml
Status Code
Reason
Model
200
Success
Tenant
Tenant {
Theme {
Business {
BusinessDiscussionSettings {
ModelCategory {
TicketSettings {
BusinessAppSettings {
BusinessAPISettings {
BusinessReviewSettings {
BusinessUserSettings {
ConnectionWorkflowSetting {
CommentSettings {
TargetResource {
Image {
AlertSettings {
BusinessGroupSettings {
PlatformApiContractExists( boolean )
FromEmailAddress( string )
IndexTargets( Collection of string )
Description( string )
Address( string )
TenantName( string )
ForwardProxyAllowedHosts( Collection of string )
AnalyticsAccountID( string )
Themes( Collection of Theme )
ESIndexName( string )
SearchSource( string )
AvatarURL( anyURI )
ContactEmailAddress( string )
LaaSIntegrationSupport( string )
AdminGroupID( string )
State( string )
ConsoleAddress( string )
FedMemberID( string )
PlatformApiClientID( string )
Business( Business )
}
Theme {
TenantID( long )
FedmemberID( string )
Alias( string )
ConsoleAddress( string )
Theme( string )
SiteTitle( string )
SiteDescription( string )
VirtualHosts( Collection of string )
ThemeImpl( string )
}
Business {
Description( string )
BusinessDiscussionSettings( BusinessDiscussionSettings )
ModelCategories( Collection of ModelCategory )
BusinessType( string )
TicketSettings( TicketSettings )
BusinessAppSettings( BusinessAppSettings )
BusinessAPISettings( BusinessAPISettings )
Name( string )
Created( dateTime )
BusinessReviewSettings( BusinessReviewSettings )
AvatarURL( anyURI )
AdminGroupID( string )
BusinessAdminMemberWorkflowDefKey( string )
Picture( anyURI )
ModelVersionWorkflowDefKey( string )
BusinessUserSettings( BusinessUserSettings )
ConnectionSettings( Collection of ConnectionWorkflowSetting )
Updated( dateTime )
MaxFileSizeForUpload( int )
PictureID( long )
ParentBusinessID( string )
CommentSettings( CommentSettings )
BusinessKey( string )
Contact( string )
TargetResources( Collection of TargetResource )
Visibility( string )
AlertSettings( AlertSettings )
IsFollowed( boolean )
BusinessID( string )
Link( anyURI )
BusinessGroupSettings( BusinessGroupSettings )
}
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 )
}
BusinessReviewSettings {
AutoPublish( boolean )
ReviewWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( 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 )
}
CommentSettings {
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
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 )
}
PUT/subscriptions/{SubscriptionID}/statechangeTenantState
Parameters
Accepts application/xml application/json application/vnd.soa.v80+json application/vnd.soa.v80+xml
Name
Type
Description
Model
SubscriptionID
path
string
body
entity
TenantStateChangeRequest
TenantStateChangeRequest {
TargetState( string, required )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v80+xml
Status Code
Reason
Model
200
Success
Tenant
Tenant {
Theme {
Business {
BusinessDiscussionSettings {
ModelCategory {
TicketSettings {
BusinessAppSettings {
BusinessAPISettings {
BusinessReviewSettings {
BusinessUserSettings {
ConnectionWorkflowSetting {
CommentSettings {
TargetResource {
Image {
AlertSettings {
BusinessGroupSettings {
PlatformApiContractExists( boolean )
FromEmailAddress( string )
IndexTargets( Collection of string )
Description( string )
Address( string )
TenantName( string )
ForwardProxyAllowedHosts( Collection of string )
AnalyticsAccountID( string )
Themes( Collection of Theme )
ESIndexName( string )
SearchSource( string )
AvatarURL( anyURI )
ContactEmailAddress( string )
LaaSIntegrationSupport( string )
AdminGroupID( string )
State( string )
ConsoleAddress( string )
FedMemberID( string )
PlatformApiClientID( string )
Business( Business )
}
Theme {
TenantID( long )
FedmemberID( string )
Alias( string )
ConsoleAddress( string )
Theme( string )
SiteTitle( string )
SiteDescription( string )
VirtualHosts( Collection of string )
ThemeImpl( string )
}
Business {
Description( string )
BusinessDiscussionSettings( BusinessDiscussionSettings )
ModelCategories( Collection of ModelCategory )
BusinessType( string )
TicketSettings( TicketSettings )
BusinessAppSettings( BusinessAppSettings )
BusinessAPISettings( BusinessAPISettings )
Name( string )
Created( dateTime )
BusinessReviewSettings( BusinessReviewSettings )
AvatarURL( anyURI )
AdminGroupID( string )
BusinessAdminMemberWorkflowDefKey( string )
Picture( anyURI )
ModelVersionWorkflowDefKey( string )
BusinessUserSettings( BusinessUserSettings )
ConnectionSettings( Collection of ConnectionWorkflowSetting )
Updated( dateTime )
MaxFileSizeForUpload( int )
PictureID( long )
ParentBusinessID( string )
CommentSettings( CommentSettings )
BusinessKey( string )
Contact( string )
TargetResources( Collection of TargetResource )
Visibility( string )
AlertSettings( AlertSettings )
IsFollowed( boolean )
BusinessID( string )
Link( anyURI )
BusinessGroupSettings( BusinessGroupSettings )
}
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 )
}
BusinessReviewSettings {
AutoPublish( boolean )
ReviewWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( 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 )
}
CommentSettings {
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
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 )
}
GET/subscriptions/{SubscriptionID}/metricsgetPlatformUsage
Parameters
Name
Type
Description
Model
SubscriptionID
path
string
ReportMonth
query
integer
ReportYear
query
integer
MetricID
query
string
IncludePerDayUsage
query
boolean
IncludeMetricItemList
query
boolean
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v80+xml
Status Code
Reason
Model
200
Success
PlatformUsage
PlatformUsage {
ReportPeriod {
UsageMetric {
MetricItemList {
DayUsage {
MetricItem {
AggregateUsage {
ReportPeriod( ReportPeriod )
UsageMetric( Collection of UsageMetric )
ReportGeneratedTimestamp( dateTime )
}
ReportPeriod {
StartDate( dateTime )
EndDate( dateTime )
}
UsageMetric {
MetricValue( double )
MetricID( string )
MetricUnits( string )
MetricType( string )
MetricItemList( MetricItemList )
DayUsage( Collection of DayUsage )
AggregateUsage( AggregateUsage )
AdditionalNote( Collection of string )
}
MetricItemList {
Type( string )
Name( Collection of string )
AdditionalNote( Collection of string )
}
DayUsage {
MetricValue( double )
MetricItem( Collection of MetricItem )
MetricUnits( string )
Date( date )
AdditionalNote( Collection of string )
}
MetricItem {
MetricUnits( string )
MetricValue( double )
Name( string )
}
AggregateUsage {
MetricValue( double )
MetricItem( Collection of MetricItem )
MetricUnits( string )
AdditionalNote( Collection of string )
}