Get all branding rows
get
/fscmRestApi/resources/11.13.18.05/brandings
Request
Query Parameters
-
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 -
finder: string
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- AltKey Finds all branding rows that match the alternate key criteria specified.
Finder Variables- BrandingCode; string; Alternate unique identifier for a branding row.
- PrimaryKey Finds all branding rows that match the primary key criteria specified.
Finder Variables- BrandingId; integer; Unique identifier for a branding row.
- AltKey Finds all branding rows that match the alternate key criteria specified.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- ActiveFlag; boolean; Indicates whether the branding definition is active or inactive.
- BrandingCode; string; The alternate unique identifier for the branding definition.
- BrandingId; integer; 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; 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.
- CreatedBy; string; The person who created the branding definition.
- CreationDate; string; The date and time when the branding definition is created.
- DefaultFlag; boolean; Indicates whether the branding definition is default.
- LastUpdateDate; string; The date and time when the branding definition is updated.
- LastUpdatedBy; string; The person who updated the branding definition.
- SeedDataFlag; boolean; Indicates whether the branding is predefined data.
-
totalResults: boolean
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
-
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 TopResponse
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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.