Jump to

• Request
• Response

Create details of recruitingCEThemes Headers

post

/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders

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=

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• EmployeeText: string
  Maximum Length: 1000

  Employee text for custom headers in recruitingCEThemes.
• HeaderId: integer (int64)
  Header ID for custom headers in recruitingCEThemes.
• LogoURL: string
  Maximum Length: 1000

  Logo URL for custom headers in recruitingCEThemes.
• Name: string
  Maximum Length: 1000

  Name for custom headers in recruitingCEThemes.
• ProfileText: string
  Maximum Length: 1000

  Profile text for custom headers in recruitingCEThemes.
• settings: array Settings of the Header
  Title: Settings of the Header

  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(required): integer (int64)
  Theme ID for custom headers 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.
• Type(required): string
  Maximum Length: 200

  Type for custom headers in recruitingCEThemes.

{
    "required":[
        "ThemeId",
        "Type"
    ],
    "type":"object",
    "properties":{
        "ThemeId":{
            "type":"integer",
            "description":"Theme ID for custom headers in recruitingCEThemes.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:OA_TRANSLATABLE":"false"
            }
        },
        "settings":{
            "title":"Settings of the Header",
            "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-customHeaders-settings-item-post-request"
            }
        },
        "Type":{
            "maxLength":200,
            "type":"string",
            "description":"Type for custom headers in recruitingCEThemes.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            }
        },
        "LogoURL":{
            "maxLength":1000,
            "type":"string",
            "description":"Logo URL for custom headers in recruitingCEThemes.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "ProfileText":{
            "maxLength":1000,
            "type":"string",
            "description":"Profile text for custom headers in recruitingCEThemes.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "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-customHeaders-translations-item-post-request"
            }
        },
        "HeaderId":{
            "type":"integer",
            "description":"Header ID for custom headers in recruitingCEThemes.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EmployeeText":{
            "maxLength":1000,
            "type":"string",
            "description":"Employee text for custom headers in recruitingCEThemes.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "Name":{
            "maxLength":1000,
            "type":"string",
            "description":"Name for custom headers in recruitingCEThemes.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            }
        }
    }
}

Nested Schema : Settings of the Header

Type: array

Title: Settings of the Header

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 schema

{
    "title":"Settings of the Header",
    "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-customHeaders-settings-item-post-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-customHeaders-translations-item-post-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-customHeaders-translations-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• SettingId: integer (int64)
  Setting ID for custom header settings in recruitingCEThemes.
• SettingKey: string
  Maximum Length: 1000

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

  Setting value for custom header settings in recruitingCEThemes.

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

Nested Schema : recruitingCEThemes-customHeaders-translations-item-post-request

Type: object

Show Source

• EmployeeText: string
  Maximum Length: 1000

  Employee text for custom header translations in recruitingCEThemes.
• Language: string
  Maximum Length: 4

  Language for custom header translations in recruitingCEThemes.
• LogoURL: string
  Maximum Length: 1000

  Logo URL for custom header translations in recruitingCEThemes.
• ProfileText: string
  Maximum Length: 1000

  Profile text for custom header translations in recruitingCEThemes.
• SourceLang: string
  Maximum Length: 4

  Source language for custom header translations in recruitingCEThemes.

{
    "type":"object",
    "properties":{
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Language for custom header translations in recruitingCEThemes.",
            "nullable":false
        },
        "EmployeeText":{
            "maxLength":1000,
            "type":"string",
            "description":"Employee text for custom header translations in recruitingCEThemes.",
            "nullable":true
        },
        "LogoURL":{
            "maxLength":1000,
            "type":"string",
            "description":"Logo URL for custom header translations in recruitingCEThemes.",
            "nullable":true
        },
        "ProfileText":{
            "maxLength":1000,
            "type":"string",
            "description":"Profile text for custom header translations in recruitingCEThemes.",
            "nullable":true
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"Source language for custom header translations in recruitingCEThemes.",
            "nullable":false
        }
    }
}

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-customHeaders-item-response

Type: object

Show Source

• EmployeeText: string
  Maximum Length: 1000

  Employee text for custom headers in recruitingCEThemes.
