APIImplementationInfo Object
Contains information about an API implementation.
This object is used by the following operations:
- POST /api/apis/versions/{APIVersionID}/implementations (in the response)
- PUT /api/apis/versions/{APIVersionID}/implementations/{ImplCode}/info (in request and response)
The properties included in the APIImplementationInfo object are listed below.
Property | Type | Description |
---|---|---|
APIVersionID | string | The unique ID for a specific API version. Required except when adding a new API version. |
ImplementationCode | string | Code name for the API implementation. |
Description | string | Description of the implementation. |
Pattern | string | Indicates the approach used to create a new implementation for an existing API version. Example: com.akana.pattern.proxy. For valid values, see API Pattern. |
ServiceKey | string |
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. |
AnonymousAccessAllowed | Boolean | Indicates whether anonymous access to the implementation is allowed. |
EndpointAccessAutoApproved | Boolean | Indicates whether API access requests to the implementation are automatically approved. |
APIOwnedImplementation | Boolean |
If the API was created on the platform (API with New Service option, the default) this value is true. If the API was created using the API With Existing Service option, the service implementation is owned by Policy Manager; in this case, the value is false. Default: true. |
ProxyImplementationRequest | ProxyImplementationRequest | Contains information about a request to create an implementation by defining a proxy. |