Get details for an API's latest iteration
/developers/services/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: string
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
- application/json
200 Response
object
-
allVersions(optional):
array allVersions
List of the API's available versions.
-
createdAt(optional):
string
The date and time the API was created.
-
createdBy(optional):
string
The name of the user who created the API.
-
description(optional):
string
The API's description.
-
details(optional):
object ApiDetailArtifact
API detail artifact representation
-
icon(optional):
string
Artifact containing the API's icon, if changed.
-
id:
integer(int32)
The API's ID.
-
iterationId(optional):
integer(int32)
The API's iteration ID.
-
links(optional):
array links
HATEOAS links for the API.
-
name:
string
The API's name.
-
plans(optional):
array plans
The API's deployment plans.
-
state(optional):
string
Allowed Values:
[ "ALPHA", "BETA", "RETIRED", "RELEASED", "DEPRECATED" ]
The API's state. Valid values:ALPHA
,BETA
,RELEASED
,DEPRECATED
, andRETIRED
. -
vanityName:
string
The API's vanity name.
-
version:
string
The API's version.
-
visibility(optional):
string
Allowed Values:
[ "PROTECTED", "INTERNAL", "PUBLIC" ]
{dto.Api.visibility}
array
-
Array of:
object ApiVersion
API version resource representation.
object
-
documentation(optional):
object ApiDetailsItem
API detail representation for overview and documentation subtypes.
-
overview(optional):
object ApiDetailsItem
API detail representation for overview and documentation subtypes.
array
-
Array of:
object GenericLink
HATEOAS generic link representation.
array
-
Array of:
object PlanForApi
Plan for a given API resource representation.
object
-
vanityName:
string
The API's vanity name.
-
version:
string
The API's version.
object
-
data(optional):
string
The documentation data as a string.
-
dataType(optional):
string
The documentation data type.
-
docType(optional):
string
The documentation type.
object
-
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.
object
-
constraints(optional):
object Constraints
Plan subscription constraints.
-
description(optional):
string
The plan's description.
-
icon(optional):
string
The plan's icon.
-
id:
integer(int32)
The plan's ID.
-
links(optional):
array links
HATEOAS links.
-
name:
string
The plan's name.
-
publicationSettings(optional):
object PublicationSettings
Publication settings for the given plan.
-
subscriptions(optional):
array subscriptions
List of applications registered to the API.
-
vanityName:
string
{dto.PlanForApi.vanityName}
object
-
rate(optional):
object Rate
Rate for plan subscription constraints.
array
-
Array of:
object GenericLink
HATEOAS generic link representation.
object
-
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.
object
-
invocations(optional):
array invocations
Invocation constraint parameters list.
array
-
Array of:
object Invocation
Plan constraint - invocation parameters.
object
-
limit:
string
Maximum number of invocations for the given period.
-
period:
string
Time period, such as minutes, days, months, etc.
object
-
rate(optional):
object RateSettings
Plan publication setting's invocation rate display options flag.
object
-
displayed(optional):
boolean
Default Value:
false
Display flag (boolean).
object
-
displayed(optional):
boolean
Default Value:
false
Display flag (boolean).
object
-
invocations(optional):
object InvocationSettings
Plan invocation's display options.
object
-
displayed(optional):
boolean
Default Value:
false
Display flag (boolean). -
displayText(optional):
string
Text to display.
object
-
state(optional):
string
The subscription's state.
-
stateComments(optional):
string
Comments regarding the subscription's state.
-
stateUpdatedAt(optional):
string
The date and time the subscription's state was last updated.
-
stateUpdatedBy(optional):
string
The user who last updated the subscription's state.
object
-
createdAt(optional):
string
The date and time the subscription was created.
-
createdBy(optional):
string
The user who created the subscription.
-
updatedAt(optional):
string
The date and time the subscription was last updated.
-
updatedBy(optional):
string
The user who last updated the subscription.
object
object
404 Response
500 Response
Examples
The following example shows how to return details about the latest iteration of the {vanityName}
for an API 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:443/developers/services/v1/apis/{vanityName}/current
{vanityName}
is 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, see Get APIs.
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 the details of the API.
"vanityName": "creditcheck", "visibility": "PROTECTED", "description": "Mobile devices", "version": "18.1.1", "createdAt": "2017-12-19T20:32:07-0800", "createdBy": "apicsadmin", "allVersions": [ { "vanityName": "creditcheck", "version": "18.1.1" } ], "name": "Mobile Device", "details": { "overview": { "data": "Mobile", "docType": "html", "dataType": "text" } }, "links": [ { "method": "GET", "templated": "true", "rel": "canonical", "href": "http://example.com:443/developers/services/v1/apis/creditcheck/current" } ], "id": 102, "state": "ALPHA", "iterationId": 4 }