REST API for the Developer Portal in Oracle API Platform Cloud Service

Get details for an API's latest iteration

get

/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

Path Parameters

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 (like https://example.com/developers/apis/weatherService.

Response

Supported Media Types

application/json

200 Response

JSON structure with details of the API.

Body

API resource representation.

Root Schema : Api

Type: object

API resource representation.

Properties

allVersions: Type: array allVersions

List 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 deployments

List of the API's available deployments.
description: Type: string

The API's description.
details: Type: object ApiDetailArtifact

API 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 links

HATEOAS links for the API.
name: Type: string

Required: true

The API's name.
plans: Type: array plans

The API's deployment plans.
state: Type: string

Allowed Values: [ "ALPHA", "BETA", "RETIRED", "RELEASED", "DEPRECATED" ]

The API's state. Valid values: ALPHA, BETA, RELEASED, DEPRECATED, and RETIRED.
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}

Nested Schema : allVersions

Type: array

List of the API's available versions.

Items

Type: object ApiVersion

API version resource representation.

Nested Schema : deployments

Type: array

List of the API's available deployments.

Items

Type: object Deployment

Deployment resource representation.

Nested Schema : ApiDetailArtifact

Type: object

API detail artifact representation

Properties

description: Type: string

The API's overview description.
documentation: Type: object ApiDetailsItem

API detail representation for overview and documentation subtypes.
overview: Type: object ApiDetailsItem

API detail representation for overview and documentation subtypes.

Nested Schema : links

Type: array

HATEOAS links for the API.

Items

Type: object GenericLink

HATEOAS generic link representation

Nested Schema : plans

Type: array

The API's deployment plans.

Items

Type: object PlanForApi

Plan for a given API resource representation.

Nested Schema : ApiVersion

Type: object

API version resource representation.

Properties

vanityName: Type: string

Required: true

The API's vanity name.
version: Type: string

Required: true

The API's version.

Nested Schema : Deployment

Type: object

Deployment resource representation.

Properties

description: Type: string

The deployment's description.
endPoints: Type: array endPoints

A list of endpoint URLs.
state: Type: string

Required: true

Allowed Values: [ "DRAFT", "WAITING_DEPLOYMENT", "DEPLOYED", "ACTIVE", "INACTIVE" ]

The deployment's state: ACTIVE or INACTIVE.

Nested Schema : endPoints

Type: array

A list of endpoint URLs.

Items

Type: string

Nested Schema : ApiDetailsItem

Type: object

API detail representation for overview and documentation subtypes.

Properties

data: Type: string

The documentation data as a string.
dataType: Type: string

The documentation data type.
docType: Type: string

The documentation type.

Nested Schema : GenericLink

Type: object

HATEOAS generic link representation

Properties

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, either canonical or a specific string value.
templated: Type: string

Allowed Values: [ "true", "false" ]

Indicates whether the link has templated parts.

Nested Schema : PlanForApi

Type: object

Plan for a given API resource representation.

Properties

description: Type: string

The plan's description.
id: Type: integer (int32)

Required: true

The plan's ID.
links: Type: array links

HATEOAS links.
name: Type: string

Required: true

The plan's name.
registeredApps: Type: array registeredApps

List of applications registered to the API.

Nested Schema : links

Type: array

HATEOAS links.

Items

Type: object GenericLink

HATEOAS generic link representation

Nested Schema : registeredApps

Type: array

List of applications registered to the API.

Items

Type: object RegisteredApp

Registered application resource representation.

Nested Schema : RegisteredApp

Type: object

Registered application resource representation.

Properties

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.

500 Response

Server error.

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"
}