Get details for an API's latest iteration
/apiplatform/developers/v1/apis/{vanityName}/current
Returns details about the latest iteration of the {vanityName}
API. This iteration of the API may not yet be published to the Developer Portal.
All authenticated users can request this resource. Only details for APIs that the requesting user is issued the Manage API, View Public Details, Register, or Request Register API grant for are returned.
Request
- vanityName
-
Type:
string
Required:true
An API's unique vanity name. This is the URI path of the details page for the API on the Developer Portal (likehttps://example.com/developers/apis/weatherService
.
Response
- application/json
object
- allVersions
-
Type:
array
allVersionsList of the API's available versions. - createdAt
-
Type:
string
The date and time the API was created. - createdBy
-
Type:
string
The name of the user who created the API. - deployments
-
Type:
array
deploymentsList of the API's available deployments. - description
-
Type:
string
The API's description. - details
-
Type:
object
ApiDetailArtifactAPI detail artifact representation - icon
-
Type:
string
Artifact containing the API's icon, if changed. - id
-
Type:
integer
(int32
)Required:true
The API's ID. - iterationId
-
Type:
integer
(int32
)The API's iteration ID. - links
-
Type:
array
linksHATEOAS links for the API. - name
-
Type:
string
Required:true
The API's name. - plans
-
Type:
array
plansThe API's deployment plans. - state
-
Type:
string
Allowed Values:[ "ALPHA", "BETA", "RETIRED", "RELEASED", "DEPRECATED" ]
The API's state. Valid values:ALPHA
,BETA
,RELEASED
,DEPRECATED
, andRETIRED
. - vanityName
-
Type:
string
Required:true
The API's vanity name. - version
-
Type:
string
Required:true
The API's version. - visibility
-
Type:
string
Allowed Values:[ "PROTECTED", "INTERNAL", "PUBLIC" ]
{dto.Api.visibility}
array
-
Type:
object
ApiVersionAPI version resource representation.
array
-
Type:
object
DeploymentDeployment resource representation.
object
- description
-
Type:
string
The API's overview description. - documentation
-
Type:
object
ApiDetailsItemAPI detail representation for overview and documentation subtypes. - overview
-
Type:
object
ApiDetailsItemAPI detail representation for overview and documentation subtypes.
array
-
Type:
object
PlanForApiPlan for a given API resource representation.
object
- vanityName
-
Type:
string
Required:true
The API's vanity name. - version
-
Type:
string
Required:true
The API's version.
object
- description
-
Type:
string
The deployment's description. - endPoints
-
Type:
array
endPointsA list of endpoint URLs. - state
-
Type:
string
Required:true
Allowed Values:[ "DRAFT", "WAITING_DEPLOYMENT", "DEPLOYED", "ACTIVE", "INACTIVE" ]
The deployment's state:ACTIVE
orINACTIVE
.
object
- data
-
Type:
string
The documentation data as a string. - dataType
-
Type:
string
The documentation data type. - docType
-
Type:
string
The documentation type.
object
- href
-
Type:
string
Required:true
Link reference string. - method
-
Type:
string
HTTP method used with the link. - rel
-
Type:
string
Required:true
Link relation string, eithercanonical
or a specific string value. - templated
-
Type:
string
Allowed Values:[ "true", "false" ]
Indicates whether the link has templated parts.
object
- description
-
Type:
string
The plan's description. - id
-
Type:
integer
(int32
)Required:true
The plan's ID. - links
-
Type:
array
linksHATEOAS links. - name
-
Type:
string
Required:true
The plan's name. - registeredApps
-
Type:
array
registeredAppsList of applications registered to the API.
array
-
Type:
object
RegisteredAppRegistered application resource representation.
object
- id
-
Type:
integer
(int32
)Required:true
The application's ID. - name
-
Type:
string
Required:true
The application's name. - state
-
Type:
string
Required:true
Allowed Values:[ "REGISTERED", "REQUESTING", "SUSPENDED", "REJECTED" ]
The application's registration state.
Examples
The following example shows how to retrieve details about the current iteration of an API published to the Oracle API Platform Cloud Service Developer Portal by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X GET -u apicsadmin:password https://example.com/apiplatform/developers/v1/apis/WeatherService1/current
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 200 OK Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Sun, 01 Jan 2017 15:53:28 GMT Content-length: 547 Content-type: application/json X-oracle-dms-ecid: qdGX61czR00000000 X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0
Example of Response Body
The following example shows the contents of the response body in JSON format, including details about the current published iteration of the API and HATEOAS links to related operations.
{ "allVersions": [ { "vanityName": "WeatherService1", "version": "1" } ], "createdAt": "2016-12-09T03:50:21+0000", "createdBy": "weblogic", "deployments": [ { "description": "test", "endPoints": [ "HTTP://example.com/WeatherService" ], "state": "APPROVED" } ], "details": {}, "id": 180, "iterationId": 1, "links": [ { "href": "https://example.com/apiplatform/developers/v1/apis/WeatherService1/current", "method": "GET", "rel": "canonical", "templated": "true" } ], "name": "WeatherService", "state": "ALPHA", "vanityName": "WeatherService1", "version": "1" }