Jump to

• Request
• Response

Get a branding row

get

/fscmRestApi/resources/11.13.18.05/brandings/{BrandingId}

Request

Path Parameters

• BrandingId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  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).
• fields: string
  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
• links: string
  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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  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".
• REST-Framework-Version:
  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

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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".
• REST-Framework-Version(required):
  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 : brandings-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the branding definition is active or inactive.
• brandingAttributes: array Theme Attributes
  Title: Theme Attributes

  The theme attributes resource is a child of UI branding options resource and provides a list of attributes associated with branding student management pages.
• BrandingCode: string
  Title: Branding Code

  Maximum Length: 30

  The alternate unique identifier for the branding definition.
• BrandingDescription: string
  Title: Branding Description

  Maximum Length: 2147483647

  The description for the branding definition.
• BrandingId: integer (int64)
  Title: Branding ID

  The branding definition unique identifier. When the user makes a branding change such as adding a small logo, it's a branding definition.
• BrandingName: string
  Title: Branding Name

  Maximum Length: 50

  The name for the branding definition. Branding definition indicates the change that's possible in the user interface. For example, a branding definition exists that allows academic institutions to update a small logo on the standard page header and this logo is displayed only on small screens such as mobile phones.
• BrandingStyles: string
  Title: Branding Styles

  Maximum Length: 2147483647

  The delivered branding styles generated from the branding attributes and attribute values. For example, branding attribute could be font color and the attribute values could be different colors.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The person who created the branding definition.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the branding definition is created.
• DefaultFlag: boolean
  Maximum Length: 1

  Indicates whether the branding definition is default.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the branding definition is updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The person who updated the branding definition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SeedDataFlag: boolean
  Read Only: true

  Default Value: false

  Indicates whether the branding is predefined data.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The person who updated the branding definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BrandingDescription":{
            "title":"Branding Description",
            "maxLength":2147483647,
            "type":"string",
            "description":"The description for the branding definition.",
            "nullable":true,
            "x-queryable":false
        },
        "BrandingStyles":{
            "title":"Branding Styles",
            "maxLength":2147483647,
            "type":"string",
            "description":"The delivered branding styles generated from the branding attributes and attribute values. For example, branding attribute could be font color and the attribute values could be different colors.",
            "nullable":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the branding definition is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The person who created the branding definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BrandingCode":{
            "title":"Branding Code",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier for the branding definition.",
            "nullable":false,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the branding definition is active or inactive.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "BrandingName":{
            "title":"Branding Name",
            "maxLength":50,
            "type":"string",
            "description":"The name for the branding definition. Branding definition indicates the change that's possible in the user interface. For example, a branding definition exists that allows academic institutions to update a small logo on the standard page header and this logo is displayed only on small screens such as mobile phones.",
            "nullable":false,
            "x-queryable":true
        },
        "BrandingId":{
            "title":"Branding ID",
            "type":"integer",
            "description":"The branding definition unique identifier. When the user makes a branding change such as adding a small logo, it's a branding definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "brandingAttributes":{
            "title":"Theme Attributes",
            "type":"array",
            "description":"The theme attributes resource is a child of UI branding options resource and provides a list of attributes associated with branding student management pages.",
            "items":{
                "$ref":"#/components/schemas/brandings-brandingAttributes-item-response"
            }
        },
        "SeedDataFlag":{
            "type":"boolean",
            "description":"Indicates whether the branding is predefined data.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "precision":1,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DefaultFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the branding definition is default.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the branding definition is updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Theme Attributes

Type: array

Title: Theme Attributes

The theme attributes resource is a child of UI branding options resource and provides a list of attributes associated with branding student management pages.

Show Source

• Array of: object brandings-brandingAttributes-item-response

{
    "title":"Theme Attributes",
    "type":"array",
    "description":"The theme attributes resource is a child of UI branding options resource and provides a list of attributes associated with branding student management pages.",
    "items":{
        "$ref":"#/components/schemas/brandings-brandingAttributes-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : brandings-brandingAttributes-item-response

Type: object

Show Source

• BrandingAttributeCode: string
  Title: Branding Attribute Code

  Maximum Length: 30

  The branding attribute identifier. A list of accepted values is defined in the lookup type ORA_HEY_BRAND_ATTRIBUTE_CODE.
• BrandingAttributeId: integer (int64)
  Title: Branding Attribute ID

  The branding attribute unique identifier.
• BrandingAttributeMeaning: string
  Title: Branding Attribute

  Read Only: true

  Maximum Length: 80

  The meaning of the branding attribute identifier. Valid values include Large logo, Small logo, or Primary branding color. A list of accepted values is defined in the lookup type ORA_HEY_BRAND_ATTRIBUTE_CODE.
• BrandingAttributeValue: string
  Title: Branding Attribute Value

  Maximum Length: 2147483647

  The value of the branding attribute. For example, the value can be the URL of a small or large logo.
• BrandingCode: string
  Maximum Length: 30

  The alternate unique identifier for the branding attribute.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The person who created the branding attribute.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the branding attribute is created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the branding attribute is updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The person who updated the branding attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SequenceNumber: integer (int32)
  Title: Sequence Number

  The sequence number of the branding attribute.
• ValueFormatCode: string
  Title: Value Format Code

  Maximum Length: 30

  The format of data contained in the branding attribute value. Valid values include ORA_HEY_FORMAT_SVG, ORA_HEY_FORMAT_PNG, ORA_HEY_FORMAT_URL, or ORA_HEY_FORMAT_HEX. A list of accepted values is defined in the lookup type ORA_HEY_ATTRIBUTE_VALUE_FORMAT.
• ValueFormatMeaning: string
  Title: Value Format

  Read Only: true

  Maximum Length: 80

  The meaning of the format of the branding attribute value. Valid values include SVG image, PNG image, URL address, or Hexadecimal color code. A list of accepted values is defined in the lookup type ORA_HEY_ATTRIBUTE_VALUE_FORMAT.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The person who updated the branding attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the branding attribute is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The person who created the branding attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BrandingAttributeValue":{
            "title":"Branding Attribute Value",
            "maxLength":2147483647,
            "type":"string",
            "description":"The value of the branding attribute. For example, the value can be the URL of a small or large logo.",
            "nullable":true,
            "x-queryable":false
        },
        "BrandingAttributeCode":{
            "title":"Branding Attribute Code",
            "maxLength":30,
            "type":"string",
            "description":"The branding attribute identifier. A list of accepted values is defined in the lookup type ORA_HEY_BRAND_ATTRIBUTE_CODE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BrandingCode":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier for the branding attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "BrandingAttributeId":{
            "title":"Branding Attribute ID",
            "type":"integer",
            "description":"The branding attribute unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "BrandingAttributeMeaning":{
            "title":"Branding Attribute",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the branding attribute identifier. Valid values include Large logo, Small logo, or Primary branding color. A list of accepted values is defined in the lookup type ORA_HEY_BRAND_ATTRIBUTE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ValueFormatMeaning":{
            "title":"Value Format",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the format of the branding attribute value. Valid values include SVG image, PNG image, URL address, or Hexadecimal color code. A list of accepted values is defined in the lookup type ORA_HEY_ATTRIBUTE_VALUE_FORMAT.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The sequence number of the branding attribute.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ValueFormatCode":{
            "title":"Value Format Code",
            "maxLength":30,
            "type":"string",
            "description":"The format of data contained in the branding attribute value. Valid values include ORA_HEY_FORMAT_SVG, ORA_HEY_FORMAT_PNG, ORA_HEY_FORMAT_URL, or ORA_HEY_FORMAT_HEX. A list of accepted values is defined in the lookup type ORA_HEY_ATTRIBUTE_VALUE_FORMAT.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the branding attribute is updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

brandingAttributes

Operation: /fscmRestApi/resources/11.13.18.05/brandings/{BrandingId}/child/brandingAttributes

Parameters:

• BrandingId: $request.path.BrandingId

The theme attributes resource is a child of UI branding options resource and provides a list of attributes associated with branding student management pages.

Back to Top