Get all recruiting job requisitions
get
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions
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 recruiting job requisitions using a unique ID
Finder Variables- RequisitionId; integer; Finds recruiting job requisitions using findByRequisitionNumber and RequisitionNumber; string;
- findByRequisitionNumber Finds recruiting job requisitions using findByRequisitionNumber
Finder Variables- RequisitionNumber; string; Finds recruiting job requisitions using findByRequisitionNumber and RequisitionNumber; string;
- PrimaryKey Finds recruiting 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:- ApplyWhenNotPosted; string; Apply When Not Posted in recruiting job requisitions.
- AutomaticallyOpenRequisitionForSourcing; string; Determines if a job requisition is opened automatically for sourcing and if the job is posted internally and externally.
- BusinessUnitId; integer; Business unit ID in recruiting job requisitions.
- CandidateSelectionProcessId; integer; Candidate Selection Process ID in recruiting job requisitions.
- DelayBeforePostingExpires; integer; Determines the number of days of delay before the job posting expires. The value can't be higher than 0 if the job requisition isn't configured to be posted automatically.
- DepartmentId; integer; Department ID in recruiting job requisitions.
- ExternalApplicationFlowId; integer; External Application Flow ID in recruiting job requisitions.
- ExternalQualStr; string; String representation of qualifications for external candidates in recruiting job requisitions.
- ExternalRespStr; string; String representation of responsibilities for external candidates in recruiting job requisitions.
- GradeId; integer; Grade ID in recruiting job requisitions.
- HiredCount; integer; Hired Count in recruiting job requisitions.
- HiringManagerId; integer; Hiring Manager ID in recruiting job requisitions.
- InternalQualStr; string; String representation of qualifications for internal candidates in recruiting job requisitions.
- InternalRespStr; string; String representation of responsibilities for internal candidates in recruiting job requisitions.
- JobFamilyId; integer; Job Family ID in recruiting job requisitions.
- JobFunction; string; Job Function in recruiting job requisitions.
- JobId; integer; Job ID in recruiting job requisitions.
- LegalEmployerId; integer; Legal Employer ID in recruiting job requisitions.
- OrganizationId; integer; Organization ID in recruiting job requisitions.
- PhaseId; integer; Phase ID in recruiting job requisitions.
- PhaseName; string; Phase Name in recruiting job requisitions.
- PipelineRequisition; string; Pipeline Requisition in recruiting job requisitions.
- PipelineRequisitionId; integer; Pipeline Requisition ID in recruiting job requisitions.
- PositionId; integer; Position ID in recruiting job requisitions.
- PrimaryLocationId; integer; Primary Location ID in recruiting job requisitions.
- PrimaryWorkLocationId; integer; Primary Work Location ID in recruiting job requisitions.
- RecruiterId; integer; Recruiter ID in recruiting job requisitions.
- RecruitingType; string; Recruiting Type in recruiting job requisitions.
- RequisitionId; integer; Requisition ID in recruiting job requisitions.
- RequisitionLastModifiedDate; string; Requisition Last Modified Date in recruiting job requisitions.
- RequisitionNumber; string; Requisition Number in recruiting job requisitions.
- SalaryPeriodCode; string; Salary period in recruiting job requisitions.
- StateId; integer; State ID in recruiting job requisitions.
- StateName; string; State Name in recruiting job requisitions.
- TemplateId; integer; Template ID in recruiting job requisitions.
- Title; string; Title in recruiting job requisitions.
- WorkEndDate; string; Work end date in recruiting job requisitions.
- WorkStartDate; string; Work start date in recruiting job requisitions.
- WorkplaceTypeCode; string; Workplace type in recruiting job requisitions.
-
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 : recruitingJobRequisitions
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:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobRequisitions-item-response
Type:
Show Source
object-
ApplyWhenNotPosted: string
Title:
Allow Candidates to Apply When Not PostedMaximum Length:1Apply When Not Posted in recruiting job requisitions. -
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
AutomaticallyOpenRequisitionForSourcing: string
Title:
Automatically Open Requisition for SourcingMaximum Length:30Determines if a job requisition is opened automatically for sourcing and if the job is posted internally and externally. -
BudgetCurrency: string
Title:
Budget CurrencyMaximum Length:30Budget Currency in recruiting job requisitions. -
BusinessJustification: string
Title:
Business JustificationMaximum Length:30Business justification in recruiting job requisitions. -
BusinessUnitId: integer
(int64)
Title:
Business UnitBusiness unit ID in recruiting job requisitions. -
CandidateSelectionProcessId: integer
(int64)
Title:
Candidate Selection ProcessCandidate Selection Process ID in recruiting job requisitions. -
collaborators: array
Collaborators in Recruiting Job Requisitions
Title:
Collaborators in Recruiting Job RequisitionsThe collaborators resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions collaborators. -
Comments: string
(byte)
Title:
CommentsComments in recruiting job requisitions. -
CompensationCurrency: string
Title:
Compensation CurrencyMaximum Length:30Compensation Currency in recruiting job requisitions. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64Create job requisitions. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueCreation Date in recruiting job requisitions. -
DelayBeforePostingExpires: integer
(int32)
Title:
Delay Before Posting ExpiresDetermines the number of days of delay before the job posting expires. The value can't be higher than 0 if the job requisition isn't configured to be posted automatically. -
DepartmentId: integer
(int64)
Title:
DepartmentDepartment ID in recruiting job requisitions. -
DisplayInOrgChart: string
Title:
Display in Organization ChartMaximum Length:1Display In Org Chart in recruiting job requisitions. -
EducationLevel: string
Title:
Education LevelMaximum Length:30Education Level in recruiting job requisitions. -
EmployeeReferralBonus: number
Title:
Employee Referral BonusEmployee Referral Bonus in recruiting job requisitions. -
EmployerExternalDescriptionId: integer
(int64)
Title:
ExternalEmployer External Description ID in recruiting job requisitions. -
EmployerInternalDescriptionId: integer
(int64)
Title:
InternalEmployer Internal Description ID in recruiting job requisitions. -
ExternalApplicationFlowId: integer
(int64)
Title:
External Application FlowExternal Application Flow ID in recruiting job requisitions. -
ExternalContactEmail: string
Title:
Email of External ContactMaximum Length:240External Contact Email in recruiting job requisitions. -
ExternalContactName: string
Title:
Name of External ContactMaximum Length:240External Contact Name in recruiting job requisitions. -
ExternalDescription: string
(byte)
Title:
Description for External CandidatesExternal Description in recruiting job requisitions. -
ExternalDescriptionHTML: string
(byte)
Title:
External Description HTMLExternal Description HTML in recruiting job requisitions. -
ExternalPublishedJobEndDate: string
(date-time)
Title:
End DateExternal Published Job End Date in recruiting job requisitions. -
ExternalPublishedJobStartDate: string
(date-time)
Title:
Start DateExternal Published Job Start Date in recruiting job requisitions. -
ExternalPublishedJobStatus: string
Title:
Posting StatusMaximum Length:30External Published Job Status in recruiting job requisitions. -
ExternalQual: string
(byte)
Title:
Qualifications for External CandidatesQualifications for external candidates in recruiting job requisitions. -
ExternalQualHTML: string
(byte)
Title:
Qualifications for External CandidatesHTML representation of qualifications for external candidates in recruiting job requisitions. -
ExternalQualStr: string
Read Only:
trueMaximum Length:255String representation of qualifications for external candidates in recruiting job requisitions. -
ExternalResp: string
(byte)
Title:
Responsibilities for External CandidatesResponsibilities for external candidates in recruiting job requisitions. -
ExternalRespHTML: string
(byte)
Title:
Responsibilities for External CandidatesHTML representation of responsibilities for external candidates in recruiting job requisitions. -
ExternalRespStr: string
Read Only:
trueMaximum Length:255String representation of responsibilities for external candidates in recruiting job requisitions. -
ExternalShortDescription: string
(byte)
Title:
External Short DescriptionExternal Short Description in recruiting job requisitions. -
FullTimeOrPartTime: string
Title:
Full Time or Part TimeMaximum Length:30Full Time Or Part Time in recruiting job requisitions. -
GradeId: integer
(int64)
Title:
GradeGrade ID in recruiting job requisitions. -
HiredCount: integer
(int32)
Title:
Hired CountHired Count in recruiting job requisitions. -
HiringManagerAssignmentId: integer
(int64)
Title:
Hiring Manager AssignmentHiring Manager Assignment ID in recruiting job requisitions. -
HiringManagerId: integer
(int64)
Title:
Hiring ManagerHiring Manager ID in recruiting job requisitions. -
InternalContactEmail: string
Title:
Email of Internal ContactMaximum Length:240Internal Contact Email in recruiting job requisitions. -
InternalContactName: string
Title:
Name of Internal ContactMaximum Length:240Internal Contact Name in recruiting job requisitions. -
InternalDescription: string
(byte)
Title:
Description for Internal CandidatesInternal Description in recruiting job requisitions. -
InternalDescriptionHTML: string
(byte)
Title:
Internal Description HTMLInternal Description HTML in recruiting job requisitions. -
InternalPublishedJobEndDate: string
(date-time)
Title:
End DateInternal Published Job End Date in recruiting job requisitions. -
InternalPublishedJobStartDate: string
(date-time)
Title:
Start DateInternal Published Job Start Date in recruiting job requisitions. -
InternalPublishedJobStatus: string
Title:
Posting StatusMaximum Length:30Internal Published Job Status in recruiting job requisitions. -
InternalQual: string
(byte)
Title:
Qualifications for Internal CandidatesQualifications for internal candidates in recruiting job requisitions. -
InternalQualHTML: string
(byte)
Title:
Qualifications for Internal CandidatesHTML representation of qualifications for internal candidates in recruiting job requisitions. -
InternalQualStr: string
Read Only:
trueMaximum Length:255String representation of qualifications for internal candidates in recruiting job requisitions. -
InternalResp: string
(byte)
Title:
Responsibilities for Internal CandidatesResponsibilities for internal candidates in recruiting job requisitions. -
InternalRespHTML: string
(byte)
Title:
Responsibilities for Internal CandidatesHTML representation of responsibilities for internal candidates in recruiting job requisitions. -
InternalRespStr: string
Read Only:
trueMaximum Length:255String representation of responsibilities for internal candidates in recruiting job requisitions. -
InternalShortDescription: string
(byte)
Title:
Internal Short DescriptionInternal Short Description in recruiting job requisitions. -
JobFamilyId: integer
(int64)
Title:
Job FamilyJob Family ID in recruiting job requisitions. -
JobFunction: string
Title:
Job FunctionMaximum Length:30Job Function in recruiting job requisitions. -
JobId: integer
(int64)
Title:
JobJob ID in recruiting job requisitions. -
JobShift: string
Title:
Job ShiftMaximum Length:30Job Shift in recruiting job requisitions. -
JobType: string
Title:
Job TypeMaximum Length:30Job Type in recruiting job requisitions. -
languages: array
Languages in Recruiting Job Requisitions
Title:
Languages in Recruiting Job RequisitionsThe languages resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions languages. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueLast Update Date in recruiting job requisitions. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64Last Update using in recruiting job requisitions. -
LegalEmployerId: integer
(int64)
Title:
Legal EmployerLegal Employer ID in recruiting job requisitions. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManagementLevel: string
Title:
Management LevelMaximum Length:30Management Level in recruiting job requisitions. -
MaximumSalary: number
Title:
Maximum SalaryMaximum Salary in recruiting job requisitions. -
mediaLinks: array
Media Links in Recruiting Job Requisitions
Title:
Media Links in Recruiting Job RequisitionsThe mediaLinks resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions media links. -
MinimumSalary: number
Title:
Minimum SalaryMinimum Salary in recruiting job requisitions. -
NumberOfOpenings: integer
(int32)
Title:
Number of OpeningsNumber Of Openings in recruiting job requisitions. -
OrganizationId: integer
(int64)
Title:
OrganizationOrganization ID in recruiting job requisitions. -
otherLocations: array
Other Locations in Recruiting Job Requisitions
Title:
Other Locations in Recruiting Job RequisitionsThe otherLocations resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions for other locations. -
OtherRequisitionTitle: string
Title:
Other Requisition TitleMaximum Length:240Other Requisition Title in recruiting job requisitions. -
otherWorkLocations: array
Other Work Locations in Recruiting Job Requisitions
Title:
Other Work Locations in Recruiting Job RequisitionsThe otherWorkLocations resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions in other work locations. -
PayFrequency: string
Title:
Pay FrequencyMaximum Length:30Pay Frequency in recruiting job requisitions. -
PhaseId: integer
(int64)
Phase ID in recruiting job requisitions.
-
PhaseName: string
Read Only:
trueMaximum Length:240Phase Name in recruiting job requisitions. -
PipelineRequisition: string
Title:
Requisition TypeMaximum Length:1Pipeline Requisition in recruiting job requisitions. -
PipelineRequisitionId: integer
(int64)
Pipeline Requisition ID in recruiting job requisitions.
-
PositionId: integer
(int64)
Title:
PositionPosition ID in recruiting job requisitions. -
PrimaryLocationId: integer
(int64)
Title:
Primary LocationPrimary Location ID in recruiting job requisitions. -
PrimaryWorkLocationId: integer
(int64)
Title:
Primary Work LocationPrimary Work Location ID in recruiting job requisitions. -
ProfileId: integer
(int64)
Profile ID in recruiting job requisitions.
-
publishedJobs: array
Published Jobs in Recruiting Job Requisitions
Title:
Published Jobs in Recruiting Job RequisitionsThe publishedJobs resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions published jobs. -
RecruiterAssignmentId: integer
(int64)
Title:
Recruiter AssignmentRecruiter Assignment ID in recruiting job requisitions. -
RecruiterId: integer
(int64)
Title:
RecruiterRecruiter ID in recruiting job requisitions. -
RecruitingOrganizationExternalDescriptionId: integer
(int64)
Title:
ExternalRecruiting Organization External Description ID in recruiting job requisitions. -
RecruitingOrganizationInternalDescriptionId: integer
(int64)
Title:
InternalRecruiting Organization Internal Description ID in recruiting job requisitions. -
RecruitingType: string
Title:
Recruiting TypeMaximum Length:30Recruiting Type in recruiting job requisitions. -
RegularOrTemporary: string
Title:
Regular or TemporaryMaximum Length:30Regular Or Temporary in recruiting job requisitions. -
RelocationBudget: number
Title:
Relocation BudgetRelocation Budget in recruiting job requisitions. -
requisitionDFF: array
requisitionDFF
-
RequisitionId: integer
(int64)
Read Only:
trueRequisition ID in recruiting job requisitions. -
RequisitionLastModifiedDate: string
(date-time)
Title:
Requisition Last Modified DateRequisition Last Modified Date in recruiting job requisitions. -
RequisitionNumber: string
Title:
Requisition NumberMaximum Length:240Requisition Number in recruiting job requisitions. -
SalaryPeriodCode: string
Title:
Salary PeriodMaximum Length:30Salary period in recruiting job requisitions. -
skills: array
Skills in Recruiting Job Requisitions
Title:
Skills in Recruiting Job RequisitionsThe skills resource is the child of the recruitingjobRequisitions resource and provides all the skills of the job requisition. -
SourcingBudget: number
Title:
Sourcing BudgetSourcing Budget in recruiting job requisitions. -
StateId: integer
(int64)
State ID in recruiting job requisitions.
-
StateName: string
Read Only:
trueMaximum Length:240State Name in recruiting job requisitions. -
TemplateId: integer
(int64)
Title:
Requisition TemplateTemplate ID in recruiting job requisitions. -
Title: string
Title:
Requisition TitleMaximum Length:240Title in recruiting job requisitions. -
TravelBudget: number
Title:
Travel BudgetTravel Budget in recruiting job requisitions. -
UnlimitedOpenings: string
Title:
Unlimited OpeningsMaximum Length:1Unlimited Openings in recruiting job requisitions. -
WorkEndDate: string
(date-time)
Title:
Work End DateWork end date in recruiting job requisitions. -
WorkerType: string
Title:
Worker TypeMaximum Length:30Worker Type in recruiting job requisitions. -
WorkplaceTypeCode: string
Title:
WorkplaceMaximum Length:30Workplace type in recruiting job requisitions. -
WorkStartDate: string
(date-time)
Title:
Work Start DateWork start date in recruiting job requisitions.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Collaborators in Recruiting Job Requisitions
Type:
arrayTitle:
Collaborators in Recruiting Job RequisitionsThe collaborators resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions collaborators.
Show Source
Nested Schema : Languages in Recruiting Job Requisitions
Type:
arrayTitle:
Languages in Recruiting Job RequisitionsThe languages resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions languages.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Media Links in Recruiting Job Requisitions
Type:
arrayTitle:
Media Links in Recruiting Job RequisitionsThe mediaLinks resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions media links.
Show Source
Nested Schema : Other Locations in Recruiting Job Requisitions
Type:
arrayTitle:
Other Locations in Recruiting Job RequisitionsThe otherLocations resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions for other locations.
Show Source
Nested Schema : Other Work Locations in Recruiting Job Requisitions
Type:
arrayTitle:
Other Work Locations in Recruiting Job RequisitionsThe otherWorkLocations resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions in other work locations.
Show Source
Nested Schema : Published Jobs in Recruiting Job Requisitions
Type:
arrayTitle:
Published Jobs in Recruiting Job RequisitionsThe publishedJobs resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions published jobs.
Show Source
Nested Schema : Skills in Recruiting Job Requisitions
Type:
arrayTitle:
Skills in Recruiting Job RequisitionsThe skills resource is the child of the recruitingjobRequisitions resource and provides all the skills of the job requisition.
Show Source
Nested Schema : recruitingJobRequisitions-attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : recruitingJobRequisitions-collaborators-item-response
Type:
Show Source
object-
CollaboratorAssignmentId: integer
(int64)
Collaborator Assignment ID in recruiting job requisitions collaborators.
-
CollaboratorId: integer
(int64)
Collaborator ID in recruiting job requisitions collaborators.
-
CollaboratorType: string
Maximum Length:
30Default Value:ORA_HIRING_TEAM_COLLABORATORCollaborator type for recruiting job requisition collaborators. -
CreatedBy: string
Read Only:
trueMaximum Length:64Created using in recruiting job requisitions collaborators. -
CreationDate: string
(date-time)
Read Only:
trueCreation Date in recruiting job requisitions collaborators. -
LastUpdateDate: string
(date-time)
Read Only:
trueLast Update Date in recruiting job requisitions collaborators. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Last Update using in recruiting job requisitions collaborators. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PersonId: integer
(int64)
Person ID in recruiting job requisitions collaborators.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobRequisitions-languages-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64Language used for creating the requisition. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueCreation Date in recruiting job requisitions languages. -
IsDefaultFlag: boolean
Maximum Length:
1Is Default indicator in recruiting job requisitions languages. -
LanguageCode: string
Maximum Length:
4Language Code in recruiting job requisitions languages. -
LanguageId: integer
(int64)
Language ID in recruiting job requisitions languages.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueLast Update Date in recruiting job requisitions languages. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64Last Update using in recruiting job requisitions languages. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobRequisitions-mediaLinks-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64Requisition created using the media links. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueCreation Date in recruiting job requisitions media links. -
IsShownOnOffers: string
Maximum Length:
1Is Shown On Offers in recruiting job requisitions media links. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueLast Update Date in recruiting job requisitions media links. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64Last Update using in recruiting job requisitions media links. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
mediaLanguages: array
Media Languages in Recruiting Job Requisitions
Title:
Media Languages in Recruiting Job RequisitionsThe mediaLanguages resource is a child of mediaLinks. It includes the details of recruiting job requisitions media languages. -
MediaLinkId: string
Read Only:
trueMaximum Length:18Media Link ID in recruiting job requisitions media links. -
RequisitionMediaLinkId: integer
(int64)
Requisition Media Link ID in recruiting job requisitions media links.
-
Sequence: integer
(int32)
Sequence in recruiting job requisitions media links.
-
ThumbnailURL: string
Maximum Length:
1000Thumbnail URL in recruiting job requisitions media links. -
Title: string
Maximum Length:
240Title in recruiting job requisitions media links. -
Type: string
Maximum Length:
30Type in recruiting job requisitions media links. -
URL: string
Maximum Length:
1000URL in recruiting job requisitions media links. -
Visibility: string
Maximum Length:
30Visibility in recruiting job requisitions media links.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Media Languages in Recruiting Job Requisitions
Type:
arrayTitle:
Media Languages in Recruiting Job RequisitionsThe mediaLanguages resource is a child of mediaLinks. It includes the details of recruiting job requisitions media languages.
Show Source
Nested Schema : recruitingJobRequisitions-mediaLinks-mediaLanguages-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64Language used in the media for creating the job requisition. -
CreationDate: string
(date-time)
Read Only:
trueCreation Date in recruiting job requisitions media languages. -
LastUpdateDate: string
(date-time)
Read Only:
trueLast Update Date in recruiting job requisitions media languages. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Last Update using in recruiting job requisitions media languages. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MediaLanguageCode: string
Maximum Length:
4Media Language Code in recruiting job requisitions media languages. -
MediaLanguageId: integer
(int64)
Media Language ID in recruiting job requisitions media languages.
-
MediaLinkId: integer
(int64)
Read Only:
trueMedia Link ID in recruiting job requisitions media languages.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobRequisitions-otherLocations-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64Requisition created for other locations. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueCreation Date in recruiting job requisitions other locations. -
GeographyNodeId: integer
(int64)
Title:
Other LocationsGeography Node ID in recruiting job requisitions other locations. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueLast Update Date in recruiting job requisitions other locations. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64Last Update using in recruiting job requisitions other locations. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationId: integer
(int64)
Location ID in recruiting job requisitions other locations.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobRequisitions-otherWorkLocations-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64Requisitions created for other work locations. -
CreationDate: string
(date-time)
Read Only:
trueCreation Date in recruiting job requisitions other work locations. -
LastUpdateDate: string
(date-time)
Read Only:
trueLast Update Date in recruiting job requisitions other work locations. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Last Update using in recruiting job requisitions other work locations. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationId: integer
(int64)
Title:
Other Work LocationsLocation ID in recruiting job requisitions other work locations. -
WorkLocationId: integer
(int64)
Work Location ID in recruiting job requisitions other work locations.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobRequisitions-publishedJobs-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64Requisitions included in the published jobs. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueCreation Date in recruiting job requisitions published jobs. -
EndDate: string
(date-time)
Title:
End DateRead Only:trueEnd Date in recruiting job requisitions published jobs. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueLast Update Date in recruiting job requisitions published jobs. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64Last Update using in recruiting job requisitions published jobs. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostingStatus: string
Title:
Posting StatusRead Only:trueMaximum Length:30Posting Status in recruiting job requisitions published jobs. -
PublishedJobId: integer
(int64)
Published Job ID in recruiting job requisitions published jobs.
-
StartDate: string
(date-time)
Title:
Start DateRead Only:trueStart Date in recruiting job requisitions published jobs. -
TimeZone: string
Read Only:
trueMaximum Length:50Time Zone in recruiting job requisitions published jobs. -
Visibility: string
Title:
VisibilityRead Only:trueMaximum Length:30Visibility in recruiting job requisitions published jobs.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobRequisitions-requisitionDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150 -
__FLEX_Context_DisplayValue: string
Title:
Context Segment -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
RequisitionId: integer
(int64)
-
ReqUsageCode: string
Maximum Length:
30
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobRequisitions-skills-item-response
Type:
Show Source
object-
Importance: integer
(int64)
Title:
ImportanceImportance value of the skill in recruiting job requisitions. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MinimumYearsOfExperience: integer
(int64)
Title:
Minimum Years ExperienceMinimum years of experience of the skill in recruiting job requisitions. -
RequiredFlag: boolean
Title:
RequiredMaximum Length:30Indicates whether the skill is required in recruiting job requisitions. -
SectionId: integer
(int64)
ID of the section which the skill is part of in recruiting job requisitions.
-
SectionName: string
Maximum Length:
255Name of the section which the skill is part of in recruiting job requisitions. -
SkillId: integer
(int64)
ID of the skill in recruiting job requisitions.
-
Skills: string
Title:
SkillMaximum Length:240Name of the skill in recruiting job requisitions.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Examples
The following example shows how to view all job requisitions by submitting a collection GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -X GET http://host:port/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions
Example of Response Header
The following is an example of the response header.
HTTP/1.1 200 OK Content-Type : application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"items": [
{
"RequisitionNumber": "BIREQ002",
"RequisitionId": 300100114115462,
"Title": "BIREQ002",
"OtherRequisitionTitle": null,
"RecruitingType": "ORA_CONTINGENT",
"TemplateId": null,
"PipelineRequisition": "N",
"PipelineRequisitionId": null,
"StateId": 31,
"StateName": "Expired",
"PhaseId": 5,
"PhaseName": "Open",
"PositionId": null,
"UnlimitedOpenings": "N",
"NumberOfOpenings": 12,
"HiredCount": 1,
"ApplyWhenNotPosted": "N",
"BusinessJustification": "ORA_NEW_POSITION",
"DisplayInOrgChart": "Y",
"HiringManagerId": 100000008153756,
"HiringManagerAssignmentId": 100000008154060,
"RecruiterId": 100000008153756,
"RecruiterAssignmentId": 100000008154060,
"ProfileId": 300100114115463,
"OrganizationId": 300100026725086,
"JobFamilyId": 100000018146410,
"JobFunction": "ADMIN",
"BusinessUnitId": 202,
"DepartmentId": 202,
"PrimaryWorkLocationId": 300100104852789,
"PrimaryLocationId": 100100069551156,
"JobId": 300100007456899,
"GradeId": 23,
"LegalEmployerId": null,
"BudgetCurrency": "USN",
"EmployeeReferralBonus": 34555,
"SourcingBudget": null,
"TravelBudget": null,
"RelocationBudget": null,
"CompensationCurrency": "USD",
"MinimumSalary": 34544,
"MaximumSalary": 56755,
"PayFrequency": "QUARTER",
"WorkerType": "E",
"RegularOrTemporary": "R",
"ManagementLevel": "7",
"FullTimeOrPartTime": "FULL_TIME",
"JobShift": "ORA_EVENING",
"JobType": "ORA_INTERNSHIP",
"EducationLevel": "17",
"InternalContactName": null,
"InternalContactEmail": null,
"ExternalContactName": null,
"ExternalContactEmail": null,
"EmployerInternalDescriptionId": 300100114081187,
"EmployerExternalDescriptionId": 300100114081187,
"RecruitingOrganizationInternalDescriptionId": 300100114081183,
"RecruitingOrganizationExternalDescriptionId": 300100114081191,
"InternalPublishedJobStartDate": "2017-07-24T20:12:57+00:00",
"InternalPublishedJobEndDate": "2019-07-16T20:12:00+00:00",
"InternalPublishedJobStatus": "ORA_EXPIRED",
"ExternalPublishedJobStartDate": "2017-07-24T20:12:57+00:00",
"ExternalPublishedJobEndDate": "2019-07-16T20:12:00+00:00",
"ExternalPublishedJobStatus": "ORA_EXPIRED",
"ExternalApplicationFlowId": 300100110482814,
"CandidateSelectionProcessId": 300100113113259,
"RequisitionLastModifiedDate": "2019-07-24T10:48:37.002+00:00",
"CreatedBy": "TM-MFITZIMMONS",
"CreationDate": "2017-07-24T20:02:30+00:00",
"LastUpdatedBy": "ZFRCE001_Marian_ZBEN",
"LastUpdateDate": "2019-07-24T10:48:36.304+00:00",
"links": [...]
},
{
"RequisitionNumber": "BIREQ003",
"RequisitionId": 300100114115492,
"Title": "BIREQ003",
"OtherRequisitionTitle": null,
"RecruitingType": "ORA_CAMPUS",
"TemplateId": null,
"PipelineRequisition": "N",
"PipelineRequisitionId": null,
"StateId": 21,
"StateName": "In Progress",
"PhaseId": 4,
"PhaseName": "Posting",
"PositionId": null,
"UnlimitedOpenings": "Y",
"NumberOfOpenings": null,
"HiredCount": null,
"ApplyWhenNotPosted": "N",
"BusinessJustification": "ORA_NEW_POSITION",
"DisplayInOrgChart": "Y",
"HiringManagerId": 100000008153756,
"HiringManagerAssignmentId": 100000008154060,
"RecruiterId": 100000008153756,
"RecruiterAssignmentId": 100000008154060,
"ProfileId": 300100114115493,
"OrganizationId": 300100026725086,
"JobFamilyId": 100000018146410,
"JobFunction": "ADMIN",
"BusinessUnitId": 202,
"DepartmentId": 202,
"PrimaryWorkLocationId": 300100104852789,
"PrimaryLocationId": 100100069551156,
"JobId": 300100007456899,
"GradeId": 23,
"LegalEmployerId": null,
"BudgetCurrency": "USN",
"EmployeeReferralBonus": 34555,
"SourcingBudget": null,
"TravelBudget": null,
"RelocationBudget": null,
"CompensationCurrency": "USD",
"MinimumSalary": 34544,
"MaximumSalary": 56755,
"PayFrequency": "QUARTER",
"WorkerType": "E",
"RegularOrTemporary": "R",
"ManagementLevel": "7",
"FullTimeOrPartTime": "FULL_TIME",
"JobShift": "ORA_EVENING",
"JobType": "ORA_INTERNSHIP",
"EducationLevel": "17",
"InternalContactName": null,
"InternalContactEmail": null,
"ExternalContactName": null,
"ExternalContactEmail": null,
"EmployerInternalDescriptionId": 300100114081187,
"EmployerExternalDescriptionId": 300100114081187,
"RecruitingOrganizationInternalDescriptionId": 300100114081183,
"RecruitingOrganizationExternalDescriptionId": 300100114081191,
"InternalPublishedJobStartDate": null,
"InternalPublishedJobEndDate": null,
"InternalPublishedJobStatus": null,
"ExternalPublishedJobStartDate": null,
"ExternalPublishedJobEndDate": null,
"ExternalPublishedJobStatus": null,
"ExternalApplicationFlowId": 300100110482814,
"CandidateSelectionProcessId": 100,
"RequisitionLastModifiedDate": null,
"CreatedBy": "TM-MFITZIMMONS",
"CreationDate": "2017-07-24T20:04:08+00:00",
"LastUpdatedBy": "TM-MFITZIMMONS",
"LastUpdateDate": "2017-07-24T20:10:56.740+00:00",
"links": [...]
},
{...}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0,
"links": [...]
}