GET /api/apis/versions/{APIVersionID}
Returns information about the specified API version.
Note: If the API version has only one implementation, this operation returns information for that implementation. If there are two implementations, it returns information for the Live implementation.
Authorization Roles/Permissions: Must have Read permission for the resource.
This topic includes the following sections:
HTTP Method
GET
URL
https://{hostname}/api/apis/versions/{APIVersionID}[?][includeTargetAPI=boolean]&[includeOperations={Boolean}]
&[includeTargetAPI={Boolean}]&[includeSettings={Boolean}]&[ContractID={ContractID}]&[includeTargetResources={Boolean}]
Sample Request
The examples below show requests for specific API version information.
Sample request URL #1
Shows a request for API version information, without optional parameters. For the response, see Sample response #1: Without optional parameters below.
https://{hostname}/api/apis/versions/afd904fd-f81e-4d0c-9fbc-f9e40efb178e.acmepaymentscorp
Sample request URL #2
Includes the optional includeOperations parameter. For the response, see Sample response #2: With optional includeOperations parameter below.
https://{hostname}/api/apis/versions/8205b5a9-0bea-4ae3-907b-d48f0b2336c7.acmepaymentscorp?includeOperations=true
Sample request headers
GET /api/apis/versions/8205b5a9-0bea-4ae3-907b-d48f0b2336c7.acmepaymentscorp HTTP/1.1
Host: {hostname}
Accept: application/json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...
Sample request body
Not applicable.
Request Headers
For general information on request header values, refer to HTTP Request Headers.
| Header | Description |
|---|---|
| Accept | application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json, application/vnd.soa.v2019+json |
| Cookie | AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies. |
| X-Csrf-Token_{fedmemberID} | The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login. |
Request Parameters
| Parameter | Parm Type | Data Type | Required | Description |
|---|---|---|---|---|
| APIVersionID | Path | string | Required | The unique ID for a specific API version. |
| includeOperations | Query | boolean | Optional | Default: false. If set to true, operations associated with the API version are included in the response. See example. |
| IncludeEndpoints | Query | boolean | Optional | Indicates whether endpoints for the API version should be included in the response. If not specified, defaults to false. |
| includeTargetAPI | Query | boolean | Optional | If set to true, Target API, if applicable, is returned. Default: false. |
| IncludeSettings | Query | boolean | Optional | Indicates whether the settings for the resource should be included in the response. If not specified, defaults to false. |
| ContractID | Query | string | Optional | The unique ID for a specific contract between an app version and an API version. |
| includeTargetResources | Query | boolean | Optional | Default: false. If set to true, information about the API is included in the response, since the API is a resource associated with the API version. |
Response
If successful, this operation returns HTTP status code 200, with information about the specified API version.
Sample Response
Examples below:
- Sample response #1: Without optional parameters
- Sample response #2: Includes the optional includeOperations parameter
- Sample response #3: Multiple OAuth providers
Sample response #1: Without optional parameters
The sample response below shows the response information for sample request #1 above (without optional parameters).
Sample response headers
HTTP/1.1 200 OK Date: Wed, 18 Aug 2021 18:43:33 GMT Content-Type: application/json
Sample response body
{
"APIVersionID":"73564f84-9eb0-4ab7-84fd-ac4f4c953185.rcoaless",
"APIID":"76c31da0-2b77-4e20-9c3c-96335e8da31d.rcoaless",
"Name":"Version 2 (Private, Live)",
"Description":"",
"Environment":"Production",
"Tag":[
"finance",
"private",
"acmepaymentscorp"
],
"Visibility":"Limited",
"Created":"2021-08-18T18:18:34Z",
"Updated":"2021-08-18T18:20:16Z",
"State":"com.soa.api.state.open",
"ProductionEndpointAccessAutoApproved":true,
"SandboxEndpointAccessAutoApproved":false,
"RatingSummary":{
"Five":0,
"Four":0,
"Three":0,
"Two":0,
"One":0
},
"SandboxAnonymousAccessAllowed":false,
"ProductionAnonymousAccessAllowed":true,
"ResourceLevelPermissionsSupported":false,
"APIOwnedImplementations":true,
"ProductionServiceKey":"uddi:fa45eac3-088d-477a-8cdd-2da7291e844c",
"APIDesign":{
"BindingType":[
"binding.http"
],
"CommonDesign":true,
"DesignServiceKey":"uddi:908b8764-342a-4b3d-9dc3-19790100269f"
},
"Links":[
{
"rel":"design",
"href":"/api/apis/versions/73564f84-9eb0-4ab7-84fd-ac4f4c953185.rcoaless/design?specification=swagger2",
"type":"GET",
"title":"Swagger2"
},
{
"rel":"design",
"href":"/api/apis/versions/73564f84-9eb0-4ab7-84fd-ac4f4c953185.rcoaless/design?specification=oas3",
"type":"GET",
"title":"OAS3"
}
]
}
Sample Response #2: With optional includeOperations parameter
Example from version: 2020.2.0
The sample response below (response to sample request URL #2) shows API version information for a subset of the Swagger Petstore API (http://petstore.swagger.io/), set up on the platform. In this example, the request message included the optional includeOperations parameter, so information about the operations is in the response.
Sample response headers
Status Code: 200 OK Content-Type: application/vnd.soa.v81+json Date: Thu, 19 Nov 2020 15:36:53 GMT
Sample response body
{
"APIVersionID":"4a1a513f-2758-48a9-8103-d869793e2ac8.acmepaymentscorp",
"APIID":"38f286d3-9628-47fd-bf6a-bc6f2ebd72ef.acmepaymentscorp",
"Name":"v1",
"Description":"Swagger_Petstore_5_Operations. Based on http://petstore.swagger.io/v2/swagger.json with deletions in API Designer.",
"Environment":"Production",
"Type":"shttp",
"Tag":[
"pet",
"store",
"user"
],
"ProductionEndpoint":"http://10.250.24.112:7905/api10083live",
"Operations":{
"Operation":[
{
"Name":"addPet",
"Method":"POST",
"Path":"/pet",
"InputContentType":"application/xml,application/json",
"OutputContentType":"application/xml,application/json",
"FaultContentType":"",
"Input":[
{
"Name":"body",
"Type":"entity"
}
],
"OperationKey":"4f30020e-5304-4f6e-a9cb-8a986caecde8",
"InterfaceQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0",
"WsdlOperationName":"addPet"
},
{
"Name":"findPetsByStatus",
"Method":"GET",
"Path":"/pet/findByStatus",
"InputContentType":"",
"OutputContentType":"application/xml,application/json",
"FaultContentType":"",
"Input":[
{
"Name":"status",
"Type":"query"
}
],
"OperationKey":"d45d2614-9f22-4cc0-893e-10c0b4338d5f",
"InterfaceQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0",
"WsdlOperationName":"findPetsByStatus"
}
]
},
"Endpoints":{
"Endpoint":[
{
"Category":"Production",
"Uri":"http://10.250.24.112:7905/api10083live",
"CName":"10.250.24.112",
"DeploymentZoneRule":"690f-8a53-4a53-a774-9df79ca961b2default-http0",
"ConnectionProperties":[
{
"Name":"virtualHost",
"Value":"10.250.24.112"
},
{
"Name":"gateway_hostname",
"Value":"10.250.24.112"
},
{
"Name":"visibility",
"Value":"public"
}
],
"BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0",
"BindingType":"binding.http",
"EndpointKey":"uddi:a78a8f48-7041-4ee6-a4ca-1ccd32550bac",
"EndpointImplementationDetails":{
"DeploymentZoneEndpoint":{
"DeploymentZoneID":"079d6161-5d70-481a-8421-7d33f276cd60.acmepaymentscorp",
"EndpointKey":"uddi:a78a8f48-7041-4ee6-a4ca-1ccd32550bac",
"ListenerName":"default-http0",
"ContainerKey":"690f-8a53-4a53-a774-9df79ca961b2",
"GatewayHostName":"10.250.24.112",
"GatewayHostPath":"/",
"EndpointHostName":"10.250.24.112",
"EndpointPath":"/api10083live",
"Protocol":"http",
"Path":"/api10083live",
"Url":"http://10.250.24.112:7905/api10083live",
"BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0",
"BindingType":"binding.http",
"Public":true
}
},
"ImplementationCode":"Live"
}
]
},
"Visibility":"Public",
"Created":"2020-11-20T14:07:54Z",
"Updated":"2020-11-20T14:24:41Z",
"State":"com.soa.api.state.open",
"ProductionEndpointAccessAutoApproved":true,
"SandboxEndpointAccessAutoApproved":false,
"RatingSummary":{
"Five":0,
"Four":0,
"Three":0,
"Two":0,
"One":0
},
"SandboxAnonymousAccessAllowed":false,
"ProductionAnonymousAccessAllowed":true,
"ResourceLevelPermissionsSupported":false,
"APIOwnedImplementations":true,
"ProductionServiceKey":"uddi:3c58a95d-5446-4458-a109-08cc0423a621",
"APIImplementations":{
"APIImplementation":[
{
"Environment":"Production",
"Name":"Swagger_Petstore_5_Operations_v1_Live",
"ImplementationCode":"Live",
"Description":"Swagger_Petstore_5_Operations. Based on http://petstore.swagger.io/v2/swagger.json with deletions in API Designer.",
"Pattern":"com.akana.pattern.proxy",
"ServiceKey":"uddi:3c58a95d-5446-4458-a109-08cc0423a621",
"APIBindings":{
"APIBinding":[
{
"BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0",
"BindingKey":"uddi:6d615e18-8633-144f-f525-a20e8f8b0c89",
"InterfaceQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0",
"InterfaceKey":"uddi:03bed5c1-1db4-4cd1-b4d9-70c828cd3c69",
"BindingType":"binding.http",
"BindingOperations":{
"BindingOperation":[
{
"OperationName":"addPet",
"WsdlOperationName":"addPet",
"HttpOperation":{
"Method":"POST",
"Path":"/pet",
"InputContentType":"application/xml,application/json",
"OutputContentType":"application/xml,application/json",
"FaultContentType":"",
"Input":[
{
"Name":"body",
"Type":"entity"
}
]
}
},
{
"OperationName":"findPetsByStatus",
"WsdlOperationName":"findPetsByStatus",
"HttpOperation":{
"Method":"GET",
"Path":"/pet/findByStatus",
"InputContentType":"",
"OutputContentType":"application/xml,application/json",
"FaultContentType":"",
"Input":[
{
"Name":"status",
"Type":"query"
}
]
}
}
]
}
}
]
},
"APIInterfaces":{
"APIInterface":[
{
"InterfaceQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0",
"InterfaceKey":"uddi:03bed5c1-1db4-4cd1-b4d9-70c828cd3c69",
"InterfaceOperations":{
"InterfaceOperation":[
{
"OperationName":"addPet",
"WsdlOperationName":"addPet"
},
{
"OperationName":"findPetsByStatus",
"WsdlOperationName":"findPetsByStatus"
}
]
}
}
]
},
"Endpoints":{
"Endpoint":[
{
"Category":"Production",
"Uri":"http://10.250.24.112:7905/api10083live",
"CName":"10.250.24.112",
"DeploymentZoneRule":"690f-8a53-4a53-a774-9df79ca961b2default-http0",
"ConnectionProperties":[
{
"Name":"virtualHost",
"Value":"10.250.24.112"
},
{
"Name":"gateway_hostname",
"Value":"10.250.24.112"
},
{
"Name":"visibility",
"Value":"public"
}
],
"BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0",
"BindingType":"binding.http",
"EndpointKey":"uddi:a78a8f48-7041-4ee6-a4ca-1ccd32550bac",
"EndpointImplementationDetails":{
"DeploymentZoneEndpoint":{
"DeploymentZoneID":"079d6161-5d70-481a-8421-7d33f276cd60.acmepaymentscorp",
"EndpointKey":"uddi:a78a8f48-7041-4ee6-a4ca-1ccd32550bac",
"ListenerName":"default-http0",
"ContainerKey":"690f-8a53-4a53-a774-9df79ca961b2",
"GatewayHostName":"10.250.24.112",
"GatewayHostPath":"/",
"EndpointHostName":"10.250.24.112",
"EndpointPath":"/api10083live",
"Protocol":"http",
"Path":"/api10083live",
"Url":"http://10.250.24.112:7905/api10083live",
"BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0",
"BindingType":"binding.http",
"Public":true
}
},
"ImplementationCode":"Live"
}
]
},
"Policies":{
"Policy":[
{
"PolicyKey":"acmepaymentscorp-AtmosphereApplicationSecurityPolicy",
"Name":"AtmosphereApplicationSecurityPolicy",
"Description":"",
"PolicyType":"Operational Policy",
"PolicySubType":"policy.apisec"
}
]
},
"APIImplementationDeployments":{
"DeploymentZonesHostingInfo":[
{
"DeploymentZoneID":"079d6161-5d70-481a-8421-7d33f276cd60.acmepaymentscorp",
"DeploymentZoneEndpoint":[
{
"DeploymentZoneID":"079d6161-5d70-481a-8421-7d33f276cd60.acmepaymentscorp",
"EndpointKey":"uddi:a78a8f48-7041-4ee6-a4ca-1ccd32550bac",
"ListenerName":"default-http0",
"ContainerKey":"690f-8a53-4a53-a774-9df79ca961b2",
"GatewayHostName":"10.250.24.112",
"GatewayHostPath":"/",
"EndpointHostName":"10.250.24.112",
"EndpointPath":"/api10083live",
"Protocol":"http",
"Path":"/api10083live",
"Url":"http://10.250.24.112:7905/api10083live",
"BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0",
"BindingType":"binding.http",
"Public":true
}
]
}
]
},
"Operations":{
"Operation":[
{
"Name":"addPet",
"OperationKey":"4f30020e-5304-4f6e-a9cb-8a986caecde8",
"InterfaceQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0",
"WsdlOperationName":"addPet"
},
{
"Name":"findPetsByStatus",
"OperationKey":"d45d2614-9f22-4cc0-893e-10c0b4338d5f",
"InterfaceQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0",
"WsdlOperationName":"findPetsByStatus"
}
]
},
"AnonymousAccessAllowed":true,
"EndpointAccessAutoApproved":true,
"ProxyImplementationDetails":{
"ProxiedService":{
"ServiceKey":"uddi:55672d61-0b0a-4fcc-891f-ecd6fc0cabb3",
"ServiceName":"Swagger_Petstore_5_Operations_v1_Live_Target",
"OrganizationKey":"uddi:988986fc-ae6a-4994-85fb-8eec32fb4599",
"Endpoints":{
"Endpoint":[
{
"Uri":"HTTP://api577172live.gateway.akana.com:80/",
"ConnectionProperties":[
],
"BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0",
"BindingType":"binding.http",
"EndpointKey":"uddi:d374a3b8-662a-4d0f-aa55-49330790f22b"
},
{
"Uri":"HTTPS://api577172live.gateway.akana.com:80/",
"ConnectionProperties":[
],
"BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0",
"BindingType":"binding.http",
"EndpointKey":"uddi:5ebc854f-42fa-41af-a810-43444e91e6ab"
}
]
}
}
}
}
]
},
"APIDesign":{
"BindingType":[
"binding.http"
],
"CommonDesign":true,
"DesignServiceKey":"uddi:cdd5b591-fd75-48db-99cd-941eb7186c08"
},
"Links":[
{
"rel":"design",
"href":"/api/apis/versions/4a1a513f-2758-48a9-8103-d869793e2ac8.acmepaymentscorp/design?specification=swagger2",
"type":"GET",
"title":"Swagger2"
},
{
"rel":"design",
"href":"/api/apis/versions/4a1a513f-2758-48a9-8103-d869793e2ac8.acmepaymentscorp/design?specification=oas3",
"type":"GET",
"title":"OAS3"
}
]
}
Sample Response #3: Multiple OAuth providers
The sample response below shows API version information when there are multiple OAuth providers set up for the API.
Sample response body
{
"APIVersionID" : "a7ece9ef-e4cd-4bac-9868-31fde66c516e.acmepaymentscorp",
"APIID" : "09e0e3b0-066e-4122-990c-e3ca325282e7.acmepaymentscorp",
"Name" : "v1",
"Description" : "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.",
"Environment" : "Production",
"Type" : "shttp",
"Tag" : [ ],
"ProductionEndpoint" : "http://api10069live.localhost:7901/",
"SandboxEndpoint" : "http://api10069sandbox.localhost:7901/",
"ProductionEndpointOAuthDetailsList" : [ {
"OAuthProvider" : "Oauth1",
"OAuth10aSupported" : true,
"OAuth20Supported" : true,
"Resource" : [ "Scope1", "profile" ]
}, {
"OAuthProvider" : "OAuth2",
"OAuth10aSupported" : true,
"OAuth20Supported" : true,
"Resource" : [ "Scope1", "profile" ]
}, {
"OAuthProvider" : "Okta",
"OAuth10aSupported" : false,
"OAuth20Supported" : true,
"Resource" : [ "Scope1", "profile" ]
}, {
"OAuthProvider" : "com.soa.oauth.provider.third-party",
"OAuth20Settings" : {
"AuthorizationEndpointURL" : "http://google.com",
"TokenEndpointURL" : "http://google.coma",
"TokenEndpointRequestVerb" : "POST",
"BearerTokenMethods" : {
"BearerTokenMethod" : [ "com.soa.oauth.bearer.token.method.auz.header", "com.soa.oauth.bearer.token.method.form.param", "com.soa.oauth.bearer.token.method.url.query.param" ]
}
},
"OAuthTokenResourceURISettings" : {
"OAuthTokenResourceURIOption" : "com.soa.oauth.token.resource.uri.proxy.url"
},
"SupportedGrant" : [ "authorization_code", "client_credentials" ],
"ClientAuthPolicyOption" : [ "com.soa.oauth.client.public" ],
"OAuth10aSupported" : true,
"OAuth10aSettings" : {
"RequestTokenEndpointURL" : "http://google.comb",
"AuthorizationEndpointURL" : "http://google.comc",
"AccessTokenEndpointURL" : "http://google.comd",
"TokenEndpointRequestVerb" : "POST",
"TokenParameterTransmissionMethods" : {
"TokenParameterTransmissionMethod" : [ "com.soa.oauth.token.parameter.transmission.method.header", "com.soa.oauth.token.parameter.transmission.method.post", "com.soa.oauth.token.parameter.transmission.method.querystring" ]
}
},
"OAuth20Supported" : true,
"Resource" : [ "Scope1", "profile" ],
"AuthorizationEndpointParameters" : {
"Parameter" : [ "abc", "def" ]
},
"TokenEndpointParameters" : {
"Parameter" : [ "ghi" ]
}
} ],
"SandboxEndpointOAuthDetailsList" : [ {
"OAuthProvider" : "Oauth1",
"OAuth10aSupported" : true,
"OAuth20Supported" : true,
"Resource" : [ "Scope1", "profile" ]
}, {
"OAuthProvider" : "OAuth2",
"OAuth10aSupported" : true,
"OAuth20Supported" : true,
"Resource" : [ "Scope1", "profile" ]
}, {
"OAuthProvider" : "Okta",
"OAuth10aSupported" : false,
"OAuth20Supported" : true,
"Resource" : [ "Scope1", "profile" ]
}, {
"OAuthProvider" : "com.soa.oauth.provider.third-party",
"OAuth20Settings" : {
"AuthorizationEndpointURL" : "http://google.com",
"TokenEndpointURL" : "http://google.coma",
"TokenEndpointRequestVerb" : "POST",
"BearerTokenMethods" : {
"BearerTokenMethod" : [ "com.soa.oauth.bearer.token.method.auz.header", "com.soa.oauth.bearer.token.method.form.param", "com.soa.oauth.bearer.token.method.url.query.param" ]
}
},
"OAuthTokenResourceURISettings" : {
"OAuthTokenResourceURIOption" : "com.soa.oauth.token.resource.uri.proxy.url"
},
"SupportedGrant" : [ "authorization_code", "client_credentials" ],
"ClientAuthPolicyOption" : [ "com.soa.oauth.client.public" ],
"OAuth10aSupported" : true,
"OAuth10aSettings" : {
"RequestTokenEndpointURL" : "http://google.comb",
"AuthorizationEndpointURL" : "http://google.comc",
"AccessTokenEndpointURL" : "http://google.comd",
"TokenEndpointRequestVerb" : "POST",
"TokenParameterTransmissionMethods" : {
"TokenParameterTransmissionMethod" : [ "com.soa.oauth.token.parameter.transmission.method.header", "com.soa.oauth.token.parameter.transmission.method.post", "com.soa.oauth.token.parameter.transmission.method.querystring" ]
}
},
"OAuth20Supported" : true,
"Resource" : [ "Scope1", "profile" ],
"AuthorizationEndpointParameters" : {
"Parameter" : [ "abc", "def" ]
},
"TokenEndpointParameters" : {
"Parameter" : [ "ghi" ]
}
} ],
"Operations" : {
"Operation" : [ {
"Name" : "getPetById",
"Method" : "GET",
"Path" : "/pet/{petId}",
"InputContentType" : "*/*",
"OutputContentType" : "application/json,application/xml",
"FaultContentType" : "",
"Input" : [ {
"Name" : "petId",
"Type" : "path"
} ],
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"WsdlOperationName" : "getPetById"
}, {
"Name" : "updatePetWithForm",
"Method" : "POST",
"Path" : "/pet/{petId}",
"InputContentType" : "application/x-www-form-urlencoded",
"OutputContentType" : "application/json,application/xml",
"FaultContentType" : "",
"Input" : [ {
"Name" : "petId",
"Type" : "path"
}, {
"Name" : "name",
"Type" : "form"
}, {
"Name" : "status",
"Type" : "form"
} ],
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"WsdlOperationName" : "updatePetWithForm"
}, {
"Name" : "deletePet",
"Method" : "DELETE",
"Path" : "/pet/{petId}",
"InputContentType" : "*/*",
"OutputContentType" : "*/*",
"FaultContentType" : "",
"Input" : [ {
"Name" : "petId",
"Type" : "path"
} ],
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"WsdlOperationName" : "deletePet"
}, {
"Name" : "findPetsByStatus",
"Method" : "GET",
"Path" : "/pet/findByStatus",
"InputContentType" : "*/*",
"OutputContentType" : "application/json,application/xml",
"FaultContentType" : "",
"Input" : [ {
"Name" : "status",
"Type" : "query"
} ],
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"WsdlOperationName" : "findPetsByStatus"
}, {
"Name" : "updatePet",
"Method" : "PUT",
"Path" : "/pet/",
"InputContentType" : "application/json,application/xml",
"OutputContentType" : "application/json,application/xml",
"FaultContentType" : "",
"Input" : [ {
"Name" : "body",
"Type" : "entity"
} ],
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"WsdlOperationName" : "updatePet"
}, {
"Name" : "addPet",
"Method" : "POST",
"Path" : "/pet/",
"InputContentType" : "application/json,application/xml",
"OutputContentType" : "application/json,application/xml",
"FaultContentType" : "",
"Input" : [ {
"Name" : "body",
"Type" : "entity"
} ],
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"WsdlOperationName" : "addPet"
}, {
"Name" : "findPetsByTags",
"Method" : "GET",
"Path" : "/pet/findByTags",
"InputContentType" : "*/*",
"OutputContentType" : "application/json,application/xml",
"FaultContentType" : "",
"Input" : [ {
"Name" : "tags",
"Type" : "query"
} ],
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"WsdlOperationName" : "findPetsByTags"
} ]
},
"Endpoints" : {
"Endpoint" : [ {
"CName" : "api10069live.localhost",
"Category" : "Production",
"Uri" : "http://api10069live.localhost:7901/",
"DeploymentZoneRule" : "21e6a509-1a41-411f-a82c-395bb969default-http0",
"ConnectionProperties" : [ {
"Name" : "virtualHost",
"Value" : "api10069live.localhost"
}, {
"Name" : "gateway_hostname",
"Value" : "api10069live.localhost"
}, {
"Name" : "visibility",
"Value" : "public"
} ],
"BindingQName" : "{PetAPI_1.0.0}PetAPI_Binding_0",
"BindingType" : "binding.http",
"EndpointKey" : "uddi:b5668760-a748-11e9-ba71-d0c88adc4934",
"EndpointImplementationDetails" : {
"DeploymentZoneEndpoint" : {
"DeploymentZoneID" : "21e6a509-1a41-411f-a82c-395bb969.acmepaymentscorp",
"EndpointKey" : "uddi:b5668760-a748-11e9-ba71-d0c88adc4934",
"ListenerName" : "default-http0",
"ContainerKey" : "21e6a509-1a41-411f-a82c-395bb969",
"GatewayHostName" : "api10069live.localhost",
"GatewayHostPath" : "/",
"EndpointHostName" : "api10069live.localhost",
"EndpointPath" : "/",
"Protocol" : "http",
"Path" : "/",
"Url" : "http://api10069live.localhost:7901/",
"BindingQName" : "{PetAPI_1.0.0}PetAPI_Binding_0",
"BindingType" : "binding.http",
"Public" : true
}
},
"ImplementationCode" : "Live"
}, {
"CName" : "api10069sandbox.localhost",
"Category" : "Sandbox",
"Uri" : "http://api10069sandbox.localhost:7901/",
"DeploymentZoneRule" : "21e6a509-1a41-411f-a82c-395bb969default-http0",
"ConnectionProperties" : [ {
"Name" : "virtualHost",
"Value" : "api10069sandbox.localhost"
}, {
"Name" : "gateway_hostname",
"Value" : "api10069sandbox.localhost"
}, {
"Name" : "visibility",
"Value" : "public"
} ],
"BindingQName" : "{PetAPI_1.0.0}PetAPI_Binding_0",
"BindingType" : "binding.http",
"EndpointKey" : "uddi:127fb0c3-a749-11e9-ba71-d0c88adc4934",
"EndpointImplementationDetails" : {
"DeploymentZoneEndpoint" : {
"DeploymentZoneID" : "21e6a509-1a41-411f-a82c-395bb969.acmepaymentscorp",
"EndpointKey" : "uddi:127fb0c3-a749-11e9-ba71-d0c88adc4934",
"ListenerName" : "default-http0",
"ContainerKey" : "21e6a509-1a41-411f-a82c-395bb969",
"GatewayHostName" : "api10069sandbox.localhost",
"GatewayHostPath" : "/",
"EndpointHostName" : "api10069sandbox.localhost",
"EndpointPath" : "/",
"Protocol" : "http",
"Path" : "/",
"Url" : "http://api10069sandbox.localhost:7901/",
"BindingQName" : "{PetAPI_1.0.0}PetAPI_Binding_0",
"BindingType" : "binding.http",
"Public" : true
}
},
"ImplementationCode" : "Sandbox"
} ]
},
"Visibility" : "Public",
"Created" : "2019-07-15T21:37:12Z",
"Updated" : "2019-07-15T21:39:50Z",
"State" : "com.soa.api.state.open",
"ProductionEndpointAccessAutoApproved" : true,
"SandboxEndpointAccessAutoApproved" : true,
"RatingSummary" : {
"Five" : 0,
"Four" : 0,
"Three" : 0,
"Two" : 0,
"One" : 0
},
"SandboxAnonymousAccessAllowed" : true,
"ProductionAnonymousAccessAllowed" : true,
"ResourceLevelPermissionsSupported" : false,
"APIOwnedImplementations" : true,
"ProductionServiceKey" : "uddi:b4e19fa7-a748-11e9-ba71-d0c88adc4934",
"SandboxServiceKey" : "uddi:1220044a-a749-11e9-ba71-d0c88adc4934",
"APIImplementations" : {
"APIImplementation" : [ {
"Name" : "PetAPI_v1_Live",
"ImplementationCode" : "Live",
"Description" : "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authori",
"Pattern" : "com.akana.pattern.proxy",
"ServiceKey" : "uddi:b4e19fa7-a748-11e9-ba71-d0c88adc4934",
"APIBindings" : {
"APIBinding" : [ {
"BindingQName" : "{PetAPI_1.0.0}PetAPI_Binding_0",
"BindingKey" : "uddi:3eb712f3-cbc9-7005-9310-dd243f89820b",
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"InterfaceKey" : "uddi:878dfe41-2348-e4a4-0cf3-9117e8bd9b2a",
"BindingType" : "binding.http",
"BindingOperations" : {
"BindingOperation" : [ {
"OperationName" : "getPetById",
"WsdlOperationName" : "getPetById",
"HttpOperation" : {
"Method" : "GET",
"Path" : "/pet/{petId}",
"InputContentType" : "*/*",
"OutputContentType" : "application/json,application/xml",
"FaultContentType" : "",
"Input" : [ {
"Name" : "petId",
"Type" : "path"
} ]
}
}, {
"OperationName" : "updatePetWithForm",
"WsdlOperationName" : "updatePetWithForm",
"HttpOperation" : {
"Method" : "POST",
"Path" : "/pet/{petId}",
"InputContentType" : "application/x-www-form-urlencoded",
"OutputContentType" : "application/json,application/xml",
"FaultContentType" : "",
"Input" : [ {
"Name" : "petId",
"Type" : "path"
}, {
"Name" : "name",
"Type" : "form"
}, {
"Name" : "status",
"Type" : "form"
} ]
}
}, {
"OperationName" : "deletePet",
"WsdlOperationName" : "deletePet",
"HttpOperation" : {
"Method" : "DELETE",
"Path" : "/pet/{petId}",
"InputContentType" : "*/*",
"OutputContentType" : "*/*",
"FaultContentType" : "",
"Input" : [ {
"Name" : "petId",
"Type" : "path"
} ]
}
}, {
"OperationName" : "findPetsByStatus",
"WsdlOperationName" : "findPetsByStatus",
"HttpOperation" : {
"Method" : "GET",
"Path" : "/pet/findByStatus",
"InputContentType" : "*/*",
"OutputContentType" : "application/json,application/xml",
"FaultContentType" : "",
"Input" : [ {
"Name" : "status",
"Type" : "query"
} ]
}
}, {
"OperationName" : "updatePet",
"WsdlOperationName" : "updatePet",
"HttpOperation" : {
"Method" : "PUT",
"Path" : "/pet/",
"InputContentType" : "application/json,application/xml",
"OutputContentType" : "application/json,application/xml",
"FaultContentType" : "",
"Input" : [ {
"Name" : "body",
"Type" : "entity"
} ]
}
}, {
"OperationName" : "addPet",
"WsdlOperationName" : "addPet",
"HttpOperation" : {
"Method" : "POST",
"Path" : "/pet/",
"InputContentType" : "application/json,application/xml",
"OutputContentType" : "application/json,application/xml",
"FaultContentType" : "",
"Input" : [ {
"Name" : "body",
"Type" : "entity"
} ]
}
}, {
"OperationName" : "findPetsByTags",
"WsdlOperationName" : "findPetsByTags",
"HttpOperation" : {
"Method" : "GET",
"Path" : "/pet/findByTags",
"InputContentType" : "*/*",
"OutputContentType" : "application/json,application/xml",
"FaultContentType" : "",
"Input" : [ {
"Name" : "tags",
"Type" : "query"
} ]
}
} ]
}
} ]
},
"APIInterfaces" : {
"APIInterface" : [ {
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"InterfaceKey" : "uddi:878dfe41-2348-e4a4-0cf3-9117e8bd9b2a",
"InterfaceOperations" : {
"InterfaceOperation" : [ {
"OperationName" : "getPetById",
"WsdlOperationName" : "getPetById"
}, {
"OperationName" : "updatePetWithForm",
"WsdlOperationName" : "updatePetWithForm"
}, {
"OperationName" : "deletePet",
"WsdlOperationName" : "deletePet"
}, {
"OperationName" : "findPetsByStatus",
"WsdlOperationName" : "findPetsByStatus"
}, {
"OperationName" : "updatePet",
"WsdlOperationName" : "updatePet"
}, {
"OperationName" : "addPet",
"WsdlOperationName" : "addPet"
}, {
"OperationName" : "findPetsByTags",
"WsdlOperationName" : "findPetsByTags"
} ]
}
} ]
},
"Endpoints" : {
"Endpoint" : [ {
"CName" : "api10069live.localhost",
"Category" : "Production",
"Uri" : "http://api10069live.localhost:7901/",
"DeploymentZoneRule" : "21e6a509-1a41-411f-a82c-395bb969default-http0",
"ConnectionProperties" : [ {
"Name" : "virtualHost",
"Value" : "api10069live.localhost"
}, {
"Name" : "gateway_hostname",
"Value" : "api10069live.localhost"
}, {
"Name" : "visibility",
"Value" : "public"
} ],
"BindingQName" : "{PetAPI_1.0.0}PetAPI_Binding_0",
"BindingType" : "binding.http",
"EndpointKey" : "uddi:b5668760-a748-11e9-ba71-d0c88adc4934",
"EndpointImplementationDetails" : {
"DeploymentZoneEndpoint" : {
"DeploymentZoneID" : "21e6a509-1a41-411f-a82c-395bb969.acmepaymentscorp",
"EndpointKey" : "uddi:b5668760-a748-11e9-ba71-d0c88adc4934",
"ListenerName" : "default-http0",
"ContainerKey" : "21e6a509-1a41-411f-a82c-395bb969",
"GatewayHostName" : "api10069live.localhost",
"GatewayHostPath" : "/",
"EndpointHostName" : "api10069live.localhost",
"EndpointPath" : "/",
"Protocol" : "http",
"Path" : "/",
"Url" : "http://api10069live.localhost:7901/",
"BindingQName" : "{PetAPI_1.0.0}PetAPI_Binding_0",
"BindingType" : "binding.http",
"Public" : true
}
},
"ImplementationCode" : "Live"
} ]
},
"EndpointOAuthDetailsList" : [ {
"OAuthProvider" : "Oauth1",
"OAuth10aSupported" : true,
"OAuth20Supported" : true,
"Resource" : [ "Scope1", "profile" ]
}, {
"OAuthProvider" : "OAuth2",
"OAuth10aSupported" : true,
"OAuth20Supported" : true,
"Resource" : [ "Scope1", "profile" ]
}, {
"OAuthProvider" : "Okta",
"OAuth10aSupported" : false,
"OAuth20Supported" : true,
"Resource" : [ "Scope1", "profile" ]
}, {
"OAuthProvider" : "com.soa.oauth.provider.third-party",
"OAuth20Settings" : {
"AuthorizationEndpointURL" : "http://google.com",
"TokenEndpointURL" : "http://google.coma",
"TokenEndpointRequestVerb" : "POST",
"BearerTokenMethods" : {
"BearerTokenMethod" : [ "com.soa.oauth.bearer.token.method.auz.header", "com.soa.oauth.bearer.token.method.form.param", "com.soa.oauth.bearer.token.method.url.query.param" ]
}
},
"OAuthTokenResourceURISettings" : {
"OAuthTokenResourceURIOption" : "com.soa.oauth.token.resource.uri.proxy.url"
},
"SupportedGrant" : [ "authorization_code", "client_credentials" ],
"ClientAuthPolicyOption" : [ "com.soa.oauth.client.public" ],
"OAuth10aSupported" : true,
"OAuth10aSettings" : {
"RequestTokenEndpointURL" : "http://google.comb",
"AuthorizationEndpointURL" : "http://google.comc",
"AccessTokenEndpointURL" : "http://google.comd",
"TokenEndpointRequestVerb" : "POST",
"TokenParameterTransmissionMethods" : {
"TokenParameterTransmissionMethod" : [ "com.soa.oauth.token.parameter.transmission.method.header", "com.soa.oauth.token.parameter.transmission.method.post", "com.soa.oauth.token.parameter.transmission.method.querystring" ]
}
},
"OAuth20Supported" : true,
"Resource" : [ "Scope1", "profile" ],
"AuthorizationEndpointParameters" : {
"Parameter" : [ "abc", "def" ]
},
"TokenEndpointParameters" : {
"Parameter" : [ "ghi" ]
}
} ],
"APIImplementationDeployments" : {
"DeploymentZonesHostingInfo" : [ {
"DeploymentZoneID" : "21e6a509-1a41-411f-a82c-395bb969.acmepaymentscorp",
"DeploymentZoneEndpoint" : [ {
"DeploymentZoneID" : "21e6a509-1a41-411f-a82c-395bb969.acmepaymentscorp",
"EndpointKey" : "uddi:b5668760-a748-11e9-ba71-d0c88adc4934",
"ListenerName" : "default-http0",
"ContainerKey" : "21e6a509-1a41-411f-a82c-395bb969",
"GatewayHostName" : "api10069live.localhost",
"GatewayHostPath" : "/",
"EndpointHostName" : "api10069live.localhost",
"EndpointPath" : "/",
"Protocol" : "http",
"Path" : "/",
"Url" : "http://api10069live.localhost:7901/",
"BindingQName" : "{PetAPI_1.0.0}PetAPI_Binding_0",
"BindingType" : "binding.http",
"Public" : true
} ]
} ]
},
"Operations" : {
"Operation" : [ {
"Name" : "addPet",
"OperationKey" : "b4fdb342-a748-11e9-ba71-d0c88adc4934",
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"WsdlOperationName" : "addPet"
}, {
"Name" : "deletePet",
"OperationKey" : "b4fb6944-a748-11e9-ba71-d0c88adc4934",
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"WsdlOperationName" : "deletePet"
}, {
"Name" : "findPetsByStatus",
"OperationKey" : "b4fc7ab8-a748-11e9-ba71-d0c88adc4934",
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"WsdlOperationName" : "findPetsByStatus"
}, {
"Name" : "findPetsByTags",
"OperationKey" : "b4fe9da6-a748-11e9-ba71-d0c88adc4934",
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"WsdlOperationName" : "findPetsByTags"
}, {
"Name" : "getPetById",
"OperationKey" : "b4f2ddbb-a748-11e9-ba71-d0c88adc4934",
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"WsdlOperationName" : "getPetById"
}, {
"Name" : "updatePet",
"OperationKey" : "b4fd3e0c-a748-11e9-ba71-d0c88adc4934",
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"WsdlOperationName" : "updatePet"
}, {
"Name" : "updatePetWithForm",
"OperationKey" : "b4faa5f0-a748-11e9-ba71-d0c88adc4934",
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"WsdlOperationName" : "updatePetWithForm"
} ]
},
"AnonymousAccessAllowed" : true,
"EndpointAccessAutoApproved" : true,
"ProxyImplementationDetails" : {
"ProxiedService" : {
"ServiceKey" : "uddi:b4915d83-a748-11e9-ba71-d0c88adc4934",
"ServiceName" : "PetAPI_v1_Live_Target",
"OrganizationKey" : "uddi:b3821020-a748-11e9-ba71-d0c88adc4934",
"Endpoints" : {
"Endpoint" : [ {
"Uri" : "HTTPS://petstore.swagger.io/v2",
"ConnectionProperties" : [ ],
"BindingQName" : "{PetAPI_1.0.0}PetAPI_Binding_0",
"BindingType" : "binding.http",
"EndpointKey" : "uddi:b4be6035-a748-11e9-ba71-d0c88adc4934"
}, {
"Uri" : "HTTP://petstore.swagger.io/v2",
"ConnectionProperties" : [ ],
"BindingQName" : "{PetAPI_1.0.0}PetAPI_Binding_0",
"BindingType" : "binding.http",
"EndpointKey" : "uddi:b4d14bf6-a748-11e9-ba71-d0c88adc4934"
} ]
}
}
}
}, {
"Name" : "PetAPI_v1_Sandbox",
"ImplementationCode" : "Sandbox",
"Description" : "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authori",
"Pattern" : "com.akana.pattern.proxy",
"ServiceKey" : "uddi:1220044a-a749-11e9-ba71-d0c88adc4934",
"APIBindings" : {
"APIBinding" : [ {
"BindingQName" : "{PetAPI_1.0.0}PetAPI_Binding_0",
"BindingKey" : "uddi:3eb712f3-cbc9-7005-9310-dd243f89820b",
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"InterfaceKey" : "uddi:878dfe41-2348-e4a4-0cf3-9117e8bd9b2a",
"BindingType" : "binding.http",
"BindingOperations" : {
"BindingOperation" : [ {
"OperationName" : "getPetById",
"WsdlOperationName" : "getPetById",
"HttpOperation" : {
"Method" : "GET",
"Path" : "/pet/{petId}",
"InputContentType" : "*/*",
"OutputContentType" : "application/json,application/xml",
"FaultContentType" : "",
"Input" : [ {
"Name" : "petId",
"Type" : "path"
} ]
}
}, {
"OperationName" : "updatePetWithForm",
"WsdlOperationName" : "updatePetWithForm",
"HttpOperation" : {
"Method" : "POST",
"Path" : "/pet/{petId}",
"InputContentType" : "application/x-www-form-urlencoded",
"OutputContentType" : "application/json,application/xml",
"FaultContentType" : "",
"Input" : [ {
"Name" : "petId",
"Type" : "path"
}, {
"Name" : "name",
"Type" : "form"
}, {
"Name" : "status",
"Type" : "form"
} ]
}
}, {
"OperationName" : "deletePet",
"WsdlOperationName" : "deletePet",
"HttpOperation" : {
"Method" : "DELETE",
"Path" : "/pet/{petId}",
"InputContentType" : "*/*",
"OutputContentType" : "*/*",
"FaultContentType" : "",
"Input" : [ {
"Name" : "petId",
"Type" : "path"
} ]
}
}, {
"OperationName" : "findPetsByStatus",
"WsdlOperationName" : "findPetsByStatus",
"HttpOperation" : {
"Method" : "GET",
"Path" : "/pet/findByStatus",
"InputContentType" : "*/*",
"OutputContentType" : "application/json,application/xml",
"FaultContentType" : "",
"Input" : [ {
"Name" : "status",
"Type" : "query"
} ]
}
}, {
"OperationName" : "updatePet",
"WsdlOperationName" : "updatePet",
"HttpOperation" : {
"Method" : "PUT",
"Path" : "/pet/",
"InputContentType" : "application/json,application/xml",
"OutputContentType" : "application/json,application/xml",
"FaultContentType" : "",
"Input" : [ {
"Name" : "body",
"Type" : "entity"
} ]
}
}, {
"OperationName" : "addPet",
"WsdlOperationName" : "addPet",
"HttpOperation" : {
"Method" : "POST",
"Path" : "/pet/",
"InputContentType" : "application/json,application/xml",
"OutputContentType" : "application/json,application/xml",
"FaultContentType" : "",
"Input" : [ {
"Name" : "body",
"Type" : "entity"
} ]
}
}, {
"OperationName" : "findPetsByTags",
"WsdlOperationName" : "findPetsByTags",
"HttpOperation" : {
"Method" : "GET",
"Path" : "/pet/findByTags",
"InputContentType" : "*/*",
"OutputContentType" : "application/json,application/xml",
"FaultContentType" : "",
"Input" : [ {
"Name" : "tags",
"Type" : "query"
} ]
}
} ]
}
} ]
},
"APIInterfaces" : {
"APIInterface" : [ {
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"InterfaceKey" : "uddi:878dfe41-2348-e4a4-0cf3-9117e8bd9b2a",
"InterfaceOperations" : {
"InterfaceOperation" : [ {
"OperationName" : "getPetById",
"WsdlOperationName" : "getPetById"
}, {
"OperationName" : "updatePetWithForm",
"WsdlOperationName" : "updatePetWithForm"
}, {
"OperationName" : "deletePet",
"WsdlOperationName" : "deletePet"
}, {
"OperationName" : "findPetsByStatus",
"WsdlOperationName" : "findPetsByStatus"
}, {
"OperationName" : "updatePet",
"WsdlOperationName" : "updatePet"
}, {
"OperationName" : "addPet",
"WsdlOperationName" : "addPet"
}, {
"OperationName" : "findPetsByTags",
"WsdlOperationName" : "findPetsByTags"
} ]
}
} ]
},
"Endpoints" : {
"Endpoint" : [ {
"CName" : "api10069sandbox.localhost",
"Category" : "Sandbox",
"Uri" : "http://api10069sandbox.localhost:7901/",
"DeploymentZoneRule" : "21e6a509-1a41-411f-a82c-395bb969default-http0",
"ConnectionProperties" : [ {
"Name" : "virtualHost",
"Value" : "api10069sandbox.localhost"
}, {
"Name" : "gateway_hostname",
"Value" : "api10069sandbox.localhost"
}, {
"Name" : "visibility",
"Value" : "public"
} ],
"BindingQName" : "{PetAPI_1.0.0}PetAPI_Binding_0",
"BindingType" : "binding.http",
"EndpointKey" : "uddi:127fb0c3-a749-11e9-ba71-d0c88adc4934",
"EndpointImplementationDetails" : {
"DeploymentZoneEndpoint" : {
"DeploymentZoneID" : "21e6a509-1a41-411f-a82c-395bb969.acmepaymentscorp",
"EndpointKey" : "uddi:127fb0c3-a749-11e9-ba71-d0c88adc4934",
"ListenerName" : "default-http0",
"ContainerKey" : "21e6a509-1a41-411f-a82c-395bb969",
"GatewayHostName" : "api10069sandbox.localhost",
"GatewayHostPath" : "/",
"EndpointHostName" : "api10069sandbox.localhost",
"EndpointPath" : "/",
"Protocol" : "http",
"Path" : "/",
"Url" : "http://api10069sandbox.localhost:7901/",
"BindingQName" : "{PetAPI_1.0.0}PetAPI_Binding_0",
"BindingType" : "binding.http",
"Public" : true
}
},
"ImplementationCode" : "Sandbox"
} ]
},
"EndpointOAuthDetailsList" : [ {
"OAuthProvider" : "Oauth1",
"OAuth10aSupported" : true,
"OAuth20Supported" : true,
"Resource" : [ "Scope1", "profile" ]
}, {
"OAuthProvider" : "OAuth2",
"OAuth10aSupported" : true,
"OAuth20Supported" : true,
"Resource" : [ "Scope1", "profile" ]
}, {
"OAuthProvider" : "Okta",
"OAuth10aSupported" : false,
"OAuth20Supported" : true,
"Resource" : [ "Scope1", "profile" ]
}, {
"OAuthProvider" : "com.soa.oauth.provider.third-party",
"OAuth20Settings" : {
"AuthorizationEndpointURL" : "http://google.com",
"TokenEndpointURL" : "http://google.coma",
"TokenEndpointRequestVerb" : "POST",
"BearerTokenMethods" : {
"BearerTokenMethod" : [ "com.soa.oauth.bearer.token.method.auz.header", "com.soa.oauth.bearer.token.method.form.param", "com.soa.oauth.bearer.token.method.url.query.param" ]
}
},
"OAuthTokenResourceURISettings" : {
"OAuthTokenResourceURIOption" : "com.soa.oauth.token.resource.uri.proxy.url"
},
"SupportedGrant" : [ "authorization_code", "client_credentials" ],
"ClientAuthPolicyOption" : [ "com.soa.oauth.client.public" ],
"OAuth10aSupported" : true,
"OAuth10aSettings" : {
"RequestTokenEndpointURL" : "http://google.comb",
"AuthorizationEndpointURL" : "http://google.comc",
"AccessTokenEndpointURL" : "http://google.comd",
"TokenEndpointRequestVerb" : "POST",
"TokenParameterTransmissionMethods" : {
"TokenParameterTransmissionMethod" : [ "com.soa.oauth.token.parameter.transmission.method.header", "com.soa.oauth.token.parameter.transmission.method.post", "com.soa.oauth.token.parameter.transmission.method.querystring" ]
}
},
"OAuth20Supported" : true,
"Resource" : [ "Scope1", "profile" ],
"AuthorizationEndpointParameters" : {
"Parameter" : [ "abc", "def" ]
},
"TokenEndpointParameters" : {
"Parameter" : [ "ghi" ]
}
} ],
"APIImplementationDeployments" : {
"DeploymentZonesHostingInfo" : [ {
"DeploymentZoneID" : "21e6a509-1a41-411f-a82c-395bb969.acmepaymentscorp",
"DeploymentZoneEndpoint" : [ {
"DeploymentZoneID" : "21e6a509-1a41-411f-a82c-395bb969.acmepaymentscorp",
"EndpointKey" : "uddi:127fb0c3-a749-11e9-ba71-d0c88adc4934",
"ListenerName" : "default-http0",
"ContainerKey" : "21e6a509-1a41-411f-a82c-395bb969",
"GatewayHostName" : "api10069sandbox.localhost",
"GatewayHostPath" : "/",
"EndpointHostName" : "api10069sandbox.localhost",
"EndpointPath" : "/",
"Protocol" : "http",
"Path" : "/",
"Url" : "http://api10069sandbox.localhost:7901/",
"BindingQName" : "{PetAPI_1.0.0}PetAPI_Binding_0",
"BindingType" : "binding.http",
"Public" : true
} ]
} ]
},
"Operations" : {
"Operation" : [ {
"Name" : "addPet",
"OperationKey" : "1239a6e5-a749-11e9-ba71-d0c88adc4934",
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"WsdlOperationName" : "addPet"
}, {
"Name" : "deletePet",
"OperationKey" : "12364b77-a749-11e9-ba71-d0c88adc4934",
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"WsdlOperationName" : "deletePet"
}, {
"Name" : "findPetsByStatus",
"OperationKey" : "12375ceb-a749-11e9-ba71-d0c88adc4934",
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"WsdlOperationName" : "findPetsByStatus"
}, {
"Name" : "findPetsByTags",
"OperationKey" : "123ab859-a749-11e9-ba71-d0c88adc4934",
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"WsdlOperationName" : "findPetsByTags"
}, {
"Name" : "getPetById",
"OperationKey" : "123476ae-a749-11e9-ba71-d0c88adc4934",
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"WsdlOperationName" : "getPetById"
}, {
"Name" : "updatePet",
"OperationKey" : "12386e5f-a749-11e9-ba71-d0c88adc4934",
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"WsdlOperationName" : "updatePet"
}, {
"Name" : "updatePetWithForm",
"OperationKey" : "12353a03-a749-11e9-ba71-d0c88adc4934",
"InterfaceQName" : "{PetAPI_1.0.0}PetAPI_PortType_0",
"WsdlOperationName" : "updatePetWithForm"
} ]
},
"AnonymousAccessAllowed" : true,
"EndpointAccessAutoApproved" : true,
"ProxyImplementationDetails" : {
"ProxiedService" : {
"ServiceKey" : "uddi:11f1a107-a749-11e9-ba71-d0c88adc4934",
"ServiceName" : "PetAPI_v1_Sandbox_Target",
"OrganizationKey" : "uddi:b3821020-a748-11e9-ba71-d0c88adc4934",
"Endpoints" : {
"Endpoint" : [ {
"Uri" : "http://opencloud.soa.com:7901",
"ConnectionProperties" : [ ],
"BindingQName" : "{PetAPI_1.0.0}PetAPI_Binding_0",
"BindingType" : "binding.http",
"EndpointKey" : "uddi:121a8609-a749-11e9-ba71-d0c88adc4934"
} ]
}
}
}
} ]
},
"APIDesign" : {
"BindingType" : [ "binding.http" ],
"CommonDesign" : true,
"DesignServiceKey" : "uddi:b3aaf4e1-a748-11e9-ba71-d0c88adc4934"
},
"APIVersionOAuthResourceMapping" : {
"Resource" : [ "Scope1", "profile" ]
},
"Links" : [ {
"rel" : "design",
"href" : "/api/apis/versions/a7ece9ef-e4cd-4bac-9868-31fde66c516e.acmepaymentscorp/design?specification=swagger2",
"type" : "GET",
"title" : "Swagger2"
}, {
"rel" : "design",
"href" : "/api/apis/versions/a7ece9ef-e4cd-4bac-9868-31fde66c516e.acmepaymentscorp/design?specification=oas3",
"type" : "GET",
"title" : "OAS3"
} ]
}
Response Headers
For general information on response header values, refer to HTTP Response Headers.
| Header | Description |
|---|---|
| Content-Type | application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json, application/vnd.soa.v2019+json |
Response Body
| Name | Type | Description |
|---|---|---|
| APIVersion | APIVersion |
Includes information about an API version. Note (2020.2.0 and later): Implementation-level policy information is returned. For operation-level policies, use the GET /api/apis/versions/{ApiVersionID}/implementations/{ImplCode}/policies operation. |
Error Codes/Messages
If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.
| Item | Value |
|---|---|
| 401 | Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing. |
| 404 | The resource could not be found. For example, you might get this if you include an invalid APIVersionID. |
| 500 | An error occurred processing the call. |
More information about Akana API Platform API error messages.