GET /api/apis/versions/{APIVersionID}

Returns the specified API version.

Authorization Roles/Permissions: Must have Read permission for the resource.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apis/versions/{APIVersionID}[?][includeTargetAPI=boolean]&[includeOperations=boolean]
&[includeTargetAPI={Boolean}]&[includeSettings={Boolean}]&[ContractID={ContractID}]

Back to top

Sample Request

The example below shows a request for specific API version information.

Sample request URL #1

https://{hostname}/api/apis/versions/d5de1637-7b00-46ba-9e8c-9d81d762f58e.acmepaymentscorp

Sample request URL #2

Includes the optional includeOperations parameter.

https://{hostname}/api/apis/versions/95e2d445-4603-443c-ba15-c50b922d3d1f.acmepaymentscorp?includeOperations=true

Sample request headers

GET /api/apis/versions/9e3846ee-bbbf-4982-82ca-5a2411ec619b.acmepaymentscorp HTTP/1.1
Host: {hostname}
Accept: application/vnd.soa.v81+json, text/javascript, */*; q=0.01
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

Not applicable.

Back to top

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

Back to top

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 string 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.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the specified API version.

Back to top

Sample Response #1

The sample response below shows the response information for sample request #1 above.

Sample response headers

HTTP/1.1 200 OK
Date: Mon, 29 Feb 2016 16:23:21 GMT
Content-Type: application/vnd.soa.v81+json

Sample response body

{
  "APIVersionID" : "d5de1637-7b00-46ba-9e8c-9d81d762f58e.acmepaymentscorp",
  "APIID" : "5130abc9-04ff-4d5c-ad69-cef7690da150.acmepaymentscorp",
  "Name" : "v1",
  "Description" : "This is a sample Petstore server apple API.",
  "Environment" : "default",
  "Tag" : [ ],
  "Visibility" : "Public",
  "Created" : "2016-02-29T16:20:11Z",
  "Updated" : "2016-02-29T16:20:11Z",
  "State" : "com.soa.api.state.open",
  "ProductionEndpointAccessAutoApproved" : false,
  "SandboxEndpointAccessAutoApproved" : true,
  "RatingSummary" : {
    "Five" : 0,
    "Four" : 0,
    "Three" : 0,
    "Two" : 0,
    "One" : 0
  },
  "SandboxAnonymousAccessAllowed" : false,
  "ProductionAnonymousAccessAllowed" : false,
  "ResourceLevelPermissionsSupported" : false,
  "APIOwnedImplementations" : true,
  "ProductionServiceKey" : "uddi:4f728f31-df00-11e5-be7a-c898302e047e",
  "BindingType" : [ "binding.http" ]
}

Sample Response #2

The sample response below (response to sample request URL #2) shows API version information for a rendition 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: Mon, 29 Feb 2016 16:39:21 GMT

Sample response body

{
  "APIVersionID" : "95e2d445-4603-443c-ba15-c50b922d3d1f.acmepaymentscorp",
  "APIID" : "96c84d2c-8e2e-42c0-9f2b-8506c6febdc5.acmepaymentscorp",
  "Name" : "1.0",
  "Description" : "First version",
  "Environment" : "default",
  "Type" : "shttp",
  "DefaultProfile" : "Any in and out",
  "Tag" : [ "swagger", "test", "api" ],
  "Operations" : {
    "Operation" : [ {
      "Name" : "getPetById",
      "Method" : "GET",
      "Path" : "/pet/{petId}",
      "InputContentType" : "*/*",
      "OutputContentType" : "*/*",
      "FaultContentType" : "*/*",
      "Input" : [ {
        "Name" : "petId",
        "Type" : "path"
      } ],
      "InterfaceQName" : "{uri:acmepaymentscorp}PortType_svc_95e2d445-4603-443c-ba15-c50b922d3d1f.acmepaymentscorp.production",
      "WsdlOperationName" : "getPetById"
    }, {
      "Name" : "addPet",
      "Method" : "POST",
      "Path" : "/pet",
      "InputContentType" : "*/*",
      "OutputContentType" : "*/*",
      "FaultContentType" : "*/*",
      "Input" : [ {
        "Name" : "Body",
        "Type" : "entity"
      } ],
      "InterfaceQName" : "{uri:acmepaymentscorp}PortType_svc_95e2d445-4603-443c-ba15-c50b922d3d1f.acmepaymentscorp.production",
      "WsdlOperationName" : "addPet"
    }, {
      "Name" : "updatePet",
      "Method" : "PUT",
      "Path" : "/pet",
      "InputContentType" : "*/*",
      "OutputContentType" : "*/*",
      "FaultContentType" : "*/*",
      "Input" : [ {
        "Name" : "Body",
        "Type" : "entity"
      } ],
      "InterfaceQName" : "{uri:acmepaymentscorp}PortType_svc_95e2d445-4603-443c-ba15-c50b922d3d1f.acmepaymentscorp.production",
      "WsdlOperationName" : "updatePet"
    } ]
  },
  "Endpoints" : {
    "Endpoint" : [ ]
  },
  "Policies" : {
    "Policy" : [ {
      "PolicyKey" : "acmepaymentscorp-acmepaymentscorpApplicationSecurityPolicy",
      "Name" : "AtmosphereApplicationSecurityPolicy",
      "Description" : "",
      "PolicyType" : "Operational Policy",
      "PolicySubType" : "policy.apisec"
    }, {
      "PolicyKey" : "Atmosphere-CORSAllowAll",
      "Name" : "CORSAllowAll",
      "Description" : "",
      "PolicyType" : "Operational Policy",
      "PolicySubType" : "policy.cors"
    }, {
      "PolicyKey" : "Atmosphere-DetailedAuditing",
      "Name" : "DetailedAuditing",
      "Description" : "",
      "PolicyType" : "Operational Policy",
      "PolicySubType" : "policy.auditservice"
    }, {
      "PolicyKey" : "Atmosphere-OAuthSecurity",
      "Name" : "OAuthSecurity",
      "Description" : "",
      "PolicyType" : "Operational Policy",
      "PolicySubType" : "policy.oauth"
    } ]
  },
  "Visibility" : "Public",
  "Created" : "2016-02-29T13:03:12Z",
  "Updated" : "2016-02-29T13:03:25Z",
  "State" : "com.soa.api.state.open",
  "ProductionEndpointAccessAutoApproved" : true,
  "SandboxEndpointAccessAutoApproved" : true,
  "RatingSummary" : {
    "Five" : 0,
    "Four" : 0,
    "Three" : 0,
    "Two" : 0,
    "One" : 0
  },
  "SandboxAnonymousAccessAllowed" : false,
  "ProductionAnonymousAccessAllowed" : false,
  "ResourceLevelPermissionsSupported" : true,
  "APIOwnedImplementations" : true,
  "ProductionServiceKey" : "uddi:ca039472-dee4-11e5-be7a-c898302e047e",
  "SandboxServiceKey" : "uddi:cba73282-dee4-11e5-be7a-c898302e047e",
  "APIImplementations" : {
    "APIImplementation" : [ {
      "Name" : "__SwaggerAPI_Both_1.0_Production_Virtual",
      "ImplementationCode" : "Live",
      "Description" : "First version",
      "Pattern" : "com.akana.pattern.physical.service",
      "ServiceKey" : "uddi:ca039472-dee4-11e5-be7a-c898302e047e",
      "APIBindings" : {
        "APIBinding" : [ {
          "BindingQName" : "{uri:acmepaymentscorp}Binding_svc_95e2d445-4603-443c-ba15-c50b922d3d1f.acmepaymentscorp.production.virtual",
          "BindingKey" : "uddi:5a12ac80-1dcc-eede-8f67-7d1a5d53d74e",
          "InterfaceQName" : "{uri:acmepaymentscorp}PortType_svc_95e2d445-4603-443c-ba15-c50b922d3d1f.acmepaymentscorp.production",
          "InterfaceKey" : "uddi:6f948c82-2717-bb91-da74-8b280151cfa7",
          "BindingType" : "binding.http",
          "BindingOperations" : {
            "BindingOperation" : [ {
              "OperationName" : "getPetById",
              "WsdlOperationName" : "getPetById",
              "HttpOperation" : {
                "Method" : "GET",
                "Path" : "/pet/{petId}",
                "InputContentType" : "*/*",
                "OutputContentType" : "*/*",
                "FaultContentType" : "*/*",
                "Input" : [ {
                  "Name" : "petId",
                  "Type" : "path"
                } ]
              }
            }, {
              "OperationName" : "addPet",
              "WsdlOperationName" : "addPet",
              "HttpOperation" : {
                "Method" : "POST",
                "Path" : "/pet",
                "InputContentType" : "*/*",
                "OutputContentType" : "*/*",
                "FaultContentType" : "*/*",
                "Input" : [ {
                  "Name" : "Body",
                  "Type" : "entity"
                } ]
              }
            }, {
              "OperationName" : "updatePet",
              "WsdlOperationName" : "updatePet",
              "HttpOperation" : {
                "Method" : "PUT",
                "Path" : "/pet",
                "InputContentType" : "*/*",
                "OutputContentType" : "*/*",
                "FaultContentType" : "*/*",
                "Input" : [ {
                  "Name" : "Body",
                  "Type" : "entity"
                } ]
              }
            } ]
          }
        } ]
      },
      "APIInterfaces" : {
        "APIInterface" : [ {
          "InterfaceQName" : "{uri:acmepaymentscorp}PortType_svc_95e2d445-4603-443c-ba15-c50b922d3d1f.acmepaymentscorp.production",
          "InterfaceKey" : "uddi:6f948c82-2717-bb91-da74-8b280151cfa7",
          "InterfaceOperations" : {
            "InterfaceOperation" : [ {
              "OperationName" : "getPetById",
              "WsdlOperationName" : "getPetById"
            }, {
              "OperationName" : "addPet",
              "WsdlOperationName" : "addPet"
            }, {
              "OperationName" : "updatePet",
              "WsdlOperationName" : "updatePet"
            } ]
          }
        } ]
      },
      "Endpoints" : {
        "Endpoint" : [ ]
      },
      "Policies" : {
        "Policy" : [ {
          "PolicyKey" : "Atmosphere-AtmosphereApplicationSecurityPolicy",
          "Name" : "AtmosphereApplicationSecurityPolicy",
          "Description" : "",
          "PolicyType" : "Operational Policy",
          "PolicySubType" : "policy.apisec"
        }, {
          "PolicyKey" : "Atmosphere-CORSAllowAll",
          "Name" : "CORSAllowAll",
          "Description" : "",
          "PolicyType" : "Operational Policy",
          "PolicySubType" : "policy.cors"
        }, {
          "PolicyKey" : "Atmosphere-DetailedAuditing",
          "Name" : "DetailedAuditing",
          "Description" : "",
          "PolicyType" : "Operational Policy",
          "PolicySubType" : "policy.auditservice"
        }, {
          "PolicyKey" : "Atmosphere-OAuthSecurity",
          "Name" : "OAuthSecurity",
          "Description" : "",
          "PolicyType" : "Operational Policy",
          "PolicySubType" : "policy.oauth"
        } ]
      },
      "APIImplementationDeployments" : {
      },
      "Operations" : {
        "Operation" : [ {
          "Name" : "addPet",
          "OperationKey" : "ca518d69-dee4-11e5-be7a-c898302e047e",
          "InterfaceQName" : "{uri:acmepaymentscorp}PortType_svc_95e2d445-4603-443c-ba15-c50b922d3d1f.acmepaymentscorp.production",
          "WsdlOperationName" : "addPet"
        }, {
          "Name" : "getPetById",
          "OperationKey" : "ca4f9196-dee4-11e5-be7a-c898302e047e",
          "InterfaceQName" : "{uri:acmepaymentscorp}PortType_svc_95e2d445-4603-443c-ba15-c50b922d3d1f.acmepaymentscorp.production",
          "WsdlOperationName" : "getPetById"
        }, {
          "Name" : "updatePet",
          "OperationKey" : "ca53b04c-dee4-11e5-be7a-c898302e047e",
          "InterfaceQName" : "{uri:acmepaymentscorp}PortType_svc_95e2d445-4603-443c-ba15-c50b922d3d1f.acmepaymentscorp.production",
          "WsdlOperationName" : "updatePet"
        } ]
      }
    }, {
      "Name" : "__SwaggerAPI_Both_1.0_Sandbox_Virtual",
      "ImplementationCode" : "Sandbox",
      "Description" : "First version",
      "Pattern" : "com.akana.pattern.physical.service",
      "ServiceKey" : "uddi:cba73282-dee4-11e5-be7a-c898302e047e",
      "APIBindings" : {
        "APIBinding" : [ {
          "BindingQName" : "{uri:acmepaymentscorp}Binding_svc_95e2d445-4603-443c-ba15-c50b922d3d1f.acmepaymentscorp.sandbox.virtual",
          "BindingKey" : "uddi:e4b1fe2b-0e43-9d93-e6c1-e0ad7714bf68",
          "InterfaceQName" : "{uri:acmepaymentscorp}PortType_svc_95e2d445-4603-443c-ba15-c50b922d3d1f.acmepaymentscorp.sandbox",
          "InterfaceKey" : "uddi:b17209b4-d4e0-5e99-4870-d8adb404d767",
          "BindingType" : "binding.http",
          "BindingOperations" : {
            "BindingOperation" : [ {
              "OperationName" : "getPetById",
              "WsdlOperationName" : "getPetById",
              "HttpOperation" : {
                "Method" : "GET",
                "Path" : "/pet/{petId}",
                "InputContentType" : "*/*",
                "OutputContentType" : "*/*",
                "FaultContentType" : "*/*",
                "Input" : [ {
                  "Name" : "petId",
                  "Type" : "path"
                } ]
              }
            }, {
              "OperationName" : "addPet",
              "WsdlOperationName" : "addPet",
              "HttpOperation" : {
                "Method" : "POST",
                "Path" : "/pet",
                "InputContentType" : "*/*",
                "OutputContentType" : "*/*",
                "FaultContentType" : "*/*",
                "Input" : [ {
                  "Name" : "Body",
                  "Type" : "entity"
                } ]
              }
            }, {
              "OperationName" : "updatePet",
              "WsdlOperationName" : "updatePet",
              "HttpOperation" : {
                "Method" : "PUT",
                "Path" : "/pet",
                "InputContentType" : "*/*",
                "OutputContentType" : "*/*",
                "FaultContentType" : "*/*",
                "Input" : [ {
                  "Name" : "Body",
                  "Type" : "entity"
                } ]
              }
            } ]
          }
        } ]
      },
      "APIInterfaces" : {
        "APIInterface" : [ {
          "InterfaceQName" : "{uri:acmepaymentscorp}PortType_svc_95e2d445-4603-443c-ba15-c50b922d3d1f.acmepaymentscorp.sandbox",
          "InterfaceKey" : "uddi:b17209b4-d4e0-5e99-4870-d8adb404d767",
          "InterfaceOperations" : {
            "InterfaceOperation" : [ {
              "OperationName" : "getPetById",
              "WsdlOperationName" : "getPetById"
            }, {
              "OperationName" : "addPet",
              "WsdlOperationName" : "addPet"
            }, {
              "OperationName" : "updatePet",
              "WsdlOperationName" : "updatePet"
            } ]
          }
        } ]
      },
      "Endpoints" : {
        "Endpoint" : [ ]
      },
      "Policies" : {
        "Policy" : [ {
          "PolicyKey" : "Atmosphere-AtmosphereApplicationSecurityPolicy",
          "Name" : "AtmosphereApplicationSecurityPolicy",
          "Description" : "",
          "PolicyType" : "Operational Policy",
          "PolicySubType" : "policy.apisec"
        }, {
          "PolicyKey" : "Atmosphere-CORSAllowAll",
          "Name" : "CORSAllowAll",
          "Description" : "",
          "PolicyType" : "Operational Policy",
          "PolicySubType" : "policy.cors"
        }, {
          "PolicyKey" : "Atmosphere-DetailedAuditing",
          "Name" : "DetailedAuditing",
          "Description" : "",
          "PolicyType" : "Operational Policy",
          "PolicySubType" : "policy.auditservice"
        }, {
          "PolicyKey" : "Atmosphere-OAuthSecurity",
          "Name" : "OAuthSecurity",
          "Description" : "",
          "PolicyType" : "Operational Policy",
          "PolicySubType" : "policy.oauth"
        } ]
      },
      "APIImplementationDeployments" : {
      },
      "Operations" : {
        "Operation" : [ {
          "Name" : "addPet",
          "OperationKey" : "cbfd8fe9-dee4-11e5-be7a-c898302e047e",
          "InterfaceQName" : "{uri:acmepaymentscorp}PortType_svc_95e2d445-4603-443c-ba15-c50b922d3d1f.acmepaymentscorp.sandbox",
          "WsdlOperationName" : "addPet"
        }, {
          "Name" : "getPetById",
          "OperationKey" : "cbfb9416-dee4-11e5-be7a-c898302e047e",
          "InterfaceQName" : "{uri:acmepaymentscorp}PortType_svc_95e2d445-4603-443c-ba15-c50b922d3d1f.acmepaymentscorp.sandbox",
          "WsdlOperationName" : "getPetById"
        }, {
          "Name" : "updatePet",
          "OperationKey" : "cc0000ec-dee4-11e5-be7a-c898302e047e",
          "InterfaceQName" : "{uri:acmepaymentscorp}PortType_svc_95e2d445-4603-443c-ba15-c50b922d3d1f.acmepaymentscorp.sandbox",
          "WsdlOperationName" : "updatePet"
        } ]
      }
    } ]
  },
  "BindingType" : [ "binding.http" ]
}

Back to top

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

Back to top

Response Body

Name Type Description
APIVersion APIVersion Includes information about an API version.

Back to top

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.
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.

Back to top

Related Topics