REST API for the Consumer Service in Oracle API Platform Cloud Service

Get details for an application

get

/developers/services/v1/applications/{id}

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

The application's ID.

Response

Supported Media Types

application/json

200 Response

JSON structure with details for the application.

Root Schema : PortalApplication

Type: object

Application resource representation.

Show Source

applicationKey: string

The application's key.
contactCompany(optional): string

The owner's company.
contactEmail(optional): string

The owner's email address.
contactFirstName(optional): string

The owner's first name.
contactLastName(optional): string

The owner's last name.
contactLdapName(optional): string

The owner's LDAP user name.
contactPhone(optional): string

The owner's phone number.
createdAt(optional): string

The date and time the application was created.
createdBy(optional): string

The user who created the application.
description(optional): string

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

The application's ID.
lastUpdatedAt(optional): string

The date and time the application was last updated.
lastUpdatedBy(optional): string

The user who last updated the application.
links(optional): array links

HATEOAS links for the application.
name: string

The application's name.
plans(optional): array plans

The application's plans.
types(optional): array types

The application's types.

{
    "type":"object",
    "required":[
        "applicationKey",
        "id",
        "name"
    ],
    "properties":{
        "contactCompany":{
            "type":"string",
            "description":"The owner's company."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"The user who last updated the application."
        },
        "types":{
            "type":"array",
            "description":"The application's types.",
            "items":{
                "type":"integer",
                "format":"int32"
            }
        },
        "lastUpdatedAt":{
            "type":"string",
            "description":"The date and time the application was last updated."
        },
        "contactEmail":{
            "type":"string",
            "description":"The owner's email address."
        },
        "contactFirstName":{
            "type":"string",
            "description":"The owner's first name."
        },
        "applicationKey":{
            "type":"string",
            "description":"The application's key."
        },
        "description":{
            "type":"string",
            "description":"The application's description."
        },
        "contactLdapName":{
            "type":"string",
            "description":"The owner's LDAP user name."
        },
        "createdAt":{
            "type":"string",
            "description":"The date and time the application was created."
        },
        "createdBy":{
            "type":"string",
            "description":"The user who created the application."
        },
        "plans":{
            "type":"array",
            "description":"The application's plans.",
            "items":{
                "$ref":"#/definitions/PlanForApplication"
            }
        },
        "name":{
            "type":"string",
            "description":"The application's name."
        },
        "contactLastName":{
            "type":"string",
            "description":"The owner's last name."
        },
        "links":{
            "type":"array",
            "description":"HATEOAS links for the application.",
            "items":{
                "$ref":"#/definitions/GenericLink"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32",
            "description":"The application's ID."
        },
        "contactPhone":{
            "type":"string",
            "description":"The owner's phone number."
        }
    },
    "description":"Application resource representation."
}

Nested Schema : links

Type: array

HATEOAS links for the application.

Show Source

Array of: object GenericLink

HATEOAS generic link representation.

{
    "type":"array",
    "description":"HATEOAS links for the application.",
    "items":{
        "$ref":"#/definitions/GenericLink"
    }
}

Nested Schema : plans

Type: array

The application's plans.

Show Source

Array of: object PlanForApplication

Application-specific plan resource representation.

{
    "type":"array",
    "description":"The application's plans.",
    "items":{
        "$ref":"#/definitions/PlanForApplication"
    }
}

Nested Schema : types

Type: array

The application's types.

Show Source

Array of: integer(int32)

{
    "type":"array",
    "description":"The application's types.",
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

Nested Schema : GenericLink

Type: object

HATEOAS generic link representation.

Show Source

href: string

Link reference string.
method(optional): string

HTTP method used with the link.
rel: string

Link relation string Value is either canonical or a specific string value.
templated(optional): string

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

Indicates if the link has templated parts.

{
    "type":"object",
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "templated":{
            "type":"string",
            "description":"Indicates if the link has templated parts.",
            "enum":[
                "true",
                "false"
            ]
        },
        "method":{
            "type":"string",
            "description":"HTTP method used with the link."
        },
        "rel":{
            "type":"string",
            "description":"Link relation string Value is either <code>canonical</code> or a specific string value."
        },
        "href":{
            "type":"string",
            "description":"Link reference string."
        }
    },
    "description":"HATEOAS generic link representation."
}

Nested Schema : PlanForApplication

Type: object

Application-specific plan resource representation.

Show Source

constraints(optional): object Constraints

Plan subscription constraints.
description(optional): string

The application plan's description.
entitlements(optional): array entitlements

List of APIs the application registers to.
icon(optional): string

The plan's icon.
id: integer(int32)

The application plan's ID.
links(optional): array links

HATEOAS links.
name: string

The application plan's name.
publicationSettings(optional): object PublicationSettings

Publication settings for the given plan.
publishedState: boolean

Default Value: false

The published state of the plan.
registrationId: integer(int32)

The contract's ID.
registrationState: string

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

The contract's state.
state: string

Allowed Values: [ "ACTIVE", "INACTIVE" ]

The application plan's state.
vanityName: string

The plan's vanity name.

{
    "type":"object",
    "required":[
        "id",
        "name",
        "publishedState",
        "registrationId",
        "registrationState",
        "state",
        "vanityName"
    ],
    "properties":{
        "entitlements":{
            "type":"array",
            "description":"List of APIs the application registers to.",
            "items":{
                "$ref":"#/definitions/Entitlement"
            }
        },
        "vanityName":{
            "type":"string",
            "description":"The plan's vanity name."
        },
        "publishedState":{
            "type":"boolean",
            "description":"The published state of the plan.",
            "default":false
        },
        "icon":{
            "type":"string",
            "description":"The plan's icon."
        },
        "description":{
            "type":"string",
            "description":"The application plan's description."
        },
        "constraints":{
            "description":"The plan subscription constraints, such as rate, limit, etc.",
            "$ref":"#/definitions/Constraints"
        },
        "publicationSettings":{
            "description":"The plan publication settings (information display related flags)",
            "$ref":"#/definitions/PublicationSettings"
        },
        "name":{
            "type":"string",
            "description":"The application plan's name."
        },
        "registrationId":{
            "type":"integer",
            "format":"int32",
            "description":"The contract's ID."
        },
        "links":{
            "type":"array",
            "description":"HATEOAS links.",
            "items":{
                "$ref":"#/definitions/GenericLink"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32",
            "description":"The application plan's ID."
        },
        "state":{
            "type":"string",
            "description":"The application plan's state.",
            "enum":[
                "ACTIVE",
                "INACTIVE"
            ]
        },
        "registrationState":{
            "type":"string",
            "description":"The contract's state.",
            "enum":[
                "SUBSCRIBED",
                "REQUESTING",
                "SUSPENDED",
                "REJECTED"
            ]
        }
    },
    "description":"Application-specific plan resource representation."
}

Nested Schema : Constraints

Type: object

Plan subscription constraints.

Show Source

rate(optional): object Rate

Rate for plan subscription constraints.

{
    "type":"object",
    "properties":{
        "rate":{
            "description":"Subscription rate (for invocations).",
            "$ref":"#/definitions/Rate"
        }
    },
    "description":"Plan subscription constraints."
}

Nested Schema : entitlements

Type: array

List of APIs the application registers to.

Show Source

Array of: object Entitlement

Entitlement resource representation.

{
    "type":"array",
    "description":"List of APIs the application registers to.",
    "items":{
        "$ref":"#/definitions/Entitlement"
    }
}

Nested Schema : links

Type: array

HATEOAS links.

Show Source

Array of: object GenericLink

HATEOAS generic link representation.

{
    "type":"array",
    "description":"HATEOAS links.",
    "items":{
        "$ref":"#/definitions/GenericLink"
    }
}

Nested Schema : PublicationSettings

Type: object

Publication settings for the given plan.

Show Source

constraints(optional): object ConstraintSettings

Plan publication setting's constraint display options.
description(optional): object DescriptionSettings

Plan publication setting's description display options.
icon(optional): object IconSettings

Plan publication setting's plan icon options.
recommended(optional): boolean

Default Value: false

Flag whether the plan should be listed as recommended.

{
    "type":"object",
    "properties":{
        "icon":{
            "description":"Plan icon display setting.",
            "$ref":"#/definitions/IconSettings"
        },
        "description":{
            "description":"Plan description setting.",
            "$ref":"#/definitions/DescriptionSettings"
        },
        "constraints":{
            "description":"Constraint related display settings.",
            "$ref":"#/definitions/ConstraintSettings"
        },
        "recommended":{
            "type":"boolean",
            "description":"Flag whether the plan should be listed as recommended.",
            "default":false
        }
    },
    "description":"Publication settings for the given plan."
}

Nested Schema : Rate

Type: object

Rate for plan subscription constraints.

Show Source

invocations(optional): array invocations

Invocation constraint parameters list.

{
    "type":"object",
    "properties":{
        "invocations":{
            "type":"array",
            "description":"Invocation constraint parameters list.",
            "items":{
                "$ref":"#/definitions/Invocation"
            }
        }
    },
    "description":"Rate for plan subscription constraints."
}

Nested Schema : invocations

Type: array

Invocation constraint parameters list.

Show Source

Array of: object Invocation

Plan constraint - invocation parameters.

{
    "type":"array",
    "description":"Invocation constraint parameters list.",
    "items":{
        "$ref":"#/definitions/Invocation"
    }
}

Nested Schema : Invocation

Type: object

Plan constraint - invocation parameters.

Show Source

limit: string

Maximum number of invocations for the given period.
period: string

Time period, such as minutes, days, months, etc.

{
    "type":"object",
    "required":[
        "limit",
        "period"
    ],
    "properties":{
        "period":{
            "type":"string",
            "description":"Time period, such as minutes, days, months, etc."
        },
        "limit":{
            "type":"string",
            "description":"Maximum number of invocations for the given period."
        }
    },
    "description":"Plan constraint - invocation parameters."
}

Nested Schema : Entitlement

Type: object

Entitlement resource representation.

Show Source

constraints(optional): object Constraints

Plan subscription constraints.
description(optional): string

The API's description.
endpoints(optional): array endpoints

The list of endpoints for this API.
entitlementId: integer(int32)

The API contract ID.
icon(optional): string

The API's icon data (base64 encoded).
id: integer(int32)

The API's ID.
links(optional): array links

HATEOAS links
name: string

The API's name.
state: string

The API contract state (currently ACTIVE/INACTIVE).
unpublished(optional): boolean

Default Value: false

Flag indicating if the API was unpublished.
vanityName: string

The API's vanity name.
version: string

The API's version.

{
    "type":"object",
    "required":[
        "entitlementId",
        "id",
        "name",
        "state",
        "vanityName",
        "version"
    ],
    "properties":{
        "vanityName":{
            "type":"string",
            "description":"The API's vanity name."
        },
        "endpoints":{
            "type":"array",
            "description":"The list of endpoints for this API.",
            "items":{
                "$ref":"#/definitions/Endpoint"
            }
        },
        "name":{
            "type":"string",
            "description":"The API's name."
        },
        "icon":{
            "type":"string",
            "description":"The API's icon data (base64 encoded)."
        },
        "entitlementId":{
            "type":"integer",
            "format":"int32",
            "description":"The API contract ID."
        },
        "description":{
            "type":"string",
            "description":"The API's description."
        },
        "links":{
            "type":"array",
            "description":"HATEOAS links",
            "items":{
                "$ref":"#/definitions/GenericLink"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32",
            "description":"The API's ID."
        },
        "state":{
            "type":"string",
            "description":"The API contract state (currently ACTIVE/INACTIVE)."
        },
        "unpublished":{
            "type":"boolean",
            "description":"Flag indicating if the API was unpublished.",
            "default":false
        },
        "version":{
            "type":"string",
            "description":"The API's version."
        },
        "constraints":{
            "description":"Plan's constraints",
            "$ref":"#/definitions/Constraints"
        }
    },
    "description":"Entitlement resource representation."
}

Nested Schema : endpoints

Type: array

The list of endpoints for this API.

Show Source

Array of: object Endpoint

Endpoint resource representation.

{
    "type":"array",
    "description":"The list of endpoints for this API.",
    "items":{
        "$ref":"#/definitions/Endpoint"
    }
}

Nested Schema : links

Type: array

HATEOAS links

Show Source

Array of: object GenericLink

HATEOAS generic link representation.

{
    "type":"array",
    "description":"HATEOAS links",
    "items":{
        "$ref":"#/definitions/GenericLink"
    }
}

Nested Schema : Endpoint

Type: object

Endpoint resource representation.

Show Source

gateway(optional): object Gateway
state(optional): string

Endpoint state value.
urls(optional): array urls

List of endpoint URL addresses.

{
    "type":"object",
    "properties":{
        "urls":{
            "type":"array",
            "description":"List of endpoint URL addresses.",
            "items":{
                "type":"string"
            }
        },
        "state":{
            "type":"string",
            "description":"Endpoint state value."
        },
        "gateway":{
            "description":"Endpoint's gateway.",
            "$ref":"#/definitions/Gateway"
        }
    },
    "description":"Endpoint resource representation."
}

Nested Schema : Gateway

Type: object

Nested Schema : urls

Type: array

List of endpoint URL addresses.

Show Source

Array of: string

{
    "type":"array",
    "description":"List of endpoint URL addresses.",
    "items":{
        "type":"string"
    }
}

Nested Schema : ConstraintSettings

Type: object

Plan publication setting's constraint display options.

Show Source

rate(optional): object RateSettings

Plan publication setting's invocation rate display options flag.

{
    "type":"object",
    "properties":{
        "rate":{
            "description":"Subscription rate display settings.",
            "$ref":"#/definitions/RateSettings"
        }
    },
    "description":"Plan publication setting's constraint display options."
}

Nested Schema : DescriptionSettings

Type: object

Plan publication setting's description display options.

Show Source

displayed(optional): boolean

Default Value: false

Display flag (boolean).

{
    "type":"object",
    "properties":{
        "displayed":{
            "type":"boolean",
            "description":"Display flag (boolean).",
            "default":false
        }
    },
    "description":"Plan publication setting's description display options."
}

Nested Schema : IconSettings

Type: object

Plan publication setting's plan icon options.

Show Source

displayed(optional): boolean

Default Value: false

Display flag (boolean).

{
    "type":"object",
    "properties":{
        "displayed":{
            "type":"boolean",
            "description":"Display flag (boolean).",
            "default":false
        }
    },
    "description":"Plan publication setting's plan icon options."
}

Nested Schema : RateSettings

Type: object

Plan publication setting's invocation rate display options flag.

Show Source

invocations(optional): object InvocationSettings

Plan invocation's display options.

{
    "type":"object",
    "properties":{
        "invocations":{
            "description":"Invocation display options.",
            "$ref":"#/definitions/InvocationSettings"
        }
    },
    "description":"Plan publication setting's invocation rate display options flag."
}

Nested Schema : InvocationSettings

Type: object

Plan invocation's display options.

Show Source

displayed(optional): boolean

Default Value: false

Display flag (boolean).
displayText(optional): string

Text to display.

{
    "type":"object",
    "properties":{
        "displayed":{
            "type":"boolean",
            "description":"Display flag (boolean).",
            "default":false
        },
        "displayText":{
            "type":"string",
            "description":"Text to display."
        }
    },
    "description":"Plan invocation's display options."
}

400 Response

Bad request: indicates a problem with the input parameters.

401 Response

Authentication required.

404 Response

Application not found.

500 Response

Server error.

Examples

The following example shows how to retrieve details about the {applicationId} application submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -i -X GET 
-H "Authorization: Bearer access_token
https://example.com:443/developers/services/v1/applications/{id}

{id} is the unique ID for an application. To retrieve available applications, see Get applications.

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Server: Oracle Traffic Director
Date: Wed, 20 Dec 2017 05:19:46 GMT
Content-type: application/json
X-oracle-dms-ecid: 6^3rv0_eR00000000
X-oracle-dms-rid: 0:1

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.

{
    "contactCompany": "oracle",
    "lastUpdatedBy": "admin",
    "types": [],
    "contactEmail": "temp@oracle.com",
    "lastUpdatedAt": "2017-12-20T23:09:39-0800",
    "contactFirstName": "John",
    "applicationKey": "25f1f87a-4c9c-4609-b158-4fd81f4f5a26",
    "description": "Application for Temperature",
    "contactLdapName": "",
    "createdAt": "2017-12-20T22:30:24-0800",
    "createdBy": "admin",
    "plans": [],
    "name": "Temperature",
    "contactLastName": "Fernandaz",
    "links": [
        {
            "method": "GET",
            "templated": "true",
            "rel": "canonical",
            "href": "http://example.com:443/developers/services/v1/applications/110"
        },
        {
            "method": "GET",
            "templated": "true",
            "rel": "analytics",
            "href": "http://example.com:443/developers/services/v1/analytics/totals/requests"
        },
        {
            "method": "PUT",
            "templated": "true",
            "rel": "edit",
            "href": "http://example.com:443/developers/services/v1/applications/110"
        },
        {
            "method": "DELETE",
            "templated": "true",
            "rel": "delete",
            "href": "http://example.com:443/developers/services/v1/applications/110"
        },
        {
            "method": "GET",
            "templated": "true",
            "rel": "manage",
            "href": "http://example.com:443/developers/services/v1/applications/110/grants"
        },
        {
            "method": "PUT",
            "templated": "true",
            "rel": "reissuekey",
            "href": "http://example.com:443/developers/services/v1/applications/110/key"
        },
        {
            "method": "POST",
            "templated": "true",
            "rel": "register",
            "href": "http://example.com:443/developers/services/v1/plans/planId/subscriptions"
        },
        {
            "method": "DELETE",
            "templated": "true",
            "rel": "unregister",
            "href": "http://example.com:443/developers/services/v1/plans/planId/subscriptions/apiId"
        }
    ],
    "id": 110,
    "contactPhone": "8765432"
}