Get a requisition list
get
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/requisitionList/{Id}
Request
Path Parameters
-
Id(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
SearchId(required): integer
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=Default Value:
1
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : recruitingICEJobRequisitions-requisitionList-item-response
Type:
Show Source
object
-
BeFirstToApplyFlag: boolean
Read Only:
true
Indicates whether the job requisition has a low number of job applications and will invite candidates to be the first to apply. -
BusinessUnit: string
Read Only:
true
Maximum Length:80
Business unit name of the job requisition. -
ContractType: string
Read Only:
true
Maximum Length:80
Contract type of the job requisition. -
Department: string
Read Only:
true
Maximum Length:240
Department name of the job requisition. -
Distance: number
Read Only:
true
Total distance from the center of a radius search. -
DomesticTravelRequired: string
Read Only:
true
Maximum Length:80
Indicates whether domestic travel is required for the job requisition. -
ExternalQualificationsStr: string
Read Only:
true
Maximum Length:255
Qualifications of the job requisition. -
ExternalResponsibilitiesStr: string
Read Only:
true
Maximum Length:255
Responsibilities of the job requisition. -
GeographyId: integer
(int64)
Read Only:
true
Geography ID of the job requisition list. -
HotJobFlag: boolean
Read Only:
true
Indicates whether the job requisition is considered a hot job. -
Id: string
Read Only:
true
Maximum Length:240
ID assigned to the job requisition list. -
InternationalTravelRequired: string
Read Only:
true
Maximum Length:80
Indicates whether international travel is required for the job requisition. -
JobFamily: string
Read Only:
true
Maximum Length:240
Job family of the job requisition. -
JobFunction: string
Read Only:
true
Maximum Length:80
Job function of the job requisition. -
JobSchedule: string
Read Only:
true
Maximum Length:80
Job schedule of the job requisition. -
JobShift: string
Read Only:
true
Maximum Length:80
Job shift of the job requisition. -
JobType: string
Read Only:
true
Maximum Length:80
Job type of the job requisition. -
Language: string
Read Only:
true
Maximum Length:4
Language of the job requisition. -
LegalEmployer: string
Read Only:
true
Maximum Length:240
Legal employer of the job requisition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManagerLevel: string
Read Only:
true
Maximum Length:80
Management level of the job requisition. -
MediaThumbURL: string
Read Only:
true
Maximum Length:255
Media thumb URL for the job requisition list. -
Organization: string
Read Only:
true
Maximum Length:80
Organization name of the job requisition. -
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. -
PostedDate: string
(date)
Read Only:
true
Date of posting of the requisition list. -
PostingEndDate: string
(date)
Read Only:
true
Posting end date of the job requisition. -
PrimaryLocation: string
Title:
Primary Location
Read Only:true
Maximum Length:255
Primary location of the requisition list. -
PrimaryLocationCountry: string
Read Only:
true
Maximum Length:2
Country of the primary location of the requisition list. -
Relevancy: number
Read Only:
true
Relevancy score of the job requisition. -
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. -
ShortDescriptionStr: string
Read Only:
true
Short description string of the requisition list. -
StudyLevel: string
Read Only:
true
Maximum Length:80
Education level of the job requisition. -
Title: string
Read Only:
true
Maximum Length:240
Title of the requisition list. -
TrendingFlag: boolean
Read Only:
true
Indicates whether the job requisition has a high number of job applications and should be displayed as trending in a job requisition details preview.. -
WorkDays: string
Read Only:
true
Maximum Length:80
Work days of the job requisition. -
WorkDurationMonths: integer
(int64)
Read Only:
true
Work duration months of the job requisition. -
WorkDurationYears: integer
(int64)
Read Only:
true
Work duration years of the job requisition. -
WorkerType: string
Read Only:
true
Maximum Length:80
Worker type of the job requisition. -
WorkHours: string
Read Only:
true
Maximum Length:80
Work hours of the job requisition. -
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. -
WorkplaceType: string
Read Only:
true
Maximum Length:255
Workplace in a job requisition details preview. -
WorkplaceTypeCode: string
Read Only:
true
Maximum Length:30
Workplace type code 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 : 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 : 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 : recruitingICEJobRequisitions-requisitionList-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 : recruitingICEJobRequisitions-requisitionList-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 : recruitingICEJobRequisitions-requisitionList-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
Links
- otherWorkLocations
-
Parameters:
- Id4:
$request.path.Id4
- SearchId:
$request.path.SearchId
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. - Id4:
- secondaryLocations
-
Parameters:
- Id4:
$request.path.Id4
- SearchId:
$request.path.SearchId
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. - Id4:
- workLocation
-
Parameters:
- Id4:
$request.path.Id4
- SearchId:
$request.path.SearchId
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. - Id4: