Jump to

• Request
• Response

Create job recommendation records

post

/hcmRestApi/resources/11.13.18.05/recruitingCEAIJobRecommendations

Request

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

• CandidateProfile: string
  Profile summary of the candidate.
• isEncodedFlag: boolean
  Indicates whether the CandidateProfile is Base-64 encoded.
• items: string
  Details to provide the job recommendations.
• Keyword: string
  Maximum Length: 255

  Keyword used for job search to provide job recommendations.
• Latitude: number
  Latitude of the location of job requisition.
• Limit: integer
  Limit input parameter to control number of records retrieved.
• LocationId: string
  LocationId of job requisitions search.
• Longitude: number
  Longitude of the location of job requisition.
• Offset: integer
  Offset input parameter to control pagination.
• Radius: integer
  Radius distance for radius search.
• RadiusUnit: string
  Measurement unit to for radius search.
• SiteNumber: string
  Site number for job search to provide job recommendations.
• SortBy: string
  Maximum Length: 255

  Field to sort results by.

{
    "type":"object",
    "properties":{
        "CandidateProfile":{
            "type":"string",
            "description":"Profile summary of the candidate.",
            "nullable":true
        },
        "Keyword":{
            "maxLength":255,
            "type":"string",
            "description":"Keyword used for job search to provide job recommendations.",
            "nullable":true
        },
        "Latitude":{
            "type":"number",
            "description":"Latitude of the location of job requisition.",
            "nullable":true
        },
        "Limit":{
            "type":"integer",
            "description":"Limit input parameter to control number of records retrieved.",
            "nullable":true
        },
        "LocationId":{
            "type":"string",
            "description":"LocationId of job requisitions search.",
            "nullable":true
        },
        "Longitude":{
            "type":"number",
            "description":"Longitude of the location of job requisition.",
            "nullable":true
        },
        "Offset":{
            "type":"integer",
            "description":"Offset input parameter to control pagination.",
            "nullable":true
        },
        "Radius":{
            "type":"integer",
            "description":"Radius distance for radius search.",
            "nullable":true
        },
        "RadiusUnit":{
            "type":"string",
            "description":"Measurement unit to for radius search.",
            "nullable":true
        },
        "SiteNumber":{
            "type":"string",
            "description":"Site number for job search to provide job recommendations.",
            "nullable":true
        },
        "SortBy":{
            "maxLength":255,
            "type":"string",
            "description":"Field to sort results by.",
            "nullable":true
        },
        "isEncodedFlag":{
            "type":"boolean",
            "description":"Indicates whether the CandidateProfile is Base-64 encoded.",
            "nullable":true
        },
        "items":{
            "type":"string",
            "description":"Details to provide the job recommendations.",
            "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 : recruitingCEAIJobRecommendations-item-response

Type: object

Show Source

• CandidateProfile: string
  Profile summary of the candidate.
• isEncodedFlag: boolean
  Indicates whether the CandidateProfile is Base-64 encoded.
• items: string
  Details to provide the job recommendations.
• Keyword: string
  Maximum Length: 255

  Keyword used for job search to provide job recommendations.
• Latitude: number
  Latitude of the location of job requisition.
• Limit: integer
  Limit input parameter to control number of records retrieved.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationId: string
  LocationId of job requisitions search.
• Longitude: number
  Longitude of the location of job requisition.
• Offset: integer
  Offset input parameter to control pagination.
• Radius: integer
  Radius distance for radius search.
• RadiusUnit: string
  Measurement unit to for radius search.
• SiteNumber: string
  Site number for job search to provide job recommendations.
• SortBy: string
  Maximum Length: 255

  Field to sort results by.

{
    "type":"object",
    "properties":{
        "CandidateProfile":{
            "type":"string",
            "description":"Profile summary of the candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "Keyword":{
            "maxLength":255,
            "type":"string",
            "description":"Keyword used for job search to provide job recommendations.",
            "nullable":true,
            "x-queryable":true
        },
        "Latitude":{
            "type":"number",
            "description":"Latitude of the location of job requisition.",
            "nullable":true,
            "x-queryable":true
        },
        "Limit":{
            "type":"integer",
            "description":"Limit input parameter to control number of records retrieved.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"string",
            "description":"LocationId of job requisitions search.",
            "nullable":true,
            "x-queryable":true
        },
        "Longitude":{
            "type":"number",
            "description":"Longitude of the location of job requisition.",
            "nullable":true,
            "x-queryable":true
        },
        "Offset":{
            "type":"integer",
            "description":"Offset input parameter to control pagination.",
            "nullable":true,
            "x-queryable":true
        },
        "Radius":{
            "type":"integer",
            "description":"Radius distance for radius search.",
            "nullable":true,
            "x-queryable":true
        },
        "RadiusUnit":{
            "type":"string",
            "description":"Measurement unit to for radius search.",
            "nullable":true,
            "x-queryable":true
        },
        "SiteNumber":{
            "type":"string",
            "description":"Site number for job search to provide job recommendations.",
            "nullable":true,
            "x-queryable":true
        },
        "SortBy":{
            "maxLength":255,
            "type":"string",
            "description":"Field to sort results by.",
            "nullable":true,
            "x-queryable":true
        },
        "isEncodedFlag":{
            "type":"boolean",
            "description":"Indicates whether the CandidateProfile is Base-64 encoded.",
            "nullable":true,
            "x-queryable":true
        },
        "items":{
            "type":"string",
            "description":"Details to provide the job recommendations.",
            "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"
    }
}

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."
        }
    }
}

Back to Top