Get configuration
/apiplatform/developers/v1/configuration
Returns the current custom Developer Portal configuration settings as JSON. Returns a 404 if no custom configuration exists.
All authenticated users can request this resource.
Request
- portalName
-
Type:
string
Optional portal name query parameter, for site-specific settings
Response
- application/json
object
- _remove_
-
Type:
array
_remove_Specifies entries to be removed from the default configuration. The entries must specify the path to the JSON property to be removed from the root down to the actual property. Separate property names with slashes. - branding
-
Type:
object
brandingCompany and product names, logos, copyright, etc. - css
-
Type:
object
cssCollection of CSS rules. - language
-
Type:
string
The default language of the Developer Portal. - layout
-
Type:
object
layoutDeveloper Portal UI layout definitions. - modules
-
Type:
object
modulesDeveloper Portal module configuration. - resources
-
Type:
string
The path where the language resources are stored, relative to the root of the portal application. - services
-
Type:
object
servicesURLs of services used by the Developer Portal. - session
-
Type:
object
sessionSession management configuration.
array
-
Type:
string
object
- about
-
Type:
object
branding_aboutAbout box branding configuration. - login
-
Type:
object
branding_loginLogin screen branding properties. - logo
-
Type:
object
branding_logoBranding bar logo properties. - product
-
Type:
string
The branded name of the product. - product_short
-
Type:
string
The short version of the product name for mobile devices. - title
-
Type:
string
The product web page title. - vendor
-
Type:
string
The name of the vendor.
object
- <selector>
-
Type:
object
css_propertiesCollection of CSS properties.
object
- home
-
Type:
object
layout_homeSpecifies the home module. - navigation
-
Type:
object
layout_navigationControls how navigation works in the Developer Portal. - panels
-
Type:
object
layout_panelsAssociates modules with elements (panels) in the page's HTML structure.
object
- base
-
Type:
string
The relative path to the module's base directory. - inventory
-
Type:
object
modules_inventoryThe list of the modules configured in the system. - redirect
-
Type:
object
modules_redirectCollection of module redirection definitions.
object
- analytics
-
Type:
string
Analytics REST services URL - console
-
Type:
string
Developer Portal console REST services URL. - manager
-
Type:
string
Management REST services URL - portal
-
Type:
string
Developer Portal data back-end URL.
object
- logout
-
Type:
string
URL navigated to when a user logs out. - timeout
-
Type:
string
URL navigated to when a session times out.
object
- body
-
Type:
string
Required:true
Paragraphs to be displayed in the About box. - links
-
Type:
array
linksList of the links in the About box footer.
object
- background
-
Type:
object
branding_login_backgroundBranded login screen background image configuration. - css
-
Type:
object
cssCollection of CSS rules. - logo
-
Type:
object
branding_logoBranding bar logo properties. - productLogo
-
Type:
string
Product logo image URL. - splash
-
Type:
string
Splash image URL (mobile devices only).
object
- alignment
-
Type:
string
Logo image alignment CSS definition. - height
-
Type:
string
Logo image height CSS definition. - url
-
Type:
string
Logo image URL. - width
-
Type:
string
Logo image width CSS definition.
array
-
Type:
object
branding_about_linkDefinition links displayed in the About box.
object
- text
-
Type:
string
The link text. - url
-
Type:
string
The link URL.
object
- desktop
-
Type:
string
Desktop background image URL. - mobile
-
Type:
object
branding_login_background_mobileBackground image configuration for mobile devices. - tablet
-
Type:
object
branding_login_background_mobileBackground image configuration for mobile devices.
object
- landscape
-
Type:
string
Landscape orientation background image URL. - portrait
-
Type:
string
Portrait orientation background image URL.
object
- <css property name>
-
Type:
string
This is a placeholder property that represents any CSS property. Any number of properties can be added to the collection. The property value must be a valid CSS value that corresponds the given property.
object
- module
-
Type:
string
The name of the Developer Portal's home module.
object
- <panel_name>
-
Type:
object
layout_panelSpecifies an association between a module and an HTML element.
object
- module
-
Type:
string
The name of the module.
The special value
${window.location.pathname}
means that the panel specifies the main work area of the Developer Portal. The module the URL scheme of that matches the current URL will be loaded here. - selector
-
Type:
string
A JQuery selector that specifies the element the module will be inserted into.
object
- <module_name>
-
Type:
object
moduleThe definition of a single Developer Portal module.
object
- <module_name>
-
Type:
string
The module identified by the property name will be replaced by the module identified by the property value. Both names must exist in the module inventory. Any number of redirections can be specified.
object
- data
-
Type:
object
module_dataModule data configuration. The layout of this object depends upon the module. The properties defined here are named by the module and apply to the data object itself. - documentationUrl
-
Type:
string
Optional URL that points to the context sensitive documentation of the module. If this is not specified, the URL is calculated from the root documentation URL using the page ID. - domain
-
Type:
string
The domain identifies the functional area the module belongs to. This property is relevant only for modules that get loaded into the main work area of the application. The button that belongs to the matching functional area is highlighted in the navigation bar. - pageId
-
Type:
object
module_page_idThe context identifier of a module. - path
-
Type:
string
The path the files of the module are loaded from. The path is relative to the base module path. For each module, there must be an.html
, a.js
and a.css
file in the specified directory; the names of files must match the module's name. - title
-
Type:
string
The page title for the module. If this property is missing, the title defaults to the branded application title. - urlScheme
-
Type:
string
One or more URLs relative to the application's context root that are be associated with the module. The property can either be a single URL or an array of URLs if the module is associated with more than one URL. The URL can reference path or query parameters between curly braces.
object
- <api.details>
-
Type:
object
module_data_api_detailsData for the api.details module. - <application.analytics>
-
Type:
object
module_data_application_analyticsModule data for the application analytics module.
object
- deep
-
Type:
object
module_page_id_deepCollection of page IDs of subpanels or tabs. - root
-
Type:
string
The context identifier of the module itself. This is usually designated as the outer container of the page.
object
- apiaryTheme
-
Type:
object
apiary_themeApiary theme properties. A complex object that specifies the theme properties to be used for embedded Apiary documentation. The theme properties structure is documented here: http://embed.apiary.io/api-reference.html.
object
- ranges
-
Type:
object
analytics_rangesAnalytics time range definitions. - refreshFrequency
-
Type:
integer
(int32
)Time interval between automatic refreshes of analytics data in seconds. The value0
turns off automatic refresh.
object
object
- default
-
Type:
string
The name of the default main analytics range. - main
-
Type:
object
analytics_range_groupA group of analytics ranges. - other
-
Type:
object
analytics_range_groupA group of analytics ranges.
object
- <range_name>
-
Type:
object
analytics_rangeAn analytics time range definition.
object
- granularity
-
Type:
object
analytics_range_granularityDefines the length of the time buckets analytics data is aggregated in. - order
-
Type:
integer
(int32
)The ordinal number of the range as it appears in the range group. - range
-
Type:
object
analytics_range_intervalDefines the time interval for the range. - title
-
Type:
string
The title of the range.
object
- length
-
Type:
integer
(int32
)The length of the aggregation time buckets.
Valid values depend on the time bucket unit:
minute:
1
,5
,10
,15
,30
hour:
1
,2
,3
,4
,6
,12
day:
1
week:
1
month:
1
year:
1
- unit
-
Type:
string
The unit of the aggregation time buckets.
Valid values:
minute
,hour
,day
,week
,month
,year
object
- from
-
Type:
string
Specifies the beginning of the time range. - to
-
Type:
string
Specifies the end of the time range.
object
- <subpanel_name>
-
Type:
string
Specifies a subpanel by name. The property value specifies the subpanel's page ID.
Examples
The following example shows how to retrieve the custom Oracle API Platform Cloud Service Developer Portal configuration file 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/configuration
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:13:46 GMT Content-length: 314 X-oracle-dms-ecid: 7Gs7D0PnR00000000 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 the custom configuration details.
{ "branding": { "vendor": "${i18n.branding.vendor}", "product": "${i18n.branding.product}", "product_short": "${i18n.branding.product_short}", "title": "${i18n.branding.title}", "logo": { "url": "http://example.com/assets/dev-portal-logo.png", "width": "auto", "height": "17px", "alignment": "baseline" } } }