API Contract Management
{ http://soa.com/wsdl/contract/1.0 } APIContractAPI
The Contracts service provides operations for managing API access contracts in the Akana API Platform.
POST/contractsrequestContract
Requests a new contract between a specific version of an app and a specific version of an API. Also used to revise a contract.
Revising an existing, active contract creates a new contract. However, there can only be one original contract and one revised
contract. An attempt to create a second revision will fail.
Authorization Roles/Permissions: App team member
Workflow: When a completely new contract is created (the first contract between a specific app version and a specific API
version in a specific environment), the @Create initial action is used to start the workflow for the new contract. When a contract
is revised, a new contract is created that is a revision of the existing contract, and the existing contract remains in place.
In this scenario, the @Revise initial action is used to start the workflow for the revised contract. When there is a revised
contract in place, any subsequent requests to create a contract for the app/API/environment combination will fail, since only
one revised contract is allowed at one time.
Sample Request
POST /api/contracts HTTP/1.1
Host: {hostname}
Accept: application/json
Content-Type: application/json
X-Csrf-Token_{tenant}: {TokenID}
{
"APIVersionID":"b49ef94a-3a4b-4cc4-b894-ef067d9a0de9.acmepaymentscorp",
"RuntimeID":"7J0w4Dy2BGN2QPUi6sFGlR6w.acmepaymentscorp",
"Environment":"Production",
"Policies":{
"Policy":[
{
"PolicyKey":"urn:uuid:a28e7b76-499c-11e4-bfe5-b1a96aa04935"
}
]
},
"ContractScope":{
"Restricted":true,
"LicenseID":[
"15d5d812-81e1-4d26-9597-e595b81b102f.acmepaymentscorp",
"e18cd5b6-93a6-4f30-b089-5ea374d2818d.acmepaymentscorp",
"104d523d-5d49-4bc3-b523-7de6725fcaae.acmepaymentscorp"
]
}
}
Sample Response
HTTP/1.1 200 OK
Date: Wed, 01 Oct 2014 00:00:00 GMT
Content-Type: application/json
{
"ContractID" : "3f548ac7-86ac-4881-8aec-bfa5b5e9f60d.acmepaymentscorp",
"APIVersionID" : "b49ef94a-3a4b-4cc4-b894-ef067d9a0de9.acmepaymentscorp",
"RuntimeID" : "2mWn90b8Y4C2vL7qCxDW8f38.acmepaymentscorp",
"Environment" : "Sandbox",
"State" : "apicontract.status.activated",
"ContractScope" : {
"Restricted" : false
},
"Updated" : "2014-10-01T19:38:20Z",
"UpdatedInMillis" : 1412192300000,
"Status" : "com.soa.apicontract.inforce"
}
Parameters
Accepts application/json application/xml 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
body
entity
Contract
Contract {
Policy {
ContractScope {
TargetResource {
Image {
Endpoint {
EndpointImplementationDetails {
GTMEndpoint {
DeploymentZoneEndpoint {
ConnectionProperty {
Scope {
Status( string )
Description( string )
Policies( Collection of Policy, required )
Updated( dateTime )
ContractScope( ContractScope, required )
PlanID( string, required )
ContractID( string )
APIVersionID( string, required )
Name( string )
TargetResources( Collection of TargetResource, required )
Endpoints( Collection of Endpoint, required )
Endpoint( string )
Scope( Scope, required )
State( string )
Environment( string )
RuntimeID( string, required )
UpdatedInMillis( long )
}
Policy {
PolicyType( string )
PolicyKey( string, required )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( string, required )
Name( string )
}
ContractScope {
Restricted( boolean )
LicenseID( 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 )
}
Endpoint {
Category( string, required )
EndpointImplementationDetails( EndpointImplementationDetails, required )
BindingType( string )
ConnectionProperties( Collection of ConnectionProperty )
ImplementationCode( string )
CName( string )
DeploymentZoneRule( string )
EndpointKey( string )
Uri( anyURI, required )
BindingQName( string )
}
EndpointImplementationDetails {
GTMEndpoint( GTMEndpoint, required )
DeploymentZoneEndpoint( DeploymentZoneEndpoint, required )
}
GTMEndpoint {
GTMInstanceID( string, required )
EndpointKey( string )
GTMType( string, 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 )
}
ConnectionProperty {
Value( string, required )
Name( string, required )
}
Scope {
Restricted( boolean )
LicenseID( Collection of 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.v1+jsonapplication/vnd.soa.v1+xmlapplication/vnd.soa.v81+xmlapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
Contract
Contract {
Policy {
ContractScope {
TargetResource {
Image {
Endpoint {
EndpointImplementationDetails {
GTMEndpoint {
DeploymentZoneEndpoint {
ConnectionProperty {
Scope {
Status( string )
Description( string )
Policies( Collection of Policy )
Updated( dateTime )
ContractScope( ContractScope )
PlanID( string )
ContractID( string )
APIVersionID( string )
Name( string )
TargetResources( Collection of TargetResource )
Endpoints( Collection of Endpoint )
Endpoint( string )
Scope( Scope )
State( string )
Environment( string )
RuntimeID( string )
UpdatedInMillis( long )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( string )
Name( string )
}
ContractScope {
Restricted( boolean )
LicenseID( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
Endpoint {
Category( string )
EndpointImplementationDetails( EndpointImplementationDetails )
BindingType( string )
ConnectionProperties( Collection of ConnectionProperty )
ImplementationCode( string )
CName( string )
DeploymentZoneRule( string )
EndpointKey( string )
Uri( anyURI )
BindingQName( string )
}
EndpointImplementationDetails {
GTMEndpoint( GTMEndpoint )
DeploymentZoneEndpoint( DeploymentZoneEndpoint )
}
GTMEndpoint {
GTMInstanceID( string )
EndpointKey( string )
GTMType( string )
}
DeploymentZoneEndpoint {
Path( string )
EndpointHostName( string )
Public( boolean )
ListenerName( string )
ContainerKey( string )
Url( string )
EndpointPath( string )
UseServiceIdentityForSNI( boolean )
GatewayHostPath( string )
DeploymentZoneID( string )
GatewayHostName( string )
BindingType( string )
EndpointKey( string )
Protocol( string )
BindingQName( string )
}
ConnectionProperty {
Value( string )
Name( string )
}
Scope {
Restricted( boolean )
LicenseID( Collection of string )
}
POST/contracts/{ContractID}requestAutoConnectContract
Parameters
Accepts application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+xml application/vnd.soa.v81+json
Name
Type
Description
Model
ContractID
path
string
body
entity
Contract
Contract {
Policy {
ContractScope {
TargetResource {
Image {
Endpoint {
EndpointImplementationDetails {
GTMEndpoint {
DeploymentZoneEndpoint {
ConnectionProperty {
Scope {
Status( string )
Description( string )
Policies( Collection of Policy, required )
Updated( dateTime )
ContractScope( ContractScope, required )
PlanID( string, required )
ContractID( string )
APIVersionID( string, required )
Name( string )
TargetResources( Collection of TargetResource, required )
Endpoints( Collection of Endpoint, required )
Endpoint( string )
Scope( Scope, required )
State( string )
Environment( string )
RuntimeID( string, required )
UpdatedInMillis( long )
}
Policy {
PolicyType( string )
PolicyKey( string, required )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( string, required )
Name( string )
}
ContractScope {
Restricted( boolean )
LicenseID( 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 )
}
Endpoint {
Category( string, required )
EndpointImplementationDetails( EndpointImplementationDetails, required )
BindingType( string )
ConnectionProperties( Collection of ConnectionProperty )
ImplementationCode( string )
CName( string )
DeploymentZoneRule( string )
EndpointKey( string )
Uri( anyURI, required )
BindingQName( string )
}
EndpointImplementationDetails {
GTMEndpoint( GTMEndpoint, required )
DeploymentZoneEndpoint( DeploymentZoneEndpoint, required )
}
GTMEndpoint {
GTMInstanceID( string, required )
EndpointKey( string )
GTMType( string, 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 )
}
ConnectionProperty {
Value( string, required )
Name( string, required )
}
Scope {
Restricted( boolean )
LicenseID( Collection of string )
}
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
Contract
Contract {
Policy {
ContractScope {
TargetResource {
Image {
Endpoint {
EndpointImplementationDetails {
GTMEndpoint {
DeploymentZoneEndpoint {
ConnectionProperty {
Scope {
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/contracts/{ContractID}getContract
Retrieves information about the specified contract.
Note: To get a list of contracts for a specific app or API you can use GET /api/apps/versions/{AppVersionID}/contracts or
GET /api/apis/versions/{APIVersionID}/contracts. This operation returns a specific contract. If you have the ContractID,
you can use this operation to get information about the contract.
Authorization Roles/Permissions: To complete this operation successfully, a user must be a member of the applicable team
(App team member or API Admin) or a Site Admin.
Sample Response
HTTP/1.1 200 OK
Content-Type: application/json
Date: Tue, 30 Sep 2014 00:00:00 GMT
{
"ContractID" : "6e56a1d4-308d-4269-a4d7-b47781664921.acmepaymentscorp",
"APIVersionID" : "b9ef39d6-5eb4-45dd-9a53-d126c83935d7.acmepaymentscorp",
"RuntimeID" : "5GeZHyOZUlk8ISehxqO2swA6.acmepaymentscorp",
"Environment" : "Production",
"State" : "apicontract.status.activated",
"ContractScope" : {
"Restricted" : true,
"LicenseID" : [ "0876cfb9-a308-4f24-a8b2-fc20493f0afb.acmepaymentscorp" ]
},
"Updated" : "2014-09-30T18:19:59Z",
"UpdatedInMillis" : 1412101199000,
"Status" : "com.soa.apicontract.inforce"
}
Parameters
Name
Type
Description
Model
ContractID
path
string
Reponse
Produces application/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
Contract
Contract {
Policy {
ContractScope {
TargetResource {
Image {
Endpoint {
EndpointImplementationDetails {
GTMEndpoint {
DeploymentZoneEndpoint {
ConnectionProperty {
Scope {
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 )
}
DELETE/contracts/{ContractID}deleteContract
Parameters
Accepts */*
Name
Type
Description
Model
ContractID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
PUT/contracts/{ContractID}updateContract
Updates information about an app/API contract.
Authorization Roles/Permissions: To complete this operation successfully, a user must be a member of the applicable team (App
team member or API Admin).
Sample Request
Accept: application/json
Content-Type: application/json
X-Csrf-Token_{tenant}: {TokenID}
{
"ContractID" : "6e56a1d4-308d-4269-a4d7-b47781664921.acmepaymentscorp",
"APIVersionID" : "b9ef39d6-5eb4-45dd-9a53-d126c83935d7.acmepaymentscorp",
"RuntimeID" : "5GeZHyOZUlk8ISehxqO2swA6.acmepaymentscorp",
"Environment" : "Production",
"State" : "apicontract.status.suspended",
"ContractScope" : {
"Restricted" : true,
"LicenseID" : [ "0876cfb9-a308-4f24-a8b2-fc20493f0afb.acmepaymentscorp" ]
},
"Status" : "com.soa.apicontract.inforce"
}
Sample Response
HTTP/1.1 200 OK
Content-Type: application/json
Date: Tue, 30 Sep 2014 00:00:00 GMT
{
"ContractID" : "6e56a1d4-308d-4269-a4d7-b47781664921.acmepaymentscorp",
"APIVersionID" : "b9ef39d6-5eb4-45dd-9a53-d126c83935d7.acmepaymentscorp",
"RuntimeID" : "5GeZHyOZUlk8ISehxqO2swA6.acmepaymentscorp",
"Environment" : "Production",
"State" : "apicontract.status.suspended",
"ContractScope" : {
"Restricted" : true,
"LicenseID" : [ "0876cfb9-a308-4f24-a8b2-fc20493f0afb.acmepaymentscorp" ]
}
}
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
ContractID
path
string
body
entity
Contract
Contract {
Policy {
ContractScope {
TargetResource {
Image {
Endpoint {
EndpointImplementationDetails {
GTMEndpoint {
DeploymentZoneEndpoint {
ConnectionProperty {
Scope {
Status( string )
Description( string )
Policies( Collection of Policy, required )
Updated( dateTime )
ContractScope( ContractScope, required )
PlanID( string, required )
ContractID( string )
APIVersionID( string, required )
Name( string )
TargetResources( Collection of TargetResource, required )
Endpoints( Collection of Endpoint, required )
Endpoint( string )
Scope( Scope, required )
State( string )
Environment( string )
RuntimeID( string, required )
UpdatedInMillis( long )
}
Policy {
PolicyType( string )
PolicyKey( string, required )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( string, required )
Name( string )
}
ContractScope {
Restricted( boolean )
LicenseID( 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 )
}
Endpoint {
Category( string, required )
EndpointImplementationDetails( EndpointImplementationDetails, required )
BindingType( string )
ConnectionProperties( Collection of ConnectionProperty )
ImplementationCode( string )
CName( string )
DeploymentZoneRule( string )
EndpointKey( string )
Uri( anyURI, required )
BindingQName( string )
}
EndpointImplementationDetails {
GTMEndpoint( GTMEndpoint, required )
DeploymentZoneEndpoint( DeploymentZoneEndpoint, required )
}
GTMEndpoint {
GTMInstanceID( string, required )
EndpointKey( string )
GTMType( string, 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 )
}
ConnectionProperty {
Value( string, required )
Name( string, required )
}
Scope {
Restricted( boolean )
LicenseID( Collection of 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.v1+jsonapplication/vnd.soa.v1+xmlapplication/vnd.soa.v81+xmlapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
Contract
Contract {
Policy {
ContractScope {
TargetResource {
Image {
Endpoint {
EndpointImplementationDetails {
GTMEndpoint {
DeploymentZoneEndpoint {
ConnectionProperty {
Scope {
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/contracts/reserveIDgetNewReserveContractDN
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/contracts/{ContractID}/appdetailsgetContractAppDetails
Parameters
Name
Type
Description
Model
ContractID
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
ContractApplication
ContractApplication {
ApplicationVersion {
RatingSummary {
AppVersionSettings {
TargetResource {
Image {
entry {
Application {
AppSettings {
ApplicationVersion( ApplicationVersion )
Application( Application )
}
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 )
}
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 )
}
GET/contracts/{ContractID}/apidetailsgetContractAPIDetails
Parameters
Name
Type
Description
Model
ContractID
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
ContractAPI
ContractAPI {
APIVersion {
APIVersionResourceDetails {
Resource {
OperationResourceDetails {
Policy {
EndpointOAuthDetails {
OAuthTokenResourceURISettings {
OAuth20Settings {
OAuth10aSettings {
APIImplementation {
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
APIBinding {
BindingOperation {
HttpOperation {
Input {
ServiceReference {
Endpoint {
ConnectionProperty {
APIInterface {
InterfaceOperation {
OperationOAuthDetails {
Operation {
entry {
stringArray {
RatingSummary {
APIDesign {
TargetResource {
Image {
Descriptor {
Links {
TargetAPI {
APIVersionSettings {
API {
APISettings {
APIVersion( APIVersion )
API( API )
}
APIVersion {
DefaultProfile( string )
APIVersionResourceDetails( APIVersionResourceDetails )
Description( string )
Policies( Collection of Policy )
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 )
}
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 )
}
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 )
}
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 )
Policies( Collection of Policy )
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 )
}
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 )
}
PUT/contracts/{ContractDN}/scopesaveContractScope
Parameters
Accepts application/json application/xml 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
ContractDN
path
string
body
entity
ContractScope
ContractScope {
Restricted( boolean )
LicenseID( string, required )
}
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
Contract
Contract {
Policy {
ContractScope {
TargetResource {
Image {
Endpoint {
EndpointImplementationDetails {
GTMEndpoint {
DeploymentZoneEndpoint {
ConnectionProperty {
Scope {
Status( string )
Description( string )
Policies( Collection of Policy )
Updated( dateTime )
ContractScope( ContractScope )
PlanID( string )
ContractID( string )
APIVersionID( string )
Name( string )
TargetResources( Collection of TargetResource )
Endpoints( Collection of Endpoint )
Endpoint( string )
Scope( Scope )
State( string )
Environment( string )
RuntimeID( string )
UpdatedInMillis( long )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( string )
Name( string )
}
ContractScope {
Restricted( boolean )
LicenseID( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
Endpoint {
Category( string )
EndpointImplementationDetails( EndpointImplementationDetails )
BindingType( string )
ConnectionProperties( Collection of ConnectionProperty )
ImplementationCode( string )
CName( string )
DeploymentZoneRule( string )
EndpointKey( string )
Uri( anyURI )
BindingQName( string )
}
EndpointImplementationDetails {
GTMEndpoint( GTMEndpoint )
DeploymentZoneEndpoint( DeploymentZoneEndpoint )
}
GTMEndpoint {
GTMInstanceID( string )
EndpointKey( string )
GTMType( string )
}
DeploymentZoneEndpoint {
Path( string )
EndpointHostName( string )
Public( boolean )
ListenerName( string )
ContainerKey( string )
Url( string )
EndpointPath( string )
UseServiceIdentityForSNI( boolean )
GatewayHostPath( string )
DeploymentZoneID( string )
GatewayHostName( string )
BindingType( string )
EndpointKey( string )
Protocol( string )
BindingQName( string )
}
ConnectionProperty {
Value( string )
Name( string )
}
Scope {
Restricted( boolean )
LicenseID( Collection of string )
}
POST/contracts/{ContractDN}/actionsexecuteWorkflowAction
Executes workflow actions associated with a specific change of contract status.
Authorization Roles/Permissions: To complete this operation successfully, a user must be a member of the applicable team
(App team member or API Admin). However, the workflow itself might enforce additional requirements:
- The specific workflow action to be executed must be valid for the specific contract the action will be performed on.
- In addition, each action might require its own conditions. Some workflow actions can only be performed by an API Admin, some by an app admin, and so forth. Depending on the combination of action name and ContractID, this operation might require different roles. For example, Activate can only be done by an API admin or business admin; Resubmit can be done by app team members or API admins. Custom workflow definitions could require different roles for different actions.
Sample Request
POST /api/contracts/contract25519.acmepaymentscorp/actions HTTP/1.1
Host: {hostname}
Accept: */*
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_{tenant}: {TokenID}
{
"ActionName":"apicontract.action.activate",
"Comments":"Granting production access (activating)."
}
Sample Response
HTTP/1.1 200 OK
Content-Type: text/plain
Date: Wed, 10 Jul 2013 19:57:49 GMT
apicontract.status.activated
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+xml application/vnd.soa.v81+json
Name
Type
Description
Model
ContractDN
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
GET/contracts/{ContractDN}/packageexport
Exports a specific app/API contract.
Authorization Roles/Permissions: To complete this operation successfully, a user must be a member of the applicable
team (App team member or API Admin) or a Site Admin or Business Admin.
The response content is sent as the export file named in the Content-Disposition header.
Sample Request
GET /api/contracts/{contract}/package?migration.export.include.apis=true&migration.export.include.apps=true&migration.export.include.licenses=true&migration.qospolicy.export=true&download=true&wrapInHTML=true HTTP/1.1
Host: {hostname}
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
X-Csrf-Token_{tenant}: {TokenID}
Additional Query Parameters
The following query parameters are optional.
download (string) If set to true (the default), the content is downloaded. If set to false, the user is prompted for content disposition
migration.export.include.apps (boolean) If specified with a true value, apps are included in the export file
migration.export.include.apis (boolean) If specified with a true value, APIs are included in the export file
migration.export.include.licenses (boolean) If specified with a true value, Licenses are included in the export file
migration.qospolicy.export (boolean) If specified with a true value, Quality of Service policies are included in the export file
Sample Response
HTTP/1.1 200 OK
Content-Type: application/octet-stream
Content-Disposition: attachment;filename=apicontract-export.zip
Parameters
Name
Type
Description
Model
ContractDN
path
string
Reponse
Produces application/octet-stream
Status Code
Reason
Model
200
Success
any
