Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• customIconSettings: array Site Custom Icon Settings
  Title: Site Custom Icon Settings

  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.

{
    "type":"object",
    "properties":{
        "IconCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Icon code for the custom icon",
            "nullable":false
        },
        "Definition":{
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the custom icon.",
            "nullable":true
        },
        "Type":{
            "maxLength":"32",
            "type":"string",
            "description":"Type of custom icon.",
            "nullable":false
        },
        "Image":{
            "type":"string",
            "description":"Image for the custom icon when used instead of code.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "StatusCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Status code assigned to the custom icon.",
            "nullable":false
        },
        "customIconSettings":{
            "title":"Site Custom Icon Settings",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/recruitingCESites-customIcons-customIconSettings-item-patch-request"
            }
        }
    }
}

Nested Schema : Site Custom Icon Settings

Type: array

Title: Site Custom Icon Settings

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

• Array of: object schema

{
    "title":"Site Custom Icon Settings",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/recruitingCESites-customIcons-customIconSettings-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• SettingKey: string
  Maximum Length: 1000

  Key assigned to the custom icon.
• SettingValue: string
  Maximum Length: 1000

  Value assigned to the icon settings.

{
    "type":"object",
    "properties":{
        "SettingKey":{
            "maxLength":"1000",
            "type":"string",
            "description":"Key assigned to the custom icon.",
            "nullable":false
        },
        "SettingValue":{
            "maxLength":"1000",
            "type":"string",
            "description":"Value assigned to the icon settings.",
            "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 : recruitingCESites-customIcons-item-response

Type: object

Show Source

• customIconSettings: array Site Custom Icon Settings
  Title: Site Custom Icon Settings

  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.

{
    "type":"object",
    "properties":{
        "IconCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Icon code for the custom icon",
            "nullable":false,
            "x-queryable":true
        },
        "Type":{
            "maxLength":"32",
            "type":"string",
            "description":"Type of custom icon.",
            "nullable":false,
            "x-queryable":true
        },
        "customIconSettings":{
            "title":"Site Custom Icon Settings",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/recruitingCESites-customIcons-customIconSettings-item-response"
            }
        },
        "Definition":{
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the custom icon.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IconId":{
            "type":"integer",
            "description":"ID assigned to the custom icon.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Image":{
            "type":"string",
            "description":"Image for the custom icon when used instead of code.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "StatusCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Status code assigned to the custom icon.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Site Custom Icon Settings

Type: array

Title: Site Custom Icon Settings

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

• Array of: object recruitingCESites-customIcons-customIconSettings-item-response

{
    "title":"Site Custom Icon Settings",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/recruitingCESites-customIcons-customIconSettings-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 : recruitingCESites-customIcons-customIconSettings-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SettingKey":{
            "maxLength":"1000",
            "type":"string",
            "description":"Key assigned to the custom icon.",
            "nullable":false,
            "x-queryable":true
        },
        "SettingValue":{
            "maxLength":"1000",
            "type":"string",
            "description":"Value assigned to the icon settings.",
            "nullable":true,
            "x-queryable":true
        },
        "SettingId":{
            "type":"integer",
            "description":"ID assigned to each setting of the custom icon.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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 : 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."
        }
    }
}

Links

customIconSettings

Operation: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customIcons/{IconId}/child/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.

Back to Top