Business API
{ http://soa.com/wsdl/business/1.0 } BusinessAPI
The Businesses service provides operations for managing business information, including apps, APIs, workflows, and other information relating to a specific business on the platform. Note that most of these operations take the Business ID as a parameter. To find out what the Business ID is for your installation, you can run the GET /api/properties operation (TenantBusinessID parameter in the response).
GET/businessesgetBusinesses
Parameters
Name
Type
Description
Model
Federation
query
Indicates whether the current implementation is a federation. If not specified, defaults to false.
boolean
Reponse
Produces text/xmlapplication/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
rss
rss {
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
channel( rssChannel )
version( string )
}
rssChannel {
image( rssImage )
copyright( string )
item( rssItem )
skipHours( rssSkipHours )
lastBuildDate( string )
link( anyURI )
rating( string )
description( string )
generator( string )
language( string )
title( string )
managingEditor( string )
webMaster( string )
pubDate( string )
ttl( int )
skipDays( rssSkipDays )
cloud( rssCloud )
textInput( rssTextInput )
docs( anyURI )
category( rssCategory )
}
rssImage {
link( anyURI )
width( int )
description( string )
title( string )
url( string )
height( int )
}
rssItem {
comments( anyURI )
enclosure( rssEnclosure )
author( string )
link( anyURI )
description( string )
guid( rssGuid )
source( rssSource )
title( string )
category( rssCategory )
pubDate( string )
}
rssEnclosure {
length( string )
type( string )
url( string )
}
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
hour( Collection of string )
}
rssSkipDays {
day( Collection of string )
}
rssCloud {
path( string )
protocol( string )
port( int )
registerProcedure( string )
domain( string )
}
rssTextInput {
name( string )
link( anyURI )
description( string )
title( string )
}
POST/businessesaddBusiness
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml application/vnd.soa.v83+json application/vnd.soa.v83+xml
Name
Type
Description
Model
body
entity
Business
Business {
BusinessDiscussionSettings {
ModelCategory {
TicketSettings {
BusinessAppSettings {
BusinessAPISettings {
BusinessReviewSettings {
BusinessUserSettings {
ConnectionWorkflowSetting {
CommentSettings {
TargetResource {
Image {
AlertSettings {
BusinessGroupSettings {
Description( string )
BusinessDiscussionSettings( BusinessDiscussionSettings, required )
ModelCategories( Collection of ModelCategory, required )
BusinessType( string )
TicketSettings( TicketSettings, required )
BusinessAppSettings( BusinessAppSettings, required )
BusinessAPISettings( BusinessAPISettings, required )
Name( string )
Created( dateTime )
BusinessReviewSettings( BusinessReviewSettings, required )
AvatarURL( anyURI )
AdminGroupID( string )
BusinessAdminMemberWorkflowDefKey( string )
Picture( anyURI )
ModelVersionWorkflowDefKey( string )
BusinessUserSettings( BusinessUserSettings, required )
ConnectionSettings( Collection of ConnectionWorkflowSetting )
Updated( dateTime )
MaxFileSizeForUpload( int )
PictureID( long )
ParentBusinessID( string )
CommentSettings( CommentSettings, required )
BusinessKey( string, required )
Contact( string )
TargetResources( Collection of TargetResource, required )
Visibility( string )
AlertSettings( AlertSettings, required )
IsFollowed( boolean )
BusinessID( string, required )
Link( anyURI )
BusinessGroupSettings( BusinessGroupSettings, required )
}
BusinessDiscussionSettings {
AutoPublish( boolean )
DiscussionWorkflowDefKey( string )
DiscussionCommentWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
ModelCategory {
Description( string )
Deleted( boolean, required )
Name( string, required )
}
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, required )
Environment( string, required )
ConnectionCommentWorkflowDefKey( string )
}
CommentSettings {
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image, required )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string, required )
Url( anyURI, required )
Link( anyURI, required )
}
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 )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xmlapplication/vnd.soa.v83+jsonapplication/vnd.soa.v83+xml
Status Code
Reason
Model
200
Success
Business
Business {
BusinessDiscussionSettings {
ModelCategory {
TicketSettings {
BusinessAppSettings {
BusinessAPISettings {
BusinessReviewSettings {
BusinessUserSettings {
ConnectionWorkflowSetting {
CommentSettings {
TargetResource {
Image {
AlertSettings {
BusinessGroupSettings {
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/businesseslistBusinesses
Returns the summary information of businesses within a given parent business. If no parent is specified the businesses at the root level of the hierarchy are returned.
Request:
GET /businesses?BusinessID=12770263-e036-4222-b8eb-87d33676d3ad.acmepaymentscorp HTTP/1.1
Accept: application/vnd.soa.v83+json
Response:
HTTP/1.1 200 OK
{
"BusinessID" : "12770263-e036-4222-b8eb-87d33676d5fe.acmepaymentscorp",
"Name" : "Engineering Department",
"Description" : "Engineering department.",
"Created" : "2014-07-18T15:43:09Z",
"Updated" : "2014-07-18T15:44:51Z",
"Visibility" : "Public",
"AvatarURL" : "http://{hostname}/api/businesses/12770263-e036-4222-b8eb-87d33676d5fe.acmepaymentscorp/avatar",
"Parent" :
{
"title" : "ACME Organization",
"href" : ""http://{hostname}/api/apis/12770263-e036-4222-b8eb-87d33676d3ad.acmepaymentscorp/avatar"
}
}
}
Parameters
Name
Type
Description
Model
Federation
query
Indicates whether the current implementation is a federation. If not specified, defaults to false.
boolean
BusinessID
query
An optional unique ID for a specific business on the platform. If not specified, defaults to the root business. Only direct child businesses are returned.
string
Reponse
Produces application/vnd.soa.v83+jsonapplication/vnd.soa.v83+xml
Status Code
Reason
Model
200
Success
BusinessInfos
BusinessInfos {
BusinessInfoType {
TargetResource {
Image {
Business( Collection of BusinessInfoType )
}
BusinessInfoType {
Description( string )
AvatarURL( anyURI )
Updated( dateTime )
BusinessType( string )
Visibility( string )
ParentBusinessID( string )
BusinessID( string )
BusinessKey( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
GET/businesses/{businessID}getBusiness
Parameters
Name
Type
Description
Model
businessID
path
The unique ID for a specific business on the platform.
string
IncludeBusinessAPISettings
query
If set to true, the business's API settings are included in the results.
boolean
IncludeBusinessAppSettings
query
If set to true, the business's app settings are included in the results.
boolean
IncludeBusinessGroupSettings
query
If set to true, the business's group settings are included in the results.
boolean
IncludeTicketSettings
query
If set to true, the business's ticket settings are included in the results.
boolean
IncludeConnectionSettings
query
If set to true, the business's connection settings are included in the results.
boolean
IncludeDiscussionSettings
query
If set to true, the business's discussion settings are included in the results.
boolean
IncludeReviewSettings
query
If set to true, the business's review settings are included in the results.
boolean
IncludeAlertSettings
query
If set to true, the business's alert settings are included in the results.
boolean
IncludeCommentSettings
query
If set to true, the business's comment settings are included in the results.
boolean
IncludeUserSettings
query
If set to true, the business's user settings are included in the results.
boolean
IncludeBusinessSettings
query
If set to true, general settings for the business are included in the results.
boolean
IncludeBusinessCategories
query
If set to true, model categories for the business are included in the results.
boolean
Reponse
Produces text/xmlapplication/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xmlapplication/vnd.soa.v83+jsonapplication/vnd.soa.v83+xml
Status Code
Reason
Model
200
Success
Business
Business {
BusinessDiscussionSettings {
ModelCategory {
TicketSettings {
BusinessAppSettings {
BusinessAPISettings {
BusinessReviewSettings {
BusinessUserSettings {
ConnectionWorkflowSetting {
CommentSettings {
TargetResource {
Image {
AlertSettings {
BusinessGroupSettings {
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/businesses/typeslistBusinessTypes
Returns the types of businesses (organizations) available in the system. By default no avatars are returned. To include avatars use the IncludeAvatars query parameter.
Request:
GET /businesses/types?IncludeAvatars=true HTTP/1.1
Accept: application/vnd.soa.v83+json
Response:
HTTP/1.1 200 OK
{
"BusinessType" : [
{
"Name" : "company",
"AvatarURL" : "http://host:port/path"
},
{
"Name" : "department",
"AvatarURL" : http://host:port/path"
}
]
}
Parameters
Name
Type
Description
Model
IncludeAvatars
query
Optional boolean query parameter that if true will return avatar links with each type. Default is false.
boolean
Reponse
Produces application/jsonapplication/vnd.soa.v83+json
Status Code
Reason
Model
200
Success
BusinessTypes
BusinessTypes {
BusinessType {
BusinessType( Collection of BusinessType )
}
BusinessType {
AvatarURL( anyURI )
Name( string )
}
PUT/businesses/{businessID}updateBusiness
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml application/vnd.soa.v83+json application/vnd.soa.v83+xml
Name
Type
Description
Model
businessID
path
string
body
entity
Business
Business {
BusinessDiscussionSettings {
ModelCategory {
TicketSettings {
BusinessAppSettings {
BusinessAPISettings {
BusinessReviewSettings {
BusinessUserSettings {
ConnectionWorkflowSetting {
CommentSettings {
TargetResource {
Image {
AlertSettings {
BusinessGroupSettings {
Description( string )
BusinessDiscussionSettings( BusinessDiscussionSettings, required )
ModelCategories( Collection of ModelCategory, required )
BusinessType( string )
TicketSettings( TicketSettings, required )
BusinessAppSettings( BusinessAppSettings, required )
BusinessAPISettings( BusinessAPISettings, required )
Name( string )
Created( dateTime )
BusinessReviewSettings( BusinessReviewSettings, required )
AvatarURL( anyURI )
AdminGroupID( string )
BusinessAdminMemberWorkflowDefKey( string )
Picture( anyURI )
ModelVersionWorkflowDefKey( string )
BusinessUserSettings( BusinessUserSettings, required )
ConnectionSettings( Collection of ConnectionWorkflowSetting )
Updated( dateTime )
MaxFileSizeForUpload( int )
PictureID( long )
ParentBusinessID( string )
CommentSettings( CommentSettings, required )
BusinessKey( string, required )
Contact( string )
TargetResources( Collection of TargetResource, required )
Visibility( string )
AlertSettings( AlertSettings, required )
IsFollowed( boolean )
BusinessID( string, required )
Link( anyURI )
BusinessGroupSettings( BusinessGroupSettings, required )
}
BusinessDiscussionSettings {
AutoPublish( boolean )
DiscussionWorkflowDefKey( string )
DiscussionCommentWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
ModelCategory {
Description( string )
Deleted( boolean, required )
Name( string, required )
}
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, required )
Environment( string, required )
ConnectionCommentWorkflowDefKey( string )
}
CommentSettings {
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image, required )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string, required )
Url( anyURI, required )
Link( anyURI, required )
}
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 )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xmlapplication/vnd.soa.v83+jsonapplication/vnd.soa.v83+xml
Status Code
Reason
Model
200
Success
Business
Business {
BusinessDiscussionSettings {
ModelCategory {
TicketSettings {
BusinessAppSettings {
BusinessAPISettings {
BusinessReviewSettings {
BusinessUserSettings {
ConnectionWorkflowSetting {
CommentSettings {
TargetResource {
Image {
AlertSettings {
BusinessGroupSettings {
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/businesses/{businessID}deleteBusiness
Parameters
Accepts */*
Name
Type
Description
Model
businessID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/businesses/{businessID}/businesssettingsgetSettings
Parameters
Name
Type
Description
Model
businessID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
Settings
Settings {
MaxFileSizeForUpload( int )
}
GET/businesses/{businessID}/challengesgetChallenges
Parameters
Name
Type
Description
Model
businessID
path
string
IncludeInactive
query
boolean
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xmlapplication/vnd.soa.v84+jsonapplication/vnd.soa.v84+xml
Status Code
Reason
Model
200
Success
Challenges
Challenges {
Challenge {
Challenge( Collection of Challenge )
}
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 )
}
GET/businesses/{businessID}/metricsgetMetrics
Parameters
Accepts */*
Name
Type
Description
Model
businessID
path
string
ReportType
query
string
Environment
query
string
StartDate
query
string
EndDate
query
string
TimeZone
query
string
TimeInterval
query
string
Duration
query
string
ShowSummary
query
boolean
ShowSLAs
query
boolean
Reponse
Produces application/jsontext/xmlapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
Graph
Graph {
TestType {
SummaryType {
Metric {
IntervalType {
GeoLocationMetric {
EndTime( dateTime )
Test( Collection of TestType )
StartTime( dateTime )
Summary( SummaryType )
Summaries( Collection of SummaryType )
Interval( Collection of IntervalType )
}
TestType {
Operator( string )
MetricType( string )
Value( integer )
ValueUnit( string )
}
SummaryType {
StartTime( dateTime )
Duration( duration )
Metric( Collection of Metric )
EndTime( dateTime )
}
Metric {
Value( int )
Key( string )
Name( string )
}
IntervalType {
StartTime( dateTime )
GeoLocationMetric( Collection of GeoLocationMetric )
Metric( Collection of Metric )
}
GeoLocationMetric {
Latitude( double )
Count( unsignedInt )
Longitude( double )
Location( string )
}
POST/businesses/{businessID}/apisaddAPI
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
businessID
path
string
body
entity
API
API {
RatingSummary {
TargetResource {
Image {
APIVersion {
APIVersionResourceDetails {
Resource {
OperationResourceDetails {
EndpointOAuthDetails {
OAuthTokenResourceURISettings {
OAuth20Settings {
OAuth10aSettings {
APIImplementation {
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
APIBinding {
BindingOperation {
HttpOperation {
Input {
Policy {
ServiceReference {
Endpoint {
ConnectionProperty {
APIInterface {
InterfaceOperation {
OperationOAuthDetails {
Operation {
entry {
stringArray {
APIDesign {
Descriptor {
Links {
TargetAPI {
APIVersionSettings {
APISettings {
RatingSummary( RatingSummary, required )
Description( string )
Updated( dateTime )
PictureID( long )
APIID( string, required )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource, required )
OrganizationKey( string )
AvatarURL( anyURI )
LatestVersionID( string )
APIVersion( APIVersion, required )
AdminGroupID( string, required )
State( string )
APISettings( APISettings, required )
Summary( string )
Visibility( string )
Tag( Collection of string )
IsFollowed( boolean )
InUserTop( boolean )
BusinessID( string )
}
RatingSummary {
Five( int, required )
Four( int, required )
One( int, required )
Two( int, required )
Three( int, required )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image, required )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string, required )
Url( anyURI, required )
Link( anyURI, required )
}
APIVersion {
DefaultProfile( string )
APIVersionResourceDetails( APIVersionResourceDetails, required )
Description( string )
SandboxEndpointOAuthDetailsList( Collection of EndpointOAuthDetails )
ProductionEndpointAccessAutoApproved( boolean )
ProductionEndpointExists( boolean )
SandboxEndpointAccessAutoApproved( boolean )
APIImplementations( Collection of APIImplementation, required )
APIVersionID( string, required )
Name( string )
Created( dateTime )
Endpoints( Collection of Endpoint, required )
SandboxAnonymousAccessAllowed( boolean )
SandboxEndpointExists( boolean )
ProductionAnonymousAccessAllowed( boolean )
SandboxServiceKey( string )
classifiers( Collection of entry )
Operations( Collection of Operation, required )
APIVersionOAuthResourceMapping( Collection of string )
artifacts( Collection of entry )
ProductionEndpointOAuthDetails( EndpointOAuthDetails )
ProductionEndpointOAuthDetailsList( Collection of EndpointOAuthDetails )
RatingSummary( RatingSummary, required )
DefaultFaultContentType( string )
SandboxEndpoint( anyURI )
Updated( dateTime )
ResourceLevelPermissionsSupported( boolean )
ProductionEndpoint( anyURI )
APIDesign( APIDesign, required )
APIID( string, required )
TargetResources( Collection of TargetResource, required )
labels( Collection of entry )
SandboxEndpointOAuthDetails( EndpointOAuthDetails )
Type( string )
APIOwnedImplementations( boolean )
State( string )
Environment( string )
Descriptor( Descriptor, required )
Links( Collection of Links, required )
Visibility( string )
Tag( Collection of string )
ProductionServiceKey( string )
DefaultInputContentType( string )
TargetAPI( TargetAPI, required )
DefaultOutputContentType( string )
APIVersionSettings( APIVersionSettings, required )
}
APIVersionResourceDetails {
Resource( Collection of Resource, required )
SupportsLicenses( boolean )
OperationResourceDetails( Collection of OperationResourceDetails, required )
}
Resource {
OAuthGrantDefaultResource( boolean )
ChildResources( Collection of Resource, required )
Name( string, required )
ShortDescription( string )
SandboxAnonymousAccessAllowed( boolean, required )
LongDescription( string )
ParentResourceID( string )
ResourcePath( string )
ResourceID( string, required )
ProductionAnonymousAccessAllowed( boolean, required )
OAuthGrantUserAuthorizationRequired( boolean )
Visibility( string, required )
BusinessID( string )
}
OperationResourceDetails {
OperationName( string )
Resource( Collection of Resource, required )
OperationKey( string )
}
EndpointOAuthDetails {
OAuthTokenResourceURISettings( OAuthTokenResourceURISettings, required )
OAuth20Settings( OAuth20Settings, required )
OAuth10aSupported( boolean )
Resource( Collection of string )
TokenEndpointParameters( Collection of string )
ClientAuthPolicyOption( Collection of string )
OAuth10aSettings( OAuth10aSettings, required )
AuthorizationEndpointParameters( Collection of string )
OAuthProvider( string, required )
PlatformAppIdentitiesInUse( boolean )
SupportedGrant( Collection of string )
OAuth20Supported( boolean )
}
OAuthTokenResourceURISettings {
OAuthTokenRequestURI( string )
OAuthTokenResourceURIOption( string, required )
}
OAuth20Settings {
TokenEndpointURL( anyURI )
TokenEndpointRequestVerb( string )
BearerTokenMethods( Collection of string, required )
AuthorizationEndpointURL( anyURI )
}
OAuth10aSettings {
TokenEndpointRequestVerb( string )
AuthorizationEndpointURL( anyURI )
AccessTokenEndpointURL( anyURI )
TokenParameterTransmissionMethods( Collection of string, required )
RequestTokenEndpointURL( anyURI )
}
APIImplementation {
Pattern( string )
APIImplementationDeployments( Collection of DeploymentZonesHostingInfo, required )
Description( string )
APIBindings( Collection of APIBinding, required )
Policies( Collection of Policy, required )
ImplementationCode( string )
EndpointOAuthDetailsList( Collection of EndpointOAuthDetails )
ServiceKey( string )
ProxiedService( ServiceReference )
EndpointOAuthDetails( EndpointOAuthDetails )
Name( string, required )
AccessPoints( Collection of string )
Endpoints( Collection of Endpoint, required )
ServiceDetails( ServiceReference, required )
Environment( string )
AnonymousAccessAllowed( boolean )
APIOwnedImplementation( boolean )
APIInterfaces( Collection of APIInterface, required )
Operations( Collection of Operation, required )
EndpointAccessAutoApproved( boolean )
}
DeploymentZonesHostingInfo {
DeploymentZoneID( string, required )
DeploymentZoneEndpoint( Collection of DeploymentZoneEndpoint, required )
}
DeploymentZoneEndpoint {
Path( string )
EndpointHostName( string )
Public( boolean )
ListenerName( string )
ContainerKey( string )
Url( string )
EndpointPath( string )
UseServiceIdentityForSNI( boolean )
GatewayHostPath( string )
DeploymentZoneID( string, required )
GatewayHostName( string )
BindingType( string )
EndpointKey( string )
Protocol( string )
BindingQName( string )
}
APIBinding {
BindingOperations( Collection of BindingOperation, required )
BindingKey( string )
BindingType( string )
InterfaceKey( string )
BindingQName( string )
InterfaceQName( string )
}
BindingOperation {
SOAPAction( string )
WsdlOperationName( string )
OperationName( string, required )
HttpOperation( HttpOperation, required )
BindingOperationKey( string )
}
HttpOperation {
Path( string, required )
OutputContentType( string, required )
FaultContentType( string )
Input( Collection of Input, required )
InputContentType( string, required )
Method( string, required )
}
Input {
Type( string, required )
Value( string )
Name( string, required )
}
Policy {
PolicyType( string )
PolicyKey( string, required )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( string )
Name( string )
}
ServiceReference {
Endpoints( Collection of Endpoint, required )
ServiceName( string )
ServiceType( string )
ServiceKey( string )
ServiceManagementState( string )
OrganizationKey( string )
}
Endpoint {
BindingType( string )
ConnectionProperties( Collection of ConnectionProperty )
EndpointKey( string )
Uri( anyURI, required )
BindingQName( string )
}
ConnectionProperty {
Value( string, required )
Name( string, required )
}
APIInterface {
InterfaceOperations( Collection of InterfaceOperation, required )
InterfaceKey( string )
InterfaceQName( string )
}
InterfaceOperation {
WsdlOperationName( string )
OperationName( string, required )
OAuthDetails( OperationOAuthDetails )
}
OperationOAuthDetails {
WsdlOperationName( string )
OperationName( string, required )
Resource( Collection of string )
OperationKey( string )
InterfaceQName( string )
}
Operation {
Path( string, required )
OutputContentType( string, required )
FaultContentType( string )
WsdlOperationName( string )
Input( Collection of Input, required )
InputContentType( string, required )
OAuthDetails( OperationOAuthDetails )
Method( string, required )
OperationKey( string )
OperationResourceDetails( OperationResourceDetails, required )
Name( string, required )
InterfaceQName( string )
}
entry {
value( stringArray )
key( string )
}
stringArray {
item( Collection of string )
}
APIDesign {
BindingType( Collection of string )
CommonDesign( boolean )
DesignServiceKey( string )
}
Descriptor {
WsdlURL( string )
WsdlId( long, required )
}
Links {
rel( string, required )
href( string, required )
type( string )
title( string )
}
TargetAPI {
DefaultProfile( string )
APIBindings( Collection of APIBinding, required )
DefaultFaultContentType( string )
Endpoints( Collection of Endpoint, required )
SandboxEndpointOAuthDetails( EndpointOAuthDetails )
Type( string )
SandboxServiceKey( string )
Descriptor( Descriptor, required )
ProductionServiceKey( string )
DefaultInputContentType( string )
Operations( Collection of Operation, required )
APIInterfaces( Collection of APIInterface, required )
DefaultOutputContentType( string )
ProductionEndpointOAuthDetails( EndpointOAuthDetails )
}
APIVersionSettings {
SandboxEndpointSupport( string )
PrivateAPIGroupTypeSupport( string )
ReviewsSupport( string )
ProductionAutoApprovalSupport( string )
PrivateAPIIndependentGroupSupport( string )
SandboxAutoApprovalSupport( string )
ResourceLevelPermissionsSupport( string )
RatingsSupport( string )
BoardSupport( string )
ProductionEndpointSupport( string )
}
APISettings {
PrivateAPIRatingsSupport( string )
PrivateAPIGroupTypeSupport( string )
PrivateAPIBoardSupport( string )
PublicAPISandboxEndpointSupport( string )
PublicAPIRatingsSupport( string )
PrivateAPIIndependentGroupSupport( string )
PrivateAPIResourceLevelPermissionsSupport( string )
PublicAPIReviewsSupport( string )
PublicAPISandboxAutoApprovalSupport( string )
PublicAPIProductionAutoApprovalSupport( string )
ValidateUniqueContextPath( string )
PublicAPIResourceLevelPermissionsSupport( string )
PrivateAPISandboxEndpointSupport( string )
PrivateAPISupport( string )
PrivateAPISandboxAutoApprovalSupport( string )
PrivateAPIProductionEndpointSupport( string )
PublicAPIBoardSupport( string )
PrivateAPIReviewsSupport( string )
PublicAPIProductionEndpointSupport( string )
PublicAPISupport( string )
PrivateAPIProductionAutoApprovalSupport( string )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
string
GET/businesses/{BusinessID}/containersgetContainers
Parameters
Name
Type
Description
Model
BusinessID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v81+jsonapplication/xmlapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
Containers
Containers {
Container {
Container( Collection of Container )
}
Container {
AddressOverrideBehavior( string )
ListenerName( string )
ContainerKey( string )
Name( string )
Location( string )
RandomHostNameBehavior( string )
}
GET/businesses/{businessID}/apisettingsgetAPISettings
Parameters
Name
Type
Description
Model
businessID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xmlapplication/vnd.soa.v84+jsonapplication/vnd.soa.v84+xml
Status Code
Reason
Model
200
Success
BusinessAPISettings
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 )
}
GET/businesses/{businessID}/appsettingsgetAppSettings
Parameters
Name
Type
Description
Model
businessID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
BusinessAppSettings
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 )
}
GET/businesses/{businessID}/settingsgetBusinessSettings
Parameters
Name
Type
Description
Model
businessID
path
string
IncludeBusinessAPISettings
query
boolean
IncludeBusinessAppSettings
query
boolean
IncludeBusinessGroupSettings
query
boolean
IncludeTicketSettings
query
boolean
IncludeConnectionSettings
query
boolean
IncludeSecuritySettings
query
boolean
IncludeUserSettings
query
boolean
IncludeDiscussionSettings
query
boolean
IncludeReviewSettings
query
boolean
IncludeAlertSettings
query
boolean
IncludeCommentSettings
query
boolean
IncludeBusinessSettings
query
boolean
IncludeBusinessCategories
query
boolean
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
BusinessSettings
BusinessSettings {
BusinessSecuritySettings {
BusinessDiscussionSettings {
ModelCategory {
TicketSettings {
BusinessAppSettings {
BusinessAPISettings {
CommentSettings {
BusinessReviewSettings {
AlertSettings {
BusinessGroupSettings {
BusinessUserSettings {
ConnectionWorkflowSetting {
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 )
}
GET/businesses/{businessID}/packageexportPackage
Parameters
Name
Type
Description
Model
businessID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/octet-streamapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
any
PUT/businesses/{businessID}/apisettingssaveAPISettings
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml application/vnd.soa.v84+json application/vnd.soa.v84+xml
Name
Type
Description
Model
businessID
path
string
body
entity
BusinessAPISettings
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 )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xmlapplication/vnd.soa.v84+jsonapplication/vnd.soa.v84+xml
Status Code
Reason
Model
200
Success
BusinessAPISettings
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 )
}
PUT/businesses/{businessID}/twofasettingssaveTwoFASettings
Parameters
Accepts application/xml application/json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
businessID
path
string
body
entity
TwoFASettings
TwoFASettings {
RecurrenceIntervalMinutes( int )
DeviceCookieValue( string )
CodeValidSeconds( int )
TwoFAEnabled( boolean, required )
RecurrenceMode( string, required )
DeviceCookieName( string )
MaxAttempts( int )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
TwoFASettings
TwoFASettings {
RecurrenceIntervalMinutes( int )
DeviceCookieValue( string )
CodeValidSeconds( int )
TwoFAEnabled( boolean )
RecurrenceMode( string )
DeviceCookieName( string )
MaxAttempts( int )
}
PUT/businesses/{businessID}/appsettingssaveAppSettings
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
businessID
path
string
body
entity
BusinessAppSettings
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 )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
BusinessAppSettings
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 )
}
PUT/businesses/{businessID}/groupsettingssaveGroupSettings
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
businessID
path
string
body
entity
BusinessGroupSettings
BusinessGroupSettings {
PrivateGroupReviewsSupport( string )
GroupMemberWorkflowDefKey( string )
PublicGroupSupport( string )
PublicGroupBoardSupport( string )
PrivateGroupSupport( string )
GroupCommentWorkflowDefKey( string )
GroupSupport( string )
PublicGroupRatingsSupport( string )
PrivateGroupRatingsSupport( string )
PublicGroupReviewsSupport( string )
PrivateGroupBoardSupport( string )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
BusinessGroupSettings
BusinessGroupSettings {
PrivateGroupReviewsSupport( string )
GroupMemberWorkflowDefKey( string )
PublicGroupSupport( string )
PublicGroupBoardSupport( string )
PrivateGroupSupport( string )
GroupCommentWorkflowDefKey( string )
GroupSupport( string )
PublicGroupRatingsSupport( string )
PrivateGroupRatingsSupport( string )
PublicGroupReviewsSupport( string )
PrivateGroupBoardSupport( string )
}
PUT/businesses/{businessID}/usersettingssaveUserSettings
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
businessID
path
string
body
entity
BusinessUserSettings
BusinessUserSettings {
UserWorkflowDefKey( string )
SelfSignup( string )
InviteUnregisteredUsers( string )
InvitedUserValidDays( int )
TopApisCountAllowed( int )
UpdateEmailValidCodeHours( int )
SignupUserValidDays( int )
NewsUpdateNotification( string )
AddedUserValidDays( int )
ResetValidCodeHours( int )
EnforceChallengesSetupOnLogin( string )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
BusinessUserSettings
BusinessUserSettings {
UserWorkflowDefKey( string )
SelfSignup( string )
InviteUnregisteredUsers( string )
InvitedUserValidDays( int )
TopApisCountAllowed( int )
UpdateEmailValidCodeHours( int )
SignupUserValidDays( int )
NewsUpdateNotification( string )
AddedUserValidDays( int )
ResetValidCodeHours( int )
EnforceChallengesSetupOnLogin( string )
}
PUT/businesses/{businessID}/ticketsettingssaveTicketSettings
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
businessID
path
string
body
entity
TicketSettings
TicketSettings {
TicketSupport( string )
TicketWorkflowDefKey( string )
TicketCommentWorkflowDefKey( string )
Visibility( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
TicketSettings
TicketSettings {
TicketSupport( string )
TicketWorkflowDefKey( string )
TicketCommentWorkflowDefKey( string )
Visibility( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
GET/businesses/types/{typeName}getBusinessType
Returns the information about a given business type including its avatar.
Request:
GET /businesses/types/company HTTP/1.1
Accept: application/vnd.soa.v83+json
Response:
HTTP/1.1 200 OK
{
"Name" : "company",
"AvatarURL" : "http://host:port/path"
}
Parameters
Name
Type
Description
Model
typeName
path
Type of business to return
string
Reponse
Produces application/jsonapplication/vnd.soa.v83+json
Status Code
Reason
Model
200
Success
BusinessType
BusinessType {
AvatarURL( anyURI )
Name( string )
}
PUT/businesses/{businessID}/alertsettingssaveAlertSettings
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
businessID
path
string
body
entity
AlertSettings
AlertSettings {
AlertWorkflowDefKey( string )
AlertCommentWorkflowDefKey( string )
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
AlertSettings
AlertSettings {
AlertWorkflowDefKey( string )
AlertCommentWorkflowDefKey( string )
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
PUT/businesses/{businessID}/commentsettingssaveCommentSettings
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
businessID
path
string
body
entity
CommentSettings
CommentSettings {
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
CommentSettings
CommentSettings {
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
PUT/businesses/{businessID}/connectionsettingssaveConnectionSettings
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
businessID
path
string
body
entity
ConnectionSettings
ConnectionSettings {
ConnectionWorkflowSetting {
WorkflowSetting( Collection of ConnectionWorkflowSetting )
}
ConnectionWorkflowSetting {
WorkflowDefinitionKey( string, required )
Environment( string, required )
ConnectionCommentWorkflowDefKey( string )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
ConnectionSettings
ConnectionSettings {
ConnectionWorkflowSetting {
WorkflowSetting( Collection of ConnectionWorkflowSetting )
}
ConnectionWorkflowSetting {
WorkflowDefinitionKey( string )
Environment( string )
ConnectionCommentWorkflowDefKey( string )
}
PUT/businesses/{businessID}/discussionsettingssaveDiscussionSettings
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
businessID
path
string
body
entity
BusinessDiscussionSettings
BusinessDiscussionSettings {
AutoPublish( boolean )
DiscussionWorkflowDefKey( string )
DiscussionCommentWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
BusinessDiscussionSettings
BusinessDiscussionSettings {
AutoPublish( boolean )
DiscussionWorkflowDefKey( string )
DiscussionCommentWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
PUT/businesses/{businessID}/businesssettingssaveSettings
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
businessID
path
string
body
entity
Settings
Settings {
MaxFileSizeForUpload( int )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
Settings
Settings {
MaxFileSizeForUpload( int )
}
GET/businesses/{businessID}/groupsettingsgetGroupSettings
Parameters
Name
Type
Description
Model
businessID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
BusinessGroupSettings
BusinessGroupSettings {
PrivateGroupReviewsSupport( string )
GroupMemberWorkflowDefKey( string )
PublicGroupSupport( string )
PublicGroupBoardSupport( string )
PrivateGroupSupport( string )
GroupCommentWorkflowDefKey( string )
GroupSupport( string )
PublicGroupRatingsSupport( string )
PrivateGroupRatingsSupport( string )
PublicGroupReviewsSupport( string )
PrivateGroupBoardSupport( string )
}
GET/businesses/{businessID}/usersettingsgetUserSettings
Parameters
Name
Type
Description
Model
businessID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
BusinessUserSettings
BusinessUserSettings {
UserWorkflowDefKey( string )
SelfSignup( string )
InviteUnregisteredUsers( string )
InvitedUserValidDays( int )
TopApisCountAllowed( int )
UpdateEmailValidCodeHours( int )
SignupUserValidDays( int )
NewsUpdateNotification( string )
AddedUserValidDays( int )
ResetValidCodeHours( int )
EnforceChallengesSetupOnLogin( string )
}
GET/businesses/{businessID}/discussionsettingsgetDiscussionSettings
Parameters
Name
Type
Description
Model
businessID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
BusinessDiscussionSettings
BusinessDiscussionSettings {
AutoPublish( boolean )
DiscussionWorkflowDefKey( string )
DiscussionCommentWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
GET/businesses/{businessID}/reviewsettingsgetReviewSettings
Parameters
Name
Type
Description
Model
businessID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
BusinessReviewSettings
BusinessReviewSettings {
AutoPublish( boolean )
ReviewWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
GET/businesses/{businessID}/ticketsettingsgetTicketSettings
Parameters
Name
Type
Description
Model
businessID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
TicketSettings
TicketSettings {
TicketSupport( string )
TicketWorkflowDefKey( string )
TicketCommentWorkflowDefKey( string )
Visibility( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
GET/businesses/{businessID}/alertsettingsgetAlertSettings
Parameters
Name
Type
Description
Model
businessID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
AlertSettings
AlertSettings {
AlertWorkflowDefKey( string )
AlertCommentWorkflowDefKey( string )
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
GET/businesses/{businessID}/commentsettingsgetCommentSettings
Parameters
Name
Type
Description
Model
businessID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
CommentSettings
CommentSettings {
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
GET/businesses/{businessID}/connectionsettingsgetConnectionSettings
Parameters
Name
Type
Description
Model
businessID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
ConnectionSettings
ConnectionSettings {
ConnectionWorkflowSetting {
WorkflowSetting( Collection of ConnectionWorkflowSetting )
}
ConnectionWorkflowSetting {
WorkflowDefinitionKey( string )
Environment( string )
ConnectionCommentWorkflowDefKey( string )
}
GET/businesses/{businessID}/securitysettingsgetSecuritySettings
Parameters
Name
Type
Description
Model
businessID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
BusinessSecuritySettings
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 )
}
GET/businesses/{businessID}/twofasettingsgetTwoFASettings
Parameters
Name
Type
Description
Model
businessID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
TwoFASettings
TwoFASettings {
RecurrenceIntervalMinutes( int )
DeviceCookieValue( string )
CodeValidSeconds( int )
TwoFAEnabled( boolean )
RecurrenceMode( string )
DeviceCookieName( string )
MaxAttempts( int )
}
GET/businesses/{businessID}/resourcesgetBusinessResources
Parameters
Name
Type
Description
Model
businessID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
rss
rss {
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
channel( rssChannel )
version( string )
}
rssChannel {
image( rssImage )
copyright( string )
item( rssItem )
skipHours( rssSkipHours )
lastBuildDate( string )
link( anyURI )
rating( string )
description( string )
generator( string )
language( string )
title( string )
managingEditor( string )
webMaster( string )
pubDate( string )
ttl( int )
skipDays( rssSkipDays )
cloud( rssCloud )
textInput( rssTextInput )
docs( anyURI )
category( rssCategory )
}
rssImage {
link( anyURI )
width( int )
description( string )
title( string )
url( string )
height( int )
}
rssItem {
comments( anyURI )
enclosure( rssEnclosure )
author( string )
link( anyURI )
description( string )
guid( rssGuid )
source( rssSource )
title( string )
category( rssCategory )
pubDate( string )
}
rssEnclosure {
length( string )
type( string )
url( string )
}
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
hour( Collection of string )
}
rssSkipDays {
day( Collection of string )
}
rssCloud {
path( string )
protocol( string )
port( int )
registerProcedure( string )
domain( string )
}
rssTextInput {
name( string )
link( anyURI )
description( string )
title( string )
}
GET/businesses/{businessID}/resourcehierarchygetBusinessResourcesHierarchy
Parameters
Name
Type
Description
Model
businessID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
BusinessResources
BusinessResources {
Resource {
Resources( Collection of Resource )
}
Resource {
OAuthGrantDefaultResource( boolean )
ChildResources( Collection of Resource )
Name( string )
ShortDescription( string )
SandboxAnonymousAccessAllowed( boolean )
LongDescription( string )
ParentResourceID( string )
ResourcePath( string )
ResourceID( string )
ProductionAnonymousAccessAllowed( boolean )
OAuthGrantUserAuthorizationRequired( boolean )
Visibility( string )
BusinessID( string )
}
GET/businesses/resources/{ResourceID}getBusinessResource
Parameters
Name
Type
Description
Model
ResourceID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
Resource
Resource {
OAuthGrantDefaultResource( boolean )
ChildResources( Collection of Resource )
Name( string )
ShortDescription( string )
SandboxAnonymousAccessAllowed( boolean )
LongDescription( string )
ParentResourceID( string )
ResourcePath( string )
ResourceID( string )
ProductionAnonymousAccessAllowed( boolean )
OAuthGrantUserAuthorizationRequired( boolean )
Visibility( string )
BusinessID( string )
}
POST/businesses/{businessID}/resourcesaddBusinessResource
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
businessID
path
string
body
entity
Resource
Resource {
OAuthGrantDefaultResource( boolean )
ChildResources( Collection of Resource, required )
Name( string, required )
ShortDescription( string )
SandboxAnonymousAccessAllowed( boolean, required )
LongDescription( string )
ParentResourceID( string )
ResourcePath( string )
ResourceID( string, required )
ProductionAnonymousAccessAllowed( boolean, required )
OAuthGrantUserAuthorizationRequired( boolean )
Visibility( string, required )
BusinessID( string )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
Resource
Resource {
OAuthGrantDefaultResource( boolean )
ChildResources( Collection of Resource )
Name( string )
ShortDescription( string )
SandboxAnonymousAccessAllowed( boolean )
LongDescription( string )
ParentResourceID( string )
ResourcePath( string )
ResourceID( string )
ProductionAnonymousAccessAllowed( boolean )
OAuthGrantUserAuthorizationRequired( boolean )
Visibility( string )
BusinessID( string )
}
PUT/businesses/resources/{ResourceID}updateBusinessResource
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
ResourceID
path
string
body
entity
Resource
Resource {
OAuthGrantDefaultResource( boolean )
ChildResources( Collection of Resource, required )
Name( string, required )
ShortDescription( string )
SandboxAnonymousAccessAllowed( boolean, required )
LongDescription( string )
ParentResourceID( string )
ResourcePath( string )
ResourceID( string, required )
ProductionAnonymousAccessAllowed( boolean, required )
OAuthGrantUserAuthorizationRequired( boolean )
Visibility( string, required )
BusinessID( string )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
Resource
Resource {
OAuthGrantDefaultResource( boolean )
ChildResources( Collection of Resource )
Name( string )
ShortDescription( string )
SandboxAnonymousAccessAllowed( boolean )
LongDescription( string )
ParentResourceID( string )
ResourcePath( string )
ResourceID( string )
ProductionAnonymousAccessAllowed( boolean )
OAuthGrantUserAuthorizationRequired( boolean )
Visibility( string )
BusinessID( string )
}
DELETE/businesses/resources/{ResourceID}deleteBusinessResource
Parameters
Name
Type
Description
Model
ResourceID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
Resource
Resource {
OAuthGrantDefaultResource( boolean )
ChildResources( Collection of Resource )
Name( string )
ShortDescription( string )
SandboxAnonymousAccessAllowed( boolean )
LongDescription( string )
ParentResourceID( string )
ResourcePath( string )
ResourceID( string )
ProductionAnonymousAccessAllowed( boolean )
OAuthGrantUserAuthorizationRequired( boolean )
Visibility( string )
BusinessID( string )
}
GET/businesses/{businessID}/licensesgetBusinessLicenses
Parameters
Name
Type
Description
Model
businessID
path
string
IncludeInactive
query
boolean
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
rss
rss {
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
channel( rssChannel )
version( string )
}
rssChannel {
image( rssImage )
copyright( string )
item( rssItem )
skipHours( rssSkipHours )
lastBuildDate( string )
link( anyURI )
rating( string )
description( string )
generator( string )
language( string )
title( string )
managingEditor( string )
webMaster( string )
pubDate( string )
ttl( int )
skipDays( rssSkipDays )
cloud( rssCloud )
textInput( rssTextInput )
docs( anyURI )
category( rssCategory )
}
rssImage {
link( anyURI )
width( int )
description( string )
title( string )
url( string )
height( int )
}
rssItem {
comments( anyURI )
enclosure( rssEnclosure )
author( string )
link( anyURI )
description( string )
guid( rssGuid )
source( rssSource )
title( string )
category( rssCategory )
pubDate( string )
}
rssEnclosure {
length( string )
type( string )
url( string )
}
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
hour( Collection of string )
}
rssSkipDays {
day( Collection of string )
}
rssCloud {
path( string )
protocol( string )
port( int )
registerProcedure( string )
domain( string )
}
rssTextInput {
name( string )
link( anyURI )
description( string )
title( string )
}
GET/businesses/licenses/{LicenseID}getBusinessLicense
Parameters
Name
Type
Description
Model
LicenseID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
LicenseDetails
LicenseDetails {
LicensePartDetails {
Policy {
Resource {
AgreementDocument {
TargetResource {
Image {
Active( boolean )
Description( string )
ProductionAccessAutoApproved( boolean )
Environment( Collection of string )
Visibility( string )
SandboxAccessAutoApproved( boolean )
LicenseID( string )
LicensePartsDetails( Collection of LicensePartDetails )
BusinessID( string )
Name( string )
AgreementDetails( Collection of AgreementDocument )
}
LicensePartDetails {
Policies( Collection of Policy )
Resource( Collection of Resource )
Name( string )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( string )
Name( string )
}
Resource {
OAuthGrantDefaultResource( boolean )
ChildResources( Collection of Resource )
Name( string )
ShortDescription( string )
SandboxAnonymousAccessAllowed( boolean )
LongDescription( string )
ParentResourceID( string )
ResourcePath( string )
ResourceID( string )
ProductionAnonymousAccessAllowed( boolean )
OAuthGrantUserAuthorizationRequired( boolean )
Visibility( string )
BusinessID( string )
}
AgreementDocument {
AgreementType( string )
DocumentState( string )
Description( string )
FileName( string )
DocumentID( string )
ResourceType( string )
ContentPath( string )
Name( string )
TargetResources( Collection of TargetResource )
Active( boolean )
PrintContentPath( string )
PrintVersion( int )
ResourceID( string )
MetadataResourceURI( string )
MetadataResourceVersion( int )
PrintResourceURI( string )
Link( 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 )
}
POST/businesses/{businessID}/licensesaddBusinessLicense
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
businessID
path
string
body
entity
License
License {
LicensePart {
AgreementDocument {
TargetResource {
Image {
LicenseParts( Collection of LicensePart, required )
Active( boolean )
Description( string )
ProductionAccessAutoApproved( boolean, required )
Environment( Collection of string )
Visibility( string, required )
SandboxAccessAutoApproved( boolean, required )
LicenseID( string, required )
BusinessID( string )
Name( string, required )
AgreementDetails( Collection of AgreementDocument, required )
}
LicensePart {
PolicyKey( Collection of string )
ResourceID( Collection of string )
Name( string )
}
AgreementDocument {
AgreementType( string, required )
DocumentState( string, required )
Description( string )
FileName( string, required )
DocumentID( string )
ResourceType( string )
ContentPath( string, required )
Name( string, required )
TargetResources( Collection of TargetResource, required )
Active( boolean, required )
PrintContentPath( string, required )
PrintVersion( int )
ResourceID( string )
MetadataResourceURI( string )
MetadataResourceVersion( int )
PrintResourceURI( string )
Link( string, required )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image, required )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string, required )
Url( anyURI, required )
Link( anyURI, required )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
License
License {
LicensePart {
AgreementDocument {
TargetResource {
Image {
LicenseParts( Collection of LicensePart )
Active( boolean )
Description( string )
ProductionAccessAutoApproved( boolean )
Environment( Collection of string )
Visibility( string )
SandboxAccessAutoApproved( boolean )
LicenseID( string )
BusinessID( string )
Name( string )
AgreementDetails( Collection of AgreementDocument )
}
LicensePart {
PolicyKey( Collection of string )
ResourceID( Collection of string )
Name( string )
}
AgreementDocument {
AgreementType( string )
DocumentState( string )
Description( string )
FileName( string )
DocumentID( string )
ResourceType( string )
ContentPath( string )
Name( string )
TargetResources( Collection of TargetResource )
Active( boolean )
PrintContentPath( string )
PrintVersion( int )
ResourceID( string )
MetadataResourceURI( string )
MetadataResourceVersion( int )
PrintResourceURI( string )
Link( 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 )
}
PUT/businesses/licenses/{LicenseID}updateBusinessLicense
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
LicenseID
path
string
body
entity
License
License {
LicensePart {
AgreementDocument {
TargetResource {
Image {
LicenseParts( Collection of LicensePart, required )
Active( boolean )
Description( string )
ProductionAccessAutoApproved( boolean, required )
Environment( Collection of string )
Visibility( string, required )
SandboxAccessAutoApproved( boolean, required )
LicenseID( string, required )
BusinessID( string )
Name( string, required )
AgreementDetails( Collection of AgreementDocument, required )
}
LicensePart {
PolicyKey( Collection of string )
ResourceID( Collection of string )
Name( string )
}
AgreementDocument {
AgreementType( string, required )
DocumentState( string, required )
Description( string )
FileName( string, required )
DocumentID( string )
ResourceType( string )
ContentPath( string, required )
Name( string, required )
TargetResources( Collection of TargetResource, required )
Active( boolean, required )
PrintContentPath( string, required )
PrintVersion( int )
ResourceID( string )
MetadataResourceURI( string )
MetadataResourceVersion( int )
PrintResourceURI( string )
Link( string, required )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image, required )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string, required )
Url( anyURI, required )
Link( anyURI, required )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
License
License {
LicensePart {
AgreementDocument {
TargetResource {
Image {
LicenseParts( Collection of LicensePart )
Active( boolean )
Description( string )
ProductionAccessAutoApproved( boolean )
Environment( Collection of string )
Visibility( string )
SandboxAccessAutoApproved( boolean )
LicenseID( string )
BusinessID( string )
Name( string )
AgreementDetails( Collection of AgreementDocument )
}
LicensePart {
PolicyKey( Collection of string )
ResourceID( Collection of string )
Name( string )
}
AgreementDocument {
AgreementType( string )
DocumentState( string )
Description( string )
FileName( string )
DocumentID( string )
ResourceType( string )
ContentPath( string )
Name( string )
TargetResources( Collection of TargetResource )
Active( boolean )
PrintContentPath( string )
PrintVersion( int )
ResourceID( string )
MetadataResourceURI( string )
MetadataResourceVersion( int )
PrintResourceURI( string )
Link( 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 )
}
DELETE/businesses/licenses/{LicenseID}deleteBusinessLicense
Parameters
Name
Type
Description
Model
LicenseID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
License
License {
LicensePart {
AgreementDocument {
TargetResource {
Image {
LicenseParts( Collection of LicensePart )
Active( boolean )
Description( string )
ProductionAccessAutoApproved( boolean )
Environment( Collection of string )
Visibility( string )
SandboxAccessAutoApproved( boolean )
LicenseID( string )
BusinessID( string )
Name( string )
AgreementDetails( Collection of AgreementDocument )
}
LicensePart {
PolicyKey( Collection of string )
ResourceID( Collection of string )
Name( string )
}
AgreementDocument {
AgreementType( string )
DocumentState( string )
Description( string )
FileName( string )
DocumentID( string )
ResourceType( string )
ContentPath( string )
Name( string )
TargetResources( Collection of TargetResource )
Active( boolean )
PrintContentPath( string )
PrintVersion( int )
ResourceID( string )
MetadataResourceURI( string )
MetadataResourceVersion( int )
PrintResourceURI( string )
Link( 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 )
}
GET/businesses/{businessID}/passwordpolicygetPasswordPolicy
Parameters
Name
Type
Description
Model
businessID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
PasswordPolicy
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 )
}
PUT/businesses/{businessID}/passwordpolicyupdatePasswordPolicy
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
businessID
path
string
body
entity
PasswordPolicy
PasswordPolicy {
MinLetterCount( int, required )
MinSpecialCharCount( int, required )
MaxPasswordLength( int, required )
CanMatchEmail( boolean, required )
PasswordChangeIntervalDays( int, required )
IsCaseSensitive( boolean, required )
NumbersOfLastPasswordCheckCount( int, required )
MinNumberCount( int, required )
CanMatchUserName( boolean, required )
AllowedSpecialCharacters( Collection of string )
MinUpperLetterCount( int, required )
MinPasswordLength( int, required )
CanContainSpaces( boolean, required )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
PasswordPolicy
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 )
}
GET/businesses/{businessID}/loginpolicygetLoginPolicy
Parameters
Name
Type
Description
Model
businessID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
LoginPolicy
LoginPolicy {
ConcurrentLogin( boolean )
MaxSequentialFailureAttemptsAllowed( int )
SuspensionMinutes( int )
AutoLoginExternalDomain( string )
LoginSessionTimeout( int )
ActiveSessionTimeout( int )
PersistentSession( boolean )
InactiveSessionTimeout( int )
AttemptsPeriod( int )
}
PUT/businesses/{businessID}/loginpolicyupdateLoginPolicy
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
businessID
path
string
body
entity
LoginPolicy
LoginPolicy {
ConcurrentLogin( boolean )
MaxSequentialFailureAttemptsAllowed( int, required )
SuspensionMinutes( int, required )
AutoLoginExternalDomain( string, required )
LoginSessionTimeout( int, required )
ActiveSessionTimeout( int, required )
PersistentSession( boolean )
InactiveSessionTimeout( int, required )
AttemptsPeriod( int, required )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
LoginPolicy
LoginPolicy {
ConcurrentLogin( boolean )
MaxSequentialFailureAttemptsAllowed( int )
SuspensionMinutes( int )
AutoLoginExternalDomain( string )
LoginSessionTimeout( int )
ActiveSessionTimeout( int )
PersistentSession( boolean )
InactiveSessionTimeout( int )
AttemptsPeriod( int )
}
POST/businesses/{businessID}/cacertificatesuploadTrustedCACertificate
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
businessID
path
string
body
entity
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/businesses/{businessID}/cacertificatesexportTrustedCACertificates
Parameters
Name
Type
Description
Model
businessID
path
string
KeyStoreType
query
string
SubjectDN
query
string
IssuerDN
query
string
SerialNumber
query
string
IncludeExpired
query
boolean
Reponse
Produces application/octet-stream
Status Code
Reason
Model
200
Success
byte
GET/businesses/{businessID}/cacertificatesgetTrustedCACertificates
Parameters
Name
Type
Description
Model
businessID
path
string
SubjectDN
query
string
IssuerDN
query
string
SerialNumber
query
string
IncludeExpired
query
boolean
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
rss
rss {
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
channel( rssChannel )
version( string )
}
rssChannel {
image( rssImage )
copyright( string )
item( rssItem )
skipHours( rssSkipHours )
lastBuildDate( string )
link( anyURI )
rating( string )
description( string )
generator( string )
language( string )
title( string )
managingEditor( string )
webMaster( string )
pubDate( string )
ttl( int )
skipDays( rssSkipDays )
cloud( rssCloud )
textInput( rssTextInput )
docs( anyURI )
category( rssCategory )
}
rssImage {
link( anyURI )
width( int )
description( string )
title( string )
url( string )
height( int )
}
rssItem {
comments( anyURI )
enclosure( rssEnclosure )
author( string )
link( anyURI )
description( string )
guid( rssGuid )
source( rssSource )
title( string )
category( rssCategory )
pubDate( string )
}
rssEnclosure {
length( string )
type( string )
url( string )
}
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
hour( Collection of string )
}
rssSkipDays {
day( Collection of string )
}
rssCloud {
path( string )
protocol( string )
port( int )
registerProcedure( string )
domain( string )
}
rssTextInput {
name( string )
link( anyURI )
description( string )
title( string )
}
GET/businesses/{businessID}/apistatusgetAPIStatusReports
Parameters
Name
Type
Description
Model
businessID
path
string
Environment
query
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
StatusReport
StatusReport {
StatusReportEntryType {
StatusPeriodType {
StatusEntry( Collection of StatusReportEntryType )
}
StatusReportEntryType {
Endpoint( string )
APIID( string )
StatusPeriod( Collection of StatusPeriodType )
APIVersionID( string )
Name( string )
}
StatusPeriodType {
Status( string )
PeriodDate( dateTime )
}
PUT/businesses/{businessID}/challengessaveChallenges
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
businessID
path
string
body
entity
Challenges
Challenges {
Challenge {
Challenge( Collection of Challenge, required )
}
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, required )
ChallengeQuestion( string, required )
MinimumAlphaCount( int )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
Challenges
Challenges {
Challenge {
Challenge( Collection of Challenge )
}
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 )
}
PUT/businesses/{businessID}/securitysettingssaveSecuritySettings
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
businessID
path
string
body
entity
BusinessSecuritySettings
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 )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
BusinessSecuritySettings
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 )
}
PUT/businesses/{businessID}/reviewsettingssaveReviewSettings
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
businessID
path
string
body
entity
BusinessReviewSettings
BusinessReviewSettings {
AutoPublish( boolean )
ReviewWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
BusinessReviewSettings
BusinessReviewSettings {
AutoPublish( boolean )
ReviewWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
GET/businesses/{BusinessID}/forumgetForumEntries
Parameters
Name
Type
Description
Model
BusinessID
path
string
ItemType
query
string
SubjectID
query
string
IncludeActions
query
boolean
start
query
integer
count
query
integer
SortBy
query
string
PublishedState
query
string
AuthorID
query
string
Reponse
Produces application/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
BoardItemList
BoardItemList {
AbstractBoardItemDetails {
BoardItemDetails( Collection of AbstractBoardItemDetails )
}
AbstractBoardItemDetails {
Type( BoardItemType )
State( string )
BoardItemAssignments( Collection of string )
ItemID( string )
}
GET/businesses/{BusinessID}/environmentsgetBusinessEnvironments
Parameters
Name
Type
Description
Model
BusinessID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v81+jsonapplication/xmlapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
Environments
Environments {
Environment( Collection of string )
}
GET/businesses/{BusinessID}/implementationsgetBusinessImplementations
Parameters
Name
Type
Description
Model
BusinessID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v81+jsonapplication/xmlapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
BusinessApiImplementations
BusinessApiImplementations {
BusinessApiImplementation {
BusinessApiImplementation( Collection of BusinessApiImplementation )
}
BusinessApiImplementation {
ImplementationName( string )
ImplementationCode( string )
AnonymousAccessAllowed( boolean )
EndpointAccessAutoApproved( boolean )
}
GET/businesses/{BusinessID}/implenvassociationsgetBusinessImplEnvAssociations
Parameters
Name
Type
Description
Model
BusinessID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v81+jsonapplication/xmlapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
ImplEnvAssociations
ImplEnvAssociations {
ImplEnvAssociation {
ImplEnvAssociation( Collection of ImplEnvAssociation )
}
ImplEnvAssociation {
Environment( string )
Implementation( string )
}
GET/businesses/{BusinessID}/modelslistModels
Parameters
Name
Type
Description
Model
BusinessID
path
string
IncludeDeleted
query
boolean
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
Models
Models {
Model {
ModelVersion {
Action {
ActionParameter {
TargetResource {
Image {
Links {
Model( Collection of Model )
}
Model {
ModelVersions( Collection of ModelVersion )
Description( string )
Updated( dateTime )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource )
LatestVersionID( string )
State( string )
Summary( string )
Links( Collection of Links )
Visibility( string )
Tag( Collection of string )
ModelVersion( ModelVersion )
ModelCategory( string )
ModelID( string )
BusinessID( string )
}
ModelVersion {
Action( Collection of Action )
Description( string )
Updated( dateTime )
Schema( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource )
State( string )
ModelVersionID( string )
ModelReferences( Collection of ModelVersion )
Links( Collection of Links )
Visibility( string )
Tag( Collection of string )
ModelID( string )
}
Action {
ActionName( string )
Parameters( Collection of ActionParameter )
UserID( string )
Comments( string )
}
ActionParameter {
Value( string )
Name( 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 )
}
Links {
rel( string )
href( string )
type( string )
title( string )
}
GET/businesses/{businessID}/modelsettingsgetModelSettings
Parameters
Name
Type
Description
Model
businessID
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
BusinessModelSettings
BusinessModelSettings {
ModelVersionWorkflowDefKey( string )
}
PUT/businesses/{businessID}/modelsettingssaveModelSettings
Parameters
Accepts application/json
Name
Type
Description
Model
businessID
path
string
body
entity
BusinessModelSettings
BusinessModelSettings {
ModelVersionWorkflowDefKey( string )
}
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
BusinessModelSettings
BusinessModelSettings {
ModelVersionWorkflowDefKey( string )
}
GET/businesses/{businessID}/modelcategoriesgetModelCategories
Parameters
Name
Type
Description
Model
businessID
path
string
IncludeDeleted
query
boolean
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
ModelCategories
ModelCategories {
ModelCategory {
ModelCategory( Collection of ModelCategory )
}
ModelCategory {
Description( string )
Deleted( boolean )
Name( string )
}
POST/businesses/{businessID}/modelcategoriesaddModelCategory
Parameters
Accepts application/json
Name
Type
Description
Model
businessID
path
string
body
entity
ModelCategory
ModelCategory {
Description( string )
Deleted( boolean, required )
Name( string, required )
}
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
ModelCategory
ModelCategory {
Description( string )
Deleted( boolean )
Name( string )
}
POST/businesses/{ID}/ratingsaddRating
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml
Name
Type
Description
Model
ID
path
string
body
entity
Rating
Rating {
UserID( string, required )
Rating( int, required )
ID( string, required )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xml
Status Code
Reason
Model
200
Success
Rating
Rating {
UserID( string )
Rating( int )
ID( string )
}
GET/businesses/{ID}/picturegetImage
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
size
query
integer
Reponse
Produces image/jpeg
Status Code
Reason
Model
200
Success
byte
GET/businesses/{ID}/avatargetDefaultAvatar
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
size
query
integer
Reponse
Produces image/png
Status Code
Reason
Model
200
Success
byte
GET/businesses/{ID}/previewavatarpreviewAvatar
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
Provider
query
string
Reponse
Produces image/jpeg
Status Code
Reason
Model
200
Success
any
POST/businesses/{ID}/pictureupdateImage
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
ID
path
string
body
entity
base64Binary
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
DELETE/businesses/{ID}/picturedeleteImage
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
GET/businesses/resources/{ResourceID}/packageexportBusinessResource
Parameters
Name
Type
Description
Model
ResourceID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/octet-stream
Status Code
Reason
Model
200
Success
any
PUT/businesses/licenses/{LicenseID}/statechangeLicenseState
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
LicenseID
path
string
body
entity
ChangeLicenseState
ChangeLicenseState {
Active( boolean, required )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
DELETE/businesses/{businessID}/cacertificates/{AliasId}deleteTrustedCACertificate
Parameters
Accepts */*
Name
Type
Description
Model
businessID
path
string
AliasId
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
PUT/businesses/{businessID}/modelcategories/{CategoryName}updateModelCategory
Parameters
Accepts application/json
Name
Type
Description
Model
businessID
path
string
CategoryName
path
string
body
entity
ModelCategory
ModelCategory {
Description( string )
Deleted( boolean, required )
Name( string, required )
}
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
ModelCategory
ModelCategory {
Description( string )
Deleted( boolean )
Name( string )
}
GET/businesses/{businessID}/modelcategories/{CategoryName}getModelCategory
Parameters
Name
Type
Description
Model
businessID
path
string
CategoryName
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
ModelCategory
ModelCategory {
Description( string )
Deleted( boolean )
Name( string )
}
DELETE/businesses/{businessID}/modelcategories/{CategoryName}deleteModelCategory
Parameters
Name
Type
Description
Model
businessID
path
string
CategoryName
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
GET/businesses/{businessID}/metrics/exportexportMetrics
Parameters
Accepts */*
Name
Type
Description
Model
businessID
path
string
ReportType
query
string
Environment
query
string
StartDate
query
string
EndDate
query
string
TimeZone
query
string
TimeInterval
query
string
Duration
query
string
ShowSummary
query
boolean
ShowSLAs
query
boolean
Reponse
Produces */*
Status Code
Reason
Model
200
Success
any
DELETE/businesses/{ID}/ratings/{userID}deleteRating
Parameters
Name
Type
Description
Model
userID
path
string
ID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xml
PUT/businesses/{ID}/ratings/{userID}updateRating
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml
Name
Type
Description
Model
userID
path
string
ID
path
string
body
entity
Rating
Rating {
UserID( string, required )
Rating( int, required )
ID( string, required )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xml
Status Code
Reason
Model
200
Success
Rating
Rating {
UserID( string )
Rating( int )
ID( string )
}
GET/businesses/{ID}/ratings/summarygetRatingSummary
Parameters
Name
Type
Description
Model
ID
path
string
Reponse
Produces text/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xml
Status Code
Reason
Model
200
Success
RatingSummary
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
GET/businesses/{ID}/ratings/{userID}getRating
Parameters
Name
Type
Description
Model
ID
path
string
userID
path
string
Reponse
Produces text/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xml
Status Code
Reason
Model
200
Success
Rating
Rating {
UserID( string )
Rating( int )
ID( string )
}
GET/businesses/{ID}/avatars/{version}.pnggetAvatar
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
version
path
string
size
query
integer
Reponse
Produces image/png
Status Code
Reason
Model
200
Success
byte
GET/businesses/avatar/{version}{Extension:(/[^/]+?)*}getDefaultVersionedAvatar
Parameters
Accepts */*
Name
Type
Description
Model
version
path
string
Extension
path
string
size
query
integer
Reponse
Produces image/png
Status Code
Reason
Model
200
Success
byte