• HeaderId: integer (int64)
  Header ID for custom headers in recruitingCEThemes.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LogoURL: string
  Maximum Length: 1000

  Logo URL for custom headers in recruitingCEThemes.
• Name: string
  Maximum Length: 1000

  Name for custom headers in recruitingCEThemes.
• ProfileText: string
  Maximum Length: 1000

  Profile text for custom headers in recruitingCEThemes.
• settings: array Settings of the Header
  Title: Settings of the Header

  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 ID for custom headers 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.
• Type: string
  Maximum Length: 200

  Type for custom headers in recruitingCEThemes.

{
    "type":"object",
    "properties":{
        "ThemeId":{
            "type":"integer",
            "description":"Theme ID for custom headers in recruitingCEThemes.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "settings":{
            "title":"Settings of the Header",
            "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-customHeaders-settings-item-response"
            }
        },
        "Type":{
            "maxLength":200,
            "type":"string",
            "description":"Type for custom headers in recruitingCEThemes.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "LogoURL":{
            "maxLength":1000,
            "type":"string",
            "description":"Logo URL for custom headers in recruitingCEThemes.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "ProfileText":{
            "maxLength":1000,
            "type":"string",
            "description":"Profile text for custom headers in recruitingCEThemes.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "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-customHeaders-translations-item-response"
            }
        },
        "HeaderId":{
            "type":"integer",
            "description":"Header ID for custom headers 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"
            }
        },
        "EmployeeText":{
            "maxLength":1000,
            "type":"string",
            "description":"Employee text for custom headers in recruitingCEThemes.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "Name":{
            "maxLength":1000,
            "type":"string",
            "description":"Name for custom headers in recruitingCEThemes.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"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 : Settings of the Header

Type: array

Title: Settings of the Header

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-customHeaders-settings-item-response

{
    "title":"Settings of the Header",
    "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-customHeaders-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-customHeaders-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-customHeaders-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-customHeaders-settings-item-response

Type: object

Show Source

• links: array Links
  Title: Links

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

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

  Setting value for custom header settings in recruitingCEThemes.

{
    "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":"Setting key for custom header settings in recruitingCEThemes.",
            "nullable":false,
            "x-queryable":true
        },
        "SettingValue":{
            "maxLength":1000,
            "type":"string",
            "description":"Setting value for custom header settings in recruitingCEThemes.",
            "nullable":true,
            "x-queryable":true
        },
        "SettingId":{
            "type":"integer",
            "description":"Setting ID for custom header settings in recruitingCEThemes.",
            "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 : recruitingCEThemes-customHeaders-translations-item-response

Type: object

Show Source

• EmployeeText: string
  Maximum Length: 1000

  Employee text for custom header translations in recruitingCEThemes.
• Language: string
  Maximum Length: 4

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

  The link relations associated with the resource instance.
• LogoURL: string
  Maximum Length: 1000

  Logo URL for custom header translations in recruitingCEThemes.
• ProfileText: string
  Maximum Length: 1000

  Profile text for custom header translations in recruitingCEThemes.
• SourceLang: string
  Maximum Length: 4

  Source language for custom header translations in recruitingCEThemes.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Language for custom header translations in recruitingCEThemes.",
            "nullable":false,
            "x-queryable":true
        },
        "EmployeeText":{
            "maxLength":1000,
            "type":"string",
            "description":"Employee text for custom header translations in recruitingCEThemes.",
            "nullable":true,
            "x-queryable":true
        },
        "LogoURL":{
            "maxLength":1000,
            "type":"string",
            "description":"Logo URL for custom header translations in recruitingCEThemes.",
            "nullable":true,
            "x-queryable":true
        },
        "ProfileText":{
            "maxLength":1000,
            "type":"string",
            "description":"Profile text for custom header translations in recruitingCEThemes.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"Source language for custom header translations in recruitingCEThemes.",
            "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"
    }
}

Links

settings

Operation: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}/child/settings

Parameters:

• HeaderId: $request.path.HeaderId
• ThemeNumber: $request.path.ThemeNumber

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.

translations

Operation: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}/child/translations

Parameters:

• HeaderId: $request.path.HeaderId
• ThemeNumber: $request.path.ThemeNumber

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

Back to Top