Set configuration
/developers/services/v1/portal/customization/configuration
Customizes the Developer Portal configuration based on the provided JSON. You can post a partial JSON file as long as it retains the same structure as the original resource file.
Users requesting this resource must be assigned the Administrator role.
Request
- application/json
-
portalName(optional): string
Optional portal name query parameter, for site-specific settings
object
-
_remove_(optional):
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(optional):
object branding
Company and product names, logos, copyright, etc.
-
css(optional):
object css
Collection of CSS rules.
-
language(optional):
string
The default language of the Developer Portal.
-
layout(optional):
object layout
Developer Portal UI layout definitions.
-
modules(optional):
object modules
Developer Portal module configuration.
-
resources(optional):
string
The path where the language resources are stored, relative to the root of the portal application.
-
services(optional):
object services
URLs of services used by the Developer Portal.
-
session(optional):
object session
Session management configuration.
array
object
-
about(optional):
object branding_about
About box branding configuration.
-
login(optional):
object branding_login
Login screen branding properties.
-
logo(optional):
object branding_logo
Branding bar logo properties.
-
product(optional):
string
The branded name of the product.
-
product_short(optional):
string
The short version of the product name for mobile devices.
-
title(optional):
string
The product web page title.
-
vendor(optional):
string
The name of the vendor.
object
-
<selector>(optional):
object css_properties
Collection of CSS properties.
object
-
home(optional):
object layout_home
Specifies the home module.
- navigation(optional): object layout_navigation
-
panels(optional):
object layout_panels
Associates modules with elements (panels) in the page's HTML structure.
object
-
base(optional):
string
The relative path to the module's base directory.
-
inventory(optional):
object modules_inventory
The list of the modules configured in the system.
-
redirect(optional):
object modules_redirect
Collection of module redirection definitions.
object
-
analytics(optional):
string
Analytics REST services URL
-
console(optional):
string
Developer Portal console REST services URL.
-
manager(optional):
string
Management REST services URL
-
portal(optional):
string
Developer Portal data back-end URL.
object
-
logout(optional):
string
URL navigated to when a user logs out.
-
timeout(optional):
string
URL navigated to when a session times out.
object
-
body:
string
Paragraphs to be displayed in the About box.
-
links(optional):
array links
List of the links in the About box footer.
object
-
background(optional):
object branding_login_background
Branded login screen background image configuration.
-
css(optional):
object css
Collection of CSS rules.
-
logo(optional):
object branding_logo
Branding bar logo properties.
-
productLogo(optional):
string
Product logo image URL.
-
splash(optional):
string
Splash image URL (mobile devices only).
object
-
alignment(optional):
string
Logo image alignment CSS definition.
-
height(optional):
string
Logo image height CSS definition.
-
url(optional):
string
Logo image URL.
-
width(optional):
string
Logo image width CSS definition.
array
-
Array of:
object branding_about_link
Definition links displayed in the About box.
object
-
text(optional):
string
The link text.
-
url(optional):
string
The link URL.
object
-
desktop(optional):
string
Desktop background image URL.
-
mobile(optional):
object branding_login_background_mobile
Background image configuration for mobile devices.
-
tablet(optional):
object branding_login_background_mobile
Background image configuration for mobile devices.
object
-
landscape(optional):
string
Landscape orientation background image URL.
-
portrait(optional):
string
Portrait orientation background image URL.
object
-
<css property name>(optional):
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(optional):
string
The name of the Developer Portal's home module.
object
-
<panel_name>(optional):
object layout_panel
Specifies an association between a module and an HTML element.
object
-
module(optional):
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(optional):
string
A JQuery selector that specifies the element the module will be inserted into.
object
-
<module_name>(optional):
object module
The definition of a single Developer Portal module.
object
-
<module_name>(optional):
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(optional):
object module_data
Module 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(optional):
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(optional):
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(optional):
object module_page_id
The context identifier of a module.
-
path(optional):
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(optional):
string
The page title for the module. If this property is missing, the title defaults to the branded application title.
-
urlScheme(optional):
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>(optional):
object module_data_api_details
Data for the api.details module.
-
<application.analytics>(optional):
object module_data_application_analytics
Module data for the application analytics module.
object
-
deep(optional):
object module_page_id_deep
Collection of page IDs of subpanels or tabs.
-
root(optional):
string
The context identifier of the module itself. This is usually designated as the outer container of the page.
object
-
apiaryTheme(optional):
object apiary_theme
Apiary 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(optional):
object analytics_ranges
Analytics time range definitions.
-
refreshFrequency(optional):
integer(int32)
Time interval between automatic refreshes of analytics data in seconds. The value
0
turns off automatic refresh.
object
object
-
default(optional):
string
The name of the default main analytics range.
-
main(optional):
object analytics_range_group
A group of analytics ranges.
-
other(optional):
object analytics_range_group
A group of analytics ranges.
object
-
<range_name>(optional):
object analytics_range
An analytics time range definition.
object
-
granularity(optional):
object analytics_range_granularity
Defines the length of the time buckets analytics data is aggregated in.
-
order(optional):
integer(int32)
The ordinal number of the range as it appears in the range group.
-
range(optional):
object analytics_range_interval
Defines the time interval for the range.
-
title(optional):
string
The title of the range.
object
-
length(optional):
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(optional):
string
The unit of the aggregation time buckets.
Valid values:
minute
,hour
,day
,week
,month
,year
object
-
from(optional):
string
Specifies the beginning of the time range.
-
to(optional):
string
Specifies the end of the time range.
object
-
<subpanel_name>(optional):
string
Specifies a subpanel by name. The property value specifies the subpanel's page ID.
Response
204 Response
401 Response
404 Response
Examples
The following example shows how to customize the Oracle API Platform Cloud Service - Classic Developer Portal by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X PUT -u apicsadmin:password -H "Content-Type: application/json" -d @config.json https://example.com/developers/services/v1/portal/customization/configuration
Example of Request Body
The following shows an example of the request body in JSON format that updates the Consumer Portal logo.
{ "branding": { "product": "${i18n.branding.product}", "product_short": "${i18n.branding.product_short}", "vendor": "${i18n.branding.vendor}", "logo": { "width": "auto", "alignment": "baseline", "url": "http://example.com/assets/dev-portal-logo.png", "height": "17px" }, "title": "${i18n.branding.title}" } }
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 204 No Content Date: Fri, 05 Jan 2018 05:38:18 GMT Content-length: 0 X-oracle-dms-ecid: fd4f7481-e810-498f-9ef3-3cc199fcc455-0006eb27 X-oracle-dms-rid: 0:1