Get all job requisitions

get

/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions

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 job requisitions using a unique ID
      Finder Variables
      • SearchId; integer; Finds job requisitions using a search ID and a primary key
    • findReqs Finds job requisitions using find requests
      Finder Variables
      • correctedKeyword; string; Corrected keyword; string; used for searching, based on the spell check result.
      • executeSpellCheckFlag; string; Indicates whether the keyword; string; must be spell checked. The default value is true.
      • facetsList; string; Finds job requisitions using find requests and facets list
      • hotJobFlag; string; Indicates whether the job requisition is considered a hot job.
      • jobFamilyId; string; Finds job requisitions using find requests and job family ID
      • keyword; string; Finds job requisitions using find requests and keyword; string;
      • lastSelectedFacet; string; Finds job requisitions using find requests and the last selected facet
      • latitude; number; Finds recruiting job requisitions using find requests and latitude; number;
      • limit; integer; Finds job requisitions using find requests and limit; integer;
      • location; string; Finds job requisitions using find requests and location; string;
      • locationId; string; Finds job requisitions using find requests and location; string; ID
      • longitude; number; Finds recruiting job requisitions using find requests and longitude; number;
      • offset; integer; Finds job requisitions using find requests and offset; integer;
      • organizationId; string; Organization ID to find job requisitions.
      • postingEndDate; string; Finds job requisitions using find requests and the end date of the job posting
      • postingStartDate; string; Finds job requisitions using find requests and the start date of the job posting
      • radius; integer; Finds job requisitions using find requests and radius; integer;
      • radiusUnit; string; Finds job requisitions using find requests and the unit of the radius; integer;
      • selectedCategoriesFacet; string; Finds job requisitions using find requests and the selected category facet
      • selectedFlexFieldsFacets; string; Finds job requisitions using selected flexfields facets
      • selectedLocationsFacet; string; Finds job requisitions using find requests and location; string; facet
      • selectedOrganizationsFacet; string; Selected organization facets to find job requisitions.
      • selectedPostingDatesFacet; string; Finds job requisitions using find requests and the selected facet of the date of job posting
      • selectedTitlesFacet; string; Finds job requisitions using find requests and title facet
      • selectedWorkLocationsFacet; string; Requisition location; string; ID and unique ID used to find work locations in a job requisition details preview.
      • selectedWorkplaceTypesFacet; string; Facet of the selected workplace type.
      • siteNumber; string; Finds recruiting job requisitions using find requests and the site number
      • sortBy; string; Finds job requisitions using find requests and sort by
      • useExactKeywordFlag; string; Indicates whether the exact keyword; string; is used for searching or if the keyword; string; is automatically spell checked and corrected. The default value is false.
      • userTargetFacetInputTerm; string; Term used to find facet values for the selected facet.
      • userTargetFacetName; string; Name of the facet to find facet values.
      • workLocationCountryCode; string; Finds job requisitions using country code of the work location; string;
      • workLocationZipCode; string; Finds job requisitions using the ZIP code of the work location; string;
      • workplaceType; string; Workplace type of the job requisition.
    • findReqsByQRShortCode Finds job requisitions by QR short code.
      Finder Variables
      • limit; integer; The maximum number of job requisitions displayed per page.
      • offset; integer; The offset; integer; value to get job requisitions from the result set.
      • qrShortCode; string; The short code associated with the QR code.
      • siteNumber; string; The site number associated with the short code URL.
    • findSimilarRequisitions Finds similar jobs
      Finder Variables
      • candidateNumber; string; Finds similar jobs using candidate ID
      • limit; integer; Finds job requisitions using find requests and limit; integer;
      • offset; integer; Finds job requisitions using find requests and offset; integer;
      • requisitionId; integer; Finds similar jobs using job ID
      • siteNumber; string; Finds similar jobs using site number
    • findSimilarRequisitionsByCandidate Finds jobs by candidate.
      Finder Variables
      • candidateNumber; string; Finds similar jobs using candidate ID
      • limit; integer; Finds job requisitions using find requests and limit; integer;
      • offset; integer; Finds job requisitions using find requests and offset; integer;
      • requisitionId; integer; Finds similar jobs using job ID
      • siteNumber; string; Finds similar jobs using site number
  • 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:
    • BotQRShortCode; string; The QR short code for the filtered job requisitions that are displayed.
    • CandidateNumber; string; ID assigned to each candidate
    • CorrectedKeyword; string; Corrected keyword used for searching, based on the spell check result.
    • ExecuteSpellCheckFlag; boolean; Indicates whether a spell check was requested for the keyword.
    • Facets; string; Facets of the job requisitions.
    • HotJobFlag; boolean; Indicates whether the job requisition is considered a hot job in a job requisition details preview.
    • JobFamilyId; string; ID assigned to the job family.
    • Keyword; string; Keyword used to search for job requisitions.
    • LastSelectedFacet; string; Last selected facet for retrieving job requisitions.
    • Latitude; number; Latitude of the location of job requisition.
    • Limit; integer; Limit of the job requisition.
    • Location; string; Location of the job requisition
    • LocationId; string; ID assigned to the location of the job requisition.
    • Longitude; number; Longitude of the location of the job requisition
    • Offset; integer; Offset of the job requisition
    • OrganizationId; string; Organization ID for a job requisition.
    • PostingEndDate; string; End date of the job posting.
    • PostingStartDate; string; Start date of the job posting.
    • Radius; integer; Radius of the job requisition.
    • RadiusUnit; string; Unit of the radius of the job requisition.
    • RequisitionId; integer; ID assigned to the similar job
    • SearchId; integer; Location ID of the secondary locations in a job requisition details preview.
    • SelectedCategoriesFacet; string; Facet of the selected categories of the job requisitions.
    • SelectedFlexFieldsFacets; string; Facets of the selected job requisitions flexfields.
    • SelectedLocationsFacet; string; Facet of the selected locations of the job requisitions.
    • SelectedOrganizationsFacet; string; Facet of the selected organizations of the job requisitions.
    • SelectedPostingDatesFacet; string; Facet of the selected dates of job posting.
    • SelectedTitlesFacet; string; Facet of the selected title of job requisitions.
    • SelectedWorkLocationsFacet; string; Facet of the selected work locations.
    • SelectedWorkplaceTypesFacet; string; Facet of the selected workplace type.
    • SiteNumber; string; Site number of the job requisition.
    • SortBy; string; Sort by attribute for the job requisition.
    • SuggestedKeyword; string; Suggested keyword based on spell check result.
    • TotalJobsCount; integer; Total job count for the job requisition.
    • UseExactKeywordFlag; boolean; Indicates whether the exact keyword is used for searching or if the keyword is automatically spell checked and corrected.
    • UserTargetFacetInputTerm; string; Term used to filter facet values.
    • UserTargetFacetName; string; Name of the facet for which the value list must be filtered by the input term.
    • WorkLocationCountryCode; string; Country code of the work location.
    • WorkLocationZipCode; string; ZIP code of the work location.
    • WorkplaceType; string; Workplace type of the job requisition.
  • 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 : recruitingCEJobRequisitions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : recruitingCEJobRequisitions-item-response
Type: object
Show Source
Nested Schema : Categories Facet
Type: array
Title: Categories Facet
The categoriesFacet resource is a child of recruitingCEJobRequisitions. It includes the details of the categories facets. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Flexfields Facet
Type: array
Title: Flexfields Facet
The flexFieldsFacet resource is a child of recruitingCEJobRequisitions. It includes the details of the flexfields facets which are based on the custom flexfields configured by the users. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Locations Facet
Type: array
Title: Locations Facet
The locationsFacet resource is a child of recruitingCEJobRequisitions. It includes the details of the locationsFacet. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Organizations Facet
Type: array
Title: Organizations Facet
The organizationsFacet resource is a child of the recruitingCEJobRequisitions and provides details about of the organizations facets. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Posting Dates Facet
Type: array
Title: Posting Dates Facet
The postingDatesFacet resource is a child of recruitingCEJobRequisitions. It includes the details of the posting dates facet. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Requisition List
Type: array
Title: Requisition List
The requisitionList resource is a child of the recruitingCEJobRequisitions. It includes the details of the requisition lists. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Requisition Locations Coordinates
Type: array
Title: Requisition Locations Coordinates
The requisitionLocationsCoordinates resource is a child of the recruitingCEJobRequisitions resource and provides details about the coordinates of the requisition's locations. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Titles Facet
Type: array
Title: Titles Facet
The titlesFacet resource is a child of the recruitingCEJobRequisitions resource. It includes the details of the titles facet. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Work Locations Facet
Type: array
Title: Work Locations Facet
The workLocationsFacet resource is a child of the recruitingCEJobRequisitions resource. It includes the details of the all the work locations facet. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Workplace Type Facet
Type: array
Title: Workplace Type Facet
The workplaceTypesFacet resource is a child of the recruitingCEJobRequisitions resource. It includes the details of the workplace type facet. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCEJobRequisitions-categoriesFacet-item-response
Type: object
Show Source
Nested Schema : recruitingCEJobRequisitions-flexFieldsFacet-item-response
Type: object
Show Source
  • Maximum Length: 255
    Label assigned to the flexfields facet.
  • Links
  • Name assigned to the flexfields facet.
  • Flexfield Facet Values
    Title: Flexfield Facet Values
    The values resource is a child of recruitingCEJobRequisitions. It includes the details of the flexfields facets values. Note that the service endpoints in this resource category are only for Oracle internal use.
Nested Schema : Flexfield Facet Values
Type: array
Title: Flexfield Facet Values
The values resource is a child of recruitingCEJobRequisitions. It includes the details of the flexfields facets values. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCEJobRequisitions-flexFieldsFacet-values-item-response
Type: object
Show Source
Nested Schema : recruitingCEJobRequisitions-locationsFacet-item-response
Type: object
Show Source
Nested Schema : recruitingCEJobRequisitions-organizationsFacet-item-response
Type: object
Show Source
Nested Schema : recruitingCEJobRequisitions-postingDatesFacet-item-response
Type: object
Show Source
Nested Schema : recruitingCEJobRequisitions-requisitionList-item-response
Type: object
Show Source
Nested Schema : Other Work Locations
Type: array
Title: Other Work Locations
The otherWorkLocations resource is a child of the recruitingCERequisitionTemplateDetailsPreviews resource and provides details about other work locations used in the job requisition. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Primary Location Coordinates
Type: array
Title: Primary Location Coordinates
The primaryLocationCoordinates resource is a child of recruitingCEJobRequisitionDetails. It includes details of primary location coordinates. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Descriptive Flexfields
Type: array
Title: Descriptive Flexfields
The requisitionFlexFields resource is a child of recruitingCERequisitionTemplateDetailsPreviews. It includes the details of the requisition flexfields. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Secondary Locations
Type: array
Title: Secondary Locations
The secondaryLocations resource is a child of the recruitingCERequisitionTemplateDetailsPreviews resource and provides details about the secondary locations used in the job requisition. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Work Locations
Type: array
Title: Work Locations
The workLocation resource is a child of the recruitingCERequisitionTemplateDetailsPreviews resource and provides details about work locations used in the job requisition. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCEJobRequisitions-requisitionList-otherWorkLocations-item-response
Type: object
Show Source
  • Title: Address Line 1
    Read Only: true
    Maximum Length: 240
    Address line 1 for other work locations in a job requisition details preview.
  • Title: Address Line 2
    Read Only: true
    Maximum Length: 240
    Address line 2 for other work locations in a job requisition details preview.
  • Title: Address Line 3
    Read Only: true
    Maximum Length: 240
    Address line 3 for other work locations in a job requisition details preview.
  • Title: Address Line 4
    Read Only: true
    Maximum Length: 240
    Address line 4 for other work locations in a job requisition details preview.
  • Title: Building
    Read Only: true
    Maximum Length: 240
    Building of other work locations in a job requisition details preview.
  • Title: Country
    Read Only: true
    Maximum Length: 60
    Country of other work locations in a job requisition details preview.
  • Latitude of other work locations in a job requisition details preview.
  • Links
  • Title: Other Work Locations
    Location ID of other work locations in a job requisition details preview.
  • Title: Display Name
    Read Only: true
    Maximum Length: 240
    Location name of other work locations in a job requisition details preview.
  • Longitude of other work locations in a job requisition details preview.
  • Title: Postal Code
    Read Only: true
    Maximum Length: 30
    Postal code of other work locations in a job requisition details preview.
  • Title: Region 1
    Read Only: true
    Maximum Length: 120
    Region 1 of other work locations in a job requisition details preview.
  • Title: Region 2
    Read Only: true
    Maximum Length: 120
    Region 2 of other work locations in a job requisition details preview.
  • Title: Region 3
    Read Only: true
    Maximum Length: 120
    Region 3 of other work locations in a job requisition details preview.
  • Location ID of the secondary locations in a job requisition details preview.
  • Title: Town or City
    Read Only: true
    Maximum Length: 30
    Town or city of other work locations in a job requisition details preview.
Nested Schema : recruitingCEJobRequisitions-requisitionList-primaryLocationCoordinates-item-response
Type: object
Show Source
Nested Schema : recruitingCEJobRequisitions-requisitionList-requisitionFlexFields-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 80
    Context code of the requisition flexfield of the requisition details.
  • Links
  • Read Only: true
    Maximum Length: 80
    Prompt of the requisition flexfield of the requisition details.
  • Read Only: true
    Maximum Length: 30
    Segment code of the requisition flexfield of the requisition details.
  • Read Only: true
    Maximum Length: 4000
    Value of the requisition flexfield of the requisition details.
Nested Schema : recruitingCEJobRequisitions-requisitionList-secondaryLocations-item-response
Type: object
Show Source
Nested Schema : recruitingCEJobRequisitions-requisitionList-workLocation-item-response
Type: object
Show Source
  • Title: Address Line 1
    Read Only: true
    Maximum Length: 240
    Address line 1 of work locations in a job requisition details preview.
  • Title: Address Line 2
    Read Only: true
    Maximum Length: 240
    Address line 2 of work locations in a job requisition details preview.
  • Title: Address Line 3
    Read Only: true
    Maximum Length: 240
    Address line 3 of work locations in a job requisition details preview.
  • Title: Address Line 4
    Read Only: true
    Maximum Length: 240
    Address line 4 of work locations in a job requisition details preview.
  • Title: Building
    Read Only: true
    Maximum Length: 240
    Building of work locations in a job requisition details preview.
  • Title: Country
    Read Only: true
    Maximum Length: 60
    Country of work locations in a job requisition details preview.
  • Latitude of work locations in a job requisition details preview.
  • Links
  • Read Only: true
    Location ID of work locations in a job requisition details preview.
  • Title: Display Name
    Read Only: true
    Maximum Length: 240
    Location name of work locations in a job requisition details preview.
  • Longitude of work locations in a job requisition details preview.
  • Title: Postal Code
    Read Only: true
    Maximum Length: 30
    Postal code of work locations in a job requisition details preview.
  • Title: Region 1
    Read Only: true
    Maximum Length: 120
    Region 1 of work locations in a job requisition details preview.
  • Title: Region 2
    Read Only: true
    Maximum Length: 120
    Region 2 of work locations in a job requisition details preview.
  • Title: Region 3
    Read Only: true
    Maximum Length: 120
    Region 3 of work locations in a job requisition details preview.
  • Title: Town or City
    Read Only: true
    Maximum Length: 30
    Town or city of work locations in a job requisition details preview.
Nested Schema : recruitingCEJobRequisitions-requisitionLocationsCoordinates-item-response
Type: object
Show Source
  • Links
  • Location Coordinates
    Title: Location Coordinates
    The locationsCoordinates resource is a child of the recruitingCEJobRequisitions resource and provides details about locations coordinates. Note that the service endpoints in this resource category are only for Oracle internal use.
  • Read Only: true
    Maximum Length: 255
    Requisition number of the requisition locations coordinates.
  • Read Only: true
    Maximum Length: 255
    Requisition title of the requisition locations coordinates.
Nested Schema : Location Coordinates
Type: array
Title: Location Coordinates
The locationsCoordinates resource is a child of the recruitingCEJobRequisitions resource and provides details about locations coordinates. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCEJobRequisitions-requisitionLocationsCoordinates-locationCoordinates-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 255
    Address line 1 of the requisition locations coordinates.
  • Read Only: true
    Maximum Length: 255
    Building of the requisition locations coordinates.
  • Read Only: true
    Maximum Length: 255
    Country of the requisition locations coordinates.
  • Read Only: true
    Maximum Length: 255
    Latitude of the requisition locations coordinates.
  • Links
  • Read Only: true
    Location ID of the requisition locations coordinates.
  • Read Only: true
    Maximum Length: 255
    Location type of the requisition locations coordinates.
  • Read Only: true
    Maximum Length: 255
    Longitude of the requisition locations coordinates.
  • Read Only: true
    Maximum Length: 255
    Name of the requisition locations coordinates.
  • Read Only: true
    Maximum Length: 255
    Postal code of the requisition locations coordinates.
  • Read Only: true
    Maximum Length: 255
    Region 1 of the requisition locations coordinates.
  • Read Only: true
    Maximum Length: 255
    Region 2 of the requisition locations coordinates.
  • Read Only: true
    Maximum Length: 255
    Region 3 of the requisition locations coordinates.
  • Read Only: true
    Maximum Length: 255
    Town or city of the requisition locations coordinates.
Nested Schema : recruitingCEJobRequisitions-titlesFacet-item-response
Type: object
Show Source
Nested Schema : recruitingCEJobRequisitions-workLocationsFacet-item-response
Type: object
Show Source
Nested Schema : recruitingCEJobRequisitions-workplaceTypesFacet-item-response
Type: object
Show Source
Back to Top