Jump to

• Request
• Response

Get all home page setup definitions

get

/fscmRestApi/resources/11.13.18.05/hedHomePageSetups

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
  
  

  • ByKeywordFinder Finds all home page setups that match the Name, Role, and Last Updated by.
    Finder Variables
    • Keyword; string; Keyword; string; to search from Name, Role, and Last Updated by.
  • HomeSetupFinder Finds all home page setups that match the home setup identifier.
    Finder Variables
    • HomePageSetupId; integer; Primary key to search from home page setups.
  • PrimaryKey Finds all home page setups that match the primary key.
    Finder Variables
    • HomePageSetupId; integer; Primary key to search from unique identifier for a home page setup.
  • RoleFinder Finds all home page setups that match the security role.
    Finder Variables
    • RoleCode; string; Security role code to search from home page setups.
  • UniquePageCodeFinder Finds all unique page codes for a home page setup.
    Finder Variables
• 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:
  

  • CreatedBy; string; The user who created the row.
  • HomePageSetupId; integer; Unique identifier for a home page setup.
  • LastUpdatedBy; string; The user who last updated the row.
  • PageCode; string; Alternate identifier for the home page setup.
  • StatusCode; string; 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; A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS.
  • ValidSetupFlag; boolean; Indicates whether the setup is currently valid and able to be published. The default value is false.
  • VersionName; string; A name is assigned to each version of a home page setup.
  • VersionNumber; integer; A number is assigned to each version of a home page setup.
• 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: string
  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: string
  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:
  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.

Body ()

Root Schema : hedHomePageSetups

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/hedHomePageSetups-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object hedHomePageSetups-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/hedHomePageSetups-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 : hedHomePageSetups-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the row was created.
• HomePageSetupId: integer (int64)
  Title: Home Page Setup ID

  Read Only: true

  Unique identifier for a home page setup.
• 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.
• PageCode: string
  Title: Page Code

  Maximum Length: 50

  Alternate identifier for the home page setup.
• PageDescription: string
  Title: Page Description

  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
  Title: Status Code

  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
  Title: Status

  Read Only: true

  Maximum Length: 80

  A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS.
• ValidSetupFlag: boolean
  Title: Valid Setup

  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
  Title: Version Name

  Maximum Length: 50

  A name is assigned to each version of a home page setup.
• VersionNumber: integer (int32)
  Title: Version Number

  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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "roles":{
            "title":"Roles",
            "type":"array",
            "description":"The roles resource is used to define the security roles that have access to a home page.",
            "items":{
                "$ref":"#/components/schemas/hedHomePageSetups-roles-item-response"
            }
        },
        "HomePageSetupId":{
            "title":"Home Page Setup ID",
            "type":"integer",
            "description":"Unique identifier for a home page setup.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PageDescription":{
            "title":"Page Description",
            "maxLength":240,
            "type":"string",
            "description":"A description is assigned to each version of a home page setup.",
            "nullable":true,
            "x-queryable":false
        },
        "zones":{
            "title":"Zones",
            "type":"array",
            "description":"The zones resource is used to define where a widget is displayed on the home page.",
            "items":{
                "$ref":"#/components/schemas/hedHomePageSetups-zones-item-response"
            }
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Code defining the status of a home page version. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "VersionNumber":{
            "title":"Version Number",
            "type":"integer",
            "description":"A number is assigned to each version of a home page setup.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ValidSetupFlag":{
            "title":"Valid Setup",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the setup is currently valid and able to be published. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PageCode":{
            "title":"Page Code",
            "maxLength":50,
            "type":"string",
            "description":"Alternate identifier for the home page setup.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "VersionName":{
            "title":"Version Name",
            "maxLength":50,
            "type":"string",
            "description":"A name is assigned to each version of a home page setup.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : Roles

Type: array

Title: Roles

The roles resource is used to define the security roles that have access to a home page.

Show Source

• Array of: object hedHomePageSetups-roles-item-response

{
    "title":"Roles",
    "type":"array",
    "description":"The roles resource is used to define the security roles that have access to a home page.",
    "items":{
        "$ref":"#/components/schemas/hedHomePageSetups-roles-item-response"
    }
}

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

• Array of: object hedHomePageSetups-zones-item-response

{
    "title":"Zones",
    "type":"array",
    "description":"The zones resource is used to define where a widget is displayed on the home page.",
    "items":{
        "$ref":"#/components/schemas/hedHomePageSetups-zones-item-response"
    }
}

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."
        }
    }
}

Nested Schema : hedHomePageSetups-roles-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RoleCode: string
  Title: Role Code

  Maximum Length: 128

  The alternate identifier for the security role.
• RoleMapId: integer (int64)
  Title: Role Map ID

  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.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RoleMapId":{
            "title":"Role Map ID",
            "type":"integer",
            "description":"The unique identifier of the role to home page mapping.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the security role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleCode":{
            "title":"Role Code",
            "maxLength":128,
            "type":"string",
            "description":"The alternate identifier for the security role.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "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 : hedHomePageSetups-zones-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PageZoneCode: string
  Title: Page Zone Code

  Maximum Length: 30

  Alternate identifier for the page zone.
• PageZoneId: integer (int64)
  Title: Page Zone ID

  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
  Title: Zone Description

  Maximum Length: 240

  The description of the page zone.
• ZoneSequence: integer (int32)
  Title: Zone Sequence

  The sequence in which page zones are displayed in a home page.
• ZoneTypeCode: string
  Title: Zone Type Code

  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
  Title: Zone Type

  Read Only: true

  Maximum Length: 80

  The name of the Page Zone Code.

{
    "type":"object",
    "properties":{
        "PageZoneCode":{
            "title":"Page Zone Code",
            "maxLength":30,
            "type":"string",
            "description":"Alternate identifier for the page zone.",
            "nullable":false,
            "x-queryable":true
        },
        "PageZoneId":{
            "title":"Page Zone ID",
            "type":"integer",
            "description":"The unique identifier of the page zone.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ZoneTypeMeaning":{
            "title":"Zone Type",
            "maxLength":80,
            "type":"string",
            "description":"The name of the Page Zone Code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ZoneSequence":{
            "title":"Zone Sequence",
            "type":"integer",
            "description":"The sequence in which page zones are displayed in a home page.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "widgets":{
            "title":"Widgets",
            "type":"array",
            "description":"The widgets resource is used to define which widgets appear on a home page.",
            "items":{
                "$ref":"#/components/schemas/hedHomePageSetups-zones-widgets-item-response"
            }
        },
        "ZoneTypeCode":{
            "title":"Zone Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the zone type. A list of accepted values for a zone is defined in the lookup type: ORA_HEY_HOME_PAGE_ZONE",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ZoneDescription":{
            "title":"Zone Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the page zone.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : Widgets

Type: array

Title: Widgets

The widgets resource is used to define which widgets appear on a home page.

Show Source

• Array of: object hedHomePageSetups-zones-widgets-item-response

{
    "title":"Widgets",
    "type":"array",
    "description":"The widgets resource is used to define which widgets appear on a home page.",
    "items":{
        "$ref":"#/components/schemas/hedHomePageSetups-zones-widgets-item-response"
    }
}

Nested Schema : hedHomePageSetups-zones-widgets-item-response

Type: object

Show Source

• 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

  Read Only: true

  Maximum Length: 100

  The component name for the widget.
• DefaultZoneTypeCode: string
  Title: Default Zone Type Code

  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
  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

  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
  Title: Page Widget Code

  Maximum Length: 30

  Alternate identifier for the widget within the page zone.
• PageWidgetId: integer (int64)
  Title: Page Widget ID

  Read Only: true

  The unique identifier of the widget within the page zone.
• PageZoneId: integer (int64)
  Title: Page Zone ID

  The unique identifier for the page zone in which the page widget is placed.
• PermissionCode: string
  Title: Permission Code

  Read Only: true

  Maximum Length: 132

  The page permission code used to grant access to a widget.
• WidgetCode: string
  Title: Widget Code

  Read Only: true

  Maximum Length: 30

  The alternate identifier for a widget.
• WidgetDescription: string
  Title: Widget Description

  Read Only: true

  Maximum Length: 256

  The description of a widget.
• WidgetId: integer (int64)
  Title: Widget ID

  The unique identifier for a home page widget.
• WidgetName: string
  Title: Widget Name

  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)
  Title: Widget Sequence

  The sequence widgets are displayed within a zone.
• WidgetTitle: string
  Title: Widget Title

  Maximum Length: 30

  The display name of the widget.

{
    "type":"object",
    "properties":{
        "DefaultZoneTypeMeaning":{
            "title":"Default Zone Type",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PageWidgetCode":{
            "title":"Page Widget Code",
            "maxLength":30,
            "type":"string",
            "description":"Alternate identifier for the widget within the page zone.",
            "nullable":false,
            "x-queryable":true
        },
        "PageWidgetId":{
            "title":"Page Widget ID",
            "type":"integer",
            "description":"The unique identifier of the widget within the page zone.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PageZoneId":{
            "title":"Page Zone ID",
            "type":"integer",
            "description":"The unique identifier for the page zone in which the page widget is placed.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CollapsibleFlag":{
            "title":"Collapsible",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a widget can be collapsed on the home page. The default value is true.",
            "nullable":true,
            "x-queryable":false
        },
        "WidgetSequence":{
            "title":"Widget Sequence",
            "type":"integer",
            "description":"The sequence widgets are displayed within a zone.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "widgetProperties":{
            "title":"Widget Properties",
            "type":"array",
            "description":"The widget properties resource is used to define how a widget functions on a home page.",
            "items":{
                "$ref":"#/components/schemas/hedHomePageSetups-zones-widgets-widgetProperties-item-response"
            }
        },
        "WidgetCode":{
            "title":"Widget Code",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier for a widget.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WidgetId":{
            "title":"Widget ID",
            "type":"integer",
            "description":"The unique identifier for a home page widget.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "WidgetName":{
            "title":"Widget Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of a widget.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WidgetTitle":{
            "title":"Widget Title",
            "maxLength":30,
            "type":"string",
            "description":"The display name of the widget.",
            "nullable":false,
            "x-queryable":true
        },
        "WidgetDescription":{
            "title":"Widget Description",
            "maxLength":256,
            "type":"string",
            "description":"The description of a widget.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ComponentName":{
            "title":"Component Name",
            "maxLength":100,
            "type":"string",
            "description":"The component name for the widget.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PermissionCode":{
            "title":"Permission Code",
            "maxLength":132,
            "type":"string",
            "description":"The page permission code used to grant access to a widget.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a widget is active and can be displayed. The default value is true.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultZoneTypeCode":{
            "title":"Default Zone Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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 : 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

• Array of: object hedHomePageSetups-zones-widgets-widgetProperties-item-response

{
    "title":"Widget Properties",
    "type":"array",
    "description":"The widget properties resource is used to define how a widget functions on a home page.",
    "items":{
        "$ref":"#/components/schemas/hedHomePageSetups-zones-widgets-widgetProperties-item-response"
    }
}

Nested Schema : hedHomePageSetups-zones-widgets-widgetProperties-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PageWidgetPropertyCode: string
  Title: Page Widget Property Code

  Maximum Length: 30

  Alternate identifier for the widget property within the page zone.
• PageWidgetPropertyId: integer (int64)
  Title: Page Widget Property ID

  Read Only: true

  The unique identifier of a widget property for a home page setup.
• PropertyDescription: string
  Title: Property Description

  Read Only: true

  Maximum Length: 512

  The description of a widget property.
• PropertyKey: string
  Title: Property Key

  Read Only: true

  Maximum Length: 30

  Unique key used to identify the widget property.
• PropertyName: string
  Title: Property Name

  Read Only: true

  Maximum Length: 240

  The display name of a widget property.
• PropertyTypeCode: string
  Title: Property Type Code

  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
  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

  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)
  Title: Widget Property ID

  The unique identifier of a widget property.

{
    "type":"object",
    "properties":{
        "PropertyDescription":{
            "title":"Property Description",
            "maxLength":512,
            "type":"string",
            "description":"The description of a widget property.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyName":{
            "title":"Property Name",
            "maxLength":240,
            "type":"string",
            "description":"The display name of a widget property.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyTypeCode":{
            "title":"Property Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "propertyValidations":{
            "title":"Property Validations",
            "type":"array",
            "description":"The property validations resource is used to define how to validate a widget property.",
            "items":{
                "$ref":"#/components/schemas/hedHomePageSetups-zones-widgets-widgetProperties-propertyValidations-item-response"
            }
        },
        "WidgetPropertyId":{
            "title":"Widget Property ID",
            "type":"integer",
            "description":"The unique identifier of a widget property.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PageWidgetPropertyCode":{
            "title":"Page Widget Property Code",
            "maxLength":30,
            "type":"string",
            "description":"Alternate identifier for the widget property within the page zone.",
            "nullable":false,
            "x-queryable":true
        },
        "PageWidgetPropertyId":{
            "title":"Page Widget Property ID",
            "type":"integer",
            "description":"The unique identifier of a widget property for a home page setup.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PropertyValue":{
            "title":"Property Value",
            "maxLength":512,
            "type":"string",
            "description":"The value given for a widget property.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PropertyTypeMeaning":{
            "title":"Property Type",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a value is required and the field can't be left blank. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyKey":{
            "title":"Property Key",
            "maxLength":30,
            "type":"string",
            "description":"Unique key used to identify the widget property.",
            "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 : Property Validations

Type: array

Title: Property Validations

The property validations resource is used to define how to validate a widget property.

Show Source

• Array of: object hedHomePageSetups-zones-widgets-widgetProperties-propertyValidations-item-response

{
    "title":"Property Validations",
    "type":"array",
    "description":"The property validations resource is used to define how to validate a widget property.",
    "items":{
        "$ref":"#/components/schemas/hedHomePageSetups-zones-widgets-widgetProperties-propertyValidations-item-response"
    }
}

Nested Schema : hedHomePageSetups-zones-widgets-widgetProperties-propertyValidations-item-response

Type: object

Show Source

• ErrorMessage: string
  Title: Error Message

  Read Only: true

  Default Value: adf.object.getErrorMessageBundle()

  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

  Read Only: true

  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.

{
    "type":"object",
    "properties":{
        "ValidatorCode":{
            "title":"Validator Code",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier for the home page widget property validator.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ErrorMessageCode":{
            "title":"Error Message Code",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier for the validation error message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ParameterOne":{
            "title":"Parameter 1",
            "maxLength":512,
            "type":"string",
            "description":"The first optional value used during validation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FunctionBody":{
            "title":"Function Body",
            "type":"string",
            "description":"The executable validation code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "FunctionBodyClob"
                ]
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParameterTwo":{
            "title":"Parameter 2",
            "maxLength":512,
            "type":"string",
            "description":"The second optional value used during validation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ErrorMessage":{
            "title":"Error Message",
            "type":"string",
            "description":"The error message describes the validation error.",
            "nullable":false,
            "readOnly":true,
            "default":"adf.object.getErrorMessageBundle()",
            "x-queryable":false
        },
        "PropertyValidationId":{
            "title":"Property Validation ID",
            "type":"integer",
            "description":"The unique identifier of a widget property validator.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"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"
    }
}

Back to Top