| Property | Required | Details | Location |
|---|---|---|---|
scope |
Optionally override the default scope. Will be ignored if invalid. Must be one of: |
URL | |
page |
Index returns 100 records per request. Defaults to 1. Must be a Integer |
URL |
GET /hr_api/v1/position_requisitions
200
{
"position_requisitions": [
{
"uuid": "314fc28f-f823-44e8-afe8-d372e4a55377",
"requisition_reference": "REF-G-GG7O30N",
"status": "open"
},
{
"uuid": "1d7bc8d2-25ab-4218-aa72-b20301fdfbbc",
"requisition_reference": "REF-E-MXLHR0D",
"status": "open"
},
{
"uuid": "9d7d67d4-63da-4220-bf9d-4e5f5733b0c9",
"requisition_reference": "REF-G-M9G8T09",
"status": "open"
},
{
"uuid": "5770ffcd-55f8-4fb8-affb-e0e3035b3772",
"requisition_reference": "REF-D-N4TS2WP",
"status": "open"
},
{
"uuid": "d427bb57-e11d-40e9-9b2b-9d504002d8a9",
"requisition_reference": "REF-J-CHXGIKT",
"status": "open"
},
{
"uuid": "e6d59ae7-a85e-48ea-b125-48056eb3f9b7",
"requisition_reference": "REF-J-D17H3WZ",
"status": "open"
},
{
"uuid": "8bb50732-74f5-42cb-b20c-52682c169937",
"requisition_reference": "REF-J-DNAZ2P5",
"status": "open"
},
{
"uuid": "58db8e73-3703-489a-a03b-6b860294adb5",
"requisition_reference": "REF-G-FF35Projects Associate AAQ",
"status": "open"
},
{
"uuid": "053da9eb-3be9-41f5-8bd7-791cbdeb1a69",
"requisition_reference": "REF-G-QYVWUEX",
"status": "open"
},
{
"uuid": "186c26b3-3ff3-43f6-9f30-dcaf978ede63",
"requisition_reference": "REF-J-ODJTIJE",
"status": "open"
},
{
"uuid": "4d68cbc1-0bf3-423e-9bc6-ad6f6e11651d",
"requisition_reference": "REF-G-I7CHVQJ",
"status": "open"
},
{
"uuid": "fb363151-0b65-47ec-a650-4891f386a320",
"requisition_reference": "REF-G-LS0FEP5",
"status": "open"
},
{
"uuid": "cb6c1cf9-afb9-4ec6-a1af-cd500a922d55",
"requisition_reference": "REF-G-G5ZZSY8",
"status": "open"
},
{
"uuid": "0b9f0952-f0b7-4a22-b29c-810c319d83a4",
"requisition_reference": "REF-1W-LAS46EA",
"status": "open"
},
{
"uuid": "59238feb-21e0-4106-ba84-4b508357f784",
"requisition_reference": "REF-1W-OH93UTG",
"status": "open"
},
{
"uuid": "4d18b1b7-ed03-4ae1-9c81-68e5bb0b6500",
"requisition_reference": "REF-1W-OIKG3X9",
"status": "open"
},
{
"uuid": "a83b7398-f504-4801-80f7-fcad0d8f83ef",
"requisition_reference": "REF-1W-OJQYH6R",
"status": "open"
},
{
"uuid": "7c69f88f-855f-415a-a7f7-a3060e23434e",
"requisition_reference": "REF-1W-OKJQ09S",
"status": "open"
},
{
"uuid": "1d38e12e-a556-42fa-8bed-32a9e3f82d98",
"requisition_reference": "REF-1W-OLF3KCV",
"status": "open"
},
{
"uuid": "3dfbb4f8-9602-4bb5-bfff-c98399d8b5e4",
"requisition_reference": "REF-1W-OMCO0Y7",
"status": "open"
},
{
"uuid": "59af4075-9fbc-499f-b544-a0e28fb329ec",
"requisition_reference": "REF-1W-ONGIKSQ",
"status": "open"
},
{
"uuid": "b00c4b63-0b46-401c-8fee-c2c333fa0d30",
"requisition_reference": "REF-1W-LF9A83P",
"status": "open"
},
{
"uuid": "6936850c-507a-4bf1-a1da-6da2bdb9e1b9",
"requisition_reference": "SELECTHR-VACANCY-134",
"status": "open"
},
{
"uuid": "a0e6d274-3bfc-44bd-a778-9cf421cfa097",
"requisition_reference": "SELECTHR-VACANCY-136",
"status": "open"
},
{
"uuid": "98562f53-e6d2-4457-bd3c-1df12bf3c624",
"requisition_reference": "SELECTHR-VACANCY-137",
"status": "open"
},
{
"uuid": "2869ab5a-abfc-4b75-bfec-15f865a301c0",
"requisition_reference": "SELECTHR-VACANCY-138",
"status": "open"
},
{
"uuid": "bd7ba348-3346-42b5-8aab-b353d683fdd5",
"requisition_reference": "SELECTHR-VACANCY-139",
"status": "open"
},
{
"uuid": "829526fb-3b4f-4a1a-ac6a-2d84127e2810",
"requisition_reference": "SELECTHR-VACANCY-140",
"status": "open"
},
{
"uuid": "ed3f5e59-a3cf-4334-96a6-cb9da96e8e5b",
"requisition_reference": "SELECTHR-VACANCY-142",
"status": "open"
},
{
"uuid": "23c03135-4b10-4604-b93f-27e7cc750100",
"requisition_reference": "SELECTHR-VACANCY-143",
"status": "open"
},
{
"uuid": "dab1143a-df4d-4f3a-b6a7-0b61317b2441",
"requisition_reference": "SELECTHR-VACANCY-149",
"status": "open"
},
{
"uuid": "df79c5d6-3b3e-4cbc-8778-1297503d055b",
"requisition_reference": "SELECTHR-VACANCY-151",
"status": "open"
},
{
"uuid": "ae6bbb57-01fc-48f7-95be-157834662924",
"requisition_reference": "SELECTHR-VACANCY-152",
"status": "open"
},
{
"uuid": "bf60242c-dca4-47ee-9265-50b21c3c9056",
"requisition_reference": "SELECTHR-VACANCY-153",
"status": "open"
},
{
"uuid": "0505ea03-1c2a-4981-aa2f-88d4ef0c2dd4",
"requisition_reference": "SELECTHR-VACANCY-154",
"status": "open"
},
{
"uuid": "cbc1a7da-ff4d-48e1-ae3f-e2b103593d79",
"requisition_reference": "SELECTHR-VACANCY-155",
"status": "open"
},
{
"uuid": "80756b9b-3205-4e60-b605-d987f6f027c8",
"requisition_reference": "SELECTHR-VACANCY-157",
"status": "open"
},
{
"uuid": "95cbc740-4d5a-4503-928d-1d9f33337888",
"requisition_reference": "SELECTHR-VACANCY-158",
"status": "open"
},
{
"uuid": "62e2d0e9-4a93-4cba-b3cb-fc8c0bde7759",
"requisition_reference": "SELECTHR-VACANCY-159",
"status": "open"
},
{
"uuid": "f64b2921-4123-4011-88d5-db45af709510",
"requisition_reference": "SELECTHR-VACANCY-160",
"status": "open"
},
{
"uuid": "2b0221f7-54d8-4bd3-8b81-cab5936c3177",
"requisition_reference": "SELECTHR-VACANCY-161",
"status": "open"
},
{
"uuid": "9888fdf0-5f35-480b-99ae-268266279b61",
"requisition_reference": "SELECTHR-VACANCY-162",
"status": "open"
},
{
"uuid": "d7ba88b0-e165-438f-8e47-aef90ceff0bd",
"requisition_reference": "SELECTHR-VACANCY-181",
"status": "open"
},
{
"uuid": "5d2db3f1-4ad5-4e35-b84c-1d6eb7696cff",
"requisition_reference": "SELECTHR-VACANCY-182",
"status": "open"
},
{
"uuid": "d7ea265b-b9db-4679-8e85-bcc6914a1035",
"requisition_reference": "SELECTHR-VACANCY-184",
"status": "open"
},
{
"uuid": "1dd4e6f8-9360-44af-81f7-79f2188fffc0",
"requisition_reference": "SELECTHR-VACANCY-185",
"status": "open"
},
{
"uuid": "35c34840-09f9-4e4f-bfe4-04458f6200b4",
"requisition_reference": "SELECTHR-VACANCY-133",
"status": "open"
},
{
"uuid": "47412ce9-1794-46f1-a0a3-e0c0adc34017",
"requisition_reference": "SELECTHR-8507599C-AEE0-4BC1-AF4C-BB1ED8EDEA5F",
"status": "open"
},
{
"uuid": "151f543a-c159-484c-bda8-b500a49df392",
"requisition_reference": "SELECTHR-59D423B6-3998-4843-BDEF-C1CFF1FA4428",
"status": "open"
},
{
"uuid": "c4f8d1c7-46ae-4615-a8bf-918016c923f1",
"requisition_reference": "SELECTHR-0ED0C5B5-D87A-4934-8ADF-D48EFBD74B5C",
"status": "open"
},
{
"uuid": "5110895f-bf6a-4f55-93d2-671c25f64af6",
"requisition_reference": "SELECTHR-VACANCY-135",
"status": "open"
},
{
"uuid": "181ec9b6-8bfe-4de2-bc5a-876037862961",
"requisition_reference": "SELECTHR-336D94FD-912E-475F-80F5-7A58F6CFC161",
"status": "open"
},
{
"uuid": "d0073189-801d-4e31-a900-cd021f479292",
"requisition_reference": "SELECTHR-21CEB825-AB4C-4374-ADF5-00773210D938",
"status": "open"
},
{
"uuid": "056719f7-05f9-410a-84d3-18454e1994b5",
"requisition_reference": "SELECTHR-EFA7F851-4A01-49CE-8E08-66A8D8D183C7",
"status": "open"
},
{
"uuid": "756a60ae-5acf-48fb-b9c6-1ca975a31616",
"requisition_reference": "SELECTHR-VACANCY-201",
"status": "open"
}
]
}
| Property | Required | Details | Location |
|---|---|---|---|
uuid |
Must be a String |
URL |
GET /hr_api/v1/position_requisitions/:uuid
200
{
"position_requisition": {
"uuid": "7ea48f86-0c1a-43e2-875e-6666ffb1587b",
"requisition_reference": "REF-M-OXMP9Q8",
"description": "",
"status": "open",
"number_to_fill": 2,
"valid_from": "2012-03-01T00:00:00.000+00:00",
"valid_to": null,
"approval_status": null,
"submitted_for_approval_at": null,
"approval_completed_at": null,
"position_title": null,
"job_purpose": null,
"responsibilities": null,
"experience": null,
"budgeted": null,
"business_case": null,
"start_date": null,
"end_date": null,
"replacement_for": null,
"opening_owner_type": null,
"auto_fill": null,
"position_location": null,
"position_requisition_template": {
"uuid": "77eb60e3-19e1-4f37-a830-5b8e952f7a2a",
"name": "Test Linking 2",
"requisition_title": "Test Linking 2",
"description": "",
"number_to_fill": null,
"status": "active",
"requisition_form_options": {
"position_title": "Test Linking 2 Position",
"position_title_editable": "0",
"require_business_unit": "0",
"restrict_worksites_flag": "",
"use_budgeted": "0",
"use_business_case": "0",
"use_business_unit": "1",
"use_business_units": "0",
"use_contract_types": "0",
"use_end_date": "0",
"use_experience": "0",
"use_hours_of_work": "0",
"use_job_category_ones": "0",
"use_job_category_threes": "0",
"use_job_category_twos": "0",
"use_job_grades": "0",
"use_job_purpose": "0",
"use_min_max_salary": "0",
"use_organizational_sub_units": "0",
"use_organizational_units": "0",
"use_other_interval": "0",
"use_replacement_for": "0",
"use_responsibilities": "0",
"use_salary_currency": "0",
"use_salary_text": "0",
"use_shift_name": "0",
"use_start_date": "0",
"use_vms_job_levels": "0",
"opening_owner_type": "all",
"use_hiring_manager": "0",
"use_shift_title": "0",
"use_pay_type_hours": "0",
"auto_fill_type": "",
"use_shift_keywords": "0",
"use_remuneration_package_keywords": "0",
"use_worksites": "0"
},
"position_title": "dsafs",
"auto_fill_type": "",
"restricted_access": 0,
"system_flags": 0,
"configuration_scope": {
"uuid": "1a213dd2-4eaa-4e4b-a38d-05e6e21e5d28",
"name": "recruitment",
"category_status": "active"
},
"custom_fieldset_template": {
"custom_fieldset_templateable_type": "PositionRequisitionTemplate",
"available_field_options": [
"keyword_2"
],
"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": false,
"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_type": "PositionRequisitionKeywordTwo",
"keyword_id": null,
"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",
"keyword_id": null,
"uuid": "5358a382-d02e-4821-bbba-485370a63de0",
"category_code": "no",
"comments": "",
"sort": 20,
"category_status": "active",
"category_description": "No"
},
{
"keyword_type": "PositionRequisitionKeywordTwo",
"keyword_id": null,
"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",
"keyword_id": null,
"uuid": "5358a382-d02e-4821-bbba-485370a63de0",
"category_code": "no",
"comments": "",
"sort": 20,
"category_status": "active",
"category_description": "No"
},
{
"keyword_type": "PositionRequisitionKeywordTwo",
"keyword_id": null,
"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",
"keyword_id": null,
"uuid": "5358a382-d02e-4821-bbba-485370a63de0",
"category_code": "no",
"comments": "",
"sort": 20,
"category_status": "active",
"category_description": "No"
}
],
"keyword_threes": [],
"keyword_fours": [],
"keyword_fives": []
}
},
"configuration_scope": {
"uuid": "1a213dd2-4eaa-4e4b-a38d-05e6e21e5d28",
"name": "recruitment",
"category_status": "active"
},
"business_unit": {
"uuid": "f626cff0-daa6-4727-8a69-56daea620f92",
"category_code": "stores",
"comments": "",
"sort": null,
"vms_transfer_status": "complete",
"category_status": "active",
"transferred_to_vms_at": "2012-05-01T10:13:29.000+01:00",
"worksite_selection": "organizational_unit",
"category_description": "Stores"
}
}
}
| 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: |
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: |
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': '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: |
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 |
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"
}
}
| 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: |
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: |
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': '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: |
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 |
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> </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"
}
}
}
| Property | Required | Details | Location |
|---|---|---|---|
uuid |
Must be a String |
URL |
DELETE /hr_api/v1/position_requisitions/:uuid
{}
200
{
"message": "PositionRequisition 48bbe474-62bf-459b-8bb4-77d5866a87ff deleted"
}