Get a subscriber and its priority item
get
/hcmRestApi/resources/11.13.18.05/recruitingRACItems/{SubscriberTypeCode}
Request
Path Parameters
-
SubscriberTypeCode(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=
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: string
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: string
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 : recruitingRACItems-item-response
Type:
Show Source
object-
ItemCount: integer
Subscriber item count.
-
jobApplicationList: array
Job Application List
Title:
Job Application ListThe jobApplicationList resource is the child of the recruitingRACItems resource. It provides the list of job applications for the recruiting activity center. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
offerList: array
Job Offers List
Title:
Job Offers ListThe offerList resource is the child of the recruitingRACItems resource. It provides a list displaying offer activity items assigned to a user in the Recruiting Activity Center. -
PriorityItemCount: integer
Priority item count.
-
requisitionList: array
Job Requisition List
Title:
Job Requisition ListThe requisitionList resource is the child of the recruitingRACItems resource. It provides a list displaying requisition activity items assigned to a user in the Recruiting Activity Center. -
SubscriberTypeCode: string
Maximum Length:
30Type code for Recruiting Activity Center subscribers.
Nested Schema : Job Application List
Type:
arrayTitle:
Job Application ListThe jobApplicationList resource is the child of the recruitingRACItems resource. It provides the list of job applications for the recruiting activity center.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Job Offers List
Type:
arrayTitle:
Job Offers ListThe offerList resource is the child of the recruitingRACItems resource. It provides a list displaying offer activity items assigned to a user in the Recruiting Activity Center.
Show Source
Nested Schema : Job Requisition List
Type:
arrayTitle:
Job Requisition ListThe requisitionList resource is the child of the recruitingRACItems resource. It provides a list displaying requisition activity items assigned to a user in the Recruiting Activity Center.
Show Source
Nested Schema : recruitingRACItems-jobApplicationList-item-response
Type:
Show Source
object-
ActionDate: string
(date)
Title:
DateAction date of the job application activity item. -
actions: array
Job Requisition Actions List
Title:
Job Requisition Actions ListThe actions resource is the child of the recruitingRACItems resource. It provides a list of job requisition actions that a user can take based on the requisition activity item. -
Candidate: string
Title:
CandidateRead Only:trueMaximum Length:240Name of the candidate the job application activity item relates to. -
CandidateNumber: string
Title:
Candidate NumberRead Only:trueMaximum Length:30Candidate number of the candidate associated with the activity item. -
CandidatePersonId: integer
(int64)
Title:
Candidate NameRead Only:truePerson identifier of the candidate associated with the activity item. -
DefaultAction: string
Read Only:
trueMaximum Length:30Default action of the job application activity item. -
DefaultActionName: string
Read Only:
trueMaximum Length:255Default action name of the job application activity item. -
HiringManager: string
Title:
Hiring ManagerRead Only:trueMaximum Length:240Hiring manager name the job application activity item relates to. -
HiringManagerId: integer
(int64)
Read Only:
truePerson identifier of the hiring manager associated with the activity item. -
ItemId: integer
(int64)
Unique identifier of the job application activity item.
-
ItemName: string
Title:
ActivityRead Only:trueMaximum Length:240Name of the job application activity item. -
jobApplicationActionPreviews: array
Job Application Action Previews
Title:
Job Application Action PreviewsThe jobApplicationActionPreviews resource is the child of the recruitingRACItems resource. It provides the action preview for the selected action for job application item. -
jobApplicationPreviews: array
Job Application Preview
Title:
Job Application PreviewThe jobApplicationPreviews resource is the child of the recruitingRACItems resource. It provide details about a job application item. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Priority: string
Title:
PriorityRead Only:trueMaximum Length:80Job application activity item priority. It can be high or null. -
Recruiter: string
Title:
NameRead Only:trueMaximum Length:240Recruiter name the job application activity item relates to. -
RecruiterId: integer
(int64)
Read Only:
truePerson identifier of the recruiter associated with the activity item. -
RequisitionNumber: string
Title:
Requisition NumberRead Only:trueMaximum Length:240Requisition number the job application activity item relates to. -
RequisitionTitle: string
Title:
RequisitionRead Only:trueMaximum Length:240Requisition title the job application activity item relates to. -
RulePriorityCode: string
Read Only:
trueMaximum Length:30Rule priority code the job application activity relates to. -
Subject: string
Maximum Length:
30Subject of the job application list. -
SubmissionId: integer
(int64)
Read Only:
trueSubmission ID the job application activity relates to. -
SubscriberLookupCode: string
Title:
Lookup CodeRead Only:trueMaximum Length:30Lookup code of the subscriber associated with the activity item. -
SubscriberLookupType: string
Title:
Lookup TypeRead Only:trueMaximum Length:30Lookup type of the subscriber associated with the activity item. -
SubscriberRuleCode: string
Read Only:
trueMaximum Length:30Subscriber rule code the job application activity item relates to. -
SubscriberTypeMeaning: string
Title:
MeaningRead Only:trueMaximum Length:80Subscriber type meaning of the subscriber associated with the activity item.
Nested Schema : Job Requisition Actions List
Type:
arrayTitle:
Job Requisition Actions ListThe actions resource is the child of the recruitingRACItems resource. It provides a list of job requisition actions that a user can take based on the requisition activity item.
Show Source
Nested Schema : Job Application Action Previews
Type:
arrayTitle:
Job Application Action PreviewsThe jobApplicationActionPreviews resource is the child of the recruitingRACItems resource. It provides the action preview for the selected action for job application item.
Show Source
Nested Schema : Job Application Preview
Type:
arrayTitle:
Job Application PreviewThe jobApplicationPreviews resource is the child of the recruitingRACItems resource. It provide details about a job application item.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingRACItems-jobApplicationList-actions-item-response
Type:
Show Source
object-
ActionCode: string
Maximum Length:
30Action code the job requisition activity item relates to. -
ActionName: string
Read Only:
trueMaximum Length:255Action name the job requisition activity item relates to. -
DefaultFlag: boolean
Maximum Length:
1Indicates whether the job requisition action is the default action for the activity item. If an action is the default action for an activity item it's displayed in the action column in the activity list. -
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 : 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 : recruitingRACItems-jobApplicationList-jobApplicationActionPreviews-item-response
Type:
Show Source
object-
ActiveOnAnotherRequisition: string
Read Only:
trueMaximum Length:255Active on another requisition indicator displayed in the job application action preview. -
AreaCode: string
Read Only:
trueMaximum Length:30Phone number area code of the candidate displayed in the job application action preview. -
CandidateLocation: string
Title:
Candidate LocationRead Only:trueMaximum Length:366Candidate location of the candidate displayed in the job application action preview. -
CandidateName: string
Title:
Candidate NameRead Only:trueMaximum Length:240Name of the candidate displayed in the job application action preview. -
CandidateNumber: string
Title:
Candidate NumberRead Only:trueMaximum Length:30Candidate number of the candidate displayed in the job application action preview. -
CandidateType: string
Title:
Candidate Type When ApplyingRead Only:trueMaximum Length:80Candidate type of the candidate displayed in the job application action preview. -
CountryCodeNumber: string
Read Only:
trueMaximum Length:30Phone number country code of the candidate displayed in the job application action preview. -
CurrentPhaseId: integer
(int64)
Read Only:
trueCurrent phase identifier of the job application displayed in the job application action preview. -
DaysinStatus: integer
Title:
Days in StatusRead Only:trueDays in status count of the candidate displayed in the job application action preview. -
DisqualifiedFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the candidate displayed in the job application action preview is disqualified. -
EmailAddress: string
Title:
Candidate EmailRead Only:trueMaximum Length:240Email address of the candidate displayed in the job application action preview. -
InternalFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the candidate displayed in the job application action preview is internal or external. -
ItemId: integer
(int64)
Read Only:
trueUnique identifier for the job application action activity item. -
LastContacted: integer
Title:
Last ContactedRead Only:trueDate and time when the candidate was last contacted, displayed in the job application action preview. -
LastContactedMode: string
Read Only:
trueMaximum Length:255Last contacted method for the candidate displayed in the job application action preview. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NextInterviewDate: string
(date-time)
Title:
Most Recent Interview DateRead Only:trueNext interview date for the candidate displayed in the job application action preview. -
ObjectId: integer
(int64)
Read Only:
trueObject identifier of the activity for the job application action preview. -
PersonId: integer
(int64)
Read Only:
truePerson identifier of the candidate displayed in the job application action preview. -
PhaseName: string
Title:
Job Application StatusRead Only:trueMaximum Length:240Phase of the job application displayed in the job application action preview. -
PhoneNumber: string
Title:
Candidate Phone NumberRead Only:trueMaximum Length:60Phone number of the candidate displayed in the job application action preview. -
PreScreeningTotalScore: integer
Read Only:
truePrescreening question total score displayed in the candidate for job application action preview. -
ProcessId: integer
(int64)
Read Only:
trueProcess identifier for the job application action preview. -
QstnrScore: number
Title:
Prescreening ScoreRead Only:truePrescreening question maximum possible score for the candidate displayed in the job application action preview. -
ReferredByAgentFlag: boolean
Read Only:
trueMaximum Length:255Indicates whether the candidate is referred by an agent, displayed in the job application action preview. -
ReferredFlag: boolean
Read Only:
trueMaximum Length:255Indicates whether the candidate is referred by an employee, displayed in the job application action preview. -
RequisitionId: integer
(int64)
Read Only:
trueRequisition identifier of the job requisition for the job application action preview. -
RequisitionNumber: string
Title:
Requisition NumberRead Only:trueMaximum Length:240Requisition number of the job requisition displayed in the job application action preview. -
RequisitionTitle: string
Title:
Requisition TitleRead Only:trueMaximum Length:240Requisition title of the job requisition displayed in the job application action preview. -
StateName: string
Read Only:
trueMaximum Length:240State of the job application displayed in the job application action preview. -
Subject: string
Read Only:
trueMaximum Length:30Subject associated with the job application action preview. -
SubjectType: string
Read Only:
trueMaximum Length:30Subject type associated with the job application action preview. -
SubmissionId: integer
Read Only:
trueSubmission ID for the job application action preview. -
SubscriberRuleCode: string
Read Only:
trueMaximum Length:256Subscriber rule code for the job application action activity item. -
UpdatedExpirationDate: string
(date-time)
Title:
New Expiration DateRead Only:trueUpdated expiration date for the job application action activity item.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingRACItems-jobApplicationList-jobApplicationPreviews-item-response
Type:
Show Source
object-
ActiveOnAnotherRequisition: string
Read Only:
trueMaximum Length:255Active on another requisition indicator displayed in the job application preview. -
AreaCode: string
Read Only:
trueMaximum Length:30Phone number area code of the candidate displayed in the job application preview. -
CandidateLocation: string
Title:
Candidate LocationRead Only:trueMaximum Length:366Candidate location of the candidate displayed in the job application preview. -
CandidateName: string
Title:
Candidate NameRead Only:trueMaximum Length:240Name of the candidate displayed in the job application preview. -
CandidateNumber: string
Title:
Candidate NumberRead Only:trueMaximum Length:30Candidate number of the candidate displayed in the job application preview. -
CandidateType: string
Title:
Candidate Type When ApplyingRead Only:trueMaximum Length:80Candidate type of the candidate displayed in the job application preview. For example, internal or external. -
CountryCodeNumber: string
Read Only:
trueMaximum Length:30Phone number country code of the candidate displayed in the job application preview. -
DaysinStatus: integer
Title:
Days in StatusRead Only:trueDays in status count of the candidate displayed in the job application preview. -
DisqualifiedFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the candidate displayed in the job application preview is disqualified or not. -
EmailAddress: string
Title:
Candidate EmailRead Only:trueMaximum Length:240Email address of the candidate displayed in the job application preview. -
InternalFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the candidate displayed in the job application preview is internal or external. -
LastContacted: integer
Title:
Last ContactedRead Only:trueLast contacted day count for the candidate displayed in the job application preview. -
LastContactedMode: string
Read Only:
trueMaximum Length:255Last contacted method for the candidate displayed in the job application preview. For example, email or phone call. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NextInterviewDate: string
(date-time)
Title:
Most Recent Interview DateRead Only:trueNext interview date for the candidate displayed in the job application preview. -
PersonId: integer
(int64)
Read Only:
truePerson ID of the candidate displayed in the job application preview. -
PhaseName: string
Title:
Job Application StatusRead Only:trueMaximum Length:240Phase name of the job application displayed in the job application preview. -
PhoneNumber: string
Title:
Candidate Phone NumberRead Only:trueMaximum Length:60Phone number of the candidate displayed in the job application preview. -
PreScreeningTotalScore: integer
(int64)
Read Only:
truePrescreening question total score for the candidate displayed in the job application preview. -
QstnrScore: number
Title:
Prescreening ScoreRead Only:truePrescreening question maximum possible score for the candidate displayed in the job application preview. -
ReferredByAgentFlag: boolean
Read Only:
trueMaximum Length:255Indicates whether the candidate displayed in job application preview is referred by an agent or not. -
ReferredFlag: boolean
Read Only:
trueMaximum Length:255Indicates whether the candidate displayed in job application preview is referred by an employee or not. -
RequisitionId: integer
(int64)
Read Only:
trueRequisition ID of the job requisition displayed in the job application preview. -
RequisitionNumber: string
Title:
Requisition NumberRead Only:trueMaximum Length:240Requisition number the job application preview relates to. -
RequisitionTitle: string
Title:
Requisition TitleRead Only:trueMaximum Length:240Requisition title the job application preview relates to. -
StateName: string
Read Only:
trueMaximum Length:240State name of the job application displayed in the job application preview. -
SubmissionId: integer
Read Only:
trueSubmission ID of the job application displayed in the job application preview.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingRACItems-offerList-item-response
Type:
Show Source
object-
ActionDate: string
(date)
Title:
DateRead Only:trueAction date of an activity item. -
actions: array
Job Requisition Actions List
Title:
Job Requisition Actions ListThe actions resource is the child of the recruitingRACItems resource. It provides a list of job requisition actions that a user can take based on the requisition activity item. -
Candidate: string
Title:
CandidateRead Only:trueMaximum Length:240Name of the candidate that the activity item relates to. -
CandidateNumber: string
Read Only:
trueMaximum Length:30Candidate number of the candidate associated with the activity item. -
DefaultAction: string
Read Only:
trueMaximum Length:30Default action of the job offer activity item. -
DefaultActionName: string
Read Only:
trueMaximum Length:255Name of the default action for the activity item. -
HiringManager: string
Title:
Hiring ManagerRead Only:trueMaximum Length:240Name of the hiring manager of the job offer for the activity item. -
HiringManagerId: integer
(int64)
Read Only:
truePerson identifier of the hiring manager associated with the activity item. -
ItemId: integer
(int64)
Read Only:
trueUnique identifier of the activity item. -
ItemName: string
Title:
ActivityRead Only:trueMaximum Length:240Name of the activity item. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectId: integer
(int64)
Read Only:
trueObject identifier of the activity item. -
offerActionPreviews: array
Job Offer Action Previews
Title:
Job Offer Action PreviewsThe offerActionPreviews resource is the child of the recruitingRACItems resource. It provides a preview displaying data about the offer based on the action being performed. -
OfferId: integer
(int64)
Read Only:
trueOffer ID of the offer related to the activity item. -
offerPreviews: array
Job Offer Preview
Title:
Job Offer PreviewThe offerPreview resource is the child of the recruitingRACItems resource. It provides a preview of the details of a job offer. -
PersonId: integer
(int64)
Read Only:
truePerson identifier of the candidate associated with the recruiting activity item. -
Priority: string
Title:
PriorityRead Only:trueMaximum Length:30Activity item priority, can be high or null. -
PriorityCode: string
Read Only:
trueMaximum Length:30Rule priority code the job offer activity relates to. -
Recruiter: string
Read Only:
trueMaximum Length:240Name of the recruiter of the job offer for the activity item. -
RecruiterId: integer
(int64)
Read Only:
truePerson identifier of the recruiter associated with the activity item. -
RequisitionId: integer
(int64)
Read Only:
trueRequisition identifier of the requisition associated with the activity item. -
RequisitionNumber: string
Read Only:
trueMaximum Length:240Requisition number of the requisition associated with the activity item. -
RequisitionTitle: string
Title:
RequisitionRead Only:trueMaximum Length:240Requisition title of the requisition associated with the activity item. -
Subject: string
Read Only:
trueMaximum Length:30Subject associated with the job offer. -
SubmissionId: integer
(int64)
Read Only:
trueSubmission ID associated with the job offer. -
SubscriberRuleCode: string
Read Only:
trueMaximum Length:256Subscriber rule code for the activity item. -
SubscriberRuleId: integer
(int64)
Read Only:
trueSubscriber rule ID for the activity item. -
SubscriberTypeCode: string
Read Only:
trueMaximum Length:30Subscriber type code for the activity item, in this case offer is the subscriber. -
SubscriberTypeMeaning: string
Read Only:
trueMaximum Length:255Subscriber type meaning of the subscriber associated with the activity item.
Nested Schema : Job Requisition Actions List
Type:
arrayTitle:
Job Requisition Actions ListThe actions resource is the child of the recruitingRACItems resource. It provides a list of job requisition actions that a user can take based on the requisition activity item.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Job Offer Action Previews
Type:
arrayTitle:
Job Offer Action PreviewsThe offerActionPreviews resource is the child of the recruitingRACItems resource. It provides a preview displaying data about the offer based on the action being performed.
Show Source
Nested Schema : Job Offer Preview
Type:
arrayTitle:
Job Offer PreviewThe offerPreview resource is the child of the recruitingRACItems resource. It provides a preview of the details of a job offer.
Show Source
Nested Schema : recruitingRACItems-offerList-actions-item-response
Type:
Show Source
object-
ActionCode: string
Maximum Length:
30Action code the job requisition activity item relates to. -
ActionName: string
Read Only:
trueMaximum Length:255Action name the job requisition activity item relates to. -
DefaultFlag: boolean
Maximum Length:
1Indicates whether the job requisition action is the default action for the activity item. If an action is the default action for an activity item it's displayed in the action column in the activity list. -
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 : recruitingRACItems-offerList-offerActionPreviews-item-response
Type:
Show Source
object-
Action: string
Title:
ActionRead Only:trueMaximum Length:80Action performed on the selected offer. -
ActionCode: string
Read Only:
trueMaximum Length:30Action code the job offer activity item relates to. -
CandidateEmail: string
Title:
Candidate EmailRead Only:trueMaximum Length:240Email address of the candidate that the offer is extended to. -
CandidateName: string
Title:
Candidate NameRead Only:trueMaximum Length:240Name of the candidate that the offer is extended to. -
CandidateNumber: string
Title:
Candidate NumberRead Only:trueMaximum Length:30Unique identifier of the candidate. -
CandidatePhoneNumber: string
Title:
Candidate Phone NumberRead Only:trueMaximum Length:240Phone number of the candidate that the offer is extended to. -
CurrentPhase: string
Read Only:
trueMaximum Length:240Phase of the offer in the candidate selection process. -
CurrentState: string
Title:
Offer StateRead Only:trueMaximum Length:240State of the offer in the candidate selection process. -
DaysInThisState: integer
Title:
Days in StateRead Only:trueNumber of days the offer has been in the current state in the candidate selection process. -
EmployeeStartDate: string
(date)
Title:
Employee Start DateRead Only:trueProposed date when the candidate will begin working. -
ItemId: integer
(int64)
Read Only:
trueUnique identifier of the action preview. -
LegalEmployer: string
Title:
Legal EmployerRead Only:trueMaximum Length:240Legal employer of the offer. -
LegalEntityId: integer
(int64)
Read Only:
trueLegal entity ID of the offer. Might be null for some offers. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OfferId: integer
(int64)
Read Only:
trueUnique identifier of the offer preview. -
RequisitionNumber: string
Title:
Requisition NumberRead Only:trueMaximum Length:240Requisition number of the requisition associated with the offer. -
RequisitionTitle: string
Title:
Requisition TitleRead Only:trueMaximum Length:240Requisition title of the requisition associated with the offer. -
SubmissionId: integer
(int64)
Read Only:
trueSubmission ID for the job offer action preview. -
WorkerType: string
Title:
Worker TypeRead Only:trueMaximum Length:80Worker type the candidate will be hired as, either employee or contingent worker.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingRACItems-offerList-offerPreviews-item-response
Type:
Show Source
object-
Action: string
Read Only:
trueMaximum Length:80Action performed on the selected offer. -
ActionCode: string
Read Only:
trueMaximum Length:30Action code the job offer activity item relates to. -
AssignmentId: integer
(int64)
Read Only:
trueAssignment ID of the offer being previewed. -
CandidateEmail: string
Title:
Candidate EmailRead Only:trueMaximum Length:240Candidate email of the offer being previewed. -
CandidateName: string
Title:
Candidate NameRead Only:trueMaximum Length:240Candidate name of the offer being previewed. -
CandidateNumber: string
Title:
Candidate NumberRead Only:trueMaximum Length:30Candidate number of the offer being previewed. -
CandidatePhoneNumber: string
Title:
Candidate Phone NumberRead Only:trueMaximum Length:240Candidate phone number of the offer being previewed. -
CurrentPhase: string
Read Only:
trueMaximum Length:240Current phase of the offer being previewed. -
CurrentState: string
Title:
Offer StateRead Only:trueMaximum Length:240Current state of the offer being previewed. -
DaysInThisState: number
Title:
Days in StatusRead Only:trueNumber of days the selected offer has been in the current state. -
EmployeeStartDate: string
(date)
Read Only:
trueEmployee start date of the offer being previewed. -
ExpirationDate: string
(date)
Title:
Expiration DateRead Only:trueExpiration date of the offer being previewed. -
ItemId: integer
(int64)
Read Only:
trueItem ID of the offer being previewed. -
LegalEmployer: string
Read Only:
trueMaximum Length:240Legal employer of the offer being previewed. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
offerAttachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
offerCustomAttachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
OfferId: integer
(int64)
Read Only:
trueOffer ID of the offer being previewed. -
OfferLetterCustomized: string
Read Only:
trueMaximum Length:1Specifies if the offer letter is modified. -
OfferLetterLayoutName: string
Maximum Length:
255Offer letter layout ID for the offer being previewed. -
RequisitionId: integer
(int64)
Read Only:
trueRequisition ID for the offer being previewed. -
RequisitionNumber: string
Title:
Requisition NumberRead Only:trueMaximum Length:240Requisition number of the offer being previewed. -
RequisitionTitle: string
Title:
Requisition TitleRead Only:trueMaximum Length:240Requisition title of the offer being previewed. -
RTFResolved: string
Read Only:
trueMaximum Length:1Specifies if RTF is resolved for the offer being previewed. -
SubmissionId: integer
(int64)
Read Only:
trueSubmission ID for the offer being previewed. -
WorkerType: string
Read Only:
trueMaximum Length:80Worker type of the offer being previewed.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : recruitingRACItems-offerList-offerPreviews-offerAttachments-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 : recruitingRACItems-offerList-offerPreviews-offerCustomAttachments-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 : recruitingRACItems-requisitionList-item-response
Type:
Show Source
object-
ActionDate: string
(date)
Title:
DateAction date of a requisition activity item. -
actions: array
Job Requisition Actions List
Title:
Job Requisition Actions ListThe actions resource is the child of the recruitingRACItems resource. It provides a list of job requisition actions that a user can take based on the requisition activity item. -
DefaultAction: string
Read Only:
trueMaximum Length:30Default action of the requisition activity item. -
DefaultActionName: string
Read Only:
trueMaximum Length:255Name of the default action for the requisition activity item. -
HiringManager: string
Title:
Hiring ManagerRead Only:trueMaximum Length:240Name of the hiring manager of the requisition for the activity item. -
HiringManagerId: integer
(int64)
Read Only:
truePerson identifier of the hiring manager associated with the activity item. -
ItemId: integer
(int64)
Read Only:
trueUnique identifier of the requisition activity item. -
ItemName: string
Title:
ActivityRead Only:trueMaximum Length:240Name of the requisition activity item. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LookupCode: string
Title:
Lookup CodeRead Only:trueMaximum Length:30Lookup code for requisition activity item. -
LookupType: string
Title:
Lookup TypeRead Only:trueMaximum Length:30Lookup type for requisition activity item. -
Priority: string
Title:
PriorityRead Only:trueMaximum Length:80Requisition activity item priority. Can be high or null. -
PriorityCode: string
Read Only:
trueMaximum Length:30Rule priority code the requisition activity relates to. -
Recruiter: string
Title:
RecruiterRead Only:trueMaximum Length:240Name of the recruiter of the requisition for the activity item. -
RecruiterId: integer
(int64)
Read Only:
truePerson identifier of the recruiter associated with the activity item. -
requisitionActionPreviews: array
Job Requisition Action Previews
Title:
Job Requisition Action PreviewsThe requisitionActionPreviews resource is the child of the recruitingRACItems resource. It provides a preview displaying data about the requisition based on the action being performed. -
RequisitionId: integer
(int64)
Read Only:
trueRequisition ID of the requisition associated with the requisition activity item. -
RequisitionNumber: string
Title:
Requisition NumberRead Only:trueMaximum Length:240Requisition number of the requisition associated with the requisition activity item. -
requisitionPreviews: array
Job Requisition Preview
Title:
Job Requisition PreviewThe requisitionPreviews is the child of the recruitingRACItems resource. It provides a preview of the details of a job requisition. -
RequisitionTitle: string
Title:
RequisitionRead Only:trueMaximum Length:240Requisition title of the requisition associated with the requisition activity item. -
Subject: string
Read Only:
trueMaximum Length:30Subject associated with the job requisition. -
SubscriberLookupCode: string
Title:
Lookup CodeRead Only:trueMaximum Length:30Lookup code of the subscriber associated with the activity item. -
SubscriberLookupType: string
Title:
Lookup TypeRead Only:trueMaximum Length:30Lookup type of the subscriber associated with the activity item. -
SubscriberRuleCode: string
Read Only:
trueMaximum Length:30Subscriber rule code of the requisition activity item. -
SubscriberTypeMeaning: string
Title:
MeaningRead Only:trueMaximum Length:80Subscriber type meaning of the subscriber associated with the activity item.
Nested Schema : Job Requisition Actions List
Type:
arrayTitle:
Job Requisition Actions ListThe actions resource is the child of the recruitingRACItems resource. It provides a list of job requisition actions that a user can take based on the requisition activity item.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Job Requisition Action Previews
Type:
arrayTitle:
Job Requisition Action PreviewsThe requisitionActionPreviews resource is the child of the recruitingRACItems resource. It provides a preview displaying data about the requisition based on the action being performed.
Show Source
Nested Schema : Job Requisition Preview
Type:
arrayTitle:
Job Requisition PreviewThe requisitionPreviews is the child of the recruitingRACItems resource. It provides a preview of the details of a job requisition.
Show Source
Nested Schema : recruitingRACItems-requisitionList-actions-item-response
Type:
Show Source
object-
ActionCode: string
Maximum Length:
30Action code the job requisition activity item relates to. -
ActionName: string
Read Only:
trueMaximum Length:255Action name the job requisition activity item relates to. -
DefaultFlag: boolean
Maximum Length:
1Indicates whether the job requisition action is the default action for the activity item. If an action is the default action for an activity item it's displayed in the action column in the activity list. -
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 : recruitingRACItems-requisitionList-requisitionActionPreviews-item-response
Type:
Show Source
object-
AdditionalLocCount: integer
Read Only:
trueCount of the additional locations associated with the requisition. -
AdditionalWorkLocCount: integer
Read Only:
trueCount of the additional work locations associated with the requisition. -
HiringManager: string
Title:
Hiring ManagerRead Only:trueMaximum Length:240Name of the hiring manager associated with the requisition. -
Job: string
Title:
JobRead Only:trueMaximum Length:240Job associated to the requisition. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Location: string
Title:
LocationRead Only:trueMaximum Length:255Location defined on the requisition. -
NumberOfHires: integer
(int32)
Title:
Hired CountRead Only:trueNumber of hires for the requisition. -
NumberOfJobApplications: integer
Title:
Number of Job ApplicationsRead Only:trueNumber of job applications submitted to the requisition. -
NumberOfOpenings: string
Title:
Number of OpeningsRead Only:trueMaximum Length:255Number of openings for the requisition. -
NumberOfProspects: integer
(int32)
Title:
Number of ProspectsRead Only:trueNumber of prospect candidates associated with the requisition. -
Organization: string
Title:
OrganizationRead Only:trueMaximum Length:255Organization associated to the requisition. -
OtherRequisitionTitle: string
Title:
Other Requisition TitleRead Only:trueMaximum Length:240Other requisition title of the requisition. -
PhaseName: string
Title:
PhaseRead Only:trueMaximum Length:240Phase of the requisition in the requisition life cycle. -
Position: string
Title:
PositionRead Only:trueMaximum Length:750Position associated to the requisition. -
Recruiter: string
Title:
RecruiterRead Only:trueMaximum Length:240Name of the recruiter associated with the requisition. -
RecruitingType: string
Title:
Recruiting TypeRead Only:trueMaximum Length:255Recruiting type defined on the requisition. For example, professional or hourly. -
RequisitionId: integer
(int64)
Read Only:
trueRequisition ID of the requisition. -
RequisitionNumber: string
Title:
Requisition NumberRead Only:trueMaximum Length:240Requisition number of the requisition. -
RequisitionStatus: string
Title:
Requisition StatusRead Only:trueMaximum Length:255Status of the requisition in the requisition life cycle. -
RequisitionTitle: string
Title:
Requisition TitleRead Only:trueMaximum Length:240Title of the requisition. -
RequisitionType: string
Title:
Requisition TypeRead Only:trueMaximum Length:255Requisition type of the requisition, either pipeline or standard. -
StateName: string
Title:
StateRead Only:trueMaximum Length:240State of the requisition in the requisition life cycle. -
WorkLocation: string
Title:
Work LocationRead Only:trueMaximum Length:255Work location of the requisition.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingRACItems-requisitionList-requisitionPreviews-item-response
Type:
Show Source
object-
AdditionalLocCount: string
Read Only:
trueMaximum Length:255Count of the additional locations associated with the requisition preview. -
AdditionalWorkLocCount: string
Read Only:
trueMaximum Length:255Count of the additional work locations associated with the requisition preview. -
BusinessJustification: string
Title:
Business JustificationRead Only:trueMaximum Length:255Business justification for creating the requisition in the requisition preview. -
Comments: string
(byte)
Title:
CommentsRead Only:trueComments provided for creating the requisition in the requisition preview. -
HiringManager: string
Title:
Hiring ManagerRead Only:trueMaximum Length:240Name of the hiring manager associated with the requisition in the requisition preview. -
HotJob: string
Title:
Hot JobRead Only:trueMaximum Length:255Hot job indicator on the requisition in the requisition preview. -
Job: string
Title:
JobRead Only:trueMaximum Length:240Job associated to the requisition in the requisition preview. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Location: string
Title:
LocationRead Only:trueMaximum Length:255Location defined on the requisition in the requisition preview. -
NumberOfHires: integer
(int32)
Title:
Hired CountRead Only:trueNumber of hires for the requisition in the requisition preview. -
NumberOfJobApplications: integer
Title:
Number of Job ApplicationsRead Only:trueNumber of job applications submitted to the requisition in the requisition preview. -
NumberOfOpenings: string
Title:
Number of OpeningsRead Only:trueMaximum Length:255Number of openings for the requisition in the requisition preview. -
NumberOfProspects: integer
(int32)
Title:
Number of ProspectsRead Only:trueNumber of prospect candidates associated with the requisition in the requisition preview. -
Organization: string
Title:
OrganizationRead Only:trueMaximum Length:255Organization associated to the requisition in the requisition preview. -
OtherRequisitionTitle: string
Title:
Other Requisition TitleRead Only:trueMaximum Length:240Other requisition title of the requisition in the requisition preview. -
Position: string
Title:
PositionRead Only:trueMaximum Length:750Position associated to the requisition in the requisition preview. -
Recruiter: string
Title:
RecruiterRead Only:trueMaximum Length:240Name of the recruiter associated with the requisition in the requisition preview. -
RecruitingType: string
Title:
Recruiting TypeRead Only:trueMaximum Length:255Recruiting type defined on the requisition in the requisition preview. For example, professional or hourly. -
RequisitionId: integer
(int64)
Read Only:
trueRequisition ID of the requisition in the requisition preview. -
RequisitionNumber: string
Title:
Requisition NumberRead Only:trueMaximum Length:240Requisition number of the requisition in the requisition preview. -
RequisitionStatus: string
Title:
Requisition StatusRead Only:trueMaximum Length:255Status of the requisition in the requisition life cycle in the requisition preview. -
RequisitionTitle: string
Title:
Requisition TitleRead Only:trueMaximum Length:240Title of the requisition in the requisition preview. -
RequisitionType: string
Title:
Requisition TypeRead Only:trueMaximum Length:255Requisition type of the requisition in the requisition preview, either pipeline or standard. -
WorkLocation: string
Title:
Work LocationRead Only:trueMaximum Length:255Work location of the requisition in the requisition preview.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- jobApplicationList
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingRACItems/{SubscriberTypeCode}/child/jobApplicationListParameters:
- SubscriberTypeCode:
$request.path.SubscriberTypeCode
The jobApplicationList resource is the child of the recruitingRACItems resource. It provides the list of job applications for the recruiting activity center. - SubscriberTypeCode:
- offerList
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingRACItems/{SubscriberTypeCode}/child/offerListParameters:
- SubscriberTypeCode:
$request.path.SubscriberTypeCode
The offerList resource is the child of the recruitingRACItems resource. It provides a list displaying offer activity items assigned to a user in the Recruiting Activity Center. - SubscriberTypeCode:
- requisitionList
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingRACItems/{SubscriberTypeCode}/child/requisitionListParameters:
- SubscriberTypeCode:
$request.path.SubscriberTypeCode
The requisitionList resource is the child of the recruitingRACItems resource. It provides a list displaying requisition activity items assigned to a user in the Recruiting Activity Center. - SubscriberTypeCode: