Create introductory text for a job category
post
/hcmRestApi/resources/11.13.18.05/recruitingCESecuredJobFamilyTextGenerativeAIResponses
Request
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
Root Schema : schema
Type:
Show Source
object
-
CategoryTileTitle: string
Maximum Length:
255
Title of the job category tile. -
ImageURL: string
URL of the image returned by large the language model prompt.
-
IntroText: string
Introductory text for a job category.
-
JobFamilyIds: string
Maximum Length:
255
Job family to generate introductory text for a job category. -
JobTitle: string
Last 3 job titles for the provided job family identifier.
-
LinkedImageURL: string
URL of the image linked to the image returned by the large language model prompt.
-
SiteNumber: string
Maximum Length:
255
Site number of the career site to generate introductory text for a job category.
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.
Root Schema : recruitingCESecuredJobFamilyTextGenerativeAIResponses-item-response
Type:
Show Source
object
-
CategoryTileTitle: string
Maximum Length:
255
Title of the job category tile. -
ImageURL: string
URL of the image returned by large the language model prompt.
-
IntroText: string
Introductory text for a job category.
-
JobFamilyIds: string
Maximum Length:
255
Job family to generate introductory text for a job category. -
JobTitle: string
Last 3 job titles for the provided job family identifier.
-
LinkedImageURL: string
URL of the image linked to the image returned by the large language model prompt.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SiteNumber: string
Maximum Length:
255
Site number of the career site to generate introductory text for a job category.
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.