1. REST API for Common Features in Oracle Fusion Cloud Applications
  2. Tasks
  3. ATK Themes

Get all themes

get

/fscmRestApi/resources/11.13.18.05/atkThemes

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds a theme with the specified theme identifier.
      Finder Variables:
      • SkinId; string; The unique identifier of the theme.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BannerImage; string; The cover image of the home page banner as well as the background image of OSN.
    • BannerImageType; string; Type of the banner image whether it???s a link, or an uploaded image, or an image that Oracle predefined.
    • BaseSeededTheme; string; The basic theme from Oracle. The user-defined theme is created on top of it.
    • ButtonBGColor; string; The button background color if gradient isn't supported.
    • ButtonBGEndColor; string; The end color of the gradient for the background of the button.
    • ButtonBGStartColor; string; The start color of the gradient for the background of the button.
    • ButtonBorderColor; string; The color of the border around the button.
    • ButtonLabelColor; string; The hex color code for the text on the buttons.
    • CardTheme; string; A style of the HCM card. The value can be dark or light.
    • CornerRadius; string; The value of the radius that defines the round corners of the buttons.
    • GlobalBGColor; string; The hex color code for the background color of the page.
    • GlobalBgColorGradient; string; Indicates if the background color of the page supports gradient or not.
    • GlobalBgColorGradientType; string; Determines the type of the gradient support that the user wants to choose for the global background color.
    • GlobalBgEndColor; string; The end color of the gradient for the global background color.
    • GlobalBgStartColor; string; The start color of the gradient for the global background color.
    • GlobalRegionBGColor; string; The hex color code for the background of global region on the pages.
    • GlobalRegionLabelColor; string; The hex color code for the global region labels on the pages.
    • GridCardSize; string; The size of the cards displayed on the grid or banner.
    • GridIconBackgroundColor; string; The color of the grid icon background.
    • GridIconBackgroundColorType; string; Determines if the icon background color is monochrome or multicolor.
    • GridIconColor; string; The color of the icons displayed in the grid, or on filmstrip, or the newsfeed page.
    • GridIconColorType; string; Indicates if the grid icon color is monochrome or multicolor.
    • GridIconIndicatorColor; string; This is the color of the dot in cluster icons that are usually displayed in the grid or banner of homepage.
    • GridIconShape; string; Determines the shape of the filmstrip or the grid icons.
    • HeaderLabelColor; string; The color of the page header label.
    • HighLightColor; string; The color used to highlight any important text or image, such as the notification count and help icon.
    • HomeLayoutType; string; The type of the home layout, such as grid, banner, or newsfeed.
    • HomePanelStyle; string; Indicates whether the background of the OSN panel is dark or light.
    • IconLabelColor; string; The label color of the navigation icons shown on the homepage or on the film strip.
    • IconStyle; string; The style of the icon that existed before Rel13. It's no longer used in Rel13.
    • IsButtonGradientSupported; string; Indicates if gradient is supported for the background color of the button.
    • IsEditedByAdvEditor; string; Indicates whether the theme was edited by the Advanced Theme Editor.
    • IsSeededTheme; string; Indicates if the theme was predefined by Oracle or if the user created it.
    • LastModified; string; The date and time when the them was last modified.
    • LoginAccentColor; string; The Accent color.
    • LoginBackgroundColor; string; The background color of the login page.
    • LoginBannerImage; string; The banner image of the proposed login page.
    • LoginBannerImageType; string; The banner image type of the proposed login page.
    • LoginHeadingColor; string; The color of the login page header.
    • LoginLinkColor; string; The color of the URL that opens the login page.
    • LoginLogo; string; The logo of the proposed login page.
    • LoginLogoType; string; The type of the proposed login logo.
    • LoginRepeatBannerImage; string; Indicates if the banner image is reapeated on login page or not.
    • LoginReuseGeneral; string; Indicates whether the login page CSS parameters are the same as that of the Fusion theme.
    • LogoHeight; string; Height of the logo.
    • LogoName; string; Name of the logo used for the theme.
    • LogoType; string; The type of the image whether it???s a link, or an uploaded file, or an image that Oracle predefined.
    • LogoWidth; string; Width of the logo.
    • OraHeroAnimationEnabled; string; The option to enable or disable the welcome animation on the Ask Oracle UI.
    • PageLinkColor; string; The color of the page links.
    • RepeatWatermark; string; Indicates if the image is repeated throughout the background or not.
    • SelectionColor; string; The color to indicate selection of the vertical tab associated with a page.
    • SkinId; string; The Unique id of the theme.
    • Status; string; Indicates the status of a theme. The value can be either Inactive or Active.
    • SvgIconType; string; Indicates if the icon type is solid or outlined.
    • ThemeName; string; The display name of the theme.
    • WaterMarkName; string; Name of the background image.
    • WaterMarkType; string; Type of the background image whether it???s a link, or an uploaded file, or an image that Oracle predefined.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : atkThemes
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : atkThemes-item-response
Type: object
Show Source
Back to Top