Jump to

• Request
• Response

Update a widget detail

patch

/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customWidgets/{WidgetId}

Request

Path Parameters

• ThemeNumber(required): string
  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=
• 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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• settings: array Settings of the Widget
  Title: Settings of the Widget

  The settings resource is a child of customHeaders. It includes the headers settings configuration. Note that the service endpoints in this resource category are only for Oracle internal use.
• ThemeId: integer (int64)
  Theme identifier for custom widgets in recruitingCEThemes.
• translations: array Brand Translations of Themes
  Title: Brand Translations of Themes

  The translation resource is a child of Brand. It includes the details of the brand translations of the recruiting CE themes. Note that the service endpoints in this resource category are only for Oracle internal use.
• WidgetEnabledFlag: boolean
  Maximum Length: 1

  Widget enabled flag for custom widgets in recruitingCEThemes.
• WidgetIconURL: string
  Maximum Length: 1000

  Icon URL for custom widgets in recruitingCEThemes.
• WidgetName: string
  Maximum Length: 1000

  Name for custom widgets in recruitingCEThemes.
• WidgetText: string
  Maximum Length: 1000

  Text for custom widgets in recruitingCEThemes.
• WidgetTypeCode: string
  Maximum Length: 200

  Type code for custom widgets in recruitingCEThemes.

{
    "type":"object",
    "properties":{
        "ThemeId":{
            "type":"integer",
            "description":"Theme identifier for custom widgets in recruitingCEThemes.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "WidgetEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Widget enabled flag for custom widgets in recruitingCEThemes.",
            "nullable":false
        },
        "WidgetIconURL":{
            "maxLength":1000,
            "type":"string",
            "description":"Icon URL for custom widgets in recruitingCEThemes.",
            "nullable":true
        },
        "WidgetName":{
            "maxLength":1000,
            "type":"string",
            "description":"Name for custom widgets in recruitingCEThemes.",
            "nullable":true
        },
        "WidgetText":{
            "maxLength":1000,
            "type":"string",
            "description":"Text for custom widgets in recruitingCEThemes.",
            "nullable":true
        },
        "WidgetTypeCode":{
            "maxLength":200,
            "type":"string",
            "description":"Type code for custom widgets in recruitingCEThemes.",
            "nullable":false
        },
        "settings":{
            "title":"Settings of the Widget",
            "type":"array",
            "description":"The settings resource is a child of customHeaders. It includes the headers settings configuration. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCEThemes-customWidgets-settings-item-patch-request"
            }
        },
        "translations":{
            "title":"Brand Translations of Themes",
            "type":"array",
            "description":"The translation resource is a child of Brand. It includes the details of the brand translations of the recruiting CE themes. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCEThemes-customWidgets-translations-item-patch-request"
            }
        }
    }
}

Nested Schema : Settings of the Widget

Type: array

Title: Settings of the Widget

The settings resource is a child of customHeaders. It includes the headers settings configuration. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCEThemes-customWidgets-settings-item-patch-request

{
    "title":"Settings of the Widget",
    "type":"array",
    "description":"The settings resource is a child of customHeaders. It includes the headers settings configuration. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCEThemes-customWidgets-settings-item-patch-request"
    }
}

Nested Schema : Brand Translations of Themes

Type: array

Title: Brand Translations of Themes

The translation resource is a child of Brand. It includes the details of the brand translations of the recruiting CE themes. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCEThemes-customWidgets-translations-item-patch-request

{
    "title":"Brand Translations of Themes",
    "type":"array",
    "description":"The translation resource is a child of Brand. It includes the details of the brand translations of the recruiting CE themes. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCEThemes-customWidgets-translations-item-patch-request"
    }
}

Nested Schema : recruitingCEThemes-customWidgets-settings-item-patch-request

Type: object

Show Source

• SettingKey: string
  Maximum Length: 1000

  Setting key for custom widget settings in recruitingCEThemes.
• SettingValue: string
  Maximum Length: 1000

  Setting value for custom widgets settings in recruitingCEThemes.
• WidgetId: integer (int64)
  Identifier for custom widgets settings in recruitingCEThemes.

