Get all job requisitions
get
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionsCoordinates
Request
Query Parameters
-
expand: string
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).
-
fields: string
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 -
finder: string
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
- PrimaryKey Finds job requisitions using a unique ID
-
limit: integer
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.
-
links: string
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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.
-
totalResults: boolean
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
-
Metadata-Context:
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".
-
REST-Framework-Version:
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : recruitingCEJobRequisitionsCoordinates
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCEJobRequisitionsCoordinates-item-response
Type:
Show Source
object
-
BotQRShortCode: string
Read Only:
true
Maximum Length:255
The QR short code for the filtered job requisitions that are displayed. -
CandidateNumber: string
Maximum Length:
255
ID assigned to each candidate -
CorrectedKeyword: string
Read Only:
true
Maximum Length:255
Corrected keyword used for searching, based on the spell check result. -
ExecuteSpellCheckFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether a spell check was requested for the keyword. -
Facets: string
Facets of the job requisitions.
-
HotJobFlag: boolean
Read Only:
true
Maximum Length:255
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
Maximum Length:
255
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.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
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
Maximum Length:
255
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
-
requisitionLocationsCoordinates: array
Requisition Locations Coordinates
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. -
SearchId: integer
Default Value:
1
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
Maximum Length:
255
Facet of the selected organizations of the job requisitions. -
SelectedPostingDatesFacet: string
Facet of the selected dates of job posting.
-
SelectedTitlesFacet: string
Maximum Length:
255
Facet of the selected title of job requisitions. -
SelectedWorkLocationsFacet: string
Facet of the selected work locations.
-
SelectedWorkplaceTypesFacet: string
Maximum Length:
255
Facet of the selected workplace type. -
SiteNumber: string
Site number of the job requisition.
-
SortBy: string
Maximum Length:
255
Sort by attribute for the job requisition. -
SuggestedKeyword: string
Read Only:
true
Maximum Length:255
Suggested keyword based on spell check result. -
TotalJobsCount: integer
Total job count for the job requisition.
-
UseExactKeywordFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether the exact keyword is used for searching or if the keyword is automatically spell checked and corrected. -
UserTargetFacetInputTerm: string
Read Only:
true
Maximum Length:255
Term used to filter facet values. -
UserTargetFacetName: string
Read Only:
true
Maximum Length:255
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
Maximum Length:
255
Workplace type of the job requisition.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : recruitingCEJobRequisitionsCoordinates-requisitionLocationsCoordinates-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
locationCoordinates: array
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. -
RequisitionNumber: string
Read Only:
true
Maximum Length:255
Requisition number of the requisition locations coordinates. -
RequisitionTitle: string
Read Only:
true
Maximum Length:255
Requisition title of the requisition locations coordinates.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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 : recruitingCEJobRequisitionsCoordinates-requisitionLocationsCoordinates-locationCoordinates-item-response
Type:
Show Source
object
-
AddressLine1: string
Read Only:
true
Maximum Length:255
Address line 1 of the requisition locations coordinates. -
Building: string
Read Only:
true
Maximum Length:255
Building of the requisition locations coordinates. -
Country: string
Read Only:
true
Maximum Length:255
Country of the requisition locations coordinates. -
Latitude: string
Read Only:
true
Maximum Length:255
Latitude of the requisition locations coordinates. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
Read Only:
true
Location ID of the requisition locations coordinates. -
LocationType: string
Read Only:
true
Maximum Length:255
Location type of the requisition locations coordinates. -
Longitude: string
Read Only:
true
Maximum Length:255
Longitude of the requisition locations coordinates. -
Name: string
Read Only:
true
Maximum Length:255
Name of the requisition locations coordinates. -
PostalCode: string
Read Only:
true
Maximum Length:255
Postal code of the requisition locations coordinates. -
Region1: string
Read Only:
true
Maximum Length:255
Region 1 of the requisition locations coordinates. -
Region2: string
Read Only:
true
Maximum Length:255
Region 2 of the requisition locations coordinates. -
Region3: string
Read Only:
true
Maximum Length:255
Region 3 of the requisition locations coordinates. -
TownOrCity: string
Read Only:
true
Maximum Length:255
Town or city of the requisition locations coordinates.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- getRequisitionDetailsForMap
-
Provides requisition and location details for the given Requisition IDs based on the work location display setting configured for the candidate experience site.
- getRequisitionsLocationCoordinates
-
Provides the location coordinates for the requisitions to plot on Oracle Maps.