Update a custom icon in recruitingCESites
patch
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customIcons/{IconId}
Request
Path Parameters
-
IconId(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=
-
SiteNumber(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=
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
Root Schema : schema
Type:
Show Source
object
-
customIconSettings: array
Site Custom Font Setting Files
Title:
Site Custom Font Setting Files
The customIconSettings resource is a child of customIcons. It includes the details for the custom icon settings. Note that the service endpoints in this resource category are only for Oracle internal use. -
Definition: string
Maximum Length:
1000
Description of the custom icon. -
IconCode: string
Maximum Length:
32
Icon code for the custom icon -
Image: string
(byte)
Image for the custom icon when used instead of code.
-
StatusCode: string
Maximum Length:
32
Status code assigned to the custom icon. -
Type: string
Maximum Length:
32
Type of custom icon.
Nested Schema : Site Custom Font Setting Files
Type:
array
Title:
Site Custom Font Setting Files
The customIconSettings resource is a child of customIcons. It includes the details for the custom icon settings. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
SettingKey: string
Maximum Length:
1000
Key assigned to the custom icon. -
SettingValue: string
Maximum Length:
1000
Value assigned to the icon settings.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : recruitingCESites-customIcons-item-response
Type:
Show Source
object
-
customIconSettings: array
Site Custom Font Setting Files
Title:
Site Custom Font Setting Files
The customIconSettings resource is a child of customIcons. It includes the details for the custom icon settings. Note that the service endpoints in this resource category are only for Oracle internal use. -
Definition: string
Maximum Length:
1000
Description of the custom icon. -
IconCode: string
Maximum Length:
32
Icon code for the custom icon -
IconId: integer
(int64)
ID assigned to the custom icon.
-
Image: string
(byte)
Image for the custom icon when used instead of code.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StatusCode: string
Maximum Length:
32
Status code assigned to the custom icon. -
Type: string
Maximum Length:
32
Type of custom icon.
Nested Schema : Site Custom Font Setting Files
Type:
array
Title:
Site Custom Font Setting Files
The customIconSettings resource is a child of customIcons. It includes the details for the custom icon settings. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCESites-customIcons-customIconSettings-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SettingId: integer
(int64)
ID assigned to each setting of the custom icon.
-
SettingKey: string
Maximum Length:
1000
Key assigned to the custom icon. -
SettingValue: string
Maximum Length:
1000
Value assigned to the icon settings.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- customIconSettings
-
Parameters:
- IconId:
$request.path.IconId
- SiteNumber:
$request.path.SiteNumber
The customIconSettings resource is a child of customIcons. It includes the details for the custom icon settings. Note that the service endpoints in this resource category are only for Oracle internal use. - IconId: