API Management Service
{ http://soa.com/wsdl/api/1.0 } ApiRESTApi
The APIs service provides a REST interface and a set of operations for managing APIs in the Akana API Platform. This API includes operations to support complete API lifecycle management, including creating and managing APIs and API versions, managing API OAuth details, managing legal agreements and the API Board, API monitoring and documentation, and relationships between APIs and apps.
POST/apisaddAPI
Adds a new API to the platform, and also adds the first API version; or, creates an API definition on the platform from an existing virtual service defined in Policy Manager. Note: Legacy operation. From version 8.1 onwards, use POST /api/apis with custom headers. This operation sends the API definition in JSON or XML format. The platform assigns the APIID and returns the full API info in the response. Authorization Roles/Permissions: To complete this operation successfully, a user must be logged in. The user who adds the API automatically becomes the first API Administrator. Workflow: There is no default workflow for new APIs. However, a custom workflow might be in place. There is only one initial action valid for Akana API Platform workflows relating to APIs, the @Create initial action. For more information on workflow, see Executing Workflow Actions. Authorization token renewal: This operation changes information that is reflected in the authorization token; therefore, when invoking this operation, you must also renew the token.
Request
Sample Request Headers
Host: {hostname}
Accept: application/json, text/javascript, */*; q=0.01
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_{tenant}: {TokenID}
Sample Request Body (application/json):
{
"Name":"aaa_Swagger_Production",
"Description":"Swagger API on the developer portal",
"Visibility":"Public",
"PictureID":"",
"APIVersion":{
"Visibility":"Public",
"Name":"1.0",
"ResourceLevelPermissionsSupported":true,
"Description":"First version",
"TargetAPI":{
"Endpoints":{
"Endpoint":[
{
"Uri":"http://petstore.swagger.io/v2/",
"Category":"Production"
}
]
},
"Type":"shttp",
"Operations":{
"Operation":[
{
"Method":"GET",
"Path":"/get /pet/{petId}",
"Input":[
{
"Name":"petId",
"Type":"path"
}
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"getPetById"
},
{
"Method":"POST",
"Path":"/pet",
"Input":[
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"addPet"
}
]
},
"Policies":{
"Policy":[
]
},
"DefaultProfile":"Any in and out"
},
"Endpoints":{
"Endpoint":[
{
"Uri":"http://www.acmepaymentscorp.com/api/swag",
"Category":"Production",
"CName":"www.acmepaymentscorp.com",
"DeploymentZoneRule":"8c06bf74-5d31-4f7a-9a84-e842ab50default-http0"
}
]
},
"Operations":{
"Operation":[
{
"Method":"GET",
"Path":"/get /pet/{petId}",
"Input":[
{
"Name":"petId",
"Type":"path"
}
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"getPetById"
},
{
"Method":"POST",
"Path":"/pet",
"Input":[
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"addPet"
}
]
},
"Type":"shttp",
"ProductionEndpoint":"http://www.acmepaymentscorp.com/api/swag",
"SandboxEndpoint":null,
"Tag":[
"swagger",
"test",
"api"
],
"Policies":{
"Policy":[
{
"PolicyKey":"10001-acmepaymentscorpApplicationSecurityPolicy",
"PolicyType":"Operational Policy"
},
{
"PolicyKey":"10001-CORSAllowAll",
"PolicyType":"Operational Policy"
},
{
"PolicyKey":"10001-DetailedAuditing",
"PolicyType":"Operational Policy"
}
]
},
"DefaultProfile":"Any in and out",
"ProductionAnonymousAccessAllowed":false,
"SandboxAnonymousAccessAllowed":false,
"ProductionEndpointAccessAutoApproved":true,
"SandboxEndpointAccessAutoApproved":true
}
}
Sample Request Body (application/xml):
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<API xmlns="http://soa.com/xsd/api/1.0" xmlns:ns2="http://soa.com/xsd/business/1.0"
xmlns:ns3="http://soa.com/xsd/legals/1.0" xmlns:ns4="http://soa.com/xsd/dnmodel/1.0"
xmlns:ns5="http://soa.com/xsd/resource/1.0">
<Name>aaa_Swagger_Production</Name>
<Description>Swagger API on the developer portal</Description>
<Visibility>Public</Visibility>
<PictureID></PictureID>
<APIVersion>
<Visibility>Public</Visibility>
<Name>1.0</Name>
<ResourceLevelPermissionsSupported>true</ResourceLevelPermissionsSupported>
<Description>First version</Description>
<TargetAPI>
<Endpoints>
<Endpoint>
<Uri>http://petstore.swagger.io/v2/</Uri>
<Category>Production</Category>
</Endpoint>
</Endpoints>
<Type>shttp</Type>
<Operations>
<Operation>
<Method>GET</Method>
<Path>/get /pet/{petId}</Path>
<Input>
<Name>petId</Name>
<Type>path</Type>
</Input>
<InputContentType>*/*</InputContentType>
<OutputContentType>*/*</OutputContentType>
<FaultContentType>*/*</FaultContentType>
<Name>getPetById</Name>
</Operation>
<Operation>
<Method>POST</Method>
<Path>/pet</Path>
<InputContentType>*/*</InputContentType>
<OutputContentType>*/*</OutputContentType>
<FaultContentType>*/*</FaultContentType>
<Name>addPet</Name>
</Operation>
</Operations>
<Policies></Policies>
<DefaultProfile>Any in and out</DefaultProfile>
</TargetAPI>
<Endpoints>
<Endpoint>
<Uri>http://www.acmepaymentscorp.com/api/swag</Uri>
<Category>Production</Category>
<CName>www.acmepaymentscorp.com</CName>
<DeploymentZoneRule>8c06bf74-5d31-4f7a-9a84-e842ab50default-http0</DeploymentZoneRule>
</Endpoint>
</Endpoints>
<Operations>
<Operation>
<Method>GET</Method>
<Path>/get /pet/{petId}</Path>
<Input>
<Name>petId</Name>
<Type>path</Type>
</Input>
<InputContentType>*/*</InputContentType>
<OutputContentType>*/*</OutputContentType>
<FaultContentType>*/*</FaultContentType>
<Name>getPetById</Name>
</Operation>
<Operation>
<Method>POST</Method>
<Path>/pet</Path>
<InputContentType>*/*</InputContentType>
<OutputContentType>*/*</OutputContentType>
<FaultContentType>*/*</FaultContentType>
<Name>addPet</Name>
</Operation>
</Operations>
<Type>shttp</Type>
<ProductionEndpoint>http://www.acmepaymentscorp.com/api/swag</ProductionEndpoint>
<SandboxEndpoint />
<Tag>swagger</Tag>
<Tag>test</Tag>
<Tag>api</Tag>
<Policies>
<Policy>
<PolicyKey>10001-acmepaymentscorpApplicationSecurityPolicy</PolicyKey>
<PolicyType>Operational Policy</PolicyType>
</Policy>
<Policy>
<PolicyKey>10001-CORSAllowAll</PolicyKey>
<PolicyType>Operational Policy</PolicyType>
</Policy>
<Policy>
<PolicyKey>10001-DetailedAuditing</PolicyKey>
<PolicyType>Operational Policy</PolicyType>
</Policy>
</Policies>
<DefaultProfile>Any in and out</DefaultProfile>
<ProductionAnonymousAccessAllowed>false</ProductionAnonymousAccessAllowed>
<SandboxAnonymousAccessAllowed>false</SandboxAnonymousAccessAllowed>
<ProductionEndpointAccessAutoApproved>true</ProductionEndpointAccessAutoApproved>
<SandboxEndpointAccessAutoApproved>true</SandboxEndpointAccessAutoApproved>
</APIVersion>
</API>
Response
Sample Response Headers:
HTTP/1.1 200 OK
Date: Wed, 07 Oct 2015 15:30:26 GMT
Content-Type: application/json
Atmo-Renew-Token: renew
Sample Response (application/json):
{
"APIID":"44d187c6-7aa0-492d-bb41-fa5b9c16b450.acmepaymentscorp",
"Name":"aaa_Swagger_Production",
"Description":"Swagger Testing API",
"Visibility":"Public",
"Tag":[
],
"APIVersion":{
"APIVersionID":"f9e38abc-9d29-4586-a45f-e61a6780b6a1.acmepaymentscorp",
"APIID":"44d187c6-7aa0-492d-bb41-fa5b9c16b450.acmepaymentscorp",
"Name":"1.0",
"Description":"First version",
"Type":"shttp",
"DefaultProfile":"Any in and out",
"Tag":[
],
"ProductionEndpoint":"http://www.acmepaymentscorp.com/api/",
"Operations":{
"Operation":[
{
"Name":"getPetById",
"Method":"GET",
"Path":"/pet/{path:.+|}",
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Input":[
{
"Name":"path",
"Type":"path"
}
],
"InterfaceQName":"{uri:acmepaymentscorp}PortType_svc_f9e38abc-9d29-4586-a45f-e61a6780b6a1.acmepaymentscorp.production",
"WsdlOperationName":"getPetById"
}
]
},
"Endpoints":{
"Endpoint":[
{
"CName":"www.acmepaymentscorp.com",
"Category":"Production",
"Uri":"http://www.acmepaymentscorp.com/api/",
"DeploymentZoneRule":"0dc4dce5-a255-4bdc-99cb-cd1ec000default-http0",
"ConnectionProperties":[
]
}
]
},
"Policies":{
"Policy":[
{
"PolicyKey":"10001-DetailedAuditing",
"PolicyType":"Operational Policy"
}
]
},
"TargetAPI":{
"Type":"shttp",
"DefaultProfile":"Any in and out",
"Endpoints":{
"Endpoint":[
{
"Category":"Production",
"Uri":"http://petstore.swagger.io/",
"ConnectionProperties":[
]
}
]
},
"Operations":{
"Operation":[
{
"Name":"getPetById",
"Method":"GET",
"Path":"/pet/{path:.+|}",
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Input":[
{
"Name":"path",
"Type":"path"
}
],
"InterfaceQName":"{uri:acmepaymentscorp}PortType_svc_f9e38abc-9d29-4586-a45f-e61a6780b6a1.acmepaymentscorp.production",
"WsdlOperationName":"getPetById"
}
]
},
"Policies":{
"Policy":[
]
}
},
"Visibility":"Public",
"ProductionEndpointAccessAutoApproved":true,
"SandboxEndpointAccessAutoApproved":true,
"SandboxAnonymousAccessAllowed":false,
"ProductionAnonymousAccessAllowed":true,
"ResourceLevelPermissionsSupported":false
}
}
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.v83+json application/vnd.soa.v83+xml
Name
Type
Description
Model
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.v83+jsonapplication/vnd.soa.v83+xml
Status Code
Reason
Model
200
Success
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 )
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 )
}
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
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 )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( 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 )
}
entry {
value( stringArray )
key( string )
}
stringArray {
item( Collection of 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 )
}
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 )
}
POST/apiscreateAPI
Parameters
Accepts application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
body
entity
AddAPIRequest
AddAPIRequest {
entry {
AddAPIImplementationRequest {
ExistingAssetImplementationRequest {
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
CloneImplementationRequest {
CloneAPIVersionRequest {
DLDescriptor {
DLURL {
ServiceDescriptorReference {
APIVersionInfo {
APIInfo {
classifiers( Collection of entry )
AddAPIImplementationRequest( AddAPIImplementationRequest, required )
CloneAPIVersionRequest( CloneAPIVersionRequest, required )
DLDescriptor( DLDescriptor, required )
APIVersionInfo( APIVersionInfo, required )
BusinessID( string )
artifacts( Collection of entry )
}
entry {
value( anyType )
key( string )
}
AddAPIImplementationRequest {
ExistingAssetImplementationRequest( ExistingAssetImplementationRequest, required )
APIImplementationDeployments( Collection of DeploymentZonesHostingInfo, required )
Description( string )
ProxyImplementationRequest( Collection of string )
ImplementationCode( string )
AnonymousAccessAllowed( boolean )
APIVersionID( string )
CreateMechanism( CreateMechanism, required )
CloneImplementationRequest( CloneImplementationRequest, required )
EndpointAccessAutoApproved( boolean )
}
ExistingAssetImplementationRequest {
MediateToBindingType( string )
AssetServiceKey( string, required )
CreateProxy( 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 )
}
CloneImplementationRequest {
Environment( string )
Implementation( string, required )
}
CloneAPIVersionRequest {
SourceAPIVersionID( string, required )
CloneDesign( boolean )
CloneImplementations( boolean )
}
DLDescriptor {
DLURL( DLURL, required )
DLContent( string )
ServiceDescriptorReference( ServiceDescriptorReference, required )
}
DLURL {
UserName( string )
URL( string, required )
Password( string )
}
ServiceDescriptorReference {
DropboxFileId( long )
ServiceName( string, required )
FileName( string, required )
}
APIVersionInfo {
Description( string )
APIInfo( APIInfo, required )
Environment( string )
VersionName( string )
Visibility( string )
APIVersionID( string, required )
Tags( Collection of string )
Name( string )
}
APIInfo {
Description( string )
AvatarURL( anyURI )
Updated( dateTime )
State( string )
Summary( string )
Visibility( string )
APIID( string, required )
Name( string )
Created( dateTime )
}
Reponse
Produces application/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
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 )
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 )
}
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
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 )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( 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 )
}
entry {
value( stringArray )
key( string )
}
stringArray {
item( Collection of 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 )
}
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 )
}
GET/apislistAPIs
Returns a list of APIs. To return only APIs related to a business pass in the ID of that business as a query parameter. By default APIs related to the root business are returned.
Request:
GET /apis?BusinessID=depta.acmepaymentscorp HTTP/1.1
Accept: application/vnd.soa.v83+json
Response:
HTTP/1.1 200 OK
{
"APIInfo" : [
{
"APIID" : "12770263-e036-4222-b8eb-87d33676d3ad.acmepaymentscorp",
"Name" : "ACME Payments API",
"Description" : "Payments API for ACME customers.",
"Created" : "2014-07-18T15:43:09Z",
"Updated" : "2014-07-18T15:44:51Z",
"State" : "com.soa.api.state.active",
"Visibility" : "Public",
"AvatarURL" : "http://{hostname}/api/apis/12770263-e036-4222-b8eb-87d33676d3ad.acmepaymentscorp/avatar"
},
{
"APIID" : "12770263-e036-4222-b8eb-87d33676d5ef.acmepaymentscorp",
"Name" : "ACME Customer Service API",
"Description" : "Customer Service API for ACME.",
"Created" : "2014-07-19T15:43:09Z",
"Updated" : "2014-07-19T15:44:51Z",
"State" : "com.soa.api.state.active",
"Visibility" : "Public",
"AvatarURL" : "http://{hostname}/api/apis/12770263-e036-4222-b8eb-87d33676d5ef.acmepaymentscorp/avatar"
}
]
}
Parameters
Accepts */*
Name
Type
Description
Model
BusinessID
query
string
Federation
query
boolean
Reponse
Produces text/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/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/apislistAPISummaries
Parameters
Accepts */*
Name
Type
Description
Model
BusinessID
query
The unique ID for a specific business on the platform. If this parameter is included, only APIs relating to the specified business are returned.
string
Reponse
Produces application/vnd.soa.v83+jsonapplication/vnd.soa.v83+xml
Status Code
Reason
Model
200
Success
APIInfos
APIInfos {
APIInfo {
APIInfo( Collection of APIInfo )
}
APIInfo {
Description( string )
AvatarURL( anyURI )
Updated( dateTime )
State( string )
Summary( string )
Visibility( string )
APIID( string )
Name( string )
Created( dateTime )
}
DELETE/apis/{ApiID}deleteAPI
Parameters
Accepts */*
Name
Type
Description
Model
ApiID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
PUT/apis/{ApiID}updateAPI
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
ApiID
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+xml
Status Code
Reason
Model
200
Success
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 )
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 )
}
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
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 )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( 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 )
}
entry {
value( stringArray )
key( string )
}
stringArray {
item( Collection of 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 )
}
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 )
}
GET/apis/{ApiID}getAPI
Parameters
Name
Type
Description
Model
ApiID
path
string
includeDefaultVersion
query
boolean
IncludeSettings
query
boolean
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v83+json
Status Code
Reason
Model
200
Success
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 )
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 )
}
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
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 )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( 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 )
}
entry {
value( stringArray )
key( string )
}
stringArray {
item( Collection of 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 )
}
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 )
}
GET/apis/servicesgetAPIImplementations
Parameters
Name
Type
Description
Model
q
query
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.akana.v2019+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+xmlapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
APIImplementations
APIImplementations {
APIImplementation {
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
APIBinding {
BindingOperation {
HttpOperation {
Input {
Policy {
EndpointOAuthDetails {
OAuthTokenResourceURISettings {
OAuth20Settings {
OAuth10aSettings {
ServiceReference {
Endpoint {
ConnectionProperty {
APIInterface {
InterfaceOperation {
OperationOAuthDetails {
Operation {
OperationResourceDetails {
Resource {
APIImplementation( Collection of APIImplementation )
}
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 )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( string )
Name( 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 )
}
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 )
}
OperationResourceDetails {
OperationName( string )
Resource( Collection of Resource )
OperationKey( 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 )
}
GET/apis/versionslistAPIVersions
Parameters
Accepts */*
Name
Type
Description
Model
State
query
string
Federation
query
boolean
IncludeEndpoints
query
boolean
IncludeTags
query
boolean
Reponse
Produces text/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 )
}
GET/apis/versionslistAllAPIVersions
Parameters
Accepts */*
Name
Type
Description
Model
State
query
string
Federation
query
boolean
IncludeEndpoints
query
boolean
IncludeTags
query
boolean
Reponse
Produces application/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+xmlapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
APIVersions
APIVersions {
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 {
RatingSummary {
APIDesign {
TargetResource {
Image {
Descriptor {
Links {
TargetAPI {
APIVersionSettings {
APIVersion( Collection of APIVersion )
}
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 )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( 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 )
}
entry {
value( stringArray )
key( string )
}
stringArray {
item( Collection of string )
}
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
APIDesign {
BindingType( Collection of string )
CommonDesign( boolean )
DesignServiceKey( 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 )
}
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 )
}
GET/apis/hostendpointslistHostingContainerEndpoints
Parameters
Accepts */*
Name
Type
Description
Model
apiVersionID
query
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+xmlapplication/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/apis/isendpointuniqueisEndpointUnique
Parameters
Accepts */*
Name
Type
Description
Model
url
query
string
ApiVersionID
query
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/apis/{ApiID}/packageexport
Parameters
Accepts */*
Name
Type
Description
Model
ApiID
path
string
Reponse
Produces application/jsonapplication/octet-stream
Status Code
Reason
Model
200
Success
any
GET/apis/{ApiID}/adminsgetAPIAdministrators
Parameters
Accepts */*
Name
Type
Description
Model
ApiID
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
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/apis/{ApiID}/versionsaddAPIVersion
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
ApiID
path
string
body
entity
APIVersion
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 {
RatingSummary {
APIDesign {
TargetResource {
Image {
Descriptor {
Links {
TargetAPI {
APIVersionSettings {
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 )
}
RatingSummary {
Five( int, required )
Four( int, required )
One( int, required )
Two( int, required )
Three( int, required )
}
APIDesign {
BindingType( Collection of string )
CommonDesign( boolean )
DesignServiceKey( 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 )
}
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 )
}
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
APIVersion
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 {
RatingSummary {
APIDesign {
TargetResource {
Image {
Descriptor {
Links {
TargetAPI {
APIVersionSettings {
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 )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( 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 )
}
entry {
value( stringArray )
key( string )
}
stringArray {
item( Collection of string )
}
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
APIDesign {
BindingType( Collection of string )
CommonDesign( boolean )
DesignServiceKey( 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 )
}
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 )
}
POST/apis/{ApiID}/versionscreateAPIVersion
Parameters
Accepts application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
ApiID
path
string
body
entity
AddAPIRequest
AddAPIRequest {
entry {
AddAPIImplementationRequest {
ExistingAssetImplementationRequest {
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
CloneImplementationRequest {
CloneAPIVersionRequest {
DLDescriptor {
DLURL {
ServiceDescriptorReference {
APIVersionInfo {
APIInfo {
classifiers( Collection of entry )
AddAPIImplementationRequest( AddAPIImplementationRequest, required )
CloneAPIVersionRequest( CloneAPIVersionRequest, required )
DLDescriptor( DLDescriptor, required )
APIVersionInfo( APIVersionInfo, required )
BusinessID( string )
artifacts( Collection of entry )
}
entry {
value( anyType )
key( string )
}
AddAPIImplementationRequest {
ExistingAssetImplementationRequest( ExistingAssetImplementationRequest, required )
APIImplementationDeployments( Collection of DeploymentZonesHostingInfo, required )
Description( string )
ProxyImplementationRequest( Collection of string )
ImplementationCode( string )
AnonymousAccessAllowed( boolean )
APIVersionID( string )
CreateMechanism( CreateMechanism, required )
CloneImplementationRequest( CloneImplementationRequest, required )
EndpointAccessAutoApproved( boolean )
}
ExistingAssetImplementationRequest {
MediateToBindingType( string )
AssetServiceKey( string, required )
CreateProxy( 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 )
}
CloneImplementationRequest {
Environment( string )
Implementation( string, required )
}
CloneAPIVersionRequest {
SourceAPIVersionID( string, required )
CloneDesign( boolean )
CloneImplementations( boolean )
}
DLDescriptor {
DLURL( DLURL, required )
DLContent( string )
ServiceDescriptorReference( ServiceDescriptorReference, required )
}
DLURL {
UserName( string )
URL( string, required )
Password( string )
}
ServiceDescriptorReference {
DropboxFileId( long )
ServiceName( string, required )
FileName( string, required )
}
APIVersionInfo {
Description( string )
APIInfo( APIInfo, required )
Environment( string )
VersionName( string )
Visibility( string )
APIVersionID( string, required )
Tags( Collection of string )
Name( string )
}
APIInfo {
Description( string )
AvatarURL( anyURI )
Updated( dateTime )
State( string )
Summary( string )
Visibility( string )
APIID( string, required )
Name( string )
Created( dateTime )
}
Reponse
Produces application/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
APIVersion
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 {
RatingSummary {
APIDesign {
TargetResource {
Image {
Descriptor {
Links {
TargetAPI {
APIVersionSettings {
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 )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( 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 )
}
entry {
value( stringArray )
key( string )
}
stringArray {
item( Collection of string )
}
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
APIDesign {
BindingType( Collection of string )
CommonDesign( boolean )
DesignServiceKey( 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 )
}
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 )
}
DELETE/apis/versions/{ApiVersionID}deleteAPIVersion
Parameters
Accepts */*
Name
Type
Description
Model
ApiVersionID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
PUT/apis/versions/{ApiVersionID}updateAPIVersion
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
ApiVersionID
path
string
body
entity
APIVersion
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 {
RatingSummary {
APIDesign {
TargetResource {
Image {
Descriptor {
Links {
TargetAPI {
APIVersionSettings {
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 )
}
RatingSummary {
Five( int, required )
Four( int, required )
One( int, required )
Two( int, required )
Three( int, required )
}
APIDesign {
BindingType( Collection of string )
CommonDesign( boolean )
DesignServiceKey( 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 )
}
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 )
}
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
APIVersion
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 {
RatingSummary {
APIDesign {
TargetResource {
Image {
Descriptor {
Links {
TargetAPI {
APIVersionSettings {
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 )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( 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 )
}
entry {
value( stringArray )
key( string )
}
stringArray {
item( Collection of string )
}
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
APIDesign {
BindingType( Collection of string )
CommonDesign( boolean )
DesignServiceKey( 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 )
}
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 )
}
GET/apis/{APIID}/boardgetBoard
Parameters
Accepts */*
Name
Type
Description
Model
APIID
path
string
ItemType
query
string
DiscussionType
query
string
AppID
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/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/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/apis/{ApiID}/settingsgetAPISettings
Parameters
Name
Type
Description
Model
ApiID
path
string
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
APISettings
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 )
}
GET/apis/{ApiID}/versionsgetAPIVersions
Parameters
Accepts */*
Name
Type
Description
Model
ApiID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+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 )
}
POST/apis/{ApiID}/administratorsaddAPIAdministrator
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
ApiID
path
string
UserID
query
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/apis/versions/implementationsfindAPIImplementations
Parameters
Name
Type
Description
Model
APIID
query
string
APIVersionID
query
string
ServiceKey
query
string
ProxiedServiceKey
query
string
ImplementationCode
query
string
Reponse
Produces application/jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
APIImplementationInfos
APIImplementationInfos {
APIImplementationInfo {
APIImplementationInfo( Collection of APIImplementationInfo )
}
APIImplementationInfo {
Pattern( string )
Description( string )
ProxyImplementationRequest( Collection of string )
ImplementationCode( string )
ServiceKey( string )
AnonymousAccessAllowed( boolean )
APIOwnedImplementation( boolean )
APIVersionID( string )
EndpointAccessAutoApproved( boolean )
}
GET/apis/versions/autosettingsgetAutoConnectedAPIVersions
Parameters
Name
Type
Description
Model
Federation
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+xmlapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
APIVersionAutoConnectDetails
APIVersionAutoConnectDetails {
APIVersionAutoConnectDetail {
APIVersionAutoConnectDetail( Collection of APIVersionAutoConnectDetail )
}
APIVersionAutoConnectDetail {
Restricted( boolean )
AutoConnectEnabled( boolean )
Environment( string )
APIVersionID( string )
AutoApproveEnabled( boolean )
LicenseID( string )
}
GET/apis/versions/{ApiVersionID}getAPIVersion
Parameters
Accepts */*
Name
Type
Description
Model
ApiVersionID
path
string
includeOperations
query
boolean
IncludeEndpoints
query
boolean
includeTargetAPI
query
boolean
IncludeSettings
query
boolean
includeTargetResources
query
boolean
ContractID
query
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.akana.v2019+json
Status Code
Reason
Model
200
Success
APIVersion
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 {
RatingSummary {
APIDesign {
TargetResource {
Image {
Descriptor {
Links {
TargetAPI {
APIVersionSettings {
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 )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( 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 )
}
entry {
value( stringArray )
key( string )
}
stringArray {
item( Collection of string )
}
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
APIDesign {
BindingType( Collection of string )
CommonDesign( boolean )
DesignServiceKey( 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 )
}
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 )
}
GET/apis/{APIID}/followersgetFollowers
Parameters
Accepts */*
Name
Type
Description
Model
APIID
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/apis/{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/apis/{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/apis/{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/apis/{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/apis/{ID}/picturedeleteImage
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
GET/apis/versions/{ApiVersionID}/metricsgetMetrics
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
ContractID
query
string
AppVersionID
query
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
ShowIntervalData
query
boolean
Reponse
Produces application/jsontext/xmlapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/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 )
}
DELETE/apis/{ApiID}/administrators/{UserID}removeAPIAdministrator
Parameters
Accepts */*
Name
Type
Description
Model
ApiID
path
string
UserID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/apis/versions/{ApiVersionID}/boardgetVersionBoard
Parameters
Accepts */*
Name
Type
Description
Model
ApiVersionID
path
string
ItemType
query
string
DiscussionType
query
string
AppID
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/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/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/apis/versions/{ApiVersionID}/designmodifyAPIVersionDesign
Parameters
Accepts application/json application/vnd.soa.v81+json
Name
Type
Description
Model
ApiVersionID
path
string
body
entity
DLDescriptor
DLDescriptor {
DLURL {
ServiceDescriptorReference {
DLURL( DLURL, required )
DLContent( string )
ServiceDescriptorReference( ServiceDescriptorReference, required )
}
DLURL {
UserName( string )
URL( string, required )
Password( string )
}
ServiceDescriptorReference {
DropboxFileId( long )
ServiceName( string, required )
FileName( string, required )
}
Reponse
Produces application/jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
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 )
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 )
}
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
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 )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( 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 )
}
entry {
value( stringArray )
key( string )
}
stringArray {
item( Collection of 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 )
}
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 )
}
GET/apis/versions/{ApiVersionID}/designgetAPIVersionDesign
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
specification
query
string
Introspection
query
boolean
Reponse
Status Code
Reason
Model
200
Success
any
PUT/apis/versions/{ApiVersionID}/infoupdateAPIVersionInfo
Parameters
Accepts application/json application/xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
ApiVersionID
path
string
body
entity
EditApiInfoRequest
EditApiInfoRequest {
VersionNotes( string )
ApiName( string )
PictureID( long )
VersionName( string )
Visibility( string )
ApiSummary( string )
ApiDescription( string )
Tags( Collection of string )
BusinessID( string )
}
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
APIVersionInfo
APIVersionInfo {
APIInfo {
Description( string )
APIInfo( APIInfo )
Environment( string )
VersionName( string )
Visibility( string )
APIVersionID( string )
Tags( Collection of string )
Name( string )
}
APIInfo {
Description( string )
AvatarURL( anyURI )
Updated( dateTime )
State( string )
Summary( string )
Visibility( string )
APIID( string )
Name( string )
Created( dateTime )
}
PUT/apis/versions/{ApiVersionID}/extensionsmodifyExtensionProperties
Updates LM extension properties for an api version.
Request:
Sample Request Headers
PUT /api/apis/versions/{ApiVersionDN}/extensions HTTP/1.1
Content-Type: application/json or application/vnd.soa.v83+json
Accept: text/plain
X-Csrf-Token_{tenant}: {TokenID}
Sample Request Body (application/json):
{
"classifiers" : {
"PropName" : [ "value1", "value2" ],
"id" : [ "ID1" ]
},
"artifacts" : {
}
}
Response:
HTTP/1.1 200 OK
ApiVersionDN
Parameters
Accepts application/json application/vnd.soa.v83+json
Name
Type
Description
Model
ApiVersionID
path
The unique ID of an api 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/apis/versions/{ApiVersionID}/actionexecuteWorkflowAction
Parameters
Accepts application/json
Name
Type
Description
Model
ApiVersionID
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
POST/apis/versions/{ApiVersionID}/implementationsaddAPIImplementation
Parameters
Accepts application/json application/vnd.soa.v81+json
Name
Type
Description
Model
ApiVersionID
path
string
body
entity
AddAPIImplementationRequest
AddAPIImplementationRequest {
ExistingAssetImplementationRequest {
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
CloneImplementationRequest {
ExistingAssetImplementationRequest( ExistingAssetImplementationRequest, required )
APIImplementationDeployments( Collection of DeploymentZonesHostingInfo, required )
Description( string )
ProxyImplementationRequest( Collection of string )
ImplementationCode( string )
AnonymousAccessAllowed( boolean )
APIVersionID( string )
CreateMechanism( CreateMechanism, required )
CloneImplementationRequest( CloneImplementationRequest, required )
EndpointAccessAutoApproved( boolean )
}
ExistingAssetImplementationRequest {
MediateToBindingType( string )
AssetServiceKey( string, required )
CreateProxy( 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 )
}
CloneImplementationRequest {
Environment( string )
Implementation( string, required )
}
Reponse
Produces application/jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
APIImplementationInfo
APIImplementationInfo {
Pattern( string )
Description( string )
ProxyImplementationRequest( Collection of string )
ImplementationCode( string )
ServiceKey( string )
AnonymousAccessAllowed( boolean )
APIOwnedImplementation( boolean )
APIVersionID( string )
EndpointAccessAutoApproved( boolean )
}
GET/apis/versions/{ApiVersionID}/swaggergetSwaggerResourceDocument
Parameters
Accepts */*
Name
Type
Description
Model
ApiVersionID
path
string
locale
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
SwaggerDocument
SwaggerDocument {
Model {
Operation {
ErrorResponse {
Parameter {
AllowableValue {
Api {
models( Collection of Model )
apiVersion( string )
swaggerVersion( string )
apis( Collection of Api )
basePath( string )
resourcePath( string )
}
Model {
path( string )
operations( Collection of Operation )
description( string )
}
Operation {
summary( string )
notes( string )
responseClass( string )
nickname( string )
errorResponses( Collection of ErrorResponse )
httpMethod( string )
parameters( Collection of Parameter )
}
ErrorResponse {
reason( string )
code( string )
}
Parameter {
paramType( string )
allowableValues( Collection of AllowableValue )
allowMultiple( boolean )
defaultValue( string )
dataType( string )
name( string )
description( string )
required( boolean )
}
AllowableValue {
valueType( string )
values( Collection of string )
}
Api {
path( string )
operations( Collection of Operation )
description( string )
}
GET/apis/versions/{ApiVersionID}/governingworkflowgetAPIVersionGoverningWorkflow
Parameters
Name
Type
Description
Model
ApiVersionID
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+xmlapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
GoverningWorkflow
GoverningWorkflow {
Description( string )
Updated( dateTime )
Governed( boolean )
State( string )
Key( string )
Name( string )
}
PUT/apis/versions/{ApiVersionID}/governingworkflowmodifyAPIVersionGoverningWorkflow
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+xml application/vnd.soa.v81+json
Name
Type
Description
Model
ApiVersionID
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+xmlapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
GoverningWorkflow
GoverningWorkflow {
Description( string )
Updated( dateTime )
Governed( boolean )
State( string )
Key( string )
Name( string )
}
GET/apis/versions/{ApiVersionID}/autosettingsgetAPIAutoConnectSettings
Parameters
Name
Type
Description
Model
ApiVersionID
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+xmlapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
APIVersionAutoConnectLicenseDetails
APIVersionAutoConnectLicenseDetails {
APIVersionAutoConnectLicenseDetail {
License {
LicensePart {
AgreementDocument {
TargetResource {
Image {
APIVersionAutoConnectLicenseDetail( Collection of APIVersionAutoConnectLicenseDetail )
}
APIVersionAutoConnectLicenseDetail {
Restricted( boolean )
AutoConnectEnabled( boolean )
License( Collection of License )
Environment( string )
APIVersionID( string )
AutoApproveEnabled( boolean )
}
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 )
}
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/apis/versions/{ApiVersionID}/autosettingssaveAPIAutoConnectSettings
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+xml application/vnd.soa.v81+json
Name
Type
Description
Model
ApiVersionID
path
string
body
entity
APIVersionAutoConnectDetails
APIVersionAutoConnectDetails {
APIVersionAutoConnectDetail {
APIVersionAutoConnectDetail( Collection of APIVersionAutoConnectDetail, required )
}
APIVersionAutoConnectDetail {
Restricted( boolean )
AutoConnectEnabled( boolean )
Environment( string, required )
APIVersionID( string, required )
AutoApproveEnabled( boolean )
LicenseID( 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+xmlapplication/vnd.soa.v81+xmlapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
APIVersionAutoConnectLicenseDetails
APIVersionAutoConnectLicenseDetails {
APIVersionAutoConnectLicenseDetail {
License {
LicensePart {
AgreementDocument {
TargetResource {
Image {
APIVersionAutoConnectLicenseDetail( Collection of APIVersionAutoConnectLicenseDetail )
}
APIVersionAutoConnectLicenseDetail {
Restricted( boolean )
AutoConnectEnabled( boolean )
License( Collection of License )
Environment( string )
APIVersionID( string )
AutoApproveEnabled( boolean )
}
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 )
}
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/apis/versions/{ApiVersionID}/licensereportgetLicenseReport
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
LicenseID
query
string
AppVersionID
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/apis/versions/{ApiVersionID}/txlogsgetTxLogs
Parameters
Accepts */*
Name
Type
Description
Model
ApiVersionID
path
string
ContractID
query
string
AppVersionID
query
string
Environment
query
string
OperationName
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+xmlapplication/vnd.soa.v81+json
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/apis/versions/{ApiVersionID}/settingsgetAPIVersionSettings
Parameters
Name
Type
Description
Model
ApiVersionID
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+xmlapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
APIVersionSettings
APIVersionSettings {
SandboxEndpointSupport( string )
PrivateAPIGroupTypeSupport( string )
ReviewsSupport( string )
ProductionAutoApprovalSupport( string )
PrivateAPIIndependentGroupSupport( string )
SandboxAutoApprovalSupport( string )
ResourceLevelPermissionsSupport( string )
RatingsSupport( string )
BoardSupport( string )
ProductionEndpointSupport( string )
}
GET/apis/versions/{ApiVersionID}/contractsgetContractVersions
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
ActivatedOnly
query
boolean
Environment
query
string
IncludeActions
query
boolean
Start
query
integer
Count
query
integer
Reponse
Produces text/xmlapplication/rss+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/apis/versions/{ApiVersionID}/connectedappsgetConnectedApps
Parameters
Accepts */*
Name
Type
Description
Model
ApiVersionID
path
string
ActivatedOnly
query
boolean
Environment
query
string
IncludeActions
query
boolean
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+xmlapplication/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/apis/versions/{ApiVersionID}/contractslistContracts
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
Environment
query
string
ActivatedOnly
query
boolean
Reponse
Produces application/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+xmlapplication/vnd.soa.v81+json
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 )
}
GET/apis/versions/{ApiVersionID}/licensesgetAPILicenses
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
Environment
query
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+xmlapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
APILicenses
APILicenses {
APILicense {
LicenseDetails {
LicensePartDetails {
Policy {
Resource {
AgreementDocument {
TargetResource {
Image {
Operation {
Input {
OperationOAuthDetails {
OperationResourceDetails {
SupportsUnrestricted( boolean )
APILicense( Collection of APILicense )
}
APILicense {
LicenseDetails( LicenseDetails )
Operations( Collection of Operation )
}
LicenseDetails {
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 )
}
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 )
}
Input {
Type( string )
Value( string )
Name( string )
}
OperationOAuthDetails {
WsdlOperationName( string )
OperationName( string )
Resource( Collection of string )
OperationKey( string )
InterfaceQName( string )
}
OperationResourceDetails {
OperationName( string )
Resource( Collection of Resource )
OperationKey( string )
}
GET/apis/versions/{ApiVersionID}/legalsgetLegals
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
Drafts
query
boolean
Inactive
query
boolean
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+xmlapplication/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/apis/versions/{ApiVersionID}/legalsgetLegalsList
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
Drafts
query
boolean
Inactive
query
boolean
Reponse
Produces application/vnd.akana.v2020+json
Status Code
Reason
Model
200
Success
AgreementDocuments
AgreementDocuments {
AgreementDocument {
TargetResource {
Image {
AgreementDocument( Collection of AgreementDocument )
}
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/apis/versions/{ApiVersionID}/legalscreateNewAgreement
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
ApiVersionID
path
string
body
entity
AgreementDocument
AgreementDocument {
TargetResource {
Image {
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 text/plain
Status Code
Reason
Model
200
Success
string
GET/apis/versions/{ApiVersionID}/viewersgetPrivateViewers
Parameters
Accepts */*
Name
Type
Description
Model
ApiVersionID
path
string
ViewerType
query
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+xmlapplication/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 )
}
POST/apis/versions/{ApiVersionID}/viewersinvitePrivateViewerWithScope
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+xml application/vnd.soa.v81+json
Name
Type
Description
Model
ApiVersionID
path
string
body
entity
VisibilityContract
VisibilityContract {
ViewerID( string )
ResourceID( string )
RestrictedScope( boolean, required )
ViewerType( string )
LicenseID( 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+xmlapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
VisibilityContractDetails
VisibilityContractDetails {
License {
LicensePart {
AgreementDocument {
TargetResource {
Image {
ViewerID( string )
ResourceID( string )
License( Collection of License )
ResourceType( string )
RestrictedScope( boolean )
ViewerType( 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 )
}
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/apis/versions/{ApiVersionID}/scopegetAPIScopeVisibleToUser
Parameters
Name
Type
Description
Model
ApiVersionID
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+xmlapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
APIVisibilityScope
APIVisibilityScope {
License {
LicensePart {
AgreementDocument {
TargetResource {
Image {
Resource {
Operation {
Input {
OperationOAuthDetails {
OperationResourceDetails {
AllAPIVisible( boolean )
Visible( boolean )
License( Collection of License )
Resource( Collection of Resource )
RestrictedScope( boolean )
Operation( Collection of Operation )
}
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 )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
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 )
}
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 )
}
Input {
Type( string )
Value( string )
Name( string )
}
OperationOAuthDetails {
WsdlOperationName( string )
OperationName( string )
Resource( Collection of string )
OperationKey( string )
InterfaceQName( string )
}
OperationResourceDetails {
OperationName( string )
Resource( Collection of Resource )
OperationKey( string )
}
GET/apis/versions/{ApiVersionID}/packageexportAPIVersion
Parameters
Accepts */*
Name
Type
Description
Model
ApiVersionID
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/apis/versions/{ApiVersionID}/oauthdetailssaveAPIOAuthDetailsSingleProvider
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
ApiVersionID
path
string
body
entity
APIVersionOAuthDetailsSingleProvider
APIVersionOAuthDetailsSingleProvider {
EndpointsOAuthDetails {
EndpointOAuthDetails {
OAuthTokenResourceURISettings {
OAuth20Settings {
OAuth10aSettings {
OperationOAuthDetails {
TargetAPI( EndpointsOAuthDetails )
ProxyAPI( EndpointsOAuthDetails )
OperationsOAuthDetails( Collection of OperationOAuthDetails, required )
APIVersionID( string, required )
APIVersionOAuthResourceMapping( Collection of string )
}
EndpointsOAuthDetails {
SandboxEndpoint( EndpointOAuthDetails )
ProductionEndpoint( EndpointOAuthDetails )
}
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 )
}
OperationOAuthDetails {
WsdlOperationName( string )
OperationName( string, required )
Resource( Collection of string )
OperationKey( string )
InterfaceQName( string )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
PUT/apis/versions/{ApiVersionID}/oauthdetailssaveAPIOAuthDetails
Parameters
Accepts application/vnd.akana.v2019+json
Name
Type
Description
Model
ApiVersionID
path
string
body
entity
APIVersionOAuthDetails
APIVersionOAuthDetails {
EndpointsOAuthDetailsList {
EndpointOAuthDetails {
OAuthTokenResourceURISettings {
OAuth20Settings {
OAuth10aSettings {
OperationOAuthDetails {
EndpointsOAuthDetails {
TargetAPIList( EndpointsOAuthDetailsList )
ProxyAPIList( EndpointsOAuthDetailsList )
OperationsOAuthDetails( Collection of OperationOAuthDetails, required )
ProxyAPI( EndpointsOAuthDetails )
TargetAPI( EndpointsOAuthDetails )
APIVersionID( string, required )
APIVersionOAuthResourceMapping( Collection of string )
}
EndpointsOAuthDetailsList {
SandboxEndpoint( Collection of EndpointOAuthDetails )
ProductionEndpoint( Collection of EndpointOAuthDetails )
}
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 )
}
OperationOAuthDetails {
WsdlOperationName( string )
OperationName( string, required )
Resource( Collection of string )
OperationKey( string )
InterfaceQName( string )
}
EndpointsOAuthDetails {
SandboxEndpoint( EndpointOAuthDetails )
ProductionEndpoint( EndpointOAuthDetails )
}
Reponse
Produces text/plain
PUT/apis/versions/{ApiVersionID}/resourcessaveOperationResources
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
ApiVersionID
path
string
body
entity
APIVersionResources
APIVersionResources {
OperationResource {
ResourceID( Collection of string )
SupportsLicenses( boolean )
OperationResource( Collection of OperationResource, required )
}
OperationResource {
OperationName( string, required )
ResourceID( Collection of string )
OperationKey( 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
APIVersionResourceDetails
APIVersionResourceDetails {
Resource {
OperationResourceDetails {
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 )
}
GET/apis/versions/{ApiVersionID}/resourcesgetOperationResources
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
APIVersionResourceDetails
APIVersionResourceDetails {
Resource {
OperationResourceDetails {
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 )
}
POST/apis/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/apis/{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/apis/versions/{ApiVersionID}/metrics/rangesgetRanges
Parameters
Accepts */*
Name
Type
Description
Model
ApiVersionID
path
string
Environment
query
string
StartDate
query
string
EndDate
query
string
TimeZone
query
string
TimeInterval
query
string
Duration
query
string
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+xmlapplication/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/apis/versions/{ApiVersionID}/implementations/{ImplCode}getAPIImplementation
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
ImplCode
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v81+jsonapplication/vnd.akana.v2019+json
Status Code
Reason
Model
200
Success
APIImplementation
APIImplementation {
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
APIBinding {
BindingOperation {
HttpOperation {
Input {
Policy {
EndpointOAuthDetails {
OAuthTokenResourceURISettings {
OAuth20Settings {
OAuth10aSettings {
ServiceReference {
Endpoint {
ConnectionProperty {
APIInterface {
InterfaceOperation {
OperationOAuthDetails {
Operation {
OperationResourceDetails {
Resource {
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 )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( string )
Name( 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 )
}
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 )
}
OperationResourceDetails {
OperationName( string )
Resource( Collection of Resource )
OperationKey( 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 )
}
DELETE/apis/versions/{ApiVersionID}/implementations/{ImplCode}deleteAPIImplementation
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
ImplCode
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
APIImplementation
APIImplementation {
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
APIBinding {
BindingOperation {
HttpOperation {
Input {
Policy {
EndpointOAuthDetails {
OAuthTokenResourceURISettings {
OAuth20Settings {
OAuth10aSettings {
ServiceReference {
Endpoint {
ConnectionProperty {
APIInterface {
InterfaceOperation {
OperationOAuthDetails {
Operation {
OperationResourceDetails {
Resource {
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 )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( string )
Name( 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 )
}
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 )
}
OperationResourceDetails {
OperationName( string )
Resource( Collection of Resource )
OperationKey( 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 )
}
GET/apis/versions/{ApiVersionID}/swagger/{SwaggerPath}getSwaggerApiDocument
Parameters
Accepts */*
Name
Type
Description
Model
ApiVersionID
path
string
SwaggerPath
path
string
locale
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
SwaggerDocument
SwaggerDocument {
Model {
Operation {
ErrorResponse {
Parameter {
AllowableValue {
Api {
models( Collection of Model )
apiVersion( string )
swaggerVersion( string )
apis( Collection of Api )
basePath( string )
resourcePath( string )
}
Model {
path( string )
operations( Collection of Operation )
description( string )
}
Operation {
summary( string )
notes( string )
responseClass( string )
nickname( string )
errorResponses( Collection of ErrorResponse )
httpMethod( string )
parameters( Collection of Parameter )
}
ErrorResponse {
reason( string )
code( string )
}
Parameter {
paramType( string )
allowableValues( Collection of AllowableValue )
allowMultiple( boolean )
defaultValue( string )
dataType( string )
name( string )
description( string )
required( boolean )
}
AllowableValue {
valueType( string )
values( Collection of string )
}
Api {
path( string )
operations( Collection of Operation )
description( string )
}
GET/apis/versions/{ApiVersionID}/txlogs/exportexportUsageLogs
Parameters
Accepts */*
Name
Type
Description
Model
ApiVersionID
path
string
ContractID
query
string
AppVersionID
query
string
Environment
query
string
OperationName
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; charset=utf-8
Status Code
Reason
Model
200
Success
any
GET/apis/versions/{ApiVersionID}/contracts/environmentsgetAPIVersionConnectionEnvironments
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
Reponse
Produces application/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/xmlapplication/jsonapplication/vnd.soa.v81+xmlapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
APIVersionConnectionEnvironments
APIVersionConnectionEnvironments {
APIVersionConnectionEnvironment {
APIVersionConnectionEnvironment( Collection of APIVersionConnectionEnvironment )
}
APIVersionConnectionEnvironment {
EnvironmentID( string )
Environment( string )
}
GET/apis/versions/{ApiVersionID}/metrics/exportexportMetrics
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
ContractID
query
string
AppVersionID
query
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 text/csv; charset=utf-8
Status Code
Reason
Model
200
Success
any
GET/apis/versions/{ApiVersionID}/txlogs/{TransactionID}getTransactionRecord
Parameters
Accepts */*
Name
Type
Description
Model
ApiVersionID
path
string
TransactionID
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+xmlapplication/vnd.soa.v81+json
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/apis/versions/{ApiVersionID}/legals/{LegalDocumentDN}deleteAgreementDocument
Parameters
Accepts */*
Name
Type
Description
Model
ApiVersionID
path
string
LegalDocumentDN
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
POST/apis/versions/{ApiVersionID}/viewers/{ViewerID}invitePrivateViewer
Parameters
Accepts */*
Name
Type
Description
Model
ApiVersionID
path
string
ViewerID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
DELETE/apis/versions/{ApiVersionID}/viewers/{ViewerID}unInvitePrivateViewer
Parameters
Accepts */*
Name
Type
Description
Model
ApiVersionID
path
string
ViewerID
path
string
Reponse
Produces text/plain
PUT/apis/versions/{ApiVersionID}/viewers/{ViewerID}savePrivateViewerScope
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+xml application/vnd.soa.v81+json
Name
Type
Description
Model
ApiVersionID
path
string
ViewerID
path
string
body
entity
VisibilityContract
VisibilityContract {
ViewerID( string )
ResourceID( string )
RestrictedScope( boolean, required )
ViewerType( string )
LicenseID( 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+xmlapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
VisibilityContractDetails
VisibilityContractDetails {
License {
LicensePart {
AgreementDocument {
TargetResource {
Image {
ViewerID( string )
ResourceID( string )
License( Collection of License )
ResourceType( string )
RestrictedScope( boolean )
ViewerType( 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 )
}
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/apis/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/apis/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/apis/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/apis/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/apis/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
GET/apis/versions/{ApiVersionID}/implementations/{ImplCode}/debuggetAPIImplementationDebugOptions
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
ImplCode
path
string
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v84+jsonapplication/vnd.soa.v84+xml
Status Code
Reason
Model
200
Success
ProcessingOptions
ProcessingOptions {
LogLevel( int )
}
PUT/apis/versions/{ApiVersionID}/implementations/{ImplCode}/debugupdateAPIImplementationDebugOptions
Parameters
Accepts application/json application/vnd.soa.v84+json
Name
Type
Description
Model
ApiVersionID
path
string
ImplCode
path
string
body
entity
ProcessingOptions
ProcessingOptions {
LogLevel( int, required )
}
Reponse
Produces application/jsonapplication/vnd.soa.v84+json
Status Code
Reason
Model
200
Success
ProcessingOptions
ProcessingOptions {
LogLevel( int )
}
GET/apis/versions/{ApiVersionID}/implementations/{ImplCode}/policiesgetAPIImplementationPolicies
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
ImplCode
path
string
IncludeImpliedPolicies
query
boolean
Reponse
Produces application/jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
ApiPolicies
ApiPolicies {
Policy {
ApiOperationPolicy {
Operation {
Input {
OperationOAuthDetails {
OperationResourceDetails {
Resource {
Policy( Collection of Policy )
ApiOperationPolicy( Collection of ApiOperationPolicy )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( string )
Name( string )
}
ApiOperationPolicy {
Policy( Collection of Policy )
Operation( Operation )
}
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 )
}
Input {
Type( string )
Value( string )
Name( string )
}
OperationOAuthDetails {
WsdlOperationName( string )
OperationName( string )
Resource( Collection of string )
OperationKey( string )
InterfaceQName( string )
}
OperationResourceDetails {
OperationName( string )
Resource( Collection of Resource )
OperationKey( 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 )
}
PUT/apis/versions/{ApiVersionID}/implementations/{ImplCode}/policiesmodifyAPIImplementationPolicies
Parameters
Accepts application/json application/vnd.soa.v81+json
Name
Type
Description
Model
ApiVersionID
path
string
ImplCode
path
string
body
entity
ApiPolicies
ApiPolicies {
Policy {
ApiOperationPolicy {
Operation {
Input {
OperationOAuthDetails {
OperationResourceDetails {
Resource {
Policy( Collection of Policy, required )
ApiOperationPolicy( Collection of ApiOperationPolicy, required )
}
Policy {
PolicyType( string )
PolicyKey( string, required )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( string )
Name( string )
}
ApiOperationPolicy {
Policy( Collection of Policy, required )
Operation( Operation, required )
}
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 )
}
Input {
Type( string, required )
Value( string )
Name( string, required )
}
OperationOAuthDetails {
WsdlOperationName( string )
OperationName( string, required )
Resource( Collection of string )
OperationKey( string )
InterfaceQName( string )
}
OperationResourceDetails {
OperationName( string )
Resource( Collection of Resource, required )
OperationKey( string )
}
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/jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
ApiPolicies
ApiPolicies {
Policy {
ApiOperationPolicy {
Operation {
Input {
OperationOAuthDetails {
OperationResourceDetails {
Resource {
Policy( Collection of Policy )
ApiOperationPolicy( Collection of ApiOperationPolicy )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( string )
Name( string )
}
ApiOperationPolicy {
Policy( Collection of Policy )
Operation( Operation )
}
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 )
}
Input {
Type( string )
Value( string )
Name( string )
}
OperationOAuthDetails {
WsdlOperationName( string )
OperationName( string )
Resource( Collection of string )
OperationKey( string )
InterfaceQName( string )
}
OperationResourceDetails {
OperationName( string )
Resource( Collection of Resource )
OperationKey( 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 )
}
GET/apis/versions/{ApiVersionID}/implementations/{ImplCode}/target-policiesgetAPIImplementationTargetPolicies
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
ImplCode
path
string
IncludeImpliedPolicies
query
boolean
Reponse
Produces application/jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
ApiPolicies
ApiPolicies {
Policy {
ApiOperationPolicy {
Operation {
Input {
OperationOAuthDetails {
OperationResourceDetails {
Resource {
Policy( Collection of Policy )
ApiOperationPolicy( Collection of ApiOperationPolicy )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( string )
Name( string )
}
ApiOperationPolicy {
Policy( Collection of Policy )
Operation( Operation )
}
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 )
}
Input {
Type( string )
Value( string )
Name( string )
}
OperationOAuthDetails {
WsdlOperationName( string )
OperationName( string )
Resource( Collection of string )
OperationKey( string )
InterfaceQName( string )
}
OperationResourceDetails {
OperationName( string )
Resource( Collection of Resource )
OperationKey( 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 )
}
PUT/apis/versions/{ApiVersionID}/implementations/{ImplCode}/target-policiesmodifyAPIImplementationTargetPolicies
Parameters
Accepts application/json application/vnd.soa.v81+json
Name
Type
Description
Model
ApiVersionID
path
string
ImplCode
path
string
body
entity
ApiPolicies
ApiPolicies {
Policy {
ApiOperationPolicy {
Operation {
Input {
OperationOAuthDetails {
OperationResourceDetails {
Resource {
Policy( Collection of Policy, required )
ApiOperationPolicy( Collection of ApiOperationPolicy, required )
}
Policy {
PolicyType( string )
PolicyKey( string, required )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( string )
Name( string )
}
ApiOperationPolicy {
Policy( Collection of Policy, required )
Operation( Operation, required )
}
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 )
}
Input {
Type( string, required )
Value( string )
Name( string, required )
}
OperationOAuthDetails {
WsdlOperationName( string )
OperationName( string, required )
Resource( Collection of string )
OperationKey( string )
InterfaceQName( string )
}
OperationResourceDetails {
OperationName( string )
Resource( Collection of Resource, required )
OperationKey( string )
}
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/jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
ApiPolicies
ApiPolicies {
Policy {
ApiOperationPolicy {
Operation {
Input {
OperationOAuthDetails {
OperationResourceDetails {
Resource {
Policy( Collection of Policy )
ApiOperationPolicy( Collection of ApiOperationPolicy )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( string )
Name( string )
}
ApiOperationPolicy {
Policy( Collection of Policy )
Operation( Operation )
}
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 )
}
Input {
Type( string )
Value( string )
Name( string )
}
OperationOAuthDetails {
WsdlOperationName( string )
OperationName( string )
Resource( Collection of string )
OperationKey( string )
InterfaceQName( string )
}
OperationResourceDetails {
OperationName( string )
Resource( Collection of Resource )
OperationKey( 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 )
}
PUT/apis/versions/{ApiVersionID}/implementations/{ImplCode}/outboundidentitiesmodifyAPIImplementationOutboundIdentities
Saves the outbound identities of an API
Request:
PUT /apis/versions/b81e7d33-7699-45ce-9a41-d18a8100d26d.atmosphere/implementations/Live/outboundidentities HTTP/1.1
Accept: application/json
Content-Type: application/json
{
"UseInboundIdentities": false,
"IdentityMap": {
"OutboundIdentity": [
{
"OutboundSubjectCategory": "urn:org:federatedgovernance:security:subject-category:consumer",
"SourceSubjectCategory": "urn:org:federatedgovernance:security:subject-category:consumer"
}
]
},
"UseServiceIdentityForHTTPS": false
}
Sample for static user
{
"UseInboundIdentities": false,
"IdentityMap": {
"OutboundIdentity": [
{
"OutboundSubjectCategory": "urn:org:federatedgovernance:security:subject-category:consumer",
"SourceUserName": "Local Domain\\user",
"SourceUserPassword" : "password"
}
]
},
"UseServiceIdentityForHTTPS": false
}
Sample for user defined category
{
"UseInboundIdentities": false,
"IdentityMap": {
"OutboundIdentity": [
{
"OutboundSubjectCategory": "urn:org:federatedgovernance:security:subject-category:consumer",
"SourceSubjectCategory": "someUserDefinedCategory"
}
]
},
"UseServiceIdentityForHTTPS": false
}
Response:
HTTP/1.1 200 OK
{
"UseInboundIdentities": false,
"IdentityMap": {
"OutboundIdentity": [
{
"OutboundSubjectCategory": "urn:org:federatedgovernance:security:subject-category:consumer",
"SourceSubjectCategory": "urn:org:federatedgovernance:security:subject-category:consumer"
}
]
},
"UseServiceIdentityForHTTPS": false
}
Parameters
Accepts application/json application/vnd.soa.v85+json
Name
Type
Description
Model
ApiVersionID
path
string
ImplCode
path
string
body
entity
OutboundIdentityConfigType
OutboundIdentityConfigType {
IdentityMapType {
OutboundIdentityType {
UseServiceIdentityForHTTPS( boolean, required )
UseInboundIdentities( boolean, required )
IdentityMap( IdentityMapType )
}
IdentityMapType {
OutboundIdentity( Collection of OutboundIdentityType )
}
OutboundIdentityType {
SourceSubjectCategory( anyURI )
OutboundSubjectCategory( anyURI, required )
SourceUserPassword( string )
SourceUserName( string )
}
Reponse
Produces application/jsonapplication/vnd.soa.v85+json
Status Code
Reason
Model
200
Success
OutboundIdentityConfigType
OutboundIdentityConfigType {
IdentityMapType {
OutboundIdentityType {
UseServiceIdentityForHTTPS( boolean )
UseInboundIdentities( boolean )
IdentityMap( IdentityMapType )
}
IdentityMapType {
OutboundIdentity( Collection of OutboundIdentityType )
}
OutboundIdentityType {
SourceSubjectCategory( anyURI )
OutboundSubjectCategory( anyURI )
SourceUserPassword( string )
SourceUserName( string )
}
GET/apis/versions/{ApiVersionID}/implementations/{ImplCode}/outboundidentitiesgetAPIImplementationOutboundIdentities
Returns the outbound identities of an API
Request:
GET /apis/versions/b81e7d33-7699-45ce-9a41-d18a8100d26d.atmosphere/implementations/Live/outboundidentities HTTP/1.1
Accept: application/json
{ImplCode} can be Live or Sandbox
Response:
HTTP/1.1 200 OK
{
"UseInboundIdentities": false,
"IdentityMap": {
"OutboundIdentity": [
{
"OutboundSubjectCategory": "urn:org:federatedgovernance:security:subject-category:consumer",
"SourceSubjectCategory": "urn:org:federatedgovernance:security:subject-category:consumer"
}
]
},
"UseServiceIdentityForHTTPS": true
}
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
ImplCode
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v85+json
Status Code
Reason
Model
200
Success
OutboundIdentityConfigType
OutboundIdentityConfigType {
IdentityMapType {
OutboundIdentityType {
UseServiceIdentityForHTTPS( boolean )
UseInboundIdentities( boolean )
IdentityMap( IdentityMapType )
}
IdentityMapType {
OutboundIdentity( Collection of OutboundIdentityType )
}
OutboundIdentityType {
SourceSubjectCategory( anyURI )
OutboundSubjectCategory( anyURI )
SourceUserPassword( string )
SourceUserName( string )
}
PUT/apis/versions/{ApiVersionID}/implementations/{ImplCode}/infoupdateAPIImplementationInfo
Parameters
Accepts application/json application/xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
ApiVersionID
path
string
ImplCode
path
string
body
entity
APIImplementationInfo
APIImplementationInfo {
Pattern( string )
Description( string )
ProxyImplementationRequest( Collection of string )
ImplementationCode( string )
ServiceKey( string )
AnonymousAccessAllowed( boolean )
APIOwnedImplementation( boolean )
APIVersionID( string )
EndpointAccessAutoApproved( boolean )
}
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
APIImplementationInfo
APIImplementationInfo {
Pattern( string )
Description( string )
ProxyImplementationRequest( Collection of string )
ImplementationCode( string )
ServiceKey( string )
AnonymousAccessAllowed( boolean )
APIOwnedImplementation( boolean )
APIVersionID( string )
EndpointAccessAutoApproved( boolean )
}
PUT/apis/versions/{ApiVersionID}/implementations/{ImplCode}/deploymentsmodifyAPIImplementationDeployments
Parameters
Accepts application/json application/vnd.soa.v81+json
Name
Type
Description
Model
ApiVersionID
path
string
ImplCode
path
string
body
entity
APIImplementationDeployments
APIImplementationDeployments {
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
DeploymentZonesHostingInfo( Collection of DeploymentZonesHostingInfo, required )
}
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 )
}
Reponse
Produces application/jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
APIImplementation
APIImplementation {
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
APIBinding {
BindingOperation {
HttpOperation {
Input {
Policy {
EndpointOAuthDetails {
OAuthTokenResourceURISettings {
OAuth20Settings {
OAuth10aSettings {
ServiceReference {
Endpoint {
ConnectionProperty {
APIInterface {
InterfaceOperation {
OperationOAuthDetails {
Operation {
OperationResourceDetails {
Resource {
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 )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( string )
Name( 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 )
}
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 )
}
OperationResourceDetails {
OperationName( string )
Resource( Collection of Resource )
OperationKey( 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 )
}
GET/apis/versions/{ApiVersionID}/implementations/{ImplCode}/deploymentsuggestionsgetAPIImplementationDeploymentSuggestions
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
ImplCode
path
string
DeploymentZoneID
query
string
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
APIImplementationDeployments
APIImplementationDeployments {
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
DeploymentZonesHostingInfo( Collection of DeploymentZonesHostingInfo )
}
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 )
}
PUT/apis/versions/{ApiVersionID}/legals/{LegalDocumentDN}/detailsmodifyLegalDetails
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
ApiVersionID
path
string
LegalDocumentDN
path
string
body
entity
AgreementDocument
AgreementDocument {
TargetResource {
Image {
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 text/plain
Status Code
Reason
Model
200
Success
string
PUT/apis/versions/{ApiVersionID}/legals/{LegalDocumentDN}/statemodifyLegalState
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
ApiVersionID
path
string
LegalDocumentDN
path
string
body
entity
AgreementDocument
AgreementDocument {
TargetResource {
Image {
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 text/plain
Status Code
Reason
Model
200
Success
string
GET/apis/versions/{ApiVersionID}/viewers/{ViewerID}/scopegetPrivateViewerScope
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
ViewerID
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+xmlapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
VisibilityContractDetails
VisibilityContractDetails {
License {
LicensePart {
AgreementDocument {
TargetResource {
Image {
ViewerID( string )
ResourceID( string )
License( Collection of License )
ResourceType( string )
RestrictedScope( boolean )
ViewerType( 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 )
}
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/apis/versions/{ApiVersionID}/implementations/{ImplCode}/services/{ServiceID}getServiceAsset
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
ImplCode
path
string
ServiceID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
ServiceAsset
ServiceAsset {
Endpoint {
ConnectionProperty {
Policy {
ServiceBinding {
BindingOperation {
HttpOperation {
Input {
Endpoints( Collection of Endpoint )
Description( string )
Policies( Collection of Policy )
Updated( dateTime )
ServiceBindings( Collection of ServiceBinding )
ServiceType( string )
BindingType( Collection of string )
ServiceKey( string )
Name( string )
Created( dateTime )
}
Endpoint {
BindingType( string )
ConnectionProperties( Collection of ConnectionProperty )
EndpointKey( string )
Uri( anyURI )
BindingQName( string )
}
ConnectionProperty {
Value( string )
Name( string )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
Name( string )
}
ServiceBinding {
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 )
}
GET/apis/versions/{ApiVersionID}/definition/{Specification}{IncludeDocId:(/[^/]+?)*}getAPIDocument
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
Specification
path
string
IncludeDocId
path
string
Environment
query
string
Implementation
query
string
Introspection
query
boolean
Reponse
Status Code
Reason
Model
200
Success
any
GET/apis/versions/{ApiVersionID}/environments/{Environment}/operations/{OperationName}/metricsgetMetricsForOperation
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
Environment
path
string
OperationName
path
string
StartDate
query
string
EndDate
query
string
TimeZone
query
string
TimeInterval
query
string
Duration
query
string
ShowSummary
query
boolean
ShowIntervalData
query
boolean
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v72+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+jsonapplication/vnd.soa.v80+xmlapplication/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 )
}
PUT/apis/versions/{ApiVersionID}/implementations/{ImplCode}/services/{ServiceID}/endpointssaveServiceEndpoints
Parameters
Accepts application/json application/vnd.soa.v81+json
Name
Type
Description
Model
ApiVersionID
path
string
ImplCode
path
string
ServiceID
path
string
body
entity
Endpoints
Endpoints {
Endpoint {
ConnectionProperty {
Endpoint( Collection of Endpoint, required )
}
Endpoint {
BindingType( string )
ConnectionProperties( Collection of ConnectionProperty )
EndpointKey( string )
Uri( anyURI, required )
BindingQName( string )
}
ConnectionProperty {
Value( string, required )
Name( string, required )
}
Reponse
Produces application/jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
Endpoints
Endpoints {
Endpoint {
ConnectionProperty {
Endpoint( Collection of Endpoint )
}
Endpoint {
BindingType( string )
ConnectionProperties( Collection of ConnectionProperty )
EndpointKey( string )
Uri( anyURI )
BindingQName( string )
}
ConnectionProperty {
Value( string )
Name( string )
}
GET/apis/versions/{ApiVersionID}/implementations/{ImplCode}/services/{ServiceID}/endpointsgetServiceEndpoints
Parameters
Name
Type
Description
Model
ApiVersionID
path
string
ImplCode
path
string
ServiceID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
Endpoints
Endpoints {
Endpoint {
ConnectionProperty {
Endpoint( Collection of Endpoint )
}
Endpoint {
BindingType( string )
ConnectionProperties( Collection of ConnectionProperty )
EndpointKey( string )
Uri( anyURI )
BindingQName( string )
}
ConnectionProperty {
Value( string )
Name( string )
}
GET/apis/versions/{ApiVersionID}/environments/{Environment}/operations/{OperationName}/txlogsgetTxLogsForOperation
Parameters
Accepts */*
Name
Type
Description
Model
ApiVersionID
path
string
Environment
path
string
OperationName
path
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/jsonapplication/xmlapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+xmlapplication/vnd.soa.v81+json
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 )
}
