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
RatingSummary {
TargetResource {
Image {
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 {
APIDesign {
Descriptor {
Links {
TargetAPI {
APIVersionSettings {
APISettings {
Reponse
RatingSummary {
TargetResource {
Image {
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 {
APIDesign {
Descriptor {
Links {
TargetAPI {
APIVersionSettings {
APISettings {
POST/apiscreateAPI
Parameters
entry {
AddAPIImplementationRequest {
ExistingAssetImplementationRequest {
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
CloneImplementationRequest {
CloneAPIVersionRequest {
DLDescriptor {
DLURL {
ServiceDescriptorReference {
APIVersionInfo {
APIInfo {
Reponse
RatingSummary {
TargetResource {
Image {
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 {
APIDesign {
Descriptor {
Links {
TargetAPI {
APIVersionSettings {
APISettings {
GET/apislistAPISummaries
Parameters
Reponse
APIInfo {
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
Reponse
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
GET/apis/{ApiID}getAPI
Parameters
Reponse
RatingSummary {
TargetResource {
Image {
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 {
APIDesign {
Descriptor {
Links {
TargetAPI {
APIVersionSettings {
APISettings {
DELETE/apis/{ApiID}deleteAPI
Parameters
Reponse
PUT/apis/{ApiID}updateAPI
Parameters
RatingSummary {
TargetResource {
Image {
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 {
APIDesign {
Descriptor {
Links {
TargetAPI {
APIVersionSettings {
APISettings {
Reponse
RatingSummary {
TargetResource {
Image {
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 {
APIDesign {
Descriptor {
Links {
TargetAPI {
APIVersionSettings {
APISettings {
GET/apis/versionslistAPIVersions
Parameters
Reponse
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
GET/apis/isendpointuniqueisEndpointUnique
Parameters
Reponse
GET/apis/hostendpointslistHostingContainerEndpoints
Parameters
Reponse
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
GET/apis/servicesgetAPIImplementations
Parameters
Reponse
APIImplementation {
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
APIBinding {
BindingOperation {
HttpOperation {
Input {
Policy {
EndpointOAuthDetails {
OAuthTokenResourceURISettings {
OAuth20Settings {
OAuth10aSettings {
ServiceReference {
Endpoint {
ConnectionProperty {
APIInterface {
InterfaceOperation {
OperationOAuthDetails {
Operation {
OperationResourceDetails {
Resource {
GET/apis/versionslistAllAPIVersions
Parameters
Reponse
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 {
GET/apis/{APIID}/boardgetBoard
Parameters
Reponse
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
GET/apis/{ApiID}/settingsgetAPISettings
Parameters
Reponse
GET/apis/{ApiID}/versionsgetAPIVersions
Parameters
Reponse
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
POST/apis/{ApiID}/versionsaddAPIVersion
Parameters
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 {
Reponse
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 {
POST/apis/{ApiID}/versionscreateAPIVersion
Parameters
entry {
AddAPIImplementationRequest {
ExistingAssetImplementationRequest {
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
CloneImplementationRequest {
CloneAPIVersionRequest {
DLDescriptor {
DLURL {
ServiceDescriptorReference {
APIVersionInfo {
APIInfo {
Reponse
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 {
DELETE/apis/versions/{ApiVersionID}deleteAPIVersion
Parameters
Reponse
GET/apis/versions/{ApiVersionID}getAPIVersion
Parameters
Reponse
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 {
GET/apis/{APIID}/followersgetFollowers
Parameters
Reponse
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
POST/apis/{ApiID}/administratorsaddAPIAdministrator
Parameters
Reponse
GET/apis/{ApiID}/adminsgetAPIAdministrators
Parameters
Reponse
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
GET/apis/{ApiID}/packageexport
Parameters
Reponse
GET/apis/versions/autosettingsgetAutoConnectedAPIVersions
Parameters
Reponse
APIVersionAutoConnectDetail {
PUT/apis/versions/{ApiVersionID}updateAPIVersion
Parameters
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 {
Reponse
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 {
GET/apis/versions/implementationsfindAPIImplementations
Parameters
Reponse
APIImplementationInfo {
GET/apis/{ID}/avatargetDefaultAvatar
Parameters
Reponse
GET/apis/{ID}/previewavatarpreviewAvatar
Parameters
Reponse
POST/apis/{ID}/pictureupdateImage
Parameters
Reponse
DELETE/apis/{ID}/picturedeleteImage
Parameters
Reponse
GET/apis/{ID}/picturegetImage
Parameters
Reponse
GET/apis/versions/{ApiVersionID}/boardgetVersionBoard
Parameters
Reponse
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
GET/apis/versions/{ApiVersionID}/licensereportgetLicenseReport
Parameters
Reponse
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 {
GET/apis/versions/{ApiVersionID}/txlogsgetTxLogs
Parameters
Reponse
TransactionInfo {
GET/apis/versions/{ApiVersionID}/connectedappsgetConnectedApps
Parameters
Reponse
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
GET/apis/versions/{ApiVersionID}/contractslistContracts
Parameters
Reponse
Contract {
Policy {
ContractScope {
TargetResource {
Image {
Endpoint {
EndpointImplementationDetails {
GTMEndpoint {
DeploymentZoneEndpoint {
ConnectionProperty {
Scope {
GET/apis/versions/{ApiVersionID}/licensesgetAPILicenses
Parameters
Reponse
APILicense {
LicenseDetails {
LicensePartDetails {
Policy {
Resource {
AgreementDocument {
TargetResource {
Image {
Operation {
Input {
OperationOAuthDetails {
OperationResourceDetails {
GET/apis/versions/{ApiVersionID}/legalsgetLegals
Parameters
Reponse
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
GET/apis/versions/{ApiVersionID}/packageexportAPIVersion
Parameters
Reponse
PUT/apis/versions/{ApiVersionID}/oauthdetailssaveAPIOAuthDetailsSingleProvider
Parameters
EndpointsOAuthDetails {
EndpointOAuthDetails {
OAuthTokenResourceURISettings {
OAuth20Settings {
OAuth10aSettings {
OperationOAuthDetails {
Reponse
PUT/apis/versions/{ApiVersionID}/governingworkflowmodifyAPIVersionGoverningWorkflow
Parameters
Reponse
GET/apis/versions/{ApiVersionID}/contractsgetContractVersions
Parameters
Reponse
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
GET/apis/versions/{ApiVersionID}/resourcesgetOperationResources
Parameters
Reponse
Resource {
OperationResourceDetails {
PUT/apis/versions/{ApiVersionID}/autosettingssaveAPIAutoConnectSettings
Parameters
APIVersionAutoConnectDetail {
Reponse
APIVersionAutoConnectLicenseDetail {
License {
LicensePart {
AgreementDocument {
TargetResource {
Image {
POST/apis/versions/{ApiVersionID}/viewersinvitePrivateViewerWithScope
Parameters
Reponse
License {
LicensePart {
AgreementDocument {
TargetResource {
Image {
POST/apis/versions/{ApiVersionID}/actionexecuteWorkflowAction
Parameters
ActionParameter {
Reponse
DELETE/apis/{ApiID}/administrators/{UserID}removeAPIAdministrator
Parameters
Reponse
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
entry {
Reponse
PUT/apis/versions/{ApiVersionID}/designmodifyAPIVersionDesign
Parameters
DLURL {
ServiceDescriptorReference {
Reponse
RatingSummary {
TargetResource {
Image {
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 {
APIDesign {
Descriptor {
Links {
TargetAPI {
APIVersionSettings {
APISettings {
POST/apis/versions/{ApiVersionID}/legalscreateNewAgreement
Parameters
TargetResource {
Image {
Reponse
GET/apis/versions/{ApiVersionID}/swaggergetSwaggerResourceDocument
Parameters
Reponse
Model {
Operation {
ErrorResponse {
Parameter {
AllowableValue {
Api {
GET/apis/versions/{ApiVersionID}/settingsgetAPIVersionSettings
Parameters
Reponse
GET/apis/versions/{ApiVersionID}/scopegetAPIScopeVisibleToUser
Parameters
Reponse
License {
LicensePart {
AgreementDocument {
TargetResource {
Image {
Resource {
Operation {
Input {
OperationOAuthDetails {
OperationResourceDetails {
GET/apis/versions/{ApiVersionID}/designgetAPIVersionDesign
Parameters
Reponse
GET/apis/versions/{ApiVersionID}/autosettingsgetAPIAutoConnectSettings
Parameters
Reponse
APIVersionAutoConnectLicenseDetail {
License {
LicensePart {
AgreementDocument {
TargetResource {
Image {
PUT/apis/versions/{ApiVersionID}/oauthdetailssaveAPIOAuthDetails
Parameters
EndpointsOAuthDetailsList {
EndpointOAuthDetails {
OAuthTokenResourceURISettings {
OAuth20Settings {
OAuth10aSettings {
OperationOAuthDetails {
EndpointsOAuthDetails {
Reponse
POST/apis/versions/{ApiVersionID}/implementationsaddAPIImplementation
Parameters
ExistingAssetImplementationRequest {
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
CloneImplementationRequest {
Reponse
PUT/apis/versions/{ApiVersionID}/resourcessaveOperationResources
Parameters
OperationResource {
Reponse
Resource {
OperationResourceDetails {
PUT/apis/versions/{ApiVersionID}/infoupdateAPIVersionInfo
Parameters
Reponse
APIInfo {
GET/apis/versions/{ApiVersionID}/metricsgetMetrics
Parameters
Reponse
TestType {
SummaryType {
Metric {
IntervalType {
GeoLocationMetric {
GET/apis/versions/{ApiVersionID}/governingworkflowgetAPIVersionGoverningWorkflow
Parameters
Reponse
GET/apis/versions/{ApiVersionID}/viewersgetPrivateViewers
Parameters
Reponse
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
POST/apis/versions/{ID}/ratingsaddRating
Parameters
Reponse
GET/apis/{ID}/avatars/{version}.pnggetAvatar
Parameters
Reponse
GET/apis/versions/{ApiVersionID}/metrics/exportexportMetrics
Parameters
Reponse
GET/apis/versions/{ApiVersionID}/metrics/rangesgetRanges
Parameters
Reponse
TestType {
SummaryType {
Metric {
IntervalType {
GeoLocationMetric {
GET/apis/versions/{ApiVersionID}/txlogs/exportexportUsageLogs
Parameters
Reponse
GET/apis/versions/{ApiVersionID}/contracts/environmentsgetAPIVersionConnectionEnvironments
Parameters
Reponse
APIVersionConnectionEnvironment {
DELETE/apis/versions/{ApiVersionID}/legals/{LegalDocumentDN}deleteAgreementDocument
Parameters
Reponse
DELETE/apis/versions/{ApiVersionID}/viewers/{ViewerID}unInvitePrivateViewer
Parameters
Reponse
DELETE/apis/versions/{ApiVersionID}/implementations/{ImplCode}deleteAPIImplementation
Parameters
Reponse
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
APIBinding {
BindingOperation {
HttpOperation {
Input {
Policy {
EndpointOAuthDetails {
OAuthTokenResourceURISettings {
OAuth20Settings {
OAuth10aSettings {
ServiceReference {
Endpoint {
ConnectionProperty {
APIInterface {
InterfaceOperation {
OperationOAuthDetails {
Operation {
OperationResourceDetails {
Resource {
GET/apis/versions/{ApiVersionID}/swagger/{SwaggerPath}getSwaggerApiDocument
Parameters
Reponse
Model {
Operation {
ErrorResponse {
Parameter {
AllowableValue {
Api {
GET/apis/versions/{ApiVersionID}/txlogs/{TransactionID}getTransactionRecord
Parameters
Reponse
RequestMessage {
Message {
ResponseMessage {
FaultMessage {
NextHopInfo {
Timestamps {
TimePeriod {
PUT/apis/versions/{ApiVersionID}/viewers/{ViewerID}savePrivateViewerScope
Parameters
Reponse
License {
LicensePart {
AgreementDocument {
TargetResource {
Image {
POST/apis/versions/{ApiVersionID}/viewers/{ViewerID}invitePrivateViewer
Parameters
Reponse
GET/apis/versions/{ApiVersionID}/implementations/{ImplCode}getAPIImplementation
Parameters
Reponse
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
APIBinding {
BindingOperation {
HttpOperation {
Input {
Policy {
EndpointOAuthDetails {
OAuthTokenResourceURISettings {
OAuth20Settings {
OAuth10aSettings {
ServiceReference {
Endpoint {
ConnectionProperty {
APIInterface {
InterfaceOperation {
OperationOAuthDetails {
Operation {
OperationResourceDetails {
Resource {
DELETE/apis/versions/{ID}/ratings/{userID}deleteRating
Parameters
Reponse
PUT/apis/versions/{ID}/ratings/{userID}updateRating
Parameters
Reponse
GET/apis/versions/{ID}/ratings/summarygetRatingSummary
Parameters
Reponse
GET/apis/versions/{ID}/ratings/{userID}getRating
Parameters
Reponse
GET/apis/avatar/{version}{Extension:(/[^/]+?)*}getDefaultVersionedAvatar
Parameters
Reponse
PUT/apis/versions/{ApiVersionID}/legals/{LegalDocumentDN}/statemodifyLegalState
Parameters
TargetResource {
Image {
Reponse
PUT/apis/versions/{ApiVersionID}/implementations/{ImplCode}/deploymentsmodifyAPIImplementationDeployments
Parameters
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
Reponse
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
APIBinding {
BindingOperation {
HttpOperation {
Input {
Policy {
EndpointOAuthDetails {
OAuthTokenResourceURISettings {
OAuth20Settings {
OAuth10aSettings {
ServiceReference {
Endpoint {
ConnectionProperty {
APIInterface {
InterfaceOperation {
OperationOAuthDetails {
Operation {
OperationResourceDetails {
Resource {
GET/apis/versions/{ApiVersionID}/implementations/{ImplCode}/deploymentsuggestionsgetAPIImplementationDeploymentSuggestions
Parameters
Reponse
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
PUT/apis/versions/{ApiVersionID}/implementations/{ImplCode}/debugupdateAPIImplementationDebugOptions
Parameters
Reponse
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
IdentityMapType {
OutboundIdentityType {
Reponse
IdentityMapType {
OutboundIdentityType {
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
Reponse
IdentityMapType {
OutboundIdentityType {
PUT/apis/versions/{ApiVersionID}/implementations/{ImplCode}/policiesmodifyAPIImplementationPolicies
Parameters
Policy {
Reponse
Policy {
GET/apis/versions/{ApiVersionID}/implementations/{ImplCode}/policiesgetAPIImplementationPolicies
Parameters
Reponse
Policy {
PUT/apis/versions/{ApiVersionID}/legals/{LegalDocumentDN}/detailsmodifyLegalDetails
Parameters
TargetResource {
Image {
Reponse
GET/apis/versions/{ApiVersionID}/implementations/{ImplCode}/debuggetAPIImplementationDebugOptions
Parameters
Reponse
GET/apis/versions/{ApiVersionID}/viewers/{ViewerID}/scopegetPrivateViewerScope
Parameters
Reponse
License {
LicensePart {
AgreementDocument {
TargetResource {
Image {
PUT/apis/versions/{ApiVersionID}/implementations/{ImplCode}/infoupdateAPIImplementationInfo
Parameters
Reponse
GET/apis/versions/{ApiVersionID}/definition/{Specification}{IncludeDocId:(/[^/]+?)*}getAPIDocument
Parameters
Reponse
GET/apis/versions/{ApiVersionID}/implementations/{ImplCode}/services/{ServiceID}getServiceAsset
Parameters
Reponse
Endpoint {
ConnectionProperty {
Policy {
ServiceBinding {
BindingOperation {
HttpOperation {
Input {
GET/apis/versions/{ApiVersionID}/implementations/{ImplCode}/services/{ServiceID}/endpointsgetServiceEndpoints
Parameters
Reponse
Endpoint {
ConnectionProperty {
PUT/apis/versions/{ApiVersionID}/implementations/{ImplCode}/services/{ServiceID}/endpointssaveServiceEndpoints
Parameters
Endpoint {
ConnectionProperty {
Reponse
Endpoint {
ConnectionProperty {
GET/apis/versions/{ApiVersionID}/environments/{Environment}/operations/{OperationName}/metricsgetMetricsForOperation
Parameters
Reponse
TestType {
SummaryType {
Metric {
IntervalType {
GeoLocationMetric {
GET/apis/versions/{ApiVersionID}/environments/{Environment}/operations/{OperationName}/txlogsgetTxLogsForOperation
Parameters
Reponse
TransactionInfo {