Get all recruiting job requisitions

get

/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds recruiting job requisitions using a unique ID
      Finder Variables
      • RequisitionId; integer; Finds recruiting job requisitions using findByRequisitionNumber and RequisitionNumber; string;
    • findByRequisitionNumber Finds recruiting job requisitions using findByRequisitionNumber
      Finder Variables
      • RequisitionNumber; string; Finds recruiting job requisitions using findByRequisitionNumber and RequisitionNumber; string;
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ApplyWhenNotPosted; string; Apply When Not Posted in recruiting job requisitions.
    • AutomaticallyOpenRequisitionForSourcing; string; Determines if a job requisition is opened automatically for sourcing and if the job is posted internally and externally.
    • BusinessUnitId; integer; Business unit ID in recruiting job requisitions.
    • CandidateSelectionProcessId; integer; Candidate Selection Process ID in recruiting job requisitions.
    • DelayBeforePostingExpires; integer; Determines the number of days of delay before the job posting expires. The value can't be higher than 0 if the job requisition isn't configured to be posted automatically.
    • DepartmentId; integer; Department ID in recruiting job requisitions.
    • ExternalApplicationFlowId; integer; External Application Flow ID in recruiting job requisitions.
    • ExternalQualStr; string; String representation of qualifications for external candidates in recruiting job requisitions.
    • ExternalRespStr; string; String representation of responsibilities for external candidates in recruiting job requisitions.
    • GradeId; integer; Grade ID in recruiting job requisitions.
    • HiredCount; integer; Hired Count in recruiting job requisitions.
    • HiringManagerId; integer; Hiring Manager ID in recruiting job requisitions.
    • InternalQualStr; string; String representation of qualifications for internal candidates in recruiting job requisitions.
    • InternalRespStr; string; String representation of responsibilities for internal candidates in recruiting job requisitions.
    • JobFamilyId; integer; Job Family ID in recruiting job requisitions.
    • JobFunction; string; Job Function in recruiting job requisitions.
    • JobId; integer; Job ID in recruiting job requisitions.
    • LegalEmployerId; integer; Legal Employer ID in recruiting job requisitions.
    • OrganizationId; integer; Organization ID in recruiting job requisitions.
    • PhaseId; integer; Phase ID in recruiting job requisitions.
    • PhaseName; string; Phase Name in recruiting job requisitions.
    • PipelineRequisition; string; Pipeline Requisition in recruiting job requisitions.
    • PipelineRequisitionId; integer; Pipeline Requisition ID in recruiting job requisitions.
    • PositionId; integer; Position ID in recruiting job requisitions.
    • PrimaryLocationId; integer; Primary Location ID in recruiting job requisitions.
    • PrimaryWorkLocationId; integer; Primary Work Location ID in recruiting job requisitions.
    • RecruiterId; integer; Recruiter ID in recruiting job requisitions.
    • RecruitingType; string; Recruiting Type in recruiting job requisitions.
    • RequisitionId; integer; Requisition ID in recruiting job requisitions.
    • RequisitionLastModifiedDate; string; Requisition Last Modified Date in recruiting job requisitions.
    • RequisitionNumber; string; Requisition Number in recruiting job requisitions.
    • StateId; integer; State ID in recruiting job requisitions.
    • StateName; string; State Name in recruiting job requisitions.
    • TemplateId; integer; Template ID in recruiting job requisitions.
    • Title; string; Title in recruiting job requisitions.
    • WorkplaceTypeCode; string; Workplace type in recruiting job requisitions.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : recruitingJobRequisitions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : recruitingJobRequisitions-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Collaborators in Recruiting Job Requisitions
Type: array
Title: Collaborators in Recruiting Job Requisitions
The collaborators resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions collaborators.
Show Source
Nested Schema : Languages in Recruiting Job Requisitions
Type: array
Title: Languages in Recruiting Job Requisitions
The languages resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions languages.
Show Source
Nested Schema : Other Locations in Recruiting Job Requisitions
Type: array
Title: Other Locations in Recruiting Job Requisitions
The otherLocations resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions for other locations.
Show Source
Nested Schema : Other Work Locations in Recruiting Job Requisitions
Type: array
Title: Other Work Locations in Recruiting Job Requisitions
The otherWorkLocations resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions in other work locations.
Show Source
Nested Schema : Published Jobs in Recruiting Job Requisitions
Type: array
Title: Published Jobs in Recruiting Job Requisitions
The publishedJobs resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions published jobs.
Show Source
Nested Schema : requisitionDFF
Type: array
Show Source
Nested Schema : Skills in Recruiting Job Requisitions
Type: array
Title: Skills in Recruiting Job Requisitions
The skills resource is the child of the recruitingjobRequisitions resource and provides all the skills of the job requisition.
Show Source
Nested Schema : recruitingJobRequisitions-attachments-item-response
Type: object
Show Source
Nested Schema : recruitingJobRequisitions-collaborators-item-response
Type: object
Show Source
Nested Schema : recruitingJobRequisitions-languages-item-response
Type: object
Show Source
Nested Schema : recruitingJobRequisitions-otherLocations-item-response
Type: object
Show Source
Nested Schema : recruitingJobRequisitions-otherWorkLocations-item-response
Type: object
Show Source
Nested Schema : recruitingJobRequisitions-publishedJobs-item-response
Type: object
Show Source
Nested Schema : recruitingJobRequisitions-requisitionDFF-item-response
Type: object
Show Source
Nested Schema : recruitingJobRequisitions-skills-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to view all job requisitions by submitting a collection GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -X GET http://host:port/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions

Example of Response Header

The following is an example of the response header.

HTTP/1.1 200 OK                                                      
Content-Type : application/vnd.oracle.adf.resourceitem+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "items": [
    {
      "RequisitionNumber": "BIREQ002",
      "RequisitionId": 300100114115462,
      "Title": "BIREQ002",
      "OtherRequisitionTitle": null,
      "RecruitingType": "ORA_CONTINGENT",
      "TemplateId": null,
      "PipelineRequisition": "N",
      "PipelineRequisitionId": null,
      "StateId": 31,
      "StateName": "Expired",
      "PhaseId": 5,
      "PhaseName": "Open",
      "PositionId": null,
      "UnlimitedOpenings": "N",
      "NumberOfOpenings": 12,
      "HiredCount": 1,
      "ApplyWhenNotPosted": "N",
      "BusinessJustification": "ORA_NEW_POSITION",
      "DisplayInOrgChart": "Y",
      "HiringManagerId": 100000008153756,
      "HiringManagerAssignmentId": 100000008154060,
      "RecruiterId": 100000008153756,
      "RecruiterAssignmentId": 100000008154060,
      "ProfileId": 300100114115463,
      "OrganizationId": 300100026725086,
      "JobFamilyId": 100000018146410,
      "JobFunction": "ADMIN",
      "BusinessUnitId": 202,
      "DepartmentId": 202,
      "PrimaryWorkLocationId": 300100104852789,
      "PrimaryLocationId": 100100069551156,
      "JobId": 300100007456899,
      "GradeId": 23,
      "LegalEmployerId": null,
      "BudgetCurrency": "USN",
      "EmployeeReferralBonus": 34555,
      "SourcingBudget": null,
      "TravelBudget": null,
      "RelocationBudget": null,
      "CompensationCurrency": "USD",
      "MinimumSalary": 34544,
      "MaximumSalary": 56755,
      "PayFrequency": "QUARTER",
      "WorkerType": "E",
      "RegularOrTemporary": "R",
      "ManagementLevel": "7",
      "FullTimeOrPartTime": "FULL_TIME",
      "JobShift": "ORA_EVENING",
      "JobType": "ORA_INTERNSHIP",
      "EducationLevel": "17",
      "InternalContactName": null,
      "InternalContactEmail": null,
      "ExternalContactName": null,
      "ExternalContactEmail": null,
      "EmployerInternalDescriptionId": 300100114081187,
      "EmployerExternalDescriptionId": 300100114081187,
      "RecruitingOrganizationInternalDescriptionId": 300100114081183,
      "RecruitingOrganizationExternalDescriptionId": 300100114081191,
      "InternalPublishedJobStartDate": "2017-07-24T20:12:57+00:00",
      "InternalPublishedJobEndDate": "2019-07-16T20:12:00+00:00",
      "InternalPublishedJobStatus": "ORA_EXPIRED",
      "ExternalPublishedJobStartDate": "2017-07-24T20:12:57+00:00",
      "ExternalPublishedJobEndDate": "2019-07-16T20:12:00+00:00",
      "ExternalPublishedJobStatus": "ORA_EXPIRED",
      "ExternalApplicationFlowId": 300100110482814,
      "CandidateSelectionProcessId": 300100113113259,
      "RequisitionLastModifiedDate": "2019-07-24T10:48:37.002+00:00",
      "CreatedBy": "TM-MFITZIMMONS",
      "CreationDate": "2017-07-24T20:02:30+00:00",
      "LastUpdatedBy": "ZFRCE001_Marian_ZBEN",
      "LastUpdateDate": "2019-07-24T10:48:36.304+00:00",
      "links": [...]
    },
    {
      "RequisitionNumber": "BIREQ003",
      "RequisitionId": 300100114115492,
      "Title": "BIREQ003",
      "OtherRequisitionTitle": null,
      "RecruitingType": "ORA_CAMPUS",
      "TemplateId": null,
      "PipelineRequisition": "N",
      "PipelineRequisitionId": null,
      "StateId": 21,
      "StateName": "In Progress",
      "PhaseId": 4,
      "PhaseName": "Posting",
      "PositionId": null,
      "UnlimitedOpenings": "Y",
      "NumberOfOpenings": null,
      "HiredCount": null,
      "ApplyWhenNotPosted": "N",
      "BusinessJustification": "ORA_NEW_POSITION",
      "DisplayInOrgChart": "Y",
      "HiringManagerId": 100000008153756,
      "HiringManagerAssignmentId": 100000008154060,
      "RecruiterId": 100000008153756,
      "RecruiterAssignmentId": 100000008154060,
      "ProfileId": 300100114115493,
      "OrganizationId": 300100026725086,
      "JobFamilyId": 100000018146410,
      "JobFunction": "ADMIN",
      "BusinessUnitId": 202,
      "DepartmentId": 202,
      "PrimaryWorkLocationId": 300100104852789,
      "PrimaryLocationId": 100100069551156,
      "JobId": 300100007456899,
      "GradeId": 23,
      "LegalEmployerId": null,
      "BudgetCurrency": "USN",
      "EmployeeReferralBonus": 34555,
      "SourcingBudget": null,
      "TravelBudget": null,
      "RelocationBudget": null,
      "CompensationCurrency": "USD",
      "MinimumSalary": 34544,
      "MaximumSalary": 56755,
      "PayFrequency": "QUARTER",
      "WorkerType": "E",
      "RegularOrTemporary": "R",
      "ManagementLevel": "7",
      "FullTimeOrPartTime": "FULL_TIME",
      "JobShift": "ORA_EVENING",
      "JobType": "ORA_INTERNSHIP",
      "EducationLevel": "17",
      "InternalContactName": null,
      "InternalContactEmail": null,
      "ExternalContactName": null,
      "ExternalContactEmail": null,
      "EmployerInternalDescriptionId": 300100114081187,
      "EmployerExternalDescriptionId": 300100114081187,
      "RecruitingOrganizationInternalDescriptionId": 300100114081183,
      "RecruitingOrganizationExternalDescriptionId": 300100114081191,
      "InternalPublishedJobStartDate": null,
      "InternalPublishedJobEndDate": null,
      "InternalPublishedJobStatus": null,
      "ExternalPublishedJobStartDate": null,
      "ExternalPublishedJobEndDate": null,
      "ExternalPublishedJobStatus": null,
      "ExternalApplicationFlowId": 300100110482814,
      "CandidateSelectionProcessId": 100,
      "RequisitionLastModifiedDate": null,
      "CreatedBy": "TM-MFITZIMMONS",
      "CreationDate": "2017-07-24T20:04:08+00:00",
      "LastUpdatedBy": "TM-MFITZIMMONS",
      "LastUpdateDate": "2017-07-24T20:10:56.740+00:00",
      "links": [...]
    },
    {...}
  ],
  "count": 25,
  "hasMore": true,
  "limit": 25,
  "offset": 0,
  "links": [...]
}
Back to Top