{
    "type":"object",
    "properties":{
        "SettingKey":{
            "maxLength":1000,
            "type":"string",
            "description":"Setting key for custom widget settings in recruitingCEThemes.",
            "nullable":false
        },
        "SettingValue":{
            "maxLength":1000,
            "type":"string",
            "description":"Setting value for custom widgets settings in recruitingCEThemes.",
            "nullable":true
        },
        "WidgetId":{
            "type":"integer",
            "description":"Identifier for custom widgets settings in recruitingCEThemes.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : recruitingCEThemes-customWidgets-translations-item-patch-request

Type: object

Show Source

• SourceLang: string
  Maximum Length: 4

  Source language for custom widgets translations in recruitingCEThemes.
• WidgetIconURL: string
  Maximum Length: 1000

  Widget icon URL for custom widgets translations in recruitingCEThemes.
• WidgetName: string
  Maximum Length: 1000

  Name for custom widgets translations in recruitingCEThemes.

{
    "type":"object",
    "properties":{
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"Source language for custom widgets translations in recruitingCEThemes.",
            "nullable":false
        },
        "WidgetIconURL":{
            "maxLength":1000,
            "type":"string",
            "description":"Widget icon URL for custom widgets translations in recruitingCEThemes.",
            "nullable":true
        },
        "WidgetName":{
            "maxLength":1000,
            "type":"string",
            "description":"Name for custom widgets translations in recruitingCEThemes.",
            "nullable":true
        }
    }
}

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 : recruitingCEThemes-customWidgets-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• settings: array Settings of the Widget
  Title: Settings of the Widget

  The settings resource is a child of customHeaders. It includes the headers settings configuration. Note that the service endpoints in this resource category are only for Oracle internal use.
• ThemeId: integer (int64)
  Theme identifier for custom widgets in recruitingCEThemes.
• translations: array Brand Translations of Themes
  Title: Brand Translations of Themes

  The translation resource is a child of Brand. It includes the details of the brand translations of the recruiting CE themes. Note that the service endpoints in this resource category are only for Oracle internal use.
• WidgetEnabledFlag: boolean
  Maximum Length: 1

  Widget enabled flag for custom widgets in recruitingCEThemes.
• WidgetIconURL: string
  Maximum Length: 1000

  Icon URL for custom widgets in recruitingCEThemes.
• WidgetId: integer (int64)
  Identifier for custom widgets in recruitingCEThemes.
• WidgetName: string
  Maximum Length: 1000

  Name for custom widgets in recruitingCEThemes.
• WidgetText: string
  Maximum Length: 1000

  Text for custom widgets in recruitingCEThemes.
• WidgetTypeCode: string
  Maximum Length: 200

  Type code for custom widgets in recruitingCEThemes.

{
    "type":"object",
    "properties":{
        "ThemeId":{
            "type":"integer",
            "description":"Theme identifier for custom widgets in recruitingCEThemes.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WidgetEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Widget enabled flag for custom widgets in recruitingCEThemes.",
            "nullable":false,
            "x-queryable":true
        },
        "WidgetIconURL":{
            "maxLength":1000,
            "type":"string",
            "description":"Icon URL for custom widgets in recruitingCEThemes.",
            "nullable":true,
            "x-queryable":true
        },
        "WidgetId":{
            "type":"integer",
            "description":"Identifier for custom widgets in recruitingCEThemes.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WidgetName":{
            "maxLength":1000,
            "type":"string",
            "description":"Name for custom widgets in recruitingCEThemes.",
            "nullable":true,
            "x-queryable":true
        },
        "WidgetText":{
            "maxLength":1000,
            "type":"string",
            "description":"Text for custom widgets in recruitingCEThemes.",
            "nullable":true,
            "x-queryable":true
        },
        "WidgetTypeCode":{
            "maxLength":200,
            "type":"string",
            "description":"Type code for custom widgets in recruitingCEThemes.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "settings":{
            "title":"Settings of the Widget",
            "type":"array",
            "description":"The settings resource is a child of customHeaders. It includes the headers settings configuration. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCEThemes-customWidgets-settings-item-response"
            }
        },
        "translations":{
            "title":"Brand Translations of Themes",
            "type":"array",
            "description":"The translation resource is a child of Brand. It includes the details of the brand translations of the recruiting CE themes. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCEThemes-customWidgets-translations-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 : Settings of the Widget

Type: array

Title: Settings of the Widget

The settings resource is a child of customHeaders. It includes the headers settings configuration. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCEThemes-customWidgets-settings-item-response

{
    "title":"Settings of the Widget",
    "type":"array",
    "description":"The settings resource is a child of customHeaders. It includes the headers settings configuration. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCEThemes-customWidgets-settings-item-response"
    }
}

Nested Schema : Brand Translations of Themes

Type: array

Title: Brand Translations of Themes

The translation resource is a child of Brand. It includes the details of the brand translations of the recruiting CE themes. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCEThemes-customWidgets-translations-item-response

{
    "title":"Brand Translations of Themes",
    "type":"array",
    "description":"The translation resource is a child of Brand. It includes the details of the brand translations of the recruiting CE themes. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCEThemes-customWidgets-translations-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 : recruitingCEThemes-customWidgets-settings-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SettingId: integer (int64)
  Setting identifier for custom widgets settings in recruitingCEThemes.
• SettingKey: string
  Maximum Length: 1000

  Setting key for custom widget settings in recruitingCEThemes.
• SettingValue: string
  Maximum Length: 1000

  Setting value for custom widgets settings in recruitingCEThemes.
• WidgetId: integer (int64)
  Identifier for custom widgets settings in recruitingCEThemes.

{
    "type":"object",
    "properties":{
        "SettingId":{
            "type":"integer",
            "description":"Setting identifier for custom widgets settings in recruitingCEThemes.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SettingKey":{
            "maxLength":1000,
            "type":"string",
            "description":"Setting key for custom widget settings in recruitingCEThemes.",
            "nullable":false,
            "x-queryable":true
        },
        "SettingValue":{
            "maxLength":1000,
            "type":"string",
            "description":"Setting value for custom widgets settings in recruitingCEThemes.",
            "nullable":true,
            "x-queryable":true
        },
        "WidgetId":{
            "type":"integer",
            "description":"Identifier for custom widgets settings in recruitingCEThemes.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : recruitingCEThemes-customWidgets-translations-item-response

Type: object

Show Source

• Language: string
  Maximum Length: 4

  Language for custom widgets translations in recruitingCEThemes.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SourceLang: string
  Maximum Length: 4

  Source language for custom widgets translations in recruitingCEThemes.
• WidgetIconURL: string
  Maximum Length: 1000

  Widget icon URL for custom widgets translations in recruitingCEThemes.
• WidgetId: integer (int64)
  Widget identifier for custom widgets translations in recruitingCEThemes.
• WidgetName: string
  Maximum Length: 1000

  Name for custom widgets translations in recruitingCEThemes.

{
    "type":"object",
    "properties":{
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Language for custom widgets translations in recruitingCEThemes.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"Source language for custom widgets translations in recruitingCEThemes.",
            "nullable":false,
            "x-queryable":true
        },
        "WidgetIconURL":{
            "maxLength":1000,
            "type":"string",
            "description":"Widget icon URL for custom widgets translations in recruitingCEThemes.",
            "nullable":true,
            "x-queryable":true
        },
        "WidgetId":{
            "type":"integer",
            "description":"Widget identifier for custom widgets translations in recruitingCEThemes.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WidgetName":{
            "maxLength":1000,
            "type":"string",
            "description":"Name for custom widgets translations in recruitingCEThemes.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

settings

Operation: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customWidgets/{WidgetId}/child/settings

Parameters:

• ThemeNumber: $request.path.ThemeNumber
• WidgetId: $request.path.WidgetId

The settings resource is a child of customWidgets. It includes the widget settings configuration. Note that the service endpoints in this resource category are only for Oracle internal use.

translations

Operation: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customWidgets/{WidgetId}/child/translations

Parameters:

• ThemeNumber: $request.path.ThemeNumber
• WidgetId: $request.path.WidgetId

The translations resource is a child of customWidgets. It includes the custom widget translations. Note that the service endpoints in this resource category are only for Oracle internal use.

Back to Top