Jump to

• Request
• Response

Get a home page widget configuration

get

/fscmRestApi/resources/11.13.18.05/hedHomePageWidgets/{WidgetId}

Request

Path Parameters

• WidgetId(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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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

  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.

{
    "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
        },
        "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
        },
        "LocationLockedFlag":{
            "title":"Location Locked",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the widget can be moved to a different zone. The default value is false.",
            "nullable":false,
            "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":false,
            "x-queryable":true
        },
        "roles":{
            "title":"Roles",
            "type":"array",
            "description":"The roles resource is used to define the security roles that have access to a widget.",
            "items":{
                "$ref":"#/components/schemas/hedHomePageWidgets-roles-item-response"
            }
        },
        "widgetProperties":{
            "title":"Home Page Widget Properties",
            "type":"array",
            "description":"The home page widget properties resource is used to define how a widget functions on a default version of the home page.",
            "items":{
                "$ref":"#/components/schemas/hedHomePageWidgets-widgetProperties-item-response"
            }
        },
        "WidgetId":{
            "title":"Widget ID",
            "type":"integer",
            "description":"The unique identifier for a home page widget.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "WidgetCode":{
            "title":"Widget Code",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier for a home page widget.",
            "nullable":false,
            "x-queryable":true
        },
        "WidgetName":{
            "title":"Widget Name",
            "maxLength":"30",
            "type":"string",
            "description":"The name of a widget.",
            "nullable":false,
            "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,
            "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,
            "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,
            "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,
            "default":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,
            "x-hints":{
                "controlType":"choice"
            },
            "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":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 : Roles

Type: array

Title: Roles

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

Show Source

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

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

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

• Array of: object hedHomePageWidgets-widgetProperties-item-response

{
    "title":"Home Page Widget Properties",
    "type":"array",
    "description":"The home page widget properties resource is used to define how a widget functions on a default version of the home page.",
    "items":{
        "$ref":"#/components/schemas/hedHomePageWidgets-widgetProperties-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 : hedHomePageWidgets-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

  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.

{
    "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 a security role.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "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,
            "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 : hedHomePageWidgets-widgetProperties-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "PropertyDescription":{
            "title":"Property Description",
            "maxLength":"512",
            "type":"string",
            "description":"The description of a widget property.",
            "nullable":false,
            "x-queryable":true
        },
        "PropertyName":{
            "title":"Property Name",
            "maxLength":"240",
            "type":"string",
            "description":"The display name of a widget property.",
            "nullable":false,
            "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,
            "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/hedHomePageWidgets-widgetProperties-propertyValidations-item-response"
            }
        },
        "WidgetPropertyId":{
            "title":"Widget Property ID",
            "type":"integer",
            "description":"The unique identifier of a widget property.",
            "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,
            "x-queryable":true
        },
        "PropertyCode":{
            "title":"Property Code",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier for a widget property.",
            "nullable":false,
            "x-queryable":true
        },
        "PropertyKey":{
            "title":"Property Key",
            "maxLength":"30",
            "type":"string",
            "description":"Unique key used to identify the widget property.",
            "nullable":false,
            "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 hedHomePageWidgets-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/hedHomePageWidgets-widgetProperties-propertyValidations-item-response"
    }
}

Nested Schema : hedHomePageWidgets-widgetProperties-propertyValidations-item-response

Type: object

Show Source

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

{
    "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":true
        },
        "ErrorMessageCode":{
            "title":"Error Message Code",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier for the validation error message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParameterOne":{
            "title":"Parameter 1",
            "maxLength":"512",
            "type":"string",
            "description":"The first optional value used during validation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionBody":{
            "title":"Function Body",
            "type":"string",
            "description":"The executable validation code.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "FunctionBodyClob"
                ]
            },
            "x-queryable":true
        },
        "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":true
        },
        "ErrorMessage":{
            "title":"Error Message",
            "type":"string",
            "description":"The error message describes the validation error.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyValidationId":{
            "title":"Property Validation ID",
            "type":"integer",
            "description":"The unique identifier of a widget property validator.",
            "format":"int64",
            "nullable":false,
            "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"
    }
}

Links

defaultZoneTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEY_HOME_PAGE_ZONE

The following properties are defined on the LOV link relation:

• Source Attribute: DefaultZoneTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

roles

Operation: /fscmRestApi/resources/11.13.18.05/hedHomePageWidgets/{WidgetId}/child/roles

Parameters:

• WidgetId: $request.path.WidgetId

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

widgetProperties

Operation: /fscmRestApi/resources/11.13.18.05/hedHomePageWidgets/{WidgetId}/child/widgetProperties

Parameters:

• WidgetId: $request.path.WidgetId

The home page widget properties resource is used to define how a widget functions on a default version of the home page.

Back to Top