Update a branding row
patch
/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=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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. -
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. -
DefaultFlag: boolean
Maximum Length:
1
Indicates whether the branding definition is default.
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
Nested Schema : schema
Type:
Show Source
object
-
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. -
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. -
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.
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.
Root Schema : brandings-item-response
Type:
Show Source
object
-
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.
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : brandings-brandingAttributes-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- 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. - BrandingId: