Jump to

• Request
• Response
• Examples

Get Global Branding

get

/rest/v19/globalBranding

This endpoint retrieves the global branding properties defined for a site.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Branding properties.

Body ()

Root Schema : Branding Properties

Type: object

Title: Branding Properties

Show Source

• backgroundColor: string
  Title: Background Color

  Background color for the branding.
• backgroundGradient: string
  Title: Background Gradient

  Background Type.
• borderColor: string
  Title: Border Color

  Color of the border.
• borderWidth: string
  Title: Border Width

  Width of the border.
• imageAlt: string
  Title: Image Alt

  Alternate text for the image.
• imageUrl: string
  Title: Image Url

  Image file path.
• isDropShadow: boolean
  Title: Is Drop Shadow

  Drop shadow property is enabled or not.
• isTitleBold: boolean
  Title: Is Title Bold

  Font type bold is enabled or not.
• isTitleItalics: boolean
  Title: Is Title Italics

  Font Style italics is enabled or not.
• isTitleUnderline: boolean
  Title: Is Title Underline

  Font format underlined is enabled or not.
• title: string
  Title: Title

  Title of the global branding.
• titleColor: string
  Title: Title Color

  Color of the title font.
• titleFont: string
  Title: Title Font

  Font style for the title.
• titleFontSize: string
  Title: Title Font Size

  Size of the title font.
• titleJustify: string
  Title: Title Justify

  Justification for the title.

{
    "type":"object",
    "properties":{
        "titleFont":{
            "type":"string",
            "description":"Font style for the title.",
            "title":"Title Font"
        },
        "titleFontSize":{
            "type":"string",
            "description":"Size of the title font.",
            "title":"Title Font Size"
        },
        "titleColor":{
            "type":"string",
            "description":"Color of the title font.",
            "title":"Title Color"
        },
        "titleJustify":{
            "type":"string",
            "description":"Justification for the title.",
            "title":"Title Justify"
        },
        "title":{
            "type":"string",
            "description":"Title of the global branding.",
            "title":"Title"
        },
        "backgroundColor":{
            "type":"string",
            "description":"Background color for the branding.",
            "title":"Background Color"
        },
        "backgroundGradient":{
            "type":"string",
            "description":"Background Type.",
            "title":"Background Gradient"
        },
        "borderWidth":{
            "type":"string",
            "description":"Width of the border.",
            "title":"Border Width"
        },
        "borderColor":{
            "type":"string",
            "description":"Color of the border.",
            "title":"Border Color"
        },
        "imageUrl":{
            "type":"string",
            "description":"Image file path.",
            "title":"Image Url"
        },
        "imageAlt":{
            "type":"string",
            "description":"Alternate text for the image.",
            "title":"Image Alt"
        },
        "isTitleBold":{
            "type":"boolean",
            "description":"Font type bold is enabled or not.",
            "title":"Is Title Bold"
        },
        "isTitleItalics":{
            "type":"boolean",
            "description":"Font Style italics is enabled or not.",
            "title":"Is Title Italics"
        },
        "isTitleUnderline":{
            "type":"boolean",
            "description":"Font format underlined is enabled or not.",
            "title":"Is Title Underline"
        },
        "isDropShadow":{
            "type":"boolean",
            "description":"Drop shadow property is enabled or not.",
            "title":"Is Drop Shadow"
        }
    },
    "title":"Branding Properties"
}

Back to Top

Examples

The following example shows how to retrieve the global branding properties defined for a site by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/globalBrandig

Response Body Sample

{
  "titleFont": "Helvetica Neue,Helvetica,Arial,sans-serif",
  "titleFontSize": "15",
  "isTitleBold": false,
  "isTitleItalics": false,
  "isTitleUnderline": false,
  "titleColor": "#454545",
  "titleJustify": "LEFT",
  "title": "CPQ Cloud",
  "backgroundColor": "#F5F5F5",
  "backgroundGradient": "",
  "borderWidth": "0",
  "borderColor": "#FFFFFF",
  "isDropShadow": true,
  "imageUrl": "/logo/oracle_logo_sm.png",
  "imageAlt": "Oracle"
}

Back to Top