Position Requisition Templates

Supported Formats: json

GET /hr_api/v1/position_requisition_templates

Returns a list of active Position Requisition Templates

Params

Property Required Details Location

scope

Optionally override the default scope. Will be ignored if invalid.

Must be one of: active, all.

URL

page

Index returns 100 records per request. Defaults to 1.

Must be a Integer

URL

Examples

GET /hr_api/v1/position_requisition_templates
200
{
  "position_requisition_templates": [
    {
      "uuid": "c7a28a16-6a2a-4254-a577-600382fac3ac",
      "name": "0.9 Test PReq Template"
    },
    {
      "uuid": "803e57ca-fe19-4e17-a17c-a372f460c6d0",
      "name": "API Test"
    },
    {
      "uuid": "b6a3813c-1061-47ef-8705-451db997ded2",
      "name": "BootS3 Requisition"
    },
    {
      "uuid": "12139b87-951a-4400-8b9a-13fcc917702a",
      "name": "BS3 Requisition"
    },
    {
      "uuid": "1a608d50-86b2-4bcb-863f-88b95d4a3ba3",
      "name": "Ladbrokes HO"
    },
    {
      "uuid": "f9bdc470-2344-4419-aa64-ab59f1b7864f",
      "name": "Rails 4.0 test"
    },
    {
      "uuid": "8aa07709-6490-4c54-ba5b-b7b0a4d93a66",
      "name": "Recruiters and Approvers Only"
    },
    {
      "uuid": "d905d706-8788-4176-b0a5-5cff5c9d83f5",
      "name": "test feb 27"
    },
    {
      "uuid": "1839e241-e7ae-46a2-ab43-01dc29a230c5",
      "name": "Test Linking"
    },
    {
      "uuid": "77eb60e3-19e1-4f37-a830-5b8e952f7a2a",
      "name": "Test Linking 2"
    },
    {
      "uuid": "0ab9bdd1-f24a-4438-bae7-f94caf102a1f",
      "name": "Test Linking 3"
    },
    {
      "uuid": "a06a8f2f-3a38-4537-8111-dd8f5b8e33a2",
      "name": "Test Linking 4"
    }
  ]
}

GET /hr_api/v1/position_requisition_templates/:uuid

Return details of an existing Position Requisition Template

Params

Property Required Details Location

uuid

Must be a String

URL

Examples

GET /hr_api/v1/position_requisition_templates/:uuid
200
{
  "position_requisition_template": {
    "uuid": "1839e241-e7ae-46a2-ab43-01dc29a230c5",
    "name": "Test Linking",
    "requisition_title": "Test Linking",
    "description": "test",
    "number_to_fill": null,
    "status": "active",
    "requisition_form_options": {
      "require_business_unit": "1",
      "require_contract_types": "0",
      "require_job_category_ones": "0",
      "require_job_category_threes": "0",
      "require_job_category_twos": "0",
      "require_organizational_sub_units": "1",
      "require_organizational_units": "1",
      "require_vms_job_levels": "0",
      "restrict_worksites_flag": "restrict_worksites_in_template",
      "use_business_unit": "1",
      "use_contract_types": "1",
      "use_job_category_ones": "1",
      "use_job_category_threes": "1",
      "use_job_category_twos": "1",
      "use_organizational_sub_units": "0",
      "use_organizational_units": "0",
      "use_vms_job_levels": "1"
    },
    "position_title": null,
    "auto_fill_type": null,
    "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": [
        "text_1",
        "text_6",
        ""
      ],
      "text_1": "",
      "text_2": null,
      "text_3": null,
      "text_4": null,
      "text_5": null,
      "text_6": "",
      "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": false,
      "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": true,
      "text_6_required": true,
      "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": []
    }
  }
}