Get applications
/apiplatform/developers/v1/applications
All authenticated users can request this resource. Only applications that the user is issued the Manage Application or View All Details application grant for are returned.
Request
- editable
-
Type:
boolean
Determines if only editable applications (those the user is issued the Manage Application grant for) are returned. A value oftrue
returns only editable applications; all applications are returned otherwise or if this parameter is absent.false
- limit
-
Type:
integer
(int32
)Requested limit for the results list. - offset
-
Type:
integer
(int32
)Requested offset in the results list. - orderBy
-
Type:
array
Collection Format:multi
{ApplicationRestService.getApplicationList.param.orderBy}-
Type:
string
Default Value:name ASC
-
- q
-
Type:
string
{ApplicationRestService.getApplicationList.param.query}
Response
- application/json
object
- count
-
Type:
integer
(int32
)Item count in this response. - filters
-
Type:
array
filtersList of filters applicable for the current API list. This isnull
by default. - hasMore
-
Type:
boolean
Default Value:false
Indicates if there are more results after the current batch. - items
-
Type:
array
itemsRequired:true
Actual response items. - limit
-
Type:
integer
(int32
)Paging limit. - links
-
Type:
array
linksHATEOAS links. - offset
-
Type:
integer
(int32
)Paging offset. - states
-
Type:
array
statesOptional list of API states. This isnull
by default. - totalResults
-
Type:
integer
(int32
)Response item count (excluding the paging parameters).
array
null
by default.-
Type:
string
object
- 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
linksHATEOAS links for the application. - name
-
Type:
string
Required:true
The application's name. - plans
-
Type:
array
plansThe application's plans. - types
-
Type:
array
typesThe application's types.
array
-
Type:
object
GenericLinkHATEOAS generic link representation
array
-
Type:
object
PlanForApplicationApplication-specific plan resource representation.
object
- 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, eithercanonical
or a specific string value. - templated
-
Type:
string
Allowed Values:[ "true", "false" ]
Indicates whether the link has templated parts.
object
- description
-
Type:
string
The application plan's description. - id
-
Type:
integer
(int32
)Required:true
The application plan's ID. - links
-
Type:
array
linksHATEOAS links. - name
-
Type:
string
Required:true
The application plan's name. - registeredApis
-
Type:
array
registeredApisList 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.
array
-
Type:
object
RegisteredApiRegistered API resource representation.
object
- description
-
Type:
string
The API's description. - id
-
Type:
integer
(int32
)Required:true
The API's ID. - links
-
Type:
array
linksHATEOAS 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.
Examples
The following example shows how to retrieve details about applications the requesting user can view in 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/applications
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:57:09 GMT Content-type: application/json X-oracle-dms-ecid: lBh1A1kGW00000000 X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0 Transfer-encoding: chunked
Example of Response Body
The following example shows the contents of the response body in JSON format, including details about the applications the requesting user can view in the Developer Portal and HATEOAS links to related operations.
{ "count": 3, "hasMore": false, "items": [ { "type": "application", "description": "WeatheriOSApp", "id": 119, "links": [ { "href": "https://example.com:443/apiplatform/developers/v1/applications", "method": "GET", "rel": "canonical", "templated": "false" }, { "href": "https://example.com:443/apiplatform/developers/v1/applications/119", "method": "GET", "rel": "canonical", "templated": "true" }, { "href": "https://example.com:443/apiplatform/management/v1/applications/119", "method": "PUT", "rel": "edit", "templated": "true" }, { "href": "https://example.com:443/apiplatform/management/v1/applications/119", "method": "DELETE", "rel": "delete", "templated": "true" }, { "href": "https://example.com:443/apiplatform/management/v1/applications/119/key", "method": "PUT", "rel": "reissuekey", "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/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": [] }, { "type": "application", "description": "MyRegisterAPP Description", "id": 120, "links": [ { "href": "https://example.com:443/apiplatform/developers/v1/applications", "method": "GET", "rel": "canonical", "templated": "false" }, { "href": "https://example.com:443/apiplatform/developers/v1/applications/120", "method": "GET", "rel": "canonical", "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/key", "method": "PUT", "rel": "reissuekey", "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/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": "APIPortalRegisterApp2", "plans": [] }, { "type": "application", "description": "MyRegisterAPP Description", "id": 121, "links": [ { "href": "https://example.com:443/apiplatform/developers/v1/applications", "method": "GET", "rel": "canonical", "templated": "false" }, { "href": "https://example.com:443/apiplatform/developers/v1/applications/121", "method": "GET", "rel": "canonical", "templated": "true" }, { "href": "https://example.com:443/apiplatform/management/v1/applications/121", "method": "PUT", "rel": "edit", "templated": "true" }, { "href": "https://example.com:443/apiplatform/management/v1/applications/121", "method": "DELETE", "rel": "delete", "templated": "true" }, { "href": "https://example.com:443/apiplatform/management/v1/applications/121/key", "method": "PUT", "rel": "reissuekey", "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/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": "APIPortalRegisterApp3", "plans": [] } ], "limit": 0, "links": [ { "href": "https://example.com:443/apiplatform/developers/v1/applications", "method": "GET", "rel": "canonical", "templated": "false" }, { "href": "https://example.com:443/apiplatform/management/v1/applications", "method": "POST", "rel": "create", "templated": "false" } ], "offset": 0 }