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

Get details for an application

get

/apiplatform/developers/v1/applications/{applicationId}

Returns details about the {applicationId} application.

All authenticated users can request this resource. Only details for applications that the user is issued the Manage Application or View All Details application grant for are returned.

Request

Path Parameters

applicationId: Type: string

Required: true

The application's ID.

Response

Supported Media Types

application/json

200 Response

JSON structure with details for the application.

Body

Application resource representation.

Root Schema : Application

Type: object

Application resource representation.

Properties

applicationKey: Type: string

Required: true

The application's key.
contactCompany: Type: string

The owner's company.
contactEmail: Type: string

The owner's email address.
contactFirstName: Type: string

The owner's first name.
contactLastName: Type: string

The owner's last name.
contactLdapName: Type: string

The owner's LDAP user name.
contactPhone: Type: string

The owner's phone number.
createdAt: Type: string

The date and time the application was created.
createdBy: Type: string

The user who created the application.
description: Type: string

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

Required: true

The application's ID.
lastUpdatedAt: Type: string

The date and time the application was last updated.
lastUpdatedBy: Type: string

The user who last updated the application.
links: Type: array links

HATEOAS links for the application.
name: Type: string

Required: true

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

The application's plans.
types: Type: array types

The application's types.

Nested Schema : links

Type: array

HATEOAS links for the application.

Items

Type: object GenericLink

HATEOAS generic link representation

Nested Schema : plans

Type: array

The application's plans.

Items

Type: object PlanForApplication

Application-specific plan resource representation.

Nested Schema : types

Type: array

The application's types.

Items

Type: integer (int32)

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 : PlanForApplication

Type: object

Application-specific plan resource representation.

Properties

description: Type: string

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

Required: true

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

HATEOAS links.
name: Type: string

Required: true

The application plan's name.
registeredApis: Type: array registeredApis

List of APIs the application registers to.
registrationId: Type: integer (int32)

Required: true

The contract's ID.
registrationState: Type: string

Required: true

Allowed Values: [ "REGISTERED", "REQUESTING", "SUSPENDED", "REJECTED" ]

The contract's state.
state: Type: string

Required: true

Allowed Values: [ "PUBLISHED", "UNPUBLISHED" ]

The application plan's state.

Nested Schema : links

Type: array

HATEOAS links.

Items

Type: object GenericLink

HATEOAS generic link representation

Nested Schema : registeredApis

Type: array

List of APIs the application registers to.

Items

Type: object RegisteredApi

Registered API resource representation.

Nested Schema : RegisteredApi

Type: object

Registered API resource representation.

Properties

description: Type: string

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

Required: true

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

HATEOAS links
name: Type: string

The API's name.
unpublished: Type: boolean

Default Value: false

Flag indicating if the API was unpublished.
vanityName: Type: string

Required: true

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

The API's ID.

Nested Schema : links

Type: array

HATEOAS links

Items

Type: object GenericLink

HATEOAS generic link 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 list an application’s details (with an applicationId of 120) 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/applications/120

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 16:08:47 GMT
Content-length: 1525
Content-type: application/json
X-oracle-dms-ecid: TQboO071S00000000
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 application and HATEOAS links to related operations.

{
  "applicationKey": "25f1f87a-4c9c-4609-b158-4fd81f4f5a26",
  "contactCompany": "",
  "contactEmail": "",
  "contactFirstName": "",
  "contactLastName": "",
  "contactLdapName": "",
  "contactPhone": "",
  "createdAt": "2016-12-05T16:47:21+0000",
  "createdBy": "weblogic",
  "description": "WeatheriOSApp",
  "id": 120,
  "lastUpdatedAt": "2016-12-05T16:52:50+0000",
  "lastUpdatedBy": "weblogic",
  "links": [
    {
      "href": "https://example.com:443/apiplatform/developers/v1/applications/120",
      "method": "GET",
      "rel": "canonical",
      "templated": "true"
    },
    {
      "href": "https://example.com:443/apiplatform/analytics/v1/totals/requests",
      "method": "GET",
      "rel": "analytics",
      "templated": "true"
    },
    {
      "href": "https://example.com:443/apiplatform/management/v1/applications/120",
      "method": "PUT",
      "rel": "edit",
      "templated": "true"
    },
    {
      "href": "https://example.com:443/apiplatform/management/v1/applications/120",
      "method": "DELETE",
      "rel": "delete",
      "templated": "true"
    },
    {
      "href": "https://example.com:443/apiplatform/management/v1/applications/120/grants",
      "method": "GET",
      "rel": "manage",
      "templated": "true"
    },
    {
      "href": "https://example.com:443/apiplatform/management/v1/applications/120/key",
      "method": "PUT",
      "rel": "reissuekey",
      "templated": "true"
    },
    {
      "href": "https://example.com:443/apiplatform/management/v1/plans/planId/registrations",
      "method": "POST",
      "rel": "register",
      "templated": "true"
    },
    {
      "href": "https://example.com:443/apiplatform/management/v1/plans/planId/registrations/apiId",
      "method": "DELETE",
      "rel": "unregister",
      "templated": "true"
    }
  ],
  "name": "WeatheriOSApp",
  "plans": [],
  "types": [
    100002
  ]
}