Application API
{ http://soa.com/wsdl/app/1.0 } ApplicationAPI
The Applications service provides a REST interface and a set of operations for managing apps in the Akana API Platform. This service includes operations to support complete app lifecycle management, including such activities as creating, modifying, and deleting apps and app versions, managing app teams, and creating, modifying, and deleting the app security mechanism.
POST/appscreateApp
Parameters
Accepts application/vnd.soa.v84+json
Name
Type
Description
Model
body
entity
Application
Application {
ApplicationVersion {
RatingSummary {
AppVersionSettings {
TargetResource {
Image {
entry {
AppSettings {
Connections( long )
Description( string )
ApplicationVersion( ApplicationVersion, required )
AppSettings( AppSettings, required )
ApplicationVersions( Collection of ApplicationVersion, required )
Rating( float )
DefaultVersionID( string )
TeamID( string )
Image( Image, required )
Name( string )
Created( dateTime )
AvatarURL( anyURI )
AppID( string )
RatingSummary( RatingSummary, required )
Updated( dateTime )
PictureID( long )
Followers( long )
TargetResources( Collection of TargetResource, required )
State( string )
Summary( string )
Visibility( string )
Tag( Collection of string )
IsFollowed( boolean )
BusinessID( string )
InitialEnvironment( string )
}
ApplicationVersion {
RatingSummary( RatingSummary, required )
SharedSecret( string )
Description( string )
Updated( dateTime )
HasKeyInfo( boolean )
SecurityMechanisms( Collection of string )
AppVersionSettings( AppVersionSettings, required )
CurrentEnvironment( string )
WebsiteAddress( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource, required )
labels( Collection of entry )
EncryptedSharedSecret( string )
AppID( string )
State( string )
classifiers( Collection of entry )
Visibility( string )
Tag( Collection of string )
RuntimeID( string )
Identity( string )
InitialEnvironment( string )
artifacts( Collection of entry )
}
RatingSummary {
Five( int, required )
Four( int, required )
One( int, required )
Two( int, required )
Three( int, required )
}
AppVersionSettings {
SimultaneousSandboxProductAccessSupport( string )
ReturnPlainTextSharedSecret( string )
AppRatingsSupport( string )
UserDefinedIdentitySupport( string )
AppReviewsSupport( string )
AppBoardSupport( 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 )
}
entry {
value( anyType )
key( string )
}
AppSettings {
SimultaneousSandboxProductAccessSupport( string )
PublicAppRatingsSupport( string )
PrivateAppReviewsSupport( string )
AppPromotionSupport( string )
PublicAppSupport( string )
RegisteredUsersAppRatingsSupport( string )
PrivateAppRatingsSupport( string )
RegisteredUsersAppReviewsSupport( string )
PublicAppBoardSupport( string )
PrivateAppBoardSupport( string )
PrivateAppSupport( string )
ContractPoliciesSupport( string )
PublicAppReviewsSupport( string )
ReturnPlainTextSharedSecret( string )
UserDefinedIdentitySupport( string )
RegisteredUsersAppSupport( string )
}
Reponse
Produces application/jsonapplication/vnd.soa.v84+json
Status Code
Reason
Model
200
Success
Application
Application {
ApplicationVersion {
RatingSummary {
AppVersionSettings {
TargetResource {
Image {
entry {
AppSettings {
Connections( long )
Description( string )
ApplicationVersion( ApplicationVersion )
AppSettings( AppSettings )
ApplicationVersions( Collection of ApplicationVersion )
Rating( float )
DefaultVersionID( string )
TeamID( string )
Image( Image )
Name( string )
Created( dateTime )
AvatarURL( anyURI )
AppID( string )
RatingSummary( RatingSummary )
Updated( dateTime )
PictureID( long )
Followers( long )
TargetResources( Collection of TargetResource )
State( string )
Summary( string )
Visibility( string )
Tag( Collection of string )
IsFollowed( boolean )
BusinessID( string )
InitialEnvironment( string )
}
ApplicationVersion {
RatingSummary( RatingSummary )
SharedSecret( string )
Description( string )
Updated( dateTime )
HasKeyInfo( boolean )
SecurityMechanisms( Collection of string )
AppVersionSettings( AppVersionSettings )
CurrentEnvironment( string )
WebsiteAddress( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource )
labels( Collection of entry )
EncryptedSharedSecret( string )
AppID( string )
State( string )
classifiers( Collection of entry )
Visibility( string )
Tag( Collection of string )
RuntimeID( string )
Identity( string )
InitialEnvironment( string )
artifacts( Collection of entry )
}
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
AppVersionSettings {
SimultaneousSandboxProductAccessSupport( string )
ReturnPlainTextSharedSecret( string )
AppRatingsSupport( string )
UserDefinedIdentitySupport( string )
AppReviewsSupport( string )
AppBoardSupport( 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 )
}
entry {
value( anyType )
key( string )
}
AppSettings {
SimultaneousSandboxProductAccessSupport( string )
PublicAppRatingsSupport( string )
PrivateAppReviewsSupport( string )
AppPromotionSupport( string )
PublicAppSupport( string )
RegisteredUsersAppRatingsSupport( string )
PrivateAppRatingsSupport( string )
RegisteredUsersAppReviewsSupport( string )
PublicAppBoardSupport( string )
PrivateAppBoardSupport( string )
PrivateAppSupport( string )
ContractPoliciesSupport( string )
PublicAppReviewsSupport( string )
ReturnPlainTextSharedSecret( string )
UserDefinedIdentitySupport( string )
RegisteredUsersAppSupport( string )
}
GET/appslistApps
Returns a list of apps. To return only apps related to a business pass in the ID of that business as a query parmaeter. By default apps related to the root business are returned.
Request:
GET /apps?BusinessID=depta.acmepaymentscorp&Federation=false HTTP/1.1
Accept: application/vnd.soa.v83+json
Response:
HTTP/1.1 200 OK
{
"App" : [
{
"AppID" : "565ae475-528b-4d06-b9c3-182424562dad.acmepaymentscorp",
"Name" : "PaaStime",
"Description" : "Android game",
"Created" : "2014-07-18T15:43:09Z",
"Updated" : "2014-07-18T15:44:51Z",
"State" : "com.soa.appp.state.active",
"Visibility" : "Public",
"AvatarURL" : "http://{hostname}/api/apps/565ae475-528b-4d06-b9c3-182424562dad.acmepaymentscorp/avatar"
}
},
{
"AppID" : "565ae475-528b-4d06-b9c3-182424562feb.acmepaymentscorp",
"Name" : "HelloWorld",
"Description" : "Test App",
"Created" : "2014-07-18T15:43:09Z",
"Updated" : "2014-07-18T15:44:51Z",
"State" : "com.soa.appp.state.active",
"Visibility" : "Public",
"AvatarURL" : "http://{hostname}/api/apps/565ae475-528b-4d06-b9c3-182424562feb.acmepaymentscorp/avatar"
}
]
}
Parameters
Accepts */*
Name
Type
Description
Model
BusinessID
query
The unique ID for a specific business organization on the platform. If this parameter is included, only apps relating to the specified organization are returned.
string
Reponse
Produces application/vnd.soa.v83+jsonapplication/vnd.soa.v83+xml
Status Code
Reason
Model
200
Success
AppInfos
AppInfos {
AppInfoType {
Application( Collection of AppInfoType )
}
AppInfoType {
Description( string )
AvatarURL( anyURI )
AppID( string )
Updated( dateTime )
State( string )
Summary( string )
Visibility( string )
Name( string )
Created( dateTime )
}
POST/apps deprecated Please use the createApp operation
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
body
entity
Application
Application {
ApplicationVersion {
RatingSummary {
AppVersionSettings {
TargetResource {
Image {
entry {
AppSettings {
Connections( long )
Description( string )
ApplicationVersion( ApplicationVersion, required )
AppSettings( AppSettings, required )
ApplicationVersions( Collection of ApplicationVersion, required )
Rating( float )
DefaultVersionID( string )
TeamID( string )
Image( Image, required )
Name( string )
Created( dateTime )
AvatarURL( anyURI )
AppID( string )
RatingSummary( RatingSummary, required )
Updated( dateTime )
PictureID( long )
Followers( long )
TargetResources( Collection of TargetResource, required )
State( string )
Summary( string )
Visibility( string )
Tag( Collection of string )
IsFollowed( boolean )
BusinessID( string )
InitialEnvironment( string )
}
ApplicationVersion {
RatingSummary( RatingSummary, required )
SharedSecret( string )
Description( string )
Updated( dateTime )
HasKeyInfo( boolean )
SecurityMechanisms( Collection of string )
AppVersionSettings( AppVersionSettings, required )
CurrentEnvironment( string )
WebsiteAddress( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource, required )
labels( Collection of entry )
EncryptedSharedSecret( string )
AppID( string )
State( string )
classifiers( Collection of entry )
Visibility( string )
Tag( Collection of string )
RuntimeID( string )
Identity( string )
InitialEnvironment( string )
artifacts( Collection of entry )
}
RatingSummary {
Five( int, required )
Four( int, required )
One( int, required )
Two( int, required )
Three( int, required )
}
AppVersionSettings {
SimultaneousSandboxProductAccessSupport( string )
ReturnPlainTextSharedSecret( string )
AppRatingsSupport( string )
UserDefinedIdentitySupport( string )
AppReviewsSupport( string )
AppBoardSupport( 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 )
}
entry {
value( anyType )
key( string )
}
AppSettings {
SimultaneousSandboxProductAccessSupport( string )
PublicAppRatingsSupport( string )
PrivateAppReviewsSupport( string )
AppPromotionSupport( string )
PublicAppSupport( string )
RegisteredUsersAppRatingsSupport( string )
PrivateAppRatingsSupport( string )
RegisteredUsersAppReviewsSupport( string )
PublicAppBoardSupport( string )
PrivateAppBoardSupport( string )
PrivateAppSupport( string )
ContractPoliciesSupport( string )
PublicAppReviewsSupport( string )
ReturnPlainTextSharedSecret( string )
UserDefinedIdentitySupport( string )
RegisteredUsersAppSupport( string )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/apps/versionslistVersions
Parameters
Name
Type
Description
Model
Identity
query
string
Reponse
Produces text/xmlapplication/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v71+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 )
}
DELETE/apps/{AppID}deleteApp
Parameters
Accepts */*
Name
Type
Description
Model
AppID
path
string
Comment
query
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/apps/versionsgetAppVersions
Parameters
Name
Type
Description
Model
Identity
query
string
Reponse
Produces application/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
ApplicationVersions
ApplicationVersions {
ApplicationVersion {
RatingSummary {
AppVersionSettings {
TargetResource {
Image {
entry {
ApplicationVersion( Collection of ApplicationVersion )
}
ApplicationVersion {
RatingSummary( RatingSummary )
SharedSecret( string )
Description( string )
Updated( dateTime )
HasKeyInfo( boolean )
SecurityMechanisms( Collection of string )
AppVersionSettings( AppVersionSettings )
CurrentEnvironment( string )
WebsiteAddress( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource )
labels( Collection of entry )
EncryptedSharedSecret( string )
AppID( string )
State( string )
classifiers( Collection of entry )
Visibility( string )
Tag( Collection of string )
RuntimeID( string )
Identity( string )
InitialEnvironment( string )
artifacts( Collection of entry )
}
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
AppVersionSettings {
SimultaneousSandboxProductAccessSupport( string )
ReturnPlainTextSharedSecret( string )
AppRatingsSupport( string )
UserDefinedIdentitySupport( string )
AppReviewsSupport( string )
AppBoardSupport( 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 )
}
entry {
value( anyType )
key( string )
}
PUT/apps/{AppID}modifyApp
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
AppID
path
string
body
entity
Application
Application {
ApplicationVersion {
RatingSummary {
AppVersionSettings {
TargetResource {
Image {
entry {
AppSettings {
Connections( long )
Description( string )
ApplicationVersion( ApplicationVersion, required )
AppSettings( AppSettings, required )
ApplicationVersions( Collection of ApplicationVersion, required )
Rating( float )
DefaultVersionID( string )
TeamID( string )
Image( Image, required )
Name( string )
Created( dateTime )
AvatarURL( anyURI )
AppID( string )
RatingSummary( RatingSummary, required )
Updated( dateTime )
PictureID( long )
Followers( long )
TargetResources( Collection of TargetResource, required )
State( string )
Summary( string )
Visibility( string )
Tag( Collection of string )
IsFollowed( boolean )
BusinessID( string )
InitialEnvironment( string )
}
ApplicationVersion {
RatingSummary( RatingSummary, required )
SharedSecret( string )
Description( string )
Updated( dateTime )
HasKeyInfo( boolean )
SecurityMechanisms( Collection of string )
AppVersionSettings( AppVersionSettings, required )
CurrentEnvironment( string )
WebsiteAddress( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource, required )
labels( Collection of entry )
EncryptedSharedSecret( string )
AppID( string )
State( string )
classifiers( Collection of entry )
Visibility( string )
Tag( Collection of string )
RuntimeID( string )
Identity( string )
InitialEnvironment( string )
artifacts( Collection of entry )
}
RatingSummary {
Five( int, required )
Four( int, required )
One( int, required )
Two( int, required )
Three( int, required )
}
AppVersionSettings {
SimultaneousSandboxProductAccessSupport( string )
ReturnPlainTextSharedSecret( string )
AppRatingsSupport( string )
UserDefinedIdentitySupport( string )
AppReviewsSupport( string )
AppBoardSupport( 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 )
}
entry {
value( anyType )
key( string )
}
AppSettings {
SimultaneousSandboxProductAccessSupport( string )
PublicAppRatingsSupport( string )
PrivateAppReviewsSupport( string )
AppPromotionSupport( string )
PublicAppSupport( string )
RegisteredUsersAppRatingsSupport( string )
PrivateAppRatingsSupport( string )
RegisteredUsersAppReviewsSupport( string )
PublicAppBoardSupport( string )
PrivateAppBoardSupport( string )
PrivateAppSupport( string )
ContractPoliciesSupport( string )
PublicAppReviewsSupport( string )
ReturnPlainTextSharedSecret( string )
UserDefinedIdentitySupport( string )
RegisteredUsersAppSupport( string )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/apps/{AppID}getApp
Parameters
Accepts */*
Name
Type
Description
Model
AppID
path
string
IncludeSettings
query
boolean
IncludeTags
query
boolean
IncludeIsFollowed
query
boolean
IncludeAvatarURL
query
boolean
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
Application
Application {
ApplicationVersion {
RatingSummary {
AppVersionSettings {
TargetResource {
Image {
entry {
AppSettings {
Connections( long )
Description( string )
ApplicationVersion( ApplicationVersion )
AppSettings( AppSettings )
ApplicationVersions( Collection of ApplicationVersion )
Rating( float )
DefaultVersionID( string )
TeamID( string )
Image( Image )
Name( string )
Created( dateTime )
AvatarURL( anyURI )
AppID( string )
RatingSummary( RatingSummary )
Updated( dateTime )
PictureID( long )
Followers( long )
TargetResources( Collection of TargetResource )
State( string )
Summary( string )
Visibility( string )
Tag( Collection of string )
IsFollowed( boolean )
BusinessID( string )
InitialEnvironment( string )
}
ApplicationVersion {
RatingSummary( RatingSummary )
SharedSecret( string )
Description( string )
Updated( dateTime )
HasKeyInfo( boolean )
SecurityMechanisms( Collection of string )
AppVersionSettings( AppVersionSettings )
CurrentEnvironment( string )
WebsiteAddress( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource )
labels( Collection of entry )
EncryptedSharedSecret( string )
AppID( string )
State( string )
classifiers( Collection of entry )
Visibility( string )
Tag( Collection of string )
RuntimeID( string )
Identity( string )
InitialEnvironment( string )
artifacts( Collection of entry )
}
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
AppVersionSettings {
SimultaneousSandboxProductAccessSupport( string )
ReturnPlainTextSharedSecret( string )
AppRatingsSupport( string )
UserDefinedIdentitySupport( string )
AppReviewsSupport( string )
AppBoardSupport( 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 )
}
entry {
value( anyType )
key( string )
}
AppSettings {
SimultaneousSandboxProductAccessSupport( string )
PublicAppRatingsSupport( string )
PrivateAppReviewsSupport( string )
AppPromotionSupport( string )
PublicAppSupport( string )
RegisteredUsersAppRatingsSupport( string )
PrivateAppRatingsSupport( string )
RegisteredUsersAppReviewsSupport( string )
PublicAppBoardSupport( string )
PrivateAppBoardSupport( string )
PrivateAppSupport( string )
ContractPoliciesSupport( string )
PublicAppReviewsSupport( string )
ReturnPlainTextSharedSecret( string )
UserDefinedIdentitySupport( string )
RegisteredUsersAppSupport( string )
}
GET/apps/{AppID}/versionsgetVersions
Parameters
Accepts */*
Name
Type
Description
Model
AppID
path
string
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 )
}
GET/apps/{AppID}/boardgetBoard
Parameters
Accepts */*
Name
Type
Description
Model
AppID
path
string
ItemType
query
string
DiscussionType
query
string
APIID
query
string
TicketLabel
query
string
TicketState
query
string
ItemID
query
string
Tag
query
string
IncludeComments
query
boolean
NumberOfComments
query
integer
IncludeActions
query
boolean
IncludeCommentActions
query
boolean
start
query
integer
count
query
integer
SortBy
query
string
RetrievingUserID
query
string
IncludeSelfAuthored
query
boolean
PublishedState
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
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/apps/{AppID}/versionsaddVersion
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
AppID
path
string
body
entity
ApplicationVersion
ApplicationVersion {
RatingSummary {
AppVersionSettings {
TargetResource {
Image {
entry {
RatingSummary( RatingSummary, required )
SharedSecret( string )
Description( string )
Updated( dateTime )
HasKeyInfo( boolean )
SecurityMechanisms( Collection of string )
AppVersionSettings( AppVersionSettings, required )
CurrentEnvironment( string )
WebsiteAddress( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource, required )
labels( Collection of entry )
EncryptedSharedSecret( string )
AppID( string )
State( string )
classifiers( Collection of entry )
Visibility( string )
Tag( Collection of string )
RuntimeID( string )
Identity( string )
InitialEnvironment( string )
artifacts( Collection of entry )
}
RatingSummary {
Five( int, required )
Four( int, required )
One( int, required )
Two( int, required )
Three( int, required )
}
AppVersionSettings {
SimultaneousSandboxProductAccessSupport( string )
ReturnPlainTextSharedSecret( string )
AppRatingsSupport( string )
UserDefinedIdentitySupport( string )
AppReviewsSupport( string )
AppBoardSupport( 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 )
}
entry {
value( anyType )
key( string )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/apps/{AppID}/membersgetTeamMembers
Parameters
Accepts */*
Name
Type
Description
Model
AppID
path
string
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/apps/{AppID}/membersaddMemberToTeam
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
AppID
path
string
body
entity
MembershipRequest
MembershipRequest {
Role( string )
Email( string )
Message( string )
MembershipRequestID( string )
UserID( string )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
PUT/apps/versions/{RuntimeID}modifyVersion
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
RuntimeID
path
string
body
entity
ApplicationVersion
ApplicationVersion {
RatingSummary {
AppVersionSettings {
TargetResource {
Image {
entry {
RatingSummary( RatingSummary, required )
SharedSecret( string )
Description( string )
Updated( dateTime )
HasKeyInfo( boolean )
SecurityMechanisms( Collection of string )
AppVersionSettings( AppVersionSettings, required )
CurrentEnvironment( string )
WebsiteAddress( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource, required )
labels( Collection of entry )
EncryptedSharedSecret( string )
AppID( string )
State( string )
classifiers( Collection of entry )
Visibility( string )
Tag( Collection of string )
RuntimeID( string )
Identity( string )
InitialEnvironment( string )
artifacts( Collection of entry )
}
RatingSummary {
Five( int, required )
Four( int, required )
One( int, required )
Two( int, required )
Three( int, required )
}
AppVersionSettings {
SimultaneousSandboxProductAccessSupport( string )
ReturnPlainTextSharedSecret( string )
AppRatingsSupport( string )
UserDefinedIdentitySupport( string )
AppReviewsSupport( string )
AppBoardSupport( 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 )
}
entry {
value( anyType )
key( string )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
DELETE/apps/versions/{RuntimeID}deleteAppVersionString
Parameters
Name
Type
Description
Model
RuntimeID
path
string
Comment
query
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
DELETE/apps/versions/{RuntimeID}deleteAppVersion
Parameters
Name
Type
Description
Model
RuntimeID
path
string
Comment
query
string
Reponse
Produces application/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+json
Status Code
Reason
Model
200
Success
ApplicationVersion
ApplicationVersion {
RatingSummary {
AppVersionSettings {
TargetResource {
Image {
entry {
RatingSummary( RatingSummary )
SharedSecret( string )
Description( string )
Updated( dateTime )
HasKeyInfo( boolean )
SecurityMechanisms( Collection of string )
AppVersionSettings( AppVersionSettings )
CurrentEnvironment( string )
WebsiteAddress( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource )
labels( Collection of entry )
EncryptedSharedSecret( string )
AppID( string )
State( string )
classifiers( Collection of entry )
Visibility( string )
Tag( Collection of string )
RuntimeID( string )
Identity( string )
InitialEnvironment( string )
artifacts( Collection of entry )
}
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
AppVersionSettings {
SimultaneousSandboxProductAccessSupport( string )
ReturnPlainTextSharedSecret( string )
AppRatingsSupport( string )
UserDefinedIdentitySupport( string )
AppReviewsSupport( string )
AppBoardSupport( 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 )
}
entry {
value( anyType )
key( string )
}
GET/apps/{AppID}/settingsgetAppSettings
Parameters
Name
Type
Description
Model
AppID
path
string
Reponse
Produces application/jsonapplication/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
AppSettings
AppSettings {
SimultaneousSandboxProductAccessSupport( string )
PublicAppRatingsSupport( string )
PrivateAppReviewsSupport( string )
AppPromotionSupport( string )
PublicAppSupport( string )
RegisteredUsersAppRatingsSupport( string )
PrivateAppRatingsSupport( string )
RegisteredUsersAppReviewsSupport( string )
PublicAppBoardSupport( string )
PrivateAppBoardSupport( string )
PrivateAppSupport( string )
ContractPoliciesSupport( string )
PublicAppReviewsSupport( string )
ReturnPlainTextSharedSecret( string )
UserDefinedIdentitySupport( string )
RegisteredUsersAppSupport( string )
}
GET/apps/{AppID}/packageexportApp
Parameters
Name
Type
Description
Model
AppID
path
string
Reponse
Produces application/jsonapplication/octet-streamapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
any
GET/apps/{APPID}/followersgetFollowers
Parameters
Accepts */*
Name
Type
Description
Model
APPID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
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/apps/versions/{RuntimeID}getVersion
Parameters
Accepts */*
Name
Type
Description
Model
RuntimeID
path
string
IncludeSettings
query
boolean
IncludeTags
query
boolean
IncludeSecurityMechanism
query
boolean
IdentityAppDeploymentState
query
boolean
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
ApplicationVersion
ApplicationVersion {
RatingSummary {
AppVersionSettings {
TargetResource {
Image {
entry {
RatingSummary( RatingSummary )
SharedSecret( string )
Description( string )
Updated( dateTime )
HasKeyInfo( boolean )
SecurityMechanisms( Collection of string )
AppVersionSettings( AppVersionSettings )
CurrentEnvironment( string )
WebsiteAddress( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource )
labels( Collection of entry )
EncryptedSharedSecret( string )
AppID( string )
State( string )
classifiers( Collection of entry )
Visibility( string )
Tag( Collection of string )
RuntimeID( string )
Identity( string )
InitialEnvironment( string )
artifacts( Collection of entry )
}
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
AppVersionSettings {
SimultaneousSandboxProductAccessSupport( string )
ReturnPlainTextSharedSecret( string )
AppRatingsSupport( string )
UserDefinedIdentitySupport( string )
AppReviewsSupport( string )
AppBoardSupport( 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 )
}
entry {
value( anyType )
key( string )
}
GET/apps/{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/apps/{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/apps/{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/apps/{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/apps/{ID}/picturedeleteImage
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
POST/apps/versions/{AppVersionID}/switch_to_productionswitchToProduction
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
AppVersionID
path
string
Comment
form
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
POST/apps/versions/{AppVersionID}/statechangeState
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
AppVersionID
path
string
body
entity
ChangeStateRequest
ChangeStateRequest {
State( string, required )
Comments( string, required )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/apps/versions/{AppVersionID}/metricsgetMetrics
Parameters
Accepts */*
Name
Type
Description
Model
AppVersionID
path
string
ReportType
query
string
ContractID
query
string
ApiVersionID
query
string
OperationName
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
ShowIntervalData
query
boolean
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
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 )
}
GET/apps/versions/{RuntimeID}/settingsgetVersionSettings
Parameters
Name
Type
Description
Model
RuntimeID
path
string
Reponse
Produces application/jsonapplication/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
AppVersionSettings
AppVersionSettings {
SimultaneousSandboxProductAccessSupport( string )
ReturnPlainTextSharedSecret( string )
AppRatingsSupport( string )
UserDefinedIdentitySupport( string )
AppReviewsSupport( string )
AppBoardSupport( string )
}
GET/apps/versions/{RuntimeID}/boardgetVersionBoard
Parameters
Accepts */*
Name
Type
Description
Model
RuntimeID
path
string
ItemType
query
string
DiscussionType
query
string
APIID
query
string
TicketLabel
query
string
TicketState
query
string
ItemID
query
string
Tag
query
string
IncludeComments
query
boolean
NumberOfComments
query
integer
IncludeActions
query
boolean
IncludeCommentActions
query
boolean
start
query
integer
count
query
integer
SortBy
query
string
RetrievingUserID
query
string
IncludeSelfAuthored
query
boolean
PublishedState
query
string
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 )
}
PUT/apps/versions/{AppVersionID}/extensionsmodifyExtensionProperties
Parameters
Accepts application/json application/vnd.soa.v83+json
Name
Type
Description
Model
AppVersionID
path
The unique ID of an app version.
string
body
entity
LMExtensionProperties
LMExtensionProperties {
entry {
classifiers( Collection of entry )
Name( string )
artifacts( Collection of entry )
}
entry {
value( anyType )
key( string )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
POST/apps/versions/{RuntimeID}/actionexecuteWorkflowAction
Parameters
Accepts 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
RuntimeID
path
string
body
entity
Action
Action {
ActionParameter {
ActionName( string, required )
Parameters( Collection of ActionParameter, required )
UserID( string, required )
Comments( string )
}
ActionParameter {
Value( string )
Name( string, required )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
DELETE/apps/{AppID}/members/{UserID}removeMemberFromTeam
Parameters
Accepts */*
Name
Type
Description
Model
AppID
path
string
UserID
path
string
Comment
query
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/apps/versions/{RuntimeID}/keyinfogetKeyInfo
Parameters
Accepts */*
Name
Type
Description
Model
RuntimeID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
ApplicationKeyInfo
ApplicationKeyInfo {
CSR( base64Binary )
Key( base64Binary )
}
DELETE/apps/versions/{RuntimeID}/keyinforemoveKeyInfo
Parameters
Accepts */*
Name
Type
Description
Model
RuntimeID
path
string
Comments
query
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
POST/apps/versions/{RuntimeID}/keyinfosaveKeyInfo
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
RuntimeID
path
string
body
entity
base64Binary
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
PUT/apps/versions/{AppVersionDN}/secretregenerateSharedSecret
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
AppVersionDN
path
string
Comments
form
string
SharedSecret
form
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
PUT/apps/versions/{AppVersionDN}/securitymechanismsmodifyAppSecurity
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
AppVersionDN
path
string
body
entity
ModifyAppSecurityRequest
ModifyAppSecurityRequest {
ActionName( string, required )
SecurityMechanismSelected( string, required )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/apps/versions/{AppVersionID}/contractsgetContracts
Parameters
Accepts */*
Name
Type
Description
Model
AppVersionID
path
string
Environment
query
string
ActivatedOnly
query
boolean
IncludeActions
query
boolean
IncludeAPIEndpoints
query
boolean
Reponse
Produces text/xmlapplication/json
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/apps/versions/{AppVersionDN}/secretgetSharedSecret
Parameters
Accepts */*
Name
Type
Description
Model
AppVersionDN
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
SharedSecret
SharedSecret {
EncryptedSharedSecret( string )
Assigned( boolean )
SharedSecret( string )
}
GET/apps/versions/{RuntimeID}/certificategetAppCertificate
Parameters
Accepts */*
Name
Type
Description
Model
RuntimeID
path
string
Reponse
Produces application/octet-stream
Status Code
Reason
Model
200
Success
byte
GET/apps/versions/{RuntimeID}/oauthclientgetAppOAuthClientProperties
Parameters
Name
Type
Description
Model
RuntimeID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+json
Status Code
Reason
Model
200
Success
OAuthClient
OAuthClient {
request_object_encryption_alg( string )
default_max_age( int )
logo_uri( anyURI )
userinfo_encrypted_response_enc( string )
access_token_expiry( long )
RedirectURI( Collection of string )
enforceReplayPrevention( boolean )
restrictedResponseTypes( Collection of string )
bypass_authorization( boolean )
request_uris( Collection of string )
id_token_signed_response_alg( string )
access_token_expiry_setting( string )
post_logout_redirect_uris( Collection of string )
Updated( dateTime )
LogoPictureID( long )
LegalDisclaimer( string )
sector_identifier_uri( string )
id_token_encrypted_response_alg( string )
token_endpoint_auth_method_supported_setting( string )
tos_uri( string )
request_object_signing_alg( string )
grant_expiration_hours( int )
restrictedScopes( Collection of string )
response_types( Collection of string )
token_endpoint_auth_signing_alg( string )
Description( string )
client_uri( string )
jwks( string )
application_type( string )
default_acr_values( Collection of string )
initiate_login_uri( string )
require_authtime_claim( boolean )
requireSignedRequests( boolean )
OAuthClientType( string )
userinfo_encrypted_response_alg( string )
token_type( string )
userinfo_signed_response_alg( string )
token_endpoint_auth_method( string )
grant_expiration_setting( string )
Created( dateTime )
LogoAssigned( boolean )
request_object_encryption_enc( string )
SubTitle( string )
policy_uri( string )
AppURI( anyURI )
grant_types( Collection of string )
subject_type( string )
Title( string )
includeResourceOwnerUserInfoOption( string )
supports_openid_connect( boolean )
grant_types_setting( string )
id_token_encrypted_response_enc( string )
jwks_uri( string )
token_endpoint_auth_methods( Collection of string )
RuntimeID( string )
OAuthClientID( string )
contacts( Collection of string )
}
GET/apps/versions/{RuntimeID}/validationreportvalidateOAuthClient
Parameters
Name
Type
Description
Model
RuntimeID
path
string
RedirectURI
query
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
OAuthClientValidationResponse
OAuthClientValidationResponse {
OAuthClient {
OAuthClient( OAuthClient )
RedirectURIMatched( boolean )
}
OAuthClient {
request_object_encryption_alg( string )
default_max_age( int )
logo_uri( anyURI )
userinfo_encrypted_response_enc( string )
access_token_expiry( long )
RedirectURI( Collection of string )
enforceReplayPrevention( boolean )
restrictedResponseTypes( Collection of string )
bypass_authorization( boolean )
request_uris( Collection of string )
id_token_signed_response_alg( string )
access_token_expiry_setting( string )
post_logout_redirect_uris( Collection of string )
Updated( dateTime )
LogoPictureID( long )
LegalDisclaimer( string )
sector_identifier_uri( string )
id_token_encrypted_response_alg( string )
token_endpoint_auth_method_supported_setting( string )
tos_uri( string )
request_object_signing_alg( string )
grant_expiration_hours( int )
restrictedScopes( Collection of string )
response_types( Collection of string )
token_endpoint_auth_signing_alg( string )
Description( string )
client_uri( string )
jwks( string )
application_type( string )
default_acr_values( Collection of string )
initiate_login_uri( string )
require_authtime_claim( boolean )
requireSignedRequests( boolean )
OAuthClientType( string )
userinfo_encrypted_response_alg( string )
token_type( string )
userinfo_signed_response_alg( string )
token_endpoint_auth_method( string )
grant_expiration_setting( string )
Created( dateTime )
LogoAssigned( boolean )
request_object_encryption_enc( string )
SubTitle( string )
policy_uri( string )
AppURI( anyURI )
grant_types( Collection of string )
subject_type( string )
Title( string )
includeResourceOwnerUserInfoOption( string )
supports_openid_connect( boolean )
grant_types_setting( string )
id_token_encrypted_response_enc( string )
jwks_uri( string )
token_endpoint_auth_methods( Collection of string )
RuntimeID( string )
OAuthClientID( string )
contacts( Collection of string )
}
PUT/apps/versions/{RuntimeID}/oauthclientsaveAppOAuthClientProperties
Parameters
Accepts application/json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
RuntimeID
path
string
body
entity
OAuthClient
OAuthClient {
request_object_encryption_alg( string )
default_max_age( int )
logo_uri( anyURI )
userinfo_encrypted_response_enc( string )
access_token_expiry( long )
RedirectURI( Collection of string )
enforceReplayPrevention( boolean )
restrictedResponseTypes( Collection of string )
bypass_authorization( boolean )
request_uris( Collection of string )
id_token_signed_response_alg( string )
access_token_expiry_setting( string )
post_logout_redirect_uris( Collection of string )
Updated( dateTime )
LogoPictureID( long )
LegalDisclaimer( string )
sector_identifier_uri( string )
id_token_encrypted_response_alg( string )
token_endpoint_auth_method_supported_setting( string )
tos_uri( string )
request_object_signing_alg( string )
grant_expiration_hours( int )
restrictedScopes( Collection of string )
response_types( Collection of string )
token_endpoint_auth_signing_alg( string )
Description( string )
client_uri( string )
jwks( string )
application_type( string )
default_acr_values( Collection of string )
initiate_login_uri( string )
require_authtime_claim( boolean )
requireSignedRequests( boolean )
OAuthClientType( string )
userinfo_encrypted_response_alg( string )
token_type( string )
userinfo_signed_response_alg( string )
token_endpoint_auth_method( string )
grant_expiration_setting( string )
Created( dateTime )
LogoAssigned( boolean )
request_object_encryption_enc( string )
SubTitle( string )
policy_uri( string )
AppURI( anyURI )
grant_types( Collection of string )
subject_type( string )
Title( string )
includeResourceOwnerUserInfoOption( string )
supports_openid_connect( boolean )
grant_types_setting( string )
id_token_encrypted_response_enc( string )
jwks_uri( string )
token_endpoint_auth_methods( Collection of string )
RuntimeID( string )
OAuthClientID( string )
contacts( Collection of string )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/apps/versions/{RuntimeID}/sandboxesgetSandboxSites
Parameters
Accepts */*
Name
Type
Description
Model
RuntimeID
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+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
ApplicationSandboxSites
ApplicationSandboxSites {
SandboxSite {
SandboxSite( Collection of SandboxSite )
}
SandboxSite {
Address( anyURI )
EncryptionKey( base64Binary )
Name( string )
}
GET/apps/versions/{RuntimeID}/apilegalsgetApiLegals
Parameters
Name
Type
Description
Model
RuntimeID
path
string
ApiVersionDN
query
string
State
query
string
Federation
query
boolean
Reponse
Produces application/json
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/apps/versions/{RuntimeID}/publicprofilegetAppPublicProfile
Parameters
Accepts */*
Name
Type
Description
Model
RuntimeID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
AppPublicProfile
AppPublicProfile {
AppURI( anyURI )
Description( string )
LogoAssigned( boolean )
Updated( dateTime )
LogoURL( anyURI )
Title( string )
LogoPictureID( long )
LegalDisclaimer( string )
RuntimeID( string )
SubTitle( string )
Created( dateTime )
}
PUT/apps/versions/{RuntimeID}/publicprofilesaveAppPublicProfile
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
RuntimeID
path
string
body
entity
AppPublicProfile
AppPublicProfile {
AppURI( anyURI )
Description( string )
LogoAssigned( boolean )
Updated( dateTime )
LogoURL( anyURI )
Title( string )
LogoPictureID( long )
LegalDisclaimer( string )
RuntimeID( string )
SubTitle( string )
Created( dateTime )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/apps/versions/{RuntimeID}/governingworkflowgetAppVersionGoverningWorkflow
Parameters
Name
Type
Description
Model
RuntimeID
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
GoverningWorkflow
GoverningWorkflow {
Description( string )
Updated( dateTime )
Governed( boolean )
State( string )
Key( string )
Name( string )
}
PUT/apps/versions/{RuntimeID}/governingworkflowmodifyAppVersionGoverningWorkflow
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
RuntimeID
path
string
body
entity
GoverningWorkflowChangeRequest
GoverningWorkflowChangeRequest {
TargetState( string )
Governed( boolean, required )
TargetWorkflowDefinitionKey( string )
TargetStatePolicy( 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
GoverningWorkflow
GoverningWorkflow {
Description( string )
Updated( dateTime )
Governed( boolean )
State( string )
Key( string )
Name( string )
}
GET/apps/versions/{RuntimeID}/clientTypegetAppOAuthClientType
Parameters
Name
Type
Description
Model
RuntimeID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+json
Status Code
Reason
Model
200
Success
string
GET/apps/versions/{AppVersionID}/packageexportAppVersion
Parameters
Name
Type
Description
Model
AppVersionID
path
string
Reponse
Produces application/jsonapplication/octet-streamapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
any
GET/apps/versions/{AppVersionID}/licensereportgetLicenseReport
Parameters
Name
Type
Description
Model
AppVersionID
path
string
LicenseID
query
string
ApiVersionID
query
string
MetricName
query
string
ReportType
query
string
Environment
query
string
StartDate
query
string
EndDate
query
string
TimeZone
query
string
Duration
query
string
Reponse
Produces application/jsonapplication/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
Report
Report {
ReferencedObjects {
ApplicationVersion {
RatingSummary {
AppVersionSettings {
TargetResource {
Image {
entry {
Policy {
APIVersion {
APIVersionResourceDetails {
Resource {
OperationResourceDetails {
EndpointOAuthDetails {
OAuthTokenResourceURISettings {
OAuth20Settings {
OAuth10aSettings {
APIImplementation {
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
APIBinding {
BindingOperation {
HttpOperation {
Input {
ServiceReference {
Endpoint {
ConnectionProperty {
APIInterface {
InterfaceOperation {
OperationOAuthDetails {
Operation {
APIDesign {
Descriptor {
Links {
TargetAPI {
APIVersionSettings {
License {
LicensePart {
AgreementDocument {
API {
APISettings {
Application {
AppSettings {
Contract {
ContractScope {
Scope {
ReportData {
Partition {
ReferencedObjects( ReferencedObjects )
ReportData( Collection of ReportData )
}
ReferencedObjects {
ApplicationVersion( Collection of ApplicationVersion )
Policies( Collection of Policy )
APIVersion( Collection of APIVersion )
License( Collection of License )
API( Collection of API )
Application( Collection of Application )
Contract( Collection of Contract )
}
ApplicationVersion {
RatingSummary( RatingSummary )
SharedSecret( string )
Description( string )
Updated( dateTime )
HasKeyInfo( boolean )
SecurityMechanisms( Collection of string )
AppVersionSettings( AppVersionSettings )
CurrentEnvironment( string )
WebsiteAddress( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource )
labels( Collection of entry )
EncryptedSharedSecret( string )
AppID( string )
State( string )
classifiers( Collection of entry )
Visibility( string )
Tag( Collection of string )
RuntimeID( string )
Identity( string )
InitialEnvironment( string )
artifacts( Collection of entry )
}
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
AppVersionSettings {
SimultaneousSandboxProductAccessSupport( string )
ReturnPlainTextSharedSecret( string )
AppRatingsSupport( string )
UserDefinedIdentitySupport( string )
AppReviewsSupport( string )
AppBoardSupport( 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 )
}
entry {
value( anyType )
key( string )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( string )
Name( string )
}
APIVersion {
DefaultProfile( string )
APIVersionResourceDetails( APIVersionResourceDetails )
Description( string )
SandboxEndpointOAuthDetailsList( Collection of EndpointOAuthDetails )
ProductionEndpointAccessAutoApproved( boolean )
ProductionEndpointExists( boolean )
SandboxEndpointAccessAutoApproved( boolean )
APIImplementations( Collection of APIImplementation )
APIVersionID( string )
Name( string )
Created( dateTime )
Endpoints( Collection of Endpoint )
SandboxAnonymousAccessAllowed( boolean )
SandboxEndpointExists( boolean )
ProductionAnonymousAccessAllowed( boolean )
SandboxServiceKey( string )
classifiers( Collection of entry )
Operations( Collection of Operation )
APIVersionOAuthResourceMapping( Collection of string )
artifacts( Collection of entry )
ProductionEndpointOAuthDetails( EndpointOAuthDetails )
ProductionEndpointOAuthDetailsList( Collection of EndpointOAuthDetails )
RatingSummary( RatingSummary )
DefaultFaultContentType( string )
SandboxEndpoint( anyURI )
Updated( dateTime )
ResourceLevelPermissionsSupported( boolean )
ProductionEndpoint( anyURI )
APIDesign( APIDesign )
APIID( string )
TargetResources( Collection of TargetResource )
labels( Collection of entry )
SandboxEndpointOAuthDetails( EndpointOAuthDetails )
Type( string )
APIOwnedImplementations( boolean )
State( string )
Environment( string )
Descriptor( Descriptor )
Links( Collection of Links )
Visibility( string )
Tag( Collection of string )
ProductionServiceKey( string )
DefaultInputContentType( string )
TargetAPI( TargetAPI )
DefaultOutputContentType( string )
APIVersionSettings( APIVersionSettings )
}
APIVersionResourceDetails {
Resource( Collection of Resource )
SupportsLicenses( boolean )
OperationResourceDetails( Collection of OperationResourceDetails )
}
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 )
}
OperationResourceDetails {
OperationName( string )
Resource( Collection of Resource )
OperationKey( string )
}
EndpointOAuthDetails {
OAuthTokenResourceURISettings( OAuthTokenResourceURISettings )
OAuth20Settings( OAuth20Settings )
OAuth10aSupported( boolean )
Resource( Collection of string )
TokenEndpointParameters( Collection of string )
ClientAuthPolicyOption( Collection of string )
OAuth10aSettings( OAuth10aSettings )
AuthorizationEndpointParameters( Collection of string )
OAuthProvider( string )
PlatformAppIdentitiesInUse( boolean )
SupportedGrant( Collection of string )
OAuth20Supported( boolean )
}
OAuthTokenResourceURISettings {
OAuthTokenRequestURI( string )
OAuthTokenResourceURIOption( string )
}
OAuth20Settings {
TokenEndpointURL( anyURI )
TokenEndpointRequestVerb( string )
BearerTokenMethods( Collection of string )
AuthorizationEndpointURL( anyURI )
}
OAuth10aSettings {
TokenEndpointRequestVerb( string )
AuthorizationEndpointURL( anyURI )
AccessTokenEndpointURL( anyURI )
TokenParameterTransmissionMethods( Collection of string )
RequestTokenEndpointURL( anyURI )
}
APIImplementation {
Pattern( string )
APIImplementationDeployments( Collection of DeploymentZonesHostingInfo )
Description( string )
APIBindings( Collection of APIBinding )
Policies( Collection of Policy )
ImplementationCode( string )
EndpointOAuthDetailsList( Collection of EndpointOAuthDetails )
ServiceKey( string )
ProxiedService( ServiceReference )
EndpointOAuthDetails( EndpointOAuthDetails )
Name( string )
AccessPoints( Collection of string )
Endpoints( Collection of Endpoint )
ServiceDetails( ServiceReference )
Environment( string )
AnonymousAccessAllowed( boolean )
APIOwnedImplementation( boolean )
APIInterfaces( Collection of APIInterface )
Operations( Collection of Operation )
EndpointAccessAutoApproved( boolean )
}
DeploymentZonesHostingInfo {
DeploymentZoneID( string )
DeploymentZoneEndpoint( Collection of DeploymentZoneEndpoint )
}
DeploymentZoneEndpoint {
Path( string )
EndpointHostName( string )
Public( boolean )
ListenerName( string )
ContainerKey( string )
Url( string )
EndpointPath( string )
UseServiceIdentityForSNI( boolean )
GatewayHostPath( string )
DeploymentZoneID( string )
GatewayHostName( string )
BindingType( string )
EndpointKey( string )
Protocol( string )
BindingQName( string )
}
APIBinding {
BindingOperations( Collection of BindingOperation )
BindingKey( string )
BindingType( string )
InterfaceKey( string )
BindingQName( string )
InterfaceQName( string )
}
BindingOperation {
SOAPAction( string )
WsdlOperationName( string )
OperationName( string )
HttpOperation( HttpOperation )
BindingOperationKey( string )
}
HttpOperation {
Path( string )
OutputContentType( string )
FaultContentType( string )
Input( Collection of Input )
InputContentType( string )
Method( string )
}
Input {
Type( string )
Value( string )
Name( string )
}
ServiceReference {
Endpoints( Collection of Endpoint )
ServiceName( string )
ServiceType( string )
ServiceKey( string )
ServiceManagementState( string )
OrganizationKey( string )
}
Endpoint {
BindingType( string )
ConnectionProperties( Collection of ConnectionProperty )
EndpointKey( string )
Uri( anyURI )
BindingQName( string )
}
ConnectionProperty {
Value( string )
Name( string )
}
APIInterface {
InterfaceOperations( Collection of InterfaceOperation )
InterfaceKey( string )
InterfaceQName( string )
}
InterfaceOperation {
WsdlOperationName( string )
OperationName( string )
OAuthDetails( OperationOAuthDetails )
}
OperationOAuthDetails {
WsdlOperationName( string )
OperationName( string )
Resource( Collection of string )
OperationKey( string )
InterfaceQName( string )
}
Operation {
Path( string )
OutputContentType( string )
FaultContentType( string )
WsdlOperationName( string )
Input( Collection of Input )
InputContentType( string )
OAuthDetails( OperationOAuthDetails )
Method( string )
OperationKey( string )
OperationResourceDetails( OperationResourceDetails )
Name( string )
InterfaceQName( string )
}
APIDesign {
BindingType( Collection of string )
CommonDesign( boolean )
DesignServiceKey( string )
}
Descriptor {
WsdlURL( string )
WsdlId( long )
}
Links {
rel( string )
href( string )
type( string )
title( string )
}
TargetAPI {
DefaultProfile( string )
APIBindings( Collection of APIBinding )
DefaultFaultContentType( string )
Endpoints( Collection of Endpoint )
SandboxEndpointOAuthDetails( EndpointOAuthDetails )
Type( string )
SandboxServiceKey( string )
Descriptor( Descriptor )
ProductionServiceKey( string )
DefaultInputContentType( string )
Operations( Collection of Operation )
APIInterfaces( Collection of APIInterface )
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 )
}
License {
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 )
}
API {
RatingSummary( RatingSummary )
Description( string )
Updated( dateTime )
PictureID( long )
APIID( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource )
OrganizationKey( string )
AvatarURL( anyURI )
LatestVersionID( string )
APIVersion( APIVersion )
AdminGroupID( string )
State( string )
APISettings( APISettings )
Summary( string )
Visibility( string )
Tag( Collection of string )
IsFollowed( boolean )
InUserTop( boolean )
BusinessID( 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 )
}
Application {
Connections( long )
Description( string )
ApplicationVersion( ApplicationVersion )
AppSettings( AppSettings )
ApplicationVersions( Collection of ApplicationVersion )
Rating( float )
DefaultVersionID( string )
TeamID( string )
Image( Image )
Name( string )
Created( dateTime )
AvatarURL( anyURI )
AppID( string )
RatingSummary( RatingSummary )
Updated( dateTime )
PictureID( long )
Followers( long )
TargetResources( Collection of TargetResource )
State( string )
Summary( string )
Visibility( string )
Tag( Collection of string )
IsFollowed( boolean )
BusinessID( string )
InitialEnvironment( string )
}
AppSettings {
SimultaneousSandboxProductAccessSupport( string )
PublicAppRatingsSupport( string )
PrivateAppReviewsSupport( string )
AppPromotionSupport( string )
PublicAppSupport( string )
RegisteredUsersAppRatingsSupport( string )
PrivateAppRatingsSupport( string )
RegisteredUsersAppReviewsSupport( string )
PublicAppBoardSupport( string )
PrivateAppBoardSupport( string )
PrivateAppSupport( string )
ContractPoliciesSupport( string )
PublicAppReviewsSupport( string )
ReturnPlainTextSharedSecret( string )
UserDefinedIdentitySupport( string )
RegisteredUsersAppSupport( string )
}
Contract {
Status( string )
Description( string )
Policies( Collection of Policy )
Updated( dateTime )
ContractScope( ContractScope )
PlanID( string )
ContractID( string )
APIVersionID( string )
Name( string )
TargetResources( Collection of TargetResource )
Endpoints( Collection of Endpoint )
Endpoint( string )
Scope( Scope )
State( string )
Environment( string )
RuntimeID( string )
UpdatedInMillis( long )
}
ContractScope {
Restricted( boolean )
LicenseID( string )
}
Scope {
Restricted( boolean )
LicenseID( Collection of string )
}
ReportData {
ScopeType( anyType )
IntervalDuration( string )
PartitionIDs( Collection of string )
Partitions( Collection of Partition )
Scope( Scope )
StartTime( dateTime )
PartitionType( string )
}
Partition {
Value( Collection of float )
Unit( string )
Name( string )
}
GET/apps/versions/{AppVersionID}/txlogsgetTxLogs
Parameters
Accepts */*
Name
Type
Description
Model
AppVersionID
path
string
ContractID
query
string
ApiVersionID
query
string
OperationName
query
string
Environment
query
string
Status
query
string
FromResponseTime
query
integer
ToResponseTime
query
integer
StartDate
query
string
EndDate
query
string
TimeZone
query
string
Duration
query
string
start
query
integer
count
query
integer
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
TransactionsInfo
TransactionsInfo {
TransactionInfo {
TransactionInfo( Collection of TransactionInfo )
}
TransactionInfo {
ResponseMessageSize( unsignedLong )
APIName( string )
AppRuntimeID( string )
APIVersionName( string )
HttpVerb( string )
APIVersionID( string )
TransactionID( string )
AppName( string )
GatewayRespProcessingTime( duration )
AppID( string )
RequestDateTime( dateTime )
ResponseStatusCode( unsignedInt )
AppVersionName( string )
GatewayReqProcessingTime( duration )
ResponseTime( duration )
RequestMessageSize( unsignedLong )
MethodName( string )
MethodKey( string )
APIURL( string )
ResponseErrorMessage( string )
GatewayTime( duration )
APIID( string )
AppVersionID( string )
ClientHost( string )
GatewayRespWriteTime( duration )
GatewayReqReadTime( duration )
APIResponseTime( duration )
}
GET/apps/versions/{AppVersionID}/contractslistContracts
Parameters
Accepts */*
Name
Type
Description
Model
AppVersionID
path
string
Environment
query
string
ActivatedOnly
query
boolean
IncludeAPIEndpoints
query
boolean
Reponse
Produces application/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
Contracts
Contracts {
Contract {
Policy {
ContractScope {
TargetResource {
Image {
Endpoint {
EndpointImplementationDetails {
GTMEndpoint {
DeploymentZoneEndpoint {
ConnectionProperty {
Scope {
Contract( Collection of Contract )
}
Contract {
Status( string )
Description( string )
Policies( Collection of Policy )
Updated( dateTime )
ContractScope( ContractScope )
PlanID( string )
ContractID( string )
APIVersionID( string )
Name( string )
TargetResources( Collection of TargetResource )
Endpoints( Collection of Endpoint )
Endpoint( string )
Scope( Scope )
State( string )
Environment( string )
RuntimeID( string )
UpdatedInMillis( long )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( string )
Name( string )
}
ContractScope {
Restricted( boolean )
LicenseID( 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 )
}
Endpoint {
Category( string )
EndpointImplementationDetails( EndpointImplementationDetails )
BindingType( string )
ConnectionProperties( Collection of ConnectionProperty )
ImplementationCode( string )
CName( string )
DeploymentZoneRule( string )
EndpointKey( string )
Uri( anyURI )
BindingQName( string )
}
EndpointImplementationDetails {
GTMEndpoint( GTMEndpoint )
DeploymentZoneEndpoint( DeploymentZoneEndpoint )
}
GTMEndpoint {
GTMInstanceID( string )
EndpointKey( string )
GTMType( string )
}
DeploymentZoneEndpoint {
Path( string )
EndpointHostName( string )
Public( boolean )
ListenerName( string )
ContainerKey( string )
Url( string )
EndpointPath( string )
UseServiceIdentityForSNI( boolean )
GatewayHostPath( string )
DeploymentZoneID( string )
GatewayHostName( string )
BindingType( string )
EndpointKey( string )
Protocol( string )
BindingQName( string )
}
ConnectionProperty {
Value( string )
Name( string )
}
Scope {
Restricted( boolean )
LicenseID( Collection of string )
}
POST/apps/versions/{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/apps/{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/apps/versions/{RuntimeID}/publicprofile/picturegetAppPublicProfilePicture
Parameters
Accepts */*
Name
Type
Description
Model
RuntimeID
path
string
size
query
integer
FallbackToAppAvatar
query
boolean
Reponse
Produces image/jpeg
Status Code
Reason
Model
200
Success
byte
DELETE/apps/versions/{RuntimeID}/publicprofile/picturedeleteAppPublicProfilePicture
Parameters
Name
Type
Description
Model
RuntimeID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/apps/versions/{RuntimeID}/contracts/environmentsgetAppVersionConnectionEnvironments
Parameters
Name
Type
Description
Model
RuntimeID
path
string
APIVersionID
query
string
Reponse
Produces application/jsonapplication/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
AppVersionEnvironments
AppVersionEnvironments {
AppVersionEnvironment {
AppVersionEnvironment( Collection of AppVersionEnvironment )
}
AppVersionEnvironment {
EnvironmentID( string )
Environment( string )
}
GET/apps/versions/{RuntimeID}/oauthprofile/choicesgetAppOAuthProfileChoices
Parameters
Name
Type
Description
Model
RuntimeID
path
string
OAuthClientProperty
query
string
Federation
query
boolean
Reponse
Produces application/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
any
GET/apps/versions/{AppVersionID}/txlogs/exportexportUsageLogs
Parameters
Name
Type
Description
Model
AppVersionID
path
string
ContractID
query
string
ApiVersionID
query
string
OperationName
query
string
Environment
query
string
Status
query
string
FromResponseTime
query
integer
ToResponseTime
query
integer
StartDate
query
string
EndDate
query
string
TimeZone
query
string
Duration
query
string
Reponse
Produces text/csv
Status Code
Reason
Model
200
Success
any
GET/apps/versions/{AppVersionID}/metrics/exportexportMetrics
Parameters
Name
Type
Description
Model
AppVersionID
path
string
ReportType
query
string
ContractID
query
string
ApiVersionID
query
string
OperationName
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 text/csv
Status Code
Reason
Model
200
Success
any
GET/apps/versions/{AppVersionID}/txlogs/{Tx}getTransactionRecord
Parameters
Accepts */*
Name
Type
Description
Model
AppVersionID
path
string
Tx
path
string
TimeZone
query
string
IncludeMessageContents
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
TransactionRecord
TransactionRecord {
RequestMessage {
Message {
ResponseMessage {
FaultMessage {
NextHopInfo {
Timestamps {
TimePeriod {
ResponseMessageSize( unsignedLong )
APIName( string )
AppRuntimeID( string )
APIVersionName( string )
HttpVerb( string )
APIVersionID( string )
TransactionID( string )
AppName( string )
GatewayRespProcessingTime( duration )
AppID( string )
RequestDateTime( dateTime )
ResponseStatusCode( unsignedInt )
AppVersionName( string )
GatewayReqProcessingTime( duration )
RequestMessage( RequestMessage )
ResponseTime( duration )
RequestMessageSize( unsignedLong )
MethodName( string )
MethodKey( string )
APIURL( string )
Messages( Collection of Message )
ResponseErrorMessage( string )
GatewayTime( duration )
ResponseMessage( ResponseMessage )
APIID( string )
AppVersionID( string )
ClientHost( string )
FaultMessage( FaultMessage )
NextHopInfo( Collection of NextHopInfo )
GatewayRespWriteTime( duration )
GatewayReqReadTime( duration )
APIResponseTime( duration )
}
RequestMessage {
TransportHeaders( string )
Message( string )
}
Message {
TransportHeaders( string )
MessageCapturedTime( dateTime )
Category( Collection of string )
MessageName( string )
MessageBody( string )
}
ResponseMessage {
TransportHeaders( string )
Message( string )
}
FaultMessage {
TransportHeaders( string )
Message( string )
}
NextHopInfo {
responseHeaderSize( long )
eventId( string )
requestDts( dateTime )
requestHeaderSize( long )
responseTime( long )
timestamps( Timestamps )
verb( string )
fault( boolean )
responseSize( long )
url( string )
createDts( dateTime )
TTFB( duration )
requestSize( long )
status( string )
}
Timestamps {
start( long )
end( long )
read( TimePeriod )
write( TimePeriod )
}
TimePeriod {
start( long )
end( long )
}
DELETE/apps/versions/{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
Status Code
Reason
Model
200
Success
any
PUT/apps/versions/{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/apps/versions/{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/apps/versions/{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
any
GET/apps/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
