Get all available home page widget configurations
get
/fscmRestApi/resources/11.13.18.05/hedHomePageWidgets
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- PrimaryKey Finds all home page widgets that match the primary key.
Finder Variables- WidgetId; integer; Primary key to search from unique identifier for a widget ID.
- PrimaryKey Finds all home page widgets that match the primary key.
-
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:- CollapsibleFlag; boolean; Indicates whether a widget can be collapsed on the home page. The default value is true.
- ComponentName; string; The component name for the widget.
- DefaultZoneTypeCode; string; Indicates the zone in which a widget will display by default. A list of accepted values for a zone is defined in the lookup type: ORA_HEY_HOME_PAGE_ZONE.
- DefaultZoneTypeMeaning; string; The meaning of a default zone code. An example of a meaning is the locked zone. A list of accepted values is defined in lookup type ORA_HEY_HOME_PAGE_ZONE.
- EnabledFlag; boolean; Indicates whether a widget is active and can be displayed. The default value is true.
- LastUpdateDate; string; The date the row was last updated.
- LastUpdatedBy; string; The user who last updated the row.
- LocationLockedFlag; boolean; Indicates whether the widget can be moved to a different zone. The default value is false.
- PermissionCode; string; The page permission code used to grant access to a widget.
- WidgetCode; string; The alternate identifier for a home page widget.
- WidgetDescription; string; The description of a widget.
- WidgetId; integer; The unique identifier for a home page widget.
- WidgetName; string; The name of a widget.
- WidgetTitle; string; The display name of the widget.
-
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 : hedHomePageWidgets
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 : hedHomePageWidgets-item-response
Type:
Show Source
object
-
CollapsibleFlag: boolean
Title:
Collapsible
Maximum Length:1
Indicates whether a widget can be collapsed on the home page. The default value is true. -
ComponentName: string
Title:
Component Name
Maximum Length:100
The component name for the widget. -
DefaultZoneTypeCode: string
Title:
Default Zone Type Code
Maximum Length:30
Indicates the zone in which a widget will display by default. A list of accepted values for a zone is defined in the lookup type: ORA_HEY_HOME_PAGE_ZONE. -
DefaultZoneTypeMeaning: string
Title:
Default Zone Type
Read Only:true
Maximum Length:80
The meaning of a default zone code. An example of a meaning is the locked zone. A list of accepted values is defined in lookup type ORA_HEY_HOME_PAGE_ZONE. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:true
Indicates whether a widget is active and can be displayed. The default value is true. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationLockedFlag: boolean
Title:
Location Locked
Maximum Length:1
Indicates whether the widget can be moved to a different zone. The default value is false. -
PermissionCode: string
Title:
Permission Code
Maximum Length:132
The page permission code used to grant access to a widget. -
roles: array
Roles
Title:
Roles
The roles resource is used to define the security roles that have access to a widget. -
WidgetCode: string
Title:
Widget Code
Maximum Length:30
The alternate identifier for a home page widget. -
WidgetDescription: string
Title:
Widget Description
Maximum Length:256
The description of a widget. -
WidgetId: integer
(int64)
Title:
Widget ID
Read Only:true
The unique identifier for a home page widget. -
WidgetName: string
Title:
Widget Name
Maximum Length:30
The name of a widget. -
widgetProperties: array
Home Page Widget Properties
Title:
Home Page Widget Properties
The home page widget properties resource is used to define how a widget functions on a default version of the home page. -
WidgetTitle: string
Title:
Widget Title
Maximum Length:30
The display name of the widget.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Roles
Type:
array
Title:
Roles
The roles resource is used to define the security roles that have access to a widget.
Show Source
Nested Schema : Home Page Widget Properties
Type:
array
Title:
Home Page Widget Properties
The home page widget properties resource is used to define how a widget functions on a default version of the home page.
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.
Nested Schema : hedHomePageWidgets-roles-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RoleCode: string
Title:
Role Code
Read Only:true
Maximum Length:128
The alternate identifier for the security role. -
RoleMapId: integer
(int64)
Title:
Role Map ID
Read Only:true
The unique identifier of a security role. -
RoleName: string
Title:
Role Name
Read Only:true
The name of the security role.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hedHomePageWidgets-widgetProperties-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PropertyCode: string
Title:
Property Code
Maximum Length:30
The alternate identifier for a widget property. -
PropertyDescription: string
Title:
Property Description
Maximum Length:512
The description of a widget property. -
PropertyKey: string
Title:
Property Key
Maximum Length:30
Unique key used to identify the widget property. -
PropertyName: string
Title:
Property Name
Maximum Length:240
The display name of a widget property. -
PropertyTypeCode: string
Title:
Property Type Code
Maximum Length:30
Indicates the property type for a widget property. Examples of property types include: string, number, boolean. A list of accepted values for a property type is defined in the lookup type: ORA_HEY_HOME_PROPERTY. -
PropertyTypeMeaning: string
Title:
Property Type
Read Only:true
Maximum Length:80
The meaning of a property type code. An example of a meaning is the string property type. A list of accepted values is defined in lookup type ORA_HEY_HOME_PROPERTY. -
propertyValidations: array
Property Validations
Title:
Property Validations
The property validations resource is used to define how to validate a widget property. -
PropertyValue: string
Title:
Property Value
Maximum Length:512
The value given for a widget property. -
RequiredFlag: boolean
Title:
Required
Maximum Length:1
Indicates whether a value is required and the field can't be left blank. The default value is false. -
WidgetPropertyId: integer
(int64)
Title:
Widget Property ID
Read Only:true
The unique identifier of a widget property.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Property Validations
Type:
array
Title:
Property Validations
The property validations resource is used to define how to validate a widget property.
Show Source
Nested Schema : hedHomePageWidgets-widgetProperties-propertyValidations-item-response
Type:
Show Source
object
-
ErrorMessage: string
Title:
Error Message
Read Only:true
The error message describes the validation error. -
ErrorMessageCode: string
Title:
Error Message Code
Read Only:true
Maximum Length:30
The alternate identifier for the validation error message. -
FunctionBody: string
Title:
Function Body
Read Only:true
The executable validation code. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParameterOne: string
Title:
Parameter 1
Read Only:true
Maximum Length:512
The first optional value used during validation. -
ParameterTwo: string
Title:
Parameter 2
Read Only:true
Maximum Length:512
The second optional value used during validation. -
PropertyValidationId: integer
(int64)
Title:
Property Validation ID
The unique identifier of a widget property validator. -
ValidatorCode: string
Title:
Validator Code
Read Only:true
Maximum Length:30
The alternate identifier for the home page widget property validator.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source