Get all requisition template details previews
get
/hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews
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- ById Finds the requisition template details previews using ById
Finder Variables- Id; string; Finds the requisition template details previews using ById and Id; string;
- siteNumber; string; Finds the requisition template details previews using ById and siteNumber; string;
- PrimaryKey Finds the requisition template details previews using a unique ID
Finder Variables- RequisitionId; integer; Finds the requisition template details previews using ById and Id; string;
- ById Finds the requisition template details previews using ById
-
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:- ApplyWhenNotPostedFlag; boolean; Indicates whether a candidate can apply to a job requisition that's not posted for the requisition template details previews.
- Category; string; Category of the requisition template details previews.
- ContractType; string; Contract type of the requisition template details previews.
- CorporateDescriptionStr; string; Corporate description string of the requisition template details previews.
- DomesticTravelRequired; string; Indicates that domestic travel is required.
- ExternalContactEmail; string; External contact email of the candidate for the requisition template details previews.
- ExternalContactName; string; External contact name of the candidate for the requisition template details previews.
- ExternalDescription; string; External description for the requisition template details previews.
- ExternalDescriptionStr; string; External description string for the requisition template details previews.
- ExternalPostedEndDate; string; External end date for the job post for the requisition template details previews.
- ExternalPostedStartDate; string; External start date for the job post for the requisition template details previews.
- ExternalQual; string; External qualifications for the requisition template details previews.
- ExternalQualStr; string; External qualifications string for the requisition template details previews.
- ExternalResp; string; External responsibilities for the requisition template details previews.
- ExternalRespStr; string; External responsibilities string for the requisition template details previews.
- Id; string; ID for the requisition template details previews.
- InternalQual; string; Internal qualifications for the requisition template details previews.
- InternalQualStr; string; Internal qualifications string for the requisition template details previews.
- InternalResp; string; Internal responsibilities for the requisition template details previews.
- InternalRespStr; string; Internal responsibilities string for the requisition template details previews.
- InternationalTravelRequired; string; Indicates that international travel is required.
- JobGrade; string; Grade of the job for the requisition template details previews.
- JobLevel; string; Level of the job for the requisition template details previews.
- JobSchedule; string; Schedule of the job for the requisition template details previews.
- JobShift; string; Shift of the job for the requisition template details previews.
- OrganizationDescriptionStr; string; Organization description string for the requisition template details previews.
- PrimaryLocation; string; Primary location for the requisition template details previews.
- RequisitionId; integer; Requisition ID in a job requisition details preview.
- RequisitionType; string; Requisition type for the requisition template details previews.
- ShortDescriptionStr; string; Short description string for the requisition template details previews.
- StudyLevel; string; Education level of the candidate.
- Title; string; Title for the requisition template details previews.
-
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 : recruitingCERequisitionTemplateDetailsPreviews
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 : recruitingCERequisitionTemplateDetailsPreviews-item-response
Type:
Show Source
object
-
ApplyWhenNotPostedFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether a candidate can apply to a job requisition that's not posted for the requisition template details previews. -
Category: string
Read Only:
true
Maximum Length:240
Category of the requisition template details previews. -
ContractType: string
Read Only:
true
Maximum Length:80
Contract type of the requisition template details previews. -
CorporateDescriptionStr: string
Read Only:
true
Corporate description string of the requisition template details previews. -
DomesticTravelRequired: string
Read Only:
true
Indicates that domestic travel is required. -
ExternalContactEmail: string
Read Only:
true
Maximum Length:240
External contact email of the candidate for the requisition template details previews. -
ExternalContactName: string
Read Only:
true
Maximum Length:240
External contact name of the candidate for the requisition template details previews. -
ExternalDescription: string
(byte)
Read Only:
true
External description for the requisition template details previews. -
ExternalDescriptionStr: string
Read Only:
true
External description string for the requisition template details previews. -
ExternalPostedEndDate: string
(date-time)
Title:
End Date
Read Only:true
External end date for the job post for the requisition template details previews. -
ExternalPostedStartDate: string
(date-time)
Title:
Start Date
Read Only:true
External start date for the job post for the requisition template details previews. -
ExternalQual: string
(byte)
Read Only:
true
External qualifications for the requisition template details previews. -
ExternalQualStr: string
Read Only:
true
External qualifications string for the requisition template details previews. -
ExternalResp: string
(byte)
Read Only:
true
External responsibilities for the requisition template details previews. -
ExternalRespStr: string
Read Only:
true
External responsibilities string for the requisition template details previews. -
Id: string
Read Only:
true
Maximum Length:240
ID for the requisition template details previews. -
InternalQual: string
(byte)
Read Only:
true
Internal qualifications for the requisition template details previews. -
InternalQualStr: string
Read Only:
true
Internal qualifications string for the requisition template details previews. -
InternalResp: string
(byte)
Read Only:
true
Internal responsibilities for the requisition template details previews. -
InternalRespStr: string
Read Only:
true
Internal responsibilities string for the requisition template details previews. -
InternationalTravelRequired: string
Read Only:
true
Indicates that international travel is required. -
JobGrade: string
Read Only:
true
Maximum Length:240
Grade of the job for the requisition template details previews. -
JobLevel: string
Read Only:
true
Maximum Length:80
Level of the job for the requisition template details previews. -
JobSchedule: string
Read Only:
true
Maximum Length:80
Schedule of the job for the requisition template details previews. -
JobShift: string
Read Only:
true
Maximum Length:80
Shift of the job for the requisition template details previews. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
media: array
Media
Title:
Media
The media resource is a child of the recruitingCERequisitionTemplateDetailsPreviews resource and provides details about the media used in the job requisition. Note that the service endpoints in this resource category are only for Oracle internal use. -
OrganizationDescriptionStr: string
Read Only:
true
Organization description string for the requisition template details previews. -
otherWorkLocations: array
Other Work Locations
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. -
PrimaryLocation: string
Read Only:
true
Maximum Length:255
Primary location for the requisition template details previews. -
requisitionFlexFields: array
Job Requisition Flexfields
Title:
Job Requisition Flexfields
The requisitionFlexFields resource is a child of the recruitingCEJobRequisitionDetails resource and provides details about the requisition flexfields. Note that the service endpoints in this resource category are only for Oracle internal use. -
RequisitionId: integer
(int64)
Read Only:
true
Requisition ID in a job requisition details preview. -
RequisitionType: string
Read Only:
true
Maximum Length:80
Requisition type for the requisition template details previews. -
secondaryLocations: array
Secondary Locations
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. -
ShortDescription: string
(byte)
Read Only:
true
Short description for the requisition template details previews. -
ShortDescriptionStr: string
Read Only:
true
Short description string for the requisition template details previews. -
StudyLevel: string
Read Only:
true
Maximum Length:80
Education level of the candidate. -
Title: string
Read Only:
true
Maximum Length:240
Title for the requisition template details previews. -
workLocation: array
Work Locations
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Media
Type:
array
Title:
Media
The media resource is a child of the recruitingCERequisitionTemplateDetailsPreviews resource and provides details about the media used in the job requisition. Note that the service endpoints in this resource category are only for Oracle internal use.
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 : Job Requisition Flexfields
Type:
array
Title:
Job Requisition Flexfields
The requisitionFlexFields resource is a child of the recruitingCEJobRequisitionDetails resource and provides details about 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 : 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 : recruitingCERequisitionTemplateDetailsPreviews-media-item-response
Type:
Show Source
object
-
Id: integer
(int64)
Read Only:
true
Media ID in a job requisition details preview. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Priority: integer
(int32)
Read Only:
true
Media priority in a job requisition details preview. -
ThumbURL: string
Read Only:
true
Maximum Length:1000
Media thumb URL in a job requisition details preview. -
Title: string
Read Only:
true
Maximum Length:240
Media title in a job requisition details preview. -
Type: string
Read Only:
true
Maximum Length:80
Media type in a job requisition details preview. -
URL: string
Read Only:
true
Maximum Length:1000
Media URL in a job requisition details preview.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCERequisitionTemplateDetailsPreviews-otherWorkLocations-item-response
Type:
Show Source
object
-
AddressLine1: string
Title:
Address Line 1
Read Only:true
Maximum Length:240
Address line 1 for other work locations in a job requisition details preview. -
AddressLine2: string
Title:
Address Line 2
Read Only:true
Maximum Length:240
Address line 2 for other work locations in a job requisition details preview. -
AddressLine3: string
Title:
Address Line 3
Read Only:true
Maximum Length:240
Address line 3 for other work locations in a job requisition details preview. -
AddressLine4: string
Title:
Address Line 4
Read Only:true
Maximum Length:240
Address line 4 for other work locations in a job requisition details preview. -
Building: string
Title:
Building
Read Only:true
Maximum Length:240
Building of other work locations in a job requisition details preview. -
Country: string
Title:
Country
Read Only:true
Maximum Length:60
Country of other work locations in a job requisition details preview. -
Latitude: integer
(int64)
Latitude of other work locations in a job requisition details preview.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
Title:
Other Work Locations
Location ID of other work locations in a job requisition details preview. -
LocationName: string
Title:
Display Name
Read Only:true
Maximum Length:240
Location name of other work locations in a job requisition details preview. -
Longitude: integer
(int64)
Longitude of other work locations in a job requisition details preview.
-
PostalCode: string
Title:
Postal Code
Read Only:true
Maximum Length:30
Postal code of other work locations in a job requisition details preview. -
Region1: string
Title:
Region 1
Read Only:true
Maximum Length:120
Region 1 of other work locations in a job requisition details preview. -
Region2: string
Title:
Region 2
Read Only:true
Maximum Length:120
Region 2 of other work locations in a job requisition details preview. -
Region3: string
Title:
Region 3
Read Only:true
Maximum Length:120
Region 3 of other work locations in a job requisition details preview. -
RequisitionWorkLocationId: integer
(int64)
Location ID of the secondary locations in a job requisition details preview.
-
TownOrCity: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCERequisitionTemplateDetailsPreviews-requisitionFlexFields-item-response
Type:
Show Source
object
-
ControlType: string
Control type of flexfields in a job requisition details preview.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Prompt: string
Prompt of flexfields in a job requisition details preview.
-
SequenceNumber: string
Sequence number of flexfields in a job requisition details preview.
-
Value: string
Value of flexfields in a job requisition details preview.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCERequisitionTemplateDetailsPreviews-secondaryLocations-item-response
Type:
Show Source
object
-
CountryCode: string
Read Only:
true
Maximum Length:2
Country code for the secondary locations in a job requisition details preview. -
GeographyId: integer
(int64)
Read Only:
true
Geography ID for the secondary locations in a job requisition details preview. -
GeographyNodeId: integer
(int64)
Title:
Primary Location
Read Only:true
Geography node ID for the secondary locations in a job requisition details preview. -
Latitude: integer
(int64)
Read Only:
true
Latitude of the secondary locations in a job requisition details preview. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Longitude: integer
(int64)
Read Only:
true
Longitude of the secondary locations in a job requisition details preview. -
Name: string
Maximum Length:
255
Location ID of the secondary locations in a job requisition details preview. -
RequisitionLocationId: integer
(int64)
Read Only:
true
Location ID of the secondary locations in a job requisition details preview.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCERequisitionTemplateDetailsPreviews-workLocation-item-response
Type:
Show Source
object
-
AddressLine1: string
Title:
Address Line 1
Read Only:true
Maximum Length:240
Address line 1 of work locations in a job requisition details preview. -
AddressLine2: string
Title:
Address Line 2
Read Only:true
Maximum Length:240
Address line 2 of work locations in a job requisition details preview. -
AddressLine3: string
Title:
Address Line 3
Read Only:true
Maximum Length:240
Address line 3 of work locations in a job requisition details preview. -
AddressLine4: string
Title:
Address Line 4
Read Only:true
Maximum Length:240
Address line 4 of work locations in a job requisition details preview. -
Building: string
Title:
Building
Read Only:true
Maximum Length:240
Building of work locations in a job requisition details preview. -
Country: string
Title:
Country
Read Only:true
Maximum Length:60
Country of work locations in a job requisition details preview. -
Latitude: integer
(int64)
Latitude of work locations in a job requisition details preview.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
Read Only:
true
Location ID of work locations in a job requisition details preview. -
LocationName: string
Title:
Display Name
Read Only:true
Maximum Length:240
Location name of work locations in a job requisition details preview. -
Longitude: integer
(int64)
Longitude of work locations in a job requisition details preview.
-
PostalCode: string
Title:
Postal Code
Read Only:true
Maximum Length:30
Postal code of work locations in a job requisition details preview. -
Region1: string
Title:
Region 1
Read Only:true
Maximum Length:120
Region 1 of work locations in a job requisition details preview. -
Region2: string
Title:
Region 2
Read Only:true
Maximum Length:120
Region 2 of work locations in a job requisition details preview. -
Region3: string
Title:
Region 3
Read Only:true
Maximum Length:120
Region 3 of work locations in a job requisition details preview. -
TownOrCity: string
Title:
Town or City
Read Only:true
Maximum Length:30
Town or city of work locations in a job requisition details preview.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source