GET /api/apis/versions/implementations

Returns information about API implementations, based on a provided APIID, APIVersionID, Service Key, or implementation code.

New in API Platform Version: 8.1

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/implementations[?][APIID={APIID}]&[APIVersionID={APIVersionID}]
&[ServiceKey={ServiceKey}]&[ProxiedServiceKey={ProxiedServiceKey}]&[ImplementationCode={ImplementationCode}]

Back to top

Sample Request #1

The example below shows a request for API implementation information.

Request URL

https://{hostname}/api/apis/versions/implementations

Sample request headers

Accept: application/vnd.soa.v81+json

Sample request body

Not applicable.

Sample Request #2

The example below shows a request for API implementation information for the specified API.

Request URL

https://{hostname}/api/apis/versions/implementations?APIID=2a6138cd-093e-4861-9fc4-2203a662129c.acmepaymentscorp

Sample request headers

Accept: application/json

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.v81+json
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.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
APIID Query string Optional The unique ID for a specific API.
APIVersionID Query string Optional The unique ID for a specific API version.
ServiceKey Query string Optional

Unique service key for a specific service implementation; for example, uddi:f1ebef06-f0a8-11e3-b49c-efec5910417e.

When adding an implementation from an existing service, it is the unique service key for the service, as set up in Policy Manager.

ProxiedServiceKey Query string Optional The service key for a proxied API, if applicable.
ImplementationCode Query string Optional Code name for the API implementation.

Back to top

Response

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

Back to top

Sample Response #1

The sample response below shows successful completion of this operation. Information on all implementations is returned.

Sample response headers: application/vnd.soa.v81+json

application/vnd.soa.v81+json
date: Thu, 26 Jul 2018 13:56:43 GMT

Sample response body: application/vnd.soa.v81+json

{
  "APIImplementationInfo":[
    {
      "APIVersionID":"f280d366-1724-486f-891d-2724fcce0f81.acmepaymentscorp",
      "ImplementationCode":"Live",
      "Pattern":"com.akana.pattern.proxy",
      "ServiceKey":"uddi:a0e0492a-90af-11e8-98c0-c211ef2ffc24",
      "AnonymousAccessAllowed":true,
      "EndpointAccessAutoApproved":true,
      "APIOwnedImplementation":true
    },
    {
      "APIVersionID":"9dfe7acc-b6ac-4d2b-b41a-3fd0b25cbdd8.acmepaymentscorp",
      "ImplementationCode":"Live",
      "Pattern":"com.akana.pattern.proxy",
      "ServiceKey":"uddi:5c48ab36-90d5-11e8-8aa5-a05d223084d5",
      "AnonymousAccessAllowed":true,
      "EndpointAccessAutoApproved":true,
      "APIOwnedImplementation":true
    },
    {
      "APIVersionID":"86a19fb1-a6f8-45e2-9775-86b575207dd0.acmepaymentscorp",
      "ImplementationCode":"Live",
      "Pattern":"com.akana.pattern.proxy",
      "ServiceKey":"uddi:075b9cc4-90d8-11e8-8aa5-a05d223084d5",
      "AnonymousAccessAllowed":true,
      "EndpointAccessAutoApproved":true,
      "APIOwnedImplementation":true
    }
  ]
}

Sample Response #2

The sample response below shows successful completion of this operation. API implementation information for the specified API is returned.

Sample response headers: application/json

application/json
date:  Thu, 26 Jul 2018 13:51:09 GMT

Sample response body: application/vnd.soa.v81+json

{
  "APIImplementationInfo":[
    {
      "APIVersionID":"86a19fb1-a6f8-45e2-9775-86b575207dd0.acmepaymentscorp",
      "ImplementationCode":"Live",
      "Pattern":"com.akana.pattern.proxy",
      "ServiceKey":"uddi:075b9cc4-90d8-11e8-8aa5-a05d223084d5",
      "AnonymousAccessAllowed":true,
      "EndpointAccessAutoApproved":true,
      "APIOwnedImplementation":true
    }
  ]
}

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.v81+json

Back to top

Response Body

Name Type Description
APIImplementationInfos APIImplementationInfos Contains information about one or more implementations for 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. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics