Create a home page setup definition
post
/fscmRestApi/resources/11.13.18.05/hedHomePageSetups
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
PageCode(required): string
Maximum Length:
30
Alternate identifier for the home page setup. -
PageDescription: string
Maximum Length:
240
A description is assigned to each version of a home page setup. -
roles: array
Roles
Title:
Roles
The roles resource is used to define the security roles that have access to a home page. -
StatusCode(required): string
Maximum Length:
30
Code defining the status of a home page version. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS. -
VersionName(required): string
Maximum Length:
50
A name is assigned to each version of a home page setup. -
zones: array
Zones
Title:
Zones
The zones resource is used to define where a widget is displayed on the home page.
Nested Schema : Roles
Type:
array
Title:
Roles
The roles resource is used to define the security roles that have access to a home page.
Show Source
Nested Schema : Zones
Type:
array
Title:
Zones
The zones resource is used to define where a widget is displayed on the home page.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
RoleCode: string
Maximum Length:
128
The alternate identifier for the security role.
Nested Schema : hedHomePageSetups-zones-item-post-request
Type:
Show Source
object
-
PageZoneCode(required): string
Maximum Length:
30
Alternate identifier for the page zone. -
widgets: array
Widgets
Title:
Widgets
The widgets resource is used to define which widgets appear on a home page. -
ZoneDescription: string
Maximum Length:
240
The description of the page zone. -
ZoneSequence(required): integer
(int32)
The sequence in which page zones are displayed in a home page.
-
ZoneTypeCode(required): string
Maximum Length:
30
Indicates the zone type. A list of accepted values for a zone is defined in the lookup type: ORA_HEY_HOME_PAGE_ZONE
Nested Schema : Widgets
Type:
array
Title:
Widgets
The widgets resource is used to define which widgets appear on a home page.
Show Source
Nested Schema : hedHomePageSetups-zones-widgets-item-post-request
Type:
Show Source
object
-
CollapsibleFlag: boolean
Maximum Length:
1
Indicates whether a widget can be collapsed on the home page. The default value is true. -
PageWidgetCode(required): string
Maximum Length:
30
Alternate identifier for the widget within the page zone. -
PageZoneId(required): integer
(int64)
The unique identifier for the page zone in which the page widget is placed.
-
WidgetId(required): integer
(int64)
The unique identifier for a home page widget.
-
widgetProperties: array
Widget Properties
Title:
Widget Properties
The widget properties resource is used to define how a widget functions on a home page. -
WidgetSequence(required): integer
(int32)
The sequence widgets are displayed within a zone.
-
WidgetTitle(required): string
Maximum Length:
30
The display name of the widget.
Nested Schema : Widget Properties
Type:
array
Title:
Widget Properties
The widget properties resource is used to define how a widget functions on a home page.
Show Source
Nested Schema : hedHomePageSetups-zones-widgets-widgetProperties-item-post-request
Type:
Show Source
object
-
PageWidgetPropertyCode(required): string
Maximum Length:
30
Alternate identifier for the widget property within the page zone. -
propertyValidations: array
Property Validations
Title:
Property Validations
The property validations resource is used to define how to validate a widget property. -
PropertyValue: string
Maximum Length:
512
The value given for a widget property. -
WidgetPropertyId(required): integer
(int64)
The unique identifier of a widget property.
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 : hedHomePageSetups-zones-widgets-widgetProperties-propertyValidations-item-post-request
Type:
Show Source
object
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 : hedHomePageSetups-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date the row was created. -
HomePageSetupId: integer
(int64)
Read Only:
true
Unique identifier for a home page setup. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date the row was last updated. -
LastUpdatedBy: string
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. -
PageCode: string
Maximum Length:
30
Alternate identifier for the home page setup. -
PageDescription: string
Maximum Length:
240
A description is assigned to each version of a home page setup. -
roles: array
Roles
Title:
Roles
The roles resource is used to define the security roles that have access to a home page. -
StatusCode: string
Maximum Length:
30
Code defining the status of a home page version. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS. -
StatusMeaning: string
Read Only:
true
Maximum Length:80
A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS. -
ValidSetupFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the setup is currently valid and able to be published. The default value is false. -
VersionName: string
Maximum Length:
50
A name is assigned to each version of a home page setup. -
VersionNumber: integer
(int32)
Read Only:
true
A number is assigned to each version of a home page setup. -
zones: array
Zones
Title:
Zones
The zones resource is used to define where a widget is displayed on the home page.
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 home page.
Show Source
Nested Schema : Zones
Type:
array
Title:
Zones
The zones resource is used to define where a widget is displayed on 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 : hedHomePageSetups-roles-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RoleCode: string
Maximum Length:
128
The alternate identifier for the security role. -
RoleMapId: integer
(int64)
Read Only:
true
The unique identifier of the role to home page mapping. -
RoleName: string
Title:
Role Name
Read Only:true
Maximum Length:240
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 : hedHomePageSetups-zones-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PageZoneCode: string
Maximum Length:
30
Alternate identifier for the page zone. -
PageZoneId: integer
(int64)
Read Only:
true
The unique identifier of the page zone. -
widgets: array
Widgets
Title:
Widgets
The widgets resource is used to define which widgets appear on a home page. -
ZoneDescription: string
Maximum Length:
240
The description of the page zone. -
ZoneSequence: integer
(int32)
The sequence in which page zones are displayed in a home page.
-
ZoneTypeCode: string
Maximum Length:
30
Indicates the zone type. A list of accepted values for a zone is defined in the lookup type: ORA_HEY_HOME_PAGE_ZONE -
ZoneTypeMeaning: string
Read Only:
true
Maximum Length:80
The name of the Page Zone Code.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Widgets
Type:
array
Title:
Widgets
The widgets resource is used to define which widgets appear on a home page.
Show Source
Nested Schema : hedHomePageSetups-zones-widgets-item-response
Type:
Show Source
object
-
CollapsibleFlag: boolean
Maximum Length:
1
Indicates whether a widget can be collapsed on the home page. The default value is true. -
ComponentName: string
Read Only:
true
Maximum Length:100
The component name for the widget. -
DefaultZoneTypeCode: string
Read Only:
true
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
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
Read Only:
true
Maximum Length:1
Indicates whether a widget is active and can be displayed. The default value is true. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PageWidgetCode: string
Maximum Length:
30
Alternate identifier for the widget within the page zone. -
PageWidgetId: integer
(int64)
Read Only:
true
The unique identifier of the widget within the page zone. -
PageZoneId: integer
(int64)
The unique identifier for the page zone in which the page widget is placed.
-
PermissionCode: string
Read Only:
true
Maximum Length:132
The page permission code used to grant access to a widget. -
WidgetCode: string
Read Only:
true
Maximum Length:30
The alternate identifier for a widget. -
WidgetDescription: string
Read Only:
true
Maximum Length:256
The description of a widget. -
WidgetId: integer
(int64)
The unique identifier for a home page widget.
-
WidgetName: string
Read Only:
true
Maximum Length:30
The name of a widget. -
widgetProperties: array
Widget Properties
Title:
Widget Properties
The widget properties resource is used to define how a widget functions on a home page. -
WidgetSequence: integer
(int32)
The sequence widgets are displayed within a zone.
-
WidgetTitle: string
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 : Widget Properties
Type:
array
Title:
Widget Properties
The widget properties resource is used to define how a widget functions on a home page.
Show Source
Nested Schema : hedHomePageSetups-zones-widgets-widgetProperties-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PageWidgetPropertyCode: string
Maximum Length:
30
Alternate identifier for the widget property within the page zone. -
PageWidgetPropertyId: integer
(int64)
Read Only:
true
The unique identifier of a widget property for a home page setup. -
PropertyDescription: string
Read Only:
true
Maximum Length:512
The description of a widget property. -
PropertyKey: string
Read Only:
true
Maximum Length:30
Unique key used to identify the widget property. -
PropertyName: string
Read Only:
true
Maximum Length:240
The display name of a widget property. -
PropertyTypeCode: string
Read Only:
true
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
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
Maximum Length:
512
The value given for a widget property. -
RequiredFlag: boolean
Read Only:
true
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)
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 : hedHomePageSetups-zones-widgets-widgetProperties-propertyValidations-item-response
Type:
Show Source
object
-
ErrorMessage: string
Read Only:
true
Default Value:adf.object.getErrorMessageBundle()
The error message describes the validation error. -
ErrorMessageCode: string
Read Only:
true
Maximum Length:30
The alternate identifier for the validation error message. -
FunctionBody: string
Read Only:
true
The executable validation code. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParameterOne: string
Read Only:
true
Maximum Length:512
The first optional value used during validation. -
ParameterTwo: string
Read Only:
true
Maximum Length:512
The second optional value used during validation. -
PropertyValidationId: integer
(int64)
Read Only:
true
The unique identifier of a widget property validator. -
ValidatorCode: string
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
Links
- roles
-
Parameters:
- HomePageSetupId:
$request.path.HomePageSetupId
The roles resource is used to define the security roles that have access to a home page. - HomePageSetupId:
- statusCodesLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEY_VERSION_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: StatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- zones
-
Parameters:
- HomePageSetupId:
$request.path.HomePageSetupId
The zones resource is used to define where a widget is displayed on the home page. - HomePageSetupId: