PATCH | PUT /hr_api/v1/position_requisitions/:uuid

Updates an existing Position Requisition

Params

Property Required Details Location

uuid

Must be a String

URL

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

PUT /hr_api/v1/position_requisitions/:uuid
{
  "position_title": "CREATED VIA API!"
}
200
{
  "message": "Position Requisition updated successfully",
  "position_requisition": {
    "uuid": "b874ea38-f631-45d0-8ff1-73cabc9eae74",
    "requisition_reference": "REF-C-I1TA7ON",
    "description": "",
    "status": "open",
    "number_to_fill": 10,
    "valid_from": "2012-03-06T00:00:00.000+00:00",
    "valid_to": null,
    "approval_status": "approved",
    "submitted_for_approval_at": "2012-04-03T15:46:48.000+01:00",
    "approval_completed_at": "2012-04-03T15:53:52.000+01:00",
    "position_title": "Example Position Title",
    "job_purpose": "<p>Job Purpose</p>",
    "responsibilities": "<p>Responsibilities</p>",
    "experience": "<p>Experience</p>",
    "budgeted": "yes",
    "business_case": "<p>We need a new person</p>\r\n<p>&nbsp;</p>",
    "start_date": "2012-03-08T00:00:00.000+00:00",
    "end_date": "2013-03-07T00:00:00.000+00:00",
    "replacement_for": "A former employee",
    "opening_owner_type": "all",
    "auto_fill": false,
    "position_location": null,
    "position_requisition_template": {
      "uuid": "1a608d50-86b2-4bcb-863f-88b95d4a3ba3",
      "description": "Text to see if we can get Ladbrokes HO form looking close.",
      "number_to_fill": null,
      "status": "active",
      "opening_owner_type": "named_user",
      "position_title": ""
    },
    "name": "Ladbrokes HO",
    "requisition_title": "Ladbrokes Requisition",
    "auto_fill_type": "always_auto_fill",
    "hiring_manager_type": "delegation_list",
    "position_title_editable": "1",
    "require_budgeted": "1",
    "require_business_case": "1",
    "require_business_unit": "1",
    "require_business_units": "1",
    "require_contract_types": "1",
    "require_end_date": "1",
    "require_experience": "1",
    "require_hours_of_work": "1",
    "require_job_category_ones": "1",
    "require_job_category_threes": "0",
    "require_job_category_twos": "1",
    "require_job_grades": "1",
    "require_job_purpose": "1",
    "require_min_max_salary": "1",
    "require_organizational_sub_units": "1",
    "require_organizational_units": "1",
    "require_other_interval": "1",
    "require_pay_type_hours": "1",
    "require_replacement_for": "1",
    "require_responsibilities": "1",
    "require_salary_currency": "1",
    "require_salary_text": "1",
    "require_shift_name": "1",
    "require_shift_title": "1",
    "require_start_date": "1",
    "require_vms_job_levels": "1",
    "require_worksites": "1",
    "restrict_worksites_flag": "",
    "use_budgeted": "1",
    "use_business_case": "1",
    "use_business_unit": "1",
    "use_business_units": "1",
    "use_contract_types": "1",
    "use_end_date": "1",
    "use_experience": "1",
    "use_hiring_manager": "1",
    "use_hours_of_work": "1",
    "use_job_category_ones": "1",
    "use_job_category_threes": "1",
    "use_job_category_twos": "1",
    "use_job_grades": "1",
    "use_job_purpose": "1",
    "use_min_max_salary": "1",
    "use_organizational_sub_units": "1",
    "use_organizational_units": "1",
    "use_other_interval": "1",
    "use_pay_type_hours": "1",
    "use_replacement_for": "1",
    "use_responsibilities": "1",
    "use_salary_currency": "1",
    "use_salary_text": "1",
    "use_shift_name": "1",
    "use_shift_title": "1",
    "use_start_date": "1",
    "use_vms_job_levels": "1",
    "use_worksites": "1",
    "use_shift_keywords": "0",
    "use_remuneration_package_keywords": "0",
    "restricted_access": 0,
    "configuration_scope": {
      "name": "recruitment",
      "category_status": "active"
    },
    "category_status": "active",
    "custom_fieldset_templateable_type": "PositionRequisitionTemplate",
    "available_field_options": [
      "text_1",
      "keyword_1",
      "keyword_2"
    ],
    "text_1": "234 months",
    "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": true,
    "text_1_required": true,
    "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": true,
    "keyword_2_required": true,
    "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_type": "PositionRequisitionKeywordOne",
        "uuid": "0763280b-dc02-483b-8381-86185906d306",
        "category_code": "0.8 pos req key one",
        "comments": "0.8 pos req key one",
        "sort": null,
        "category_status": "active",
        "category_description": "0.8 pos req key one"
      }
    ],
    "keyword_twos": [
      {
        "keyword_type": "PositionRequisitionKeywordTwo",
        "uuid": "5e08d5b9-abc2-4271-8171-f7facf9abacd",
        "category_code": "yes",
        "comments": "",
        "sort": 10,
        "category_status": "active",
        "category_description": "Yes"
      },
      {
        "keyword_type": "PositionRequisitionKeywordTwo",
        "uuid": "fda8c0f5-575a-4fd3-b0b0-1b8035ed7fda",
        "category_code": "0.8 pos req key two",
        "comments": "0.8 pos req key two",
        "sort": null,
        "category_status": "active",
        "category_description": "0.8 pos req key two"
      },
      {
        "keyword_type": "PositionRequisitionKeywordTwo",
        "uuid": "5358a382-d02e-4821-bbba-485370a63de0",
        "category_code": "no",
        "comments": "",
        "sort": 20,
        "category_status": "active",
        "category_description": "No"
      }
    ],
    "keyword_threes": [],
    "keyword_fours": [],
    "keyword_fives": [],
    "business_unit": {
      "uuid": "5b5ff364-4bdb-45c4-be99-5089a22aa67e",
      "category_status": "active"
    },
    "category_code": "ladbrokes_ho",
    "comments": "",
    "sort": null,
    "vms_transfer_status": "complete",
    "transferred_to_vms_at": "2012-03-05T10:15:38.000+00:00",
    "worksite_selection": "organizational_sub_unit",
    "category_description": "Ladbrokes Head Office",
    "keyword_type": "PositionReason",
    "keyword_id": null,
    "position_reason": {
      "uuid": "467ac832-a2d9-4319-bddf-fd27e1a94625",
      "category_code": "perm_replacement",
      "comments": "",
      "category_status": "active",
      "category_description": "Perm - Replacement"
    }
  }
}