{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"approver": {
"type": "object",
"description": "The approver associated with an opportunity.",
"properties": {
"id": {
"type": "string",
"description": "The ID of an opportunity's approver, which must be a valid recruiter or hiring manager. __NOTE:__ The approver must be null if the approvals feature is disabled."
}
}
},
"behavior_criteria": {
"type": "array",
"items": {
"type": "object",
"properties": {
"is_required": {
"type": "boolean",
"description": "A Boolean indicator of whether or not a behavior criteria is required."
},
"behavior": {
"type": "object",
"description": "The behavior model."
}
}
},
"description": "An array of an opportunity's behavior criteria. All behavior criteria must have a valid behavior ID and the behavior must not be archived."
},
"company": {
"type": "object",
"description": "The company associated with an opportunity.",
"properties": {
"id": {
"type": "string",
"description": "The ID of an opportunity's company, which must be a valid company. The company's country must match the job's country. Required to publish."
}
}
},
"compensation": {
"type": "object",
"description": "The compensation details associated with an opportunity.",
"properties": {
"is_full_time": {
"type": "boolean",
"description": "A Boolean indicator of whether or not an opportunity is full-time. Defaults to true."
},
"is_salaried": {
"type": "boolean",
"description": "A Boolean indicator of whether or not an opportunity is salaried. Defaults to true."
},
"pay_rate": {
"type": "integer",
"description": "The pay rate of an opportunity. Required to publish, but can be 0."
},
"shown": {
"type": "string",
"description": "An opportunity's compensation visibility (All, Internal, External, None). Defaults to `None`."
},
"currency": {
"type": "object",
"description": "The currency details associated with an opportunity."
}
}
},
"created_at": {
"type": "string",
"description": "The date and time the opportunity was created. Defaults to NOW."
},
"default_locale": {
"type": "object",
"description": "The default locale associated with an opportunity.",
"properties": {
"code": {
"type": "string",
"description": "An opportunity's default language code. Defaults to the tenant default language code."
}
}
},
"description": {
"type": "object",
"description": "The description of an opportunity in all available languages.",
"properties": {
"brief": {
"type": "object",
"description": "The brief description of an opportunity in all available languages."
},
"detailed": {
"type": "object",
"description": "The detailed description of an opportunity in all available languages."
}
}
},
"education_criteria": {
"type": "array",
"items": {
"type": "object",
"properties": {
"is_required": {
"type": "boolean",
"description": "A Boolean indicator of whether or not an education criteria is required."
},
"allow_related": {
"type": "boolean",
"description": "A Boolean indicator of whether or not to allow related education criteria to meet the requirements of an opportunity."
},
"degree": {
"type": "object",
"description": "The degree associated with an education criteria."
},
"major": {
"type": "object",
"description": "The major field of study associated with an education criteria."
}
}
},
"description": "An array of an opportunity's education criteria. The only required field when education is included is degree, and a valid degree ID must be specified. If a major is included, it must be a valid major ID."
},
"employee_type": {
"type": "object",
"description": "The employee type associated with an opportunity.",
"properties": {
"id": {
"type": "string",
"description": "The ID of an opportunity's employee type, which must be one of the currently available employee types. Employee types can be retrieved by calling the [Retrieve all employeeType configurations](ref:retrieve-all-employee-type-configurations) operation."
}
}
},
"full_time_equivalent": {
"type": "object",
"description": "The full time equivalent model, which is an integer representing what is defined as full time.",
"properties": {
"budgeted": {
"type": "integer",
"description": "The budgeted full time equivalent, which must be a number greater than zero with a maximum of four decimal places. The maximum value is 9,999,999,999.9999 and the default value is `null`."
}
}
},
"head_count": {
"type": "object",
"description": "The head count associated with an opportunity.",
"properties": {
"max": {
"type": "integer",
"description": "The maximum head count associated with an opportunity, which must be a number greater than zero with a maximum length of 15 characters."
}
}
},
"hiring_manager": {
"type": "object",
"description": "The hiring manager associated with an opportunity.",
"properties": {
"id": {
"type": "string",
"description": "The ID of an opportunity's hiring manager, which must be a valid hiring manager."
}
}
},
"hours_per_shift": {
"type": "integer",
"description": "The number of hours per shift. Defaults to `null`."
},
"hours_per_week": {
"type": "integer",
"description": "The number of hours per week. Defaults to `null`."
},
"incumbent": {
"type": "object",
"description": "The incumbent who occupied an opportunity's listed position prior to the opportunity's candidate.",
"properties": {
"first_name": {
"type": "string",
"description": "The incumbent's first name. Defaults to `null`. Maximum 100 characters."
},
"last_name": {
"type": "string",
"description": "The incumbent's last name. Defaults to `null`. Maximum 100 characters."
},
"last_day_worked": {
"type": "string",
"description": "The incumbent's last day worked. Defaults to `null`."
}
}
},
"internal_notes": {
"type": "object",
"description": "An opportunity's internal notes. Maximum of 4,000 characters.",
"properties": {
"en_us": {
"type": "string",
"description": "The US English rendering of an opportunity's internal notes."
}
}
},
"internal_title": {
"type": "object",
"description": "The internal title of an opportunity. Optional. Maximum of 75 characters. Uses the value associated with the default locale. If the default locale is not provided, it uses the default tenant locale.",
"properties": {
"en_US": {
"type": "string",
"description": "The US English rendering of the opportunity's internal title."
}
}
},
"is_budgeted": {
"type": "string",
"description": "An opportunity's budgeting status (yes, no). Defaults to null."
},
"is_continuous_opening": {
"type": "boolean",
"description": "A Boolean indicator of whether or not an opportunity is a continous or 'forever' opening. Defaults to false. If true, `full_time_equivalent` and `head_count` are ignored."
},
"is_featured": {
"type": "boolean",
"description": "A Boolean indicator of whether or not an opportunity is featured. Defaults to false."
},
"is_shared_with_everyone": {
"type": "boolean",
"description": "A Boolean indicator of whether or not an opportunity is shared with everyone. Defaults to false."
},
"job": {
"type": "object",
"description": "The job associated with an opportunity.",
"properties": {
"code": {
"type": "string",
"description": "The job code associated with an opportunity."
}
},
"required": [
"code"
]
},
"job_boards": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of a job board."
},
"is_published_internal": {
"type": "boolean",
"description": "A Boolean indicator of whether or not a job board is published internally."
},
"is_published_external": {
"type": "boolean",
"description": "A Boolean indicator of whether or not a job board is published externally."
}
}
},
"description": "An array of an opportunity's associated job boards, which must be valid job boards. Not required to publish."
},
"job_family": {
"type": "object",
"description": "The job family details associated with an opportunity.",
"properties": {
"id": {
"type": "string",
"description": "The ID of an opportunity's job family. Required to publish."
}
}
},
"justification_comments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"description": "The text of a comment. Maximum of 500 characters."
}
}
},
"description": "An array of an opportunity's justification comments. Maximum of 10 comments per opportunity. Each comment has a maximum of 500 characters."
},
"license_and_certification_criteria": {
"type": "array",
"items": {
"type": "object",
"properties": {
"is_required": {
"type": "boolean",
"description": "A Boolean indicator of whether or not a license and certification criteria is required."
},
"license": {
"type": "object",
"description": "The license model."
}
}
},
"description": "An array containing an opportunity's license and certification criteria. All license and certification criteria must have a valid license ID."
},
"locations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of a location in GUID format."
}
}
},
"description": "An array of an opportunity's locations. They must be valid locations. At least one location is required to publish. If the `UserDefinedLocations` feature toggle is off, each location must be a valid GUID for a record in the `Location` collection. If the `UserDefinedLocations` feature toggle is on, each location must be a valid GUID for a record in the `PhysicalLocation` collection."
},
"motivation_criteria": {
"type": "array",
"items": {
"type": "object",
"properties": {
"is_required": {
"type": "boolean",
"description": "A Boolean indicator of whether or not a motivation criteria is required. Defaults to false."
},
"motivation": {
"type": "object",
"description": "The motivation model."
}
}
},
"description": "An array of an opportunity's motivation criteria."
},
"onboarding_owner": {
"type": "object",
"description": "The onboarding owner associated with an opportunity.",
"properties": {
"id": {
"type": "string",
"description": "The ID of an opportunity's onboarding owner, which must be a valid onboarding owner. __Note:__ Can also be a hiring manager if tenant has `IncludeHiringManagersInOnboardingOwnerField` enabled. __Note:__ Must be a valid hiring manager if the `OnboardingOwnerRole` feature is disabled."
}
}
},
"opening_reason": {
"type": "string",
"description": "An opportunity's opening reason (new-headcount, replacement, over-hire, temporary). Defaults to `null`."
},
"org_unit_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"org_units": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of an org level unit in GUID format. Must be active in UKG Pro. A group may contain only one org level unit of each level. For example, only one Region, only one Division, and so on."
}
}
},
"description": "An array of org units."
}
}
},
"description": "An array of an opportunity's org unit groups. Maximum of 20 org unit groups per opportunity. Each org unit group consists of a set of org units: org unit 1, org unit 2, ...org unit N. Currently, the Recruiting system supports only one group of org units, but multiple group support will be added in the future."
},
"priority": {
"type": "string",
"description": "An opportunity's priority (low, medium, high). Defaults to `null`."
},
"recruiter": {
"type": "object",
"description": "The recruiter associated with an opportunity.",
"properties": {
"id": {
"type": "string",
"description": "The ID of an opportunity's recruiter, which must be a valid recruiter or hiring manager. Required to publish. __Note:__ Can only be a hiring manager if the tenant has `IncludeHiringManagersInRecruiterField` enabled."
}
}
},
"recruiting_process": {
"type": "object",
"description": "The recruiting process associated with an opportunity.",
"properties": {
"id": {
"type": "string",
"description": "The ID of an opportunity's recruiting process, which must be a valid recruiting process. Required to publish."
}
}
},
"request_candidate_availability": {
"type": "boolean",
"description": "A Boolean indicator of whether or not to request a candidate's availability. Defaults to false."
},
"skill_criteria": {
"type": "array",
"items": {
"type": "object",
"properties": {
"is_required": {
"type": "boolean",
"description": "A Boolean indicator of whether or not a skill criteria is required."
},
"skill": {
"type": "object",
"description": "The skill model."
},
"proficiency_level": {
"type": "object",
"description": "The proficiency level associated with a skill."
}
}
},
"description": "An array of an opportunity's skill criteria. All skill criteria must have a valid skill ID and proficiency level ID."
},
"staffing_plan_impact": {
"type": "string",
"description": "An opportunity's impact to staffing plan notes. Defaults to `null`. Maximum 500 characters."
},
"supervisor": {
"type": "object",
"description": "The supervisor associated with an opportunity.",
"properties": {
"id": {
"type": "string",
"description": "The ID of an opportunity's supervisor, which must be a valid internal and active candidate."
}
}
},
"target_start_date": {
"type": "string",
"description": "An opportunity's target start date. Defaults to `null`."
},
"title": {
"type": "object",
"description": "The title of an opportunity in all available languages. Maximum of 75 characters. Required to publish.",
"properties": {
"en_gb": {
"type": "string",
"description": "The UK English rendering of the opportunity title."
},
"en_us": {
"type": "string",
"description": "The US English rendering of the opportunity title."
}
}
},
"travel": {
"type": "object",
"description": "The travel model for an opportunity.",
"properties": {
"is_required": {
"type": "boolean",
"description": "A Boolean indicator of whether or not travel is required."
},
"details": {
"type": "object",
"description": "An opportunity's travel description in all available languages. Maximum 75 characters. Optional."
}
}
},
"work_experience_criteria": {
"type": "array",
"items": {
"type": "object",
"properties": {
"is_required": {
"type": "boolean",
"description": "A Boolean indicator of whether or not a work experience criteria is required by an opportunity."
},
"minimum_required_years": {
"type": "integer",
"description": "The minimum number of years required by an opportunity."
},
"maximum_required_years": {
"type": "integer",
"description": "The maximum number of years required by an opportunity."
},
"description": {
"type": "object",
"description": "The description of a work experience criteria in all available languages."
}
}
},
"description": "An array of an opportunity's work experience criteria. All work experiences must have a translation for the opportunity's default language code."
}
},
"required": [
"PCID",
"tenantalias"
]
}
