POST /hr_api/v1/position_requisitions

Creates a new Position Requisition

Params

Property Required Details Location

position_title

Must be a String

JSON

position_reason_uuid

Obtained from a separate Position Reason request.

Must be a String

JSON

valid_from

Must be a Date

JSON

number_to_fill

Must be a Integer

JSON

requisition_reference

Example format: REF-5N-QLBVS7E

Must be a String

JSON

position_requisition_template_uuid

Obtained from a separate Position Requisition Template request.

Must be a String

JSON

configuration_scope_uuid

Obtained from a separate Configuration Scope request.

Must be a String

JSON

start_date

Must be a Date

JSON

end_date

Must be a Date

JSON

status

Must be one of: open, closed_filled, closed_not_filled, closed_not_approved, closed_cancelled, closed_part_filled, draft, hold.

JSON

valid_to

Must be a Date

JSON

submitted_for_approval_at

Must be a Date

JSON

approval_completed_at

Must be a Date

JSON

job_purpose

Must be a String

JSON

responsibilities

Must be a String

JSON

experience

Must be a String

JSON

budgeted

Must be one of: yes, no.

JSON

business_case

Must be a String

JSON

description

Must be a String

JSON

replacement_for

Requires the PositionRequisitionTemplate used to have 'use_replacement_for' set to true.

Must be a String

JSON

auto_fill

Must be one of: 0, 1.

'0': 'No'
'1': 'Yes'
JSON

position_location

Must be a String

JSON

position_requestor

A string to identify the requestor.

Must be a String

JSON

salary_text

Requires the PositionRequisitionTemplate used to have 'use_salary_text' set to true.

Must be a String

JSON

approval_status

Must be one of: approved, not_approved, rework, cancelled.

JSON

job_specification_attachment_data

Base64 encoded string. Will be decoded and saved against the PositionRequisition with filename provided in job_specification_attachment_filename.

Must be a String

JSON

job_specification_attachment_filename

Required if job_specification_attachment_data is present. Requires file extension.

Must be a String

JSON

job_specification_attachment_content_type

Required if job_specification_attachment_data is present.

Must be a String

JSON

person_specification_attachment_data

Base64 encoded string. Will be decoded and saved against the PositionRequisition. with filename provided in person_specification_attachment_filename.

Must be a String

JSON

person_specification_attachment_filename

Required if person_specification_attachment_data is present. Requires file extension.

Must be a String

JSON

person_specification_attachment_content_type

Required if person_specification_attachment_data is present. Requires file extension.

Must be a String

JSON

Examples

POST /hr_api/v1/position_requisitions
{
  "position_title": "CREATED VIA API!",
  "position_reason_uuid": "7efc3807-4931-498f-9bfd-25a6743cb5e2",
  "valid_from": "2016-11-17T00:00:00.000+00:00",
  "number_to_fill": 1,
  "requisition_reference": "SELECTHR-VACANCY-647",
  "position_requisition_template_uuid": "803e57ca-fe19-4e17-a17c-a372f460c6d0"
}
201
{
  "message": "Position Requisition created successfully",
  "position_requisition": {
    "uuid": "a45b5dad-9870-4cd9-a976-223e629a0c0f",
    "requisition_reference": "SELECTHR-VACANCY-647",
    "description": "",
    "status": "open",
    "number_to_fill": 1,
    "valid_from": "2016-11-17T00:00:00.000+00:00",
    "valid_to": null,
    "approval_status": null,
    "submitted_for_approval_at": null,
    "approval_completed_at": null,
    "position_title": "CREATED VIA API!",
    "job_purpose": null,
    "responsibilities": null,
    "experience": null,
    "budgeted": null,
    "business_case": null,
    "start_date": "2016-11-17T00:00:00.000+00:00",
    "end_date": "2016-12-31T00:00:00.000+00:00",
    "replacement_for": null,
    "opening_owner_type": "all",
    "auto_fill": null,
    "position_location": "AEG Europe Head Office",
    "position_requisition_template": {
      "uuid": "803e57ca-fe19-4e17-a17c-a372f460c6d0",
      "number_to_fill": null,
      "status": "active",
      "opening_owner_type": "",
      "position_title": ""
    },
    "name": "API Test",
    "requisition_title": "API test",
    "use_hiring_manager": "0",
    "use_start_date": "1",
    "require_start_date": "0",
    "use_end_date": "1",
    "require_end_date": "0",
    "use_business_case": "1",
    "require_business_case": "0",
    "use_replacement_for": "1",
    "require_replacement_for": "0",
    "use_budgeted": "1",
    "require_budgeted": "0",
    "position_title_editable": "1",
    "use_position_location": "1",
    "require_position_location": "0",
    "use_job_purpose": "1",
    "require_job_purpose": "0",
    "use_responsibilities": "1",
    "require_responsibilities": "0",
    "use_experience": "1",
    "require_experience": "0",
    "use_salary_text": "1",
    "require_salary_text": "0",
    "use_min_max_salary": "1",
    "require_min_max_salary": "0",
    "use_salary_currency": "1",
    "require_salary_currency": "0",
    "use_other_interval": "1",
    "require_other_interval": "0",
    "use_shift_title": "1",
    "require_shift_title": "0",
    "use_pay_type_hours": "1",
    "require_pay_type_hours": "0",
    "use_job_grades": "0",
    "auto_fill_type": "",
    "use_business_units": "0",
    "use_organizational_units": "0",
    "use_organizational_sub_units": "0",
    "use_shift_keywords": "0",
    "use_remuneration_package_keywords": "0",
    "use_vms_job_levels": "0",
    "use_contract_types": "0",
    "use_job_category_ones": "0",
    "use_job_category_twos": "0",
    "use_job_category_threes": "0",
    "use_worksites": "0",
    "api_only": "1",
    "restricted_access": 0,
    "configuration_scope": {
      "uuid": null,
      "name": "distributed",
      "category_status": "active"
    },
    "category_status": "active",
    "custom_fieldset_templateable_type": "PositionRequisitionTemplate",
    "available_field_options": [],
    "text_1": null,
    "text_2": null,
    "text_3": null,
    "text_4": null,
    "text_5": null,
    "text_6": null,
    "text_7": null,
    "text_8": null,
    "text_9": null,
    "text_10": null,
    "text_11": null,
    "text_12": null,
    "text_13": null,
    "text_14": null,
    "datetime_1": null,
    "datetime_2": null,
    "text_1_editable": null,
    "text_1_required": null,
    "text_2_editable": null,
    "text_2_required": null,
    "text_3_editable": null,
    "text_3_required": null,
    "text_4_editable": null,
    "text_4_required": null,
    "text_5_editable": null,
    "text_5_required": null,
    "text_6_editable": null,
    "text_6_required": null,
    "text_7_editable": null,
    "text_7_required": null,
    "text_8_editable": null,
    "text_8_required": null,
    "text_9_editable": null,
    "text_9_required": null,
    "text_10_editable": null,
    "text_10_required": null,
    "text_11_editable": null,
    "text_11_required": null,
    "text_12_editable": null,
    "text_12_required": null,
    "text_13_editable": null,
    "text_13_required": null,
    "text_14_editable": null,
    "text_14_required": null,
    "datetime_1_required": null,
    "datetime_2_required": null,
    "keyword_1_required": null,
    "keyword_2_required": null,
    "text_area_1": null,
    "text_area_1_editable": null,
    "text_area_1_required": null,
    "text_15": null,
    "text_16": null,
    "text_17": null,
    "text_18": null,
    "text_19": null,
    "text_20": null,
    "text_15_editable": null,
    "text_15_required": null,
    "text_16_editable": null,
    "text_16_required": null,
    "text_17_editable": null,
    "text_17_required": null,
    "text_18_editable": null,
    "text_18_required": null,
    "text_19_editable": null,
    "text_19_required": null,
    "text_20_editable": null,
    "text_20_required": null,
    "keyword_3_required": null,
    "keyword_4_required": null,
    "keyword_5_required": null,
    "keyword_ones": [],
    "keyword_twos": [],
    "keyword_threes": [],
    "keyword_fours": [],
    "keyword_fives": [],
    "keyword_type": "PositionReason",
    "position_reason": {
      "uuid": "7efc3807-4931-498f-9bfd-25a6743cb5e2",
      "category_status": "active"
    },
    "category_code": "perm_new_position",
    "comments": "",
    "sort": 10,
    "category_description": "Perm - New Position`",
    "remuneration_package": {
      "uuid": "50deee3f-d0a7-46c6-bc89-093ed790b2df",
      "name": null,
      "comments": null,
      "sort": null,
      "category_status": "active"
    },
    "currency_code": null,
    "base_interval": null,
    "base_pay_amount_min": null,
    "base_pay_amount_max": null,
    "other_interval": null,
    "other_pay_amount_min": null,
    "other_pay_amount_max": null,
    "other_pay_calculation": null,
    "other_pay_comments": null,
    "insurance": null,
    "insurance_type": null,
    "retirement_or_savings_plan": null,
    "company_vehicle": null,
    "company_vehicle_description": null,
    "relocation_assistance": null,
    "relocation_assistance_description": null,
    "visa_sponsorship": null,
    "time_off_allowance": null,
    "expatriate_benefits": null,
    "other_benefits": null,
    "is_keyword": false,
    "salary_text": "free"
  }
}