1. REST API for the Developer Portal in Oracle API Platform Cloud Service
  2. Tasks
  3. APIs

Get details for an API's published iteration

get

/apiplatform/developers/v1/apis/{vanityName}

Returns details about the iteration of the {vanityName} API published to the Developer Portal.

All authenticated users can request this resource. Only details for APIs that are published to the Developer Portal and 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.
Nested Schema : allVersions
Type: array
List of the API's available versions.
Nested Schema : deployments
Type: array
List of the API's available deployments.
Nested Schema : ApiDetailArtifact
Type: object
API detail artifact representation
Nested Schema : plans
Type: array
The API's deployment plans.
Nested Schema : ApiVersion
Type: object
API version resource representation.
Nested Schema : Deployment
Type: object
Deployment resource representation.
Nested Schema : endPoints
Type: array
A list of endpoint URLs.
Nested Schema : ApiDetailsItem
Type: object
API detail representation for overview and documentation subtypes.
Nested Schema : PlanForApi
Type: object
Plan for a given API resource representation.
Nested Schema : registeredApps
Type: array
List of applications registered to the API.
Nested Schema : RegisteredApp
Type: object
Registered application resource representation.
400 Response
Bad request: indicates a problem with the input parameters.
401 Response
Authentication required.
500 Response
Server error.

Examples

The following example shows how to retrieve details about a specific 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

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:46:02 GMT
Content-length: 859
Content-type: application/json
X-oracle-dms-ecid: R^4Oa1FpR00000000
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 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/WeatherService1"
      ],
      "state": "APPROVED"
    }
  ],
  "details": {},
  "id": 180,
  "iterationId": 1,
  "links": [
    {
      "href": "https://example.com/apiplatform/developers/v1/apis/WeatherService1",
      "method": "GET",
      "rel": "canonical",
      "templated": "true"
    }
  ],
  "name": "WeatherService",
  "plans": [
    {
      "description": "default",
      "id": 168,
      "links": [
        {
          "href": "https://example.com/apiplatform/management/v1/plans/168/registrations",
          "method": "POST",
          "rel": "register",
          "templated": "true"
        }
      ],
      "name": "WeatherService 1",
      "registeredApps": [
        {
          "id": 345,
          "name": "WeatherMobileApp",
          "state": "REGISTERED"
        }
      ]
    }
  ],
  "state": "ALPHA",
  "vanityName": "WeatherService1",
  "version": "1"
}