Jump to

• Request
• Response

Update a widget within a home page setup zone

patch

/fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/zones/{PageZoneId}/child/widgets/{PageWidgetId}

Request

Path Parameters

• HomePageSetupId(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=
• PageWidgetId(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=
• PageZoneId(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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CollapsibleFlag: boolean
  Maximum Length: 1

  Indicates whether a widget can be collapsed on the home page. The default value is true.
• PageZoneId: integer (int64)
  The unique identifier for the page zone in which the page widget is placed.
• 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.

{
    "type":"object",
    "properties":{
        "WidgetTitle":{
            "maxLength":"30",
            "type":"string",
            "description":"The display name of the widget.",
            "nullable":false
        },
        "WidgetSequence":{
            "type":"integer",
            "description":"The sequence widgets are displayed within a zone.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "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-patch-request"
            }
        },
        "PageZoneId":{
            "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"
            }
        },
        "CollapsibleFlag":{
            "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
        }
    }
}

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 schema

{
    "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-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "PropertyValue":{
            "maxLength":"512",
            "type":"string",
            "description":"The value given for a widget property.",
            "nullable":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-patch-request"
            }
        }
    }
}

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

{
    "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-patch-request"
    }
}

Nested Schema : hedHomePageSetups-zones-widgets-widgetProperties-propertyValidations-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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-zones-widgets-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "DefaultZoneTypeMeaning":{
            "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":{
            "maxLength":"30",
            "type":"string",
            "description":"Alternate identifier for the widget within the page zone.",
            "nullable":false,
            "x-queryable":true
        },
        "PageWidgetId":{
            "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":{
            "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":{
            "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":{
            "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":{
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier for a widget.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WidgetId":{
            "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":{
            "maxLength":"30",
            "type":"string",
            "description":"The name of a widget.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WidgetTitle":{
            "maxLength":"30",
            "type":"string",
            "description":"The display name of the widget.",
            "nullable":false,
            "x-queryable":true
        },
        "WidgetDescription":{
            "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":{
            "maxLength":"100",
            "type":"string",
            "description":"The component name for the widget.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PermissionCode":{
            "maxLength":"132",
            "type":"string",
            "description":"The page permission code used to grant access to a widget.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "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":{
            "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 : 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-zones-widgets-widgetProperties-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "PropertyDescription":{
            "maxLength":"512",
            "type":"string",
            "description":"The description of a widget property.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyName":{
            "maxLength":"240",
            "type":"string",
            "description":"The display name of a widget property.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyTypeCode":{
            "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":{
            "type":"integer",
            "description":"The unique identifier of a widget property.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PageWidgetPropertyCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Alternate identifier for the widget property within the page zone.",
            "nullable":false,
            "x-queryable":true
        },
        "PageWidgetPropertyId":{
            "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":{
            "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":{
            "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":{
            "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":{
            "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
  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.

{
    "type":"object",
    "properties":{
        "ValidatorCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier for the home page widget property validator.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ErrorMessageCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier for the validation error message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ParameterOne":{
            "maxLength":"512",
            "type":"string",
            "description":"The first optional value used during validation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FunctionBody":{
            "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":{
            "maxLength":"512",
            "type":"string",
            "description":"The second optional value used during validation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ErrorMessage":{
            "type":"string",
            "description":"The error message describes the validation error.",
            "nullable":false,
            "readOnly":true,
            "default":"adf.object.getErrorMessageBundle()",
            "x-queryable":false
        },
        "PropertyValidationId":{
            "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"
    }
}

Links

defaultZoneTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%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

widgetProperties

Operation: /fscmRestApi/resources/11.13.18.05/hedHomePageSetups/{HomePageSetupId}/child/zones/{PageZoneId}/child/widgets/{PageWidgetId}/child/widgetProperties

Parameters:

• HomePageSetupId: $request.path.HomePageSetupId
• PageWidgetId: $request.path.PageWidgetId
• PageZoneId: $request.path.PageZoneId

The widget properties resource is used to define how a widget functions on a home page.

Back to Top