Get all subscribers and its priority items
get
/hcmRestApi/resources/11.13.18.05/recruitingRACItems
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 all subscribers by a primary key.
Finder Variables- SubscriberTypeCode; string; Primary key and subscriber type code used to find all subscribers.
- PrimaryKey Finds all subscribers by a primary key.
-
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:- ItemCount; integer; Subscriber item count.
- PriorityItemCount; integer; Priority item count.
- SubscriberTypeCode; string; Type code for Recruiting Activity Center subscribers.
-
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 : recruitingRACItems
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingRACItems-item-response
Type:
Show Source
object
-
ItemCount: integer
Subscriber item count.
-
jobApplicationList: array
Job Application List
Title:
Job Application List
The 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:
Links
The link relations associated with the resource instance. -
offerList: array
Job Offers List
Title:
Job Offers List
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. -
PriorityItemCount: integer
Priority item count.
-
requisitionList: array
Job Requisition List
Title:
Job Requisition List
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: string
Maximum Length:
30
Type code for Recruiting Activity Center subscribers.
Nested Schema : Job Application List
Type:
array
Title:
Job Application List
The 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Job Offers List
Type:
array
Title:
Job Offers List
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.
Show Source
Nested Schema : Job Requisition List
Type:
array
Title:
Job Requisition List
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.
Show Source
Nested Schema : recruitingRACItems-jobApplicationList-item-response
Type:
Show Source
object
-
ActionDate: string
(date)
Title:
Date
Action date of the job application activity item. -
actions: array
Job Requisition Actions List
Title:
Job Requisition Actions List
The 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:
Candidate
Read Only:true
Maximum Length:240
Name of the candidate the job application activity item relates to. -
CandidateNumber: string
Title:
Candidate Number
Read Only:true
Maximum Length:30
Candidate number of the candidate associated with the activity item. -
CandidatePersonId: integer
(int64)
Title:
Candidate Name
Read Only:true
Person identifier of the candidate associated with the activity item. -
DefaultAction: string
Read Only:
true
Maximum Length:30
Default action of the job application activity item. -
DefaultActionName: string
Read Only:
true
Maximum Length:255
Default action name of the job application activity item. -
HiringManager: string
Title:
Hiring Manager
Read Only:true
Maximum Length:240
Hiring manager name the job application activity item relates to. -
HiringManagerId: integer
(int64)
Read Only:
true
Person identifier of the hiring manager associated with the activity item. -
ItemId: integer
(int64)
Unique identifier of the job application activity item.
-
ItemName: string
Title:
Activity
Read Only:true
Maximum Length:240
Name of the job application activity item. -
jobApplicationActionPreviews: array
Job Application Action Previews
Title:
Job Application Action Previews
The 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 Preview
The jobApplicationPreviews resource is the child of the recruitingRACItems resource. It provide details about a job application item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Priority: string
Title:
Priority
Read Only:true
Maximum Length:80
Job application activity item priority. It can be high or null. -
Recruiter: string
Title:
Name
Read Only:true
Maximum Length:240
Recruiter name the job application activity item relates to. -
RecruiterId: integer
(int64)
Read Only:
true
Person identifier of the recruiter associated with the activity item. -
RequisitionNumber: string
Title:
Requisition Number
Read Only:true
Maximum Length:240
Requisition number the job application activity item relates to. -
RequisitionTitle: string
Title:
Requisition
Read Only:true
Maximum Length:240
Requisition title the job application activity item relates to. -
RulePriorityCode: string
Read Only:
true
Maximum Length:30
Rule priority code the job application activity relates to. -
Subject: string
Maximum Length:
30
Subject of the job application list. -
SubmissionId: integer
(int64)
Read Only:
true
Submission ID the job application activity relates to. -
SubscriberLookupCode: string
Title:
Lookup Code
Read Only:true
Maximum Length:30
Lookup code of the subscriber associated with the activity item. -
SubscriberLookupType: string
Title:
Lookup Type
Read Only:true
Maximum Length:30
Lookup type of the subscriber associated with the activity item. -
SubscriberRuleCode: string
Read Only:
true
Maximum Length:30
Subscriber rule code the job application activity item relates to. -
SubscriberTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Subscriber type meaning of the subscriber associated with the activity item.
Nested Schema : Job Requisition Actions List
Type:
array
Title:
Job Requisition Actions List
The 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:
array
Title:
Job Application Action Previews
The 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:
array
Title:
Job Application Preview
The jobApplicationPreviews resource is the child of the recruitingRACItems resource. It provide details about a job application item.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingRACItems-jobApplicationList-actions-item-response
Type:
Show Source
object
-
ActionCode: string
Maximum Length:
30
Action code the job requisition activity item relates to. -
ActionName: string
Read Only:
true
Maximum Length:255
Action name the job requisition activity item relates to. -
DefaultFlag: boolean
Maximum Length:
1
Indicates 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:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : recruitingRACItems-jobApplicationList-jobApplicationActionPreviews-item-response
Type:
Show Source
object
-
ActiveOnAnotherRequisition: string
Read Only:
true
Maximum Length:255
Active on another requisition indicator displayed in the job application action preview. -
AreaCode: string
Read Only:
true
Maximum Length:30
Phone number area code of the candidate displayed in the job application action preview. -
CandidateLocation: string
Title:
Candidate Location
Read Only:true
Maximum Length:366
Candidate location of the candidate displayed in the job application action preview. -
CandidateName: string
Title:
Candidate Name
Read Only:true
Maximum Length:240
Name of the candidate displayed in the job application action preview. -
CandidateNumber: string
Title:
Candidate Number
Read Only:true
Maximum Length:30
Candidate number of the candidate displayed in the job application action preview. -
CandidateType: string
Title:
Candidate Type When Applying
Read Only:true
Maximum Length:80
Candidate type of the candidate displayed in the job application action preview. -
CountryCodeNumber: string
Read Only:
true
Maximum Length:30
Phone number country code of the candidate displayed in the job application action preview. -
CurrentPhaseId: integer
(int64)
Read Only:
true
Current phase identifier of the job application displayed in the job application action preview. -
DaysinStatus: integer
Title:
Days in Status
Read Only:true
Days in status count of the candidate displayed in the job application action preview. -
DisqualifiedFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the candidate displayed in the job application action preview is disqualified. -
EmailAddress: string
Title:
Candidate Email
Read Only:true
Maximum Length:240
Email address of the candidate displayed in the job application action preview. -
InternalFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the candidate displayed in the job application action preview is internal or external. -
ItemId: integer
(int64)
Read Only:
true
Unique identifier for the job application action activity item. -
LastContacted: integer
Title:
Last Contacted
Read Only:true
Date and time when the candidate was last contacted, displayed in the job application action preview. -
LastContactedMode: string
Read Only:
true
Maximum Length:255
Last contacted method for the candidate displayed in the job application action preview. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NextInterviewDate: string
(date-time)
Title:
Most Recent Interview Date
Read Only:true
Next interview date for the candidate displayed in the job application action preview. -
ObjectId: integer
(int64)
Read Only:
true
Object identifier of the activity for the job application action preview. -
PersonId: integer
(int64)
Read Only:
true
Person identifier of the candidate displayed in the job application action preview. -
PhaseName: string
Title:
Job Application Status
Read Only:true
Maximum Length:240
Phase of the job application displayed in the job application action preview. -
PhoneNumber: string
Title:
Candidate Phone Number
Read Only:true
Maximum Length:60
Phone number of the candidate displayed in the job application action preview. -
PreScreeningTotalScore: integer
Read Only:
true
Prescreening question total score displayed in the candidate for job application action preview. -
ProcessId: integer
(int64)
Read Only:
true
Process identifier for the job application action preview. -
QstnrScore: number
Title:
Prescreening Score
Read Only:true
Prescreening question maximum possible score for the candidate displayed in the job application action preview. -
ReferredByAgentFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether the candidate is referred by an agent, displayed in the job application action preview. -
ReferredFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether the candidate is referred by an employee, displayed in the job application action preview. -
RequisitionId: integer
(int64)
Read Only:
true
Requisition identifier of the job requisition for the job application action preview. -
RequisitionNumber: string
Title:
Requisition Number
Read Only:true
Maximum Length:240
Requisition number of the job requisition displayed in the job application action preview. -
RequisitionTitle: string
Title:
Requisition Title
Read Only:true
Maximum Length:240
Requisition title of the job requisition displayed in the job application action preview. -
StateName: string
Read Only:
true
Maximum Length:240
State of the job application displayed in the job application action preview. -
Subject: string
Read Only:
true
Maximum Length:30
Subject associated with the job application action preview. -
SubjectType: string
Read Only:
true
Maximum Length:30
Subject type associated with the job application action preview. -
SubmissionId: integer
Read Only:
true
Submission ID for the job application action preview. -
SubscriberRuleCode: string
Read Only:
true
Maximum Length:256
Subscriber rule code for the job application action activity item. -
UpdatedExpirationDate: string
(date-time)
Title:
New Expiration Date
Read Only:true
Updated expiration date for the job application action activity item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingRACItems-jobApplicationList-jobApplicationPreviews-item-response
Type:
Show Source
object
-
ActiveOnAnotherRequisition: string
Read Only:
true
Maximum Length:255
Active on another requisition indicator displayed in the job application preview. -
AreaCode: string
Read Only:
true
Maximum Length:30
Phone number area code of the candidate displayed in the job application preview. -
CandidateLocation: string
Title:
Candidate Location
Read Only:true
Maximum Length:366
Candidate location of the candidate displayed in the job application preview. -
CandidateName: string
Title:
Candidate Name
Read Only:true
Maximum Length:240
Name of the candidate displayed in the job application preview. -
CandidateNumber: string
Title:
Candidate Number
Read Only:true
Maximum Length:30
Candidate number of the candidate displayed in the job application preview. -
CandidateType: string
Title:
Candidate Type When Applying
Read Only:true
Maximum Length:80
Candidate type of the candidate displayed in the job application preview. For example, internal or external. -
CountryCodeNumber: string
Read Only:
true
Maximum Length:30
Phone number country code of the candidate displayed in the job application preview. -
DaysinStatus: integer
Title:
Days in Status
Read Only:true
Days in status count of the candidate displayed in the job application preview. -
DisqualifiedFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the candidate displayed in the job application preview is disqualified or not. -
EmailAddress: string
Title:
Candidate Email
Read Only:true
Maximum Length:240
Email address of the candidate displayed in the job application preview. -
InternalFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the candidate displayed in the job application preview is internal or external. -
LastContacted: integer
Title:
Last Contacted
Read Only:true
Last contacted day count for the candidate displayed in the job application preview. -
LastContactedMode: string
Read Only:
true
Maximum Length:255
Last contacted method for the candidate displayed in the job application preview. For example, email or phone call. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NextInterviewDate: string
(date-time)
Title:
Most Recent Interview Date
Read Only:true
Next interview date for the candidate displayed in the job application preview. -
PersonId: integer
(int64)
Read Only:
true
Person ID of the candidate displayed in the job application preview. -
PhaseName: string
Title:
Job Application Status
Read Only:true
Maximum Length:240
Phase name of the job application displayed in the job application preview. -
PhoneNumber: string
Title:
Candidate Phone Number
Read Only:true
Maximum Length:60
Phone number of the candidate displayed in the job application preview. -
PreScreeningTotalScore: integer
(int64)
Read Only:
true
Prescreening question total score for the candidate displayed in the job application preview. -
QstnrScore: number
Title:
Prescreening Score
Read Only:true
Prescreening question maximum possible score for the candidate displayed in the job application preview. -
ReferredByAgentFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether the candidate displayed in job application preview is referred by an agent or not. -
ReferredFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether the candidate displayed in job application preview is referred by an employee or not. -
RequisitionId: integer
(int64)
Read Only:
true
Requisition ID of the job requisition displayed in the job application preview. -
RequisitionNumber: string
Title:
Requisition Number
Read Only:true
Maximum Length:240
Requisition number the job application preview relates to. -
RequisitionTitle: string
Title:
Requisition Title
Read Only:true
Maximum Length:240
Requisition title the job application preview relates to. -
StateName: string
Read Only:
true
Maximum Length:240
State name of the job application displayed in the job application preview. -
SubmissionId: integer
Read Only:
true
Submission ID of the job application displayed in the job application preview.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingRACItems-offerList-item-response
Type:
Show Source
object
-
ActionDate: string
(date)
Title:
Date
Read Only:true
Action date of an activity item. -
actions: array
Job Requisition Actions List
Title:
Job Requisition Actions List
The 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:
Candidate
Read Only:true
Maximum Length:240
Name of the candidate that the activity item relates to. -
CandidateNumber: string
Read Only:
true
Maximum Length:30
Candidate number of the candidate associated with the activity item. -
DefaultAction: string
Read Only:
true
Maximum Length:30
Default action of the job offer activity item. -
DefaultActionName: string
Read Only:
true
Maximum Length:255
Name of the default action for the activity item. -
HiringManager: string
Title:
Hiring Manager
Read Only:true
Maximum Length:240
Name of the hiring manager of the job offer for the activity item. -
HiringManagerId: integer
(int64)
Read Only:
true
Person identifier of the hiring manager associated with the activity item. -
ItemId: integer
(int64)
Read Only:
true
Unique identifier of the activity item. -
ItemName: string
Title:
Activity
Read Only:true
Maximum Length:240
Name of the activity item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: integer
(int64)
Read Only:
true
Object identifier of the activity item. -
offerActionPreviews: array
Job Offer Action Previews
Title:
Job Offer Action Previews
The 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:
true
Offer ID of the offer related to the activity item. -
offerPreviews: array
Job Offer Preview
Title:
Job Offer Preview
The offerPreview resource is the child of the recruitingRACItems resource. It provides a preview of the details of a job offer. -
Priority: string
Title:
Priority
Read Only:true
Maximum Length:30
Activity item priority, can be high or null. -
PriorityCode: string
Read Only:
true
Maximum Length:30
Rule priority code the job offer activity relates to. -
Recruiter: string
Read Only:
true
Maximum Length:240
Name of the recruiter of the job offer for the activity item. -
RecruiterId: integer
(int64)
Read Only:
true
Person identifier of the recruiter associated with the activity item. -
RequisitionId: integer
(int64)
Read Only:
true
Requisition identifier of the requisition associated with the activity item. -
RequisitionNumber: string
Read Only:
true
Maximum Length:240
Requisition number of the requisition associated with the activity item. -
RequisitionTitle: string
Title:
Requisition
Read Only:true
Maximum Length:240
Requisition title of the requisition associated with the activity item. -
Subject: string
Read Only:
true
Maximum Length:30
Subject associated with the job offer. -
SubmissionId: integer
(int64)
Read Only:
true
Submission ID associated with the job offer. -
SubscriberRuleCode: string
Read Only:
true
Maximum Length:256
Subscriber rule code for the activity item. -
SubscriberRuleId: integer
(int64)
Read Only:
true
Subscriber rule ID for the activity item. -
SubscriberTypeCode: string
Read Only:
true
Maximum Length:30
Subscriber type code for the activity item, in this case offer is the subscriber. -
SubscriberTypeMeaning: string
Read Only:
true
Maximum Length:255
Subscriber type meaning of the subscriber associated with the activity item.
Nested Schema : Job Requisition Actions List
Type:
array
Title:
Job Requisition Actions List
The 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Job Offer Action Previews
Type:
array
Title:
Job Offer Action Previews
The 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:
array
Title:
Job Offer Preview
The 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:
30
Action code the job requisition activity item relates to. -
ActionName: string
Read Only:
true
Maximum Length:255
Action name the job requisition activity item relates to. -
DefaultFlag: boolean
Maximum Length:
1
Indicates 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:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingRACItems-offerList-offerActionPreviews-item-response
Type:
Show Source
object
-
Action: string
Title:
Action
Read Only:true
Maximum Length:80
Action performed on the selected offer. -
ActionCode: string
Read Only:
true
Maximum Length:30
Action code the job offer activity item relates to. -
CandidateEmail: string
Title:
Candidate Email
Read Only:true
Maximum Length:240
Email address of the candidate that the offer is extended to. -
CandidateName: string
Title:
Candidate Name
Read Only:true
Maximum Length:240
Name of the candidate that the offer is extended to. -
CandidateNumber: string
Title:
Candidate Number
Read Only:true
Maximum Length:30
Unique identifier of the candidate. -
CandidatePhoneNumber: string
Title:
Candidate Phone Number
Read Only:true
Maximum Length:240
Phone number of the candidate that the offer is extended to. -
CurrentPhase: string
Read Only:
true
Maximum Length:240
Phase of the offer in the candidate selection process. -
CurrentState: string
Title:
Offer State
Read Only:true
Maximum Length:240
State of the offer in the candidate selection process. -
DaysInThisState: integer
Title:
Days in State
Read Only:true
Number of days the offer has been in the current state in the candidate selection process. -
EmployeeStartDate: string
(date)
Title:
Employee Start Date
Read Only:true
Proposed date when the candidate will begin working. -
ItemId: integer
(int64)
Read Only:
true
Unique identifier of the action preview. -
LegalEmployer: string
Title:
Legal Employer
Read Only:true
Maximum Length:240
Legal employer of the offer. -
LegalEntityId: integer
(int64)
Read Only:
true
Legal entity ID of the offer. Might be null for some offers. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OfferId: integer
(int64)
Read Only:
true
Unique identifier of the offer preview. -
RequisitionNumber: string
Title:
Requisition Number
Read Only:true
Maximum Length:240
Requisition number of the requisition associated with the offer. -
RequisitionTitle: string
Title:
Requisition Title
Read Only:true
Maximum Length:240
Requisition title of the requisition associated with the offer. -
SubmissionId: integer
(int64)
Read Only:
true
Submission ID for the job offer action preview. -
WorkerType: string
Title:
Worker Type
Read Only:true
Maximum Length:80
Worker type the candidate will be hired as, either employee or contingent worker.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingRACItems-offerList-offerPreviews-item-response
Type:
Show Source
object
-
Action: string
Read Only:
true
Maximum Length:80
Action performed on the selected offer. -
ActionCode: string
Read Only:
true
Maximum Length:30
Action code the job offer activity item relates to. -
AssignmentId: integer
(int64)
Read Only:
true
Assignment ID of the offer being previewed. -
CandidateEmail: string
Title:
Candidate Email
Read Only:true
Maximum Length:240
Candidate email of the offer being previewed. -
CandidateName: string
Title:
Candidate Name
Read Only:true
Maximum Length:240
Candidate name of the offer being previewed. -
CandidateNumber: string
Title:
Candidate Number
Read Only:true
Maximum Length:30
Candidate number of the offer being previewed. -
CandidatePhoneNumber: string
Title:
Candidate Phone Number
Read Only:true
Maximum Length:240
Candidate phone number of the offer being previewed. -
CurrentPhase: string
Read Only:
true
Maximum Length:240
Current phase of the offer being previewed. -
CurrentState: string
Title:
Offer State
Read Only:true
Maximum Length:240
Current state of the offer being previewed. -
DaysInThisState: number
Title:
Days in Status
Read Only:true
Number of days the selected offer has been in the current state. -
EmployeeStartDate: string
(date)
Read Only:
true
Employee start date of the offer being previewed. -
ExpirationDate: string
(date)
Title:
Expiration Date
Read Only:true
Expiration date of the offer being previewed. -
ItemId: integer
(int64)
Read Only:
true
Item ID of the offer being previewed. -
LegalEmployer: string
Read Only:
true
Maximum Length:240
Legal employer of the offer being previewed. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
offerAttachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
offerCustomAttachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
OfferId: integer
(int64)
Read Only:
true
Offer ID of the offer being previewed. -
OfferLetterCustomized: string
Read Only:
true
Maximum Length:1
Specifies if the offer letter is modified. -
OfferLetterLayoutName: string
Maximum Length:
255
Offer letter layout ID for the offer being previewed. -
RequisitionId: integer
(int64)
Read Only:
true
Requisition ID for the offer being previewed. -
RequisitionNumber: string
Title:
Requisition Number
Read Only:true
Maximum Length:240
Requisition number of the offer being previewed. -
RequisitionTitle: string
Title:
Requisition Title
Read Only:true
Maximum Length:240
Requisition title of the offer being previewed. -
RTFResolved: string
Read Only:
true
Maximum Length:1
Specifies if RTF is resolved for the offer being previewed. -
SubmissionId: integer
(int64)
Read Only:
true
Submission ID for the offer being previewed. -
WorkerType: string
Read Only:
true
Maximum Length:80
Worker type of the offer being previewed.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The 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 Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The 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 Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingRACItems-requisitionList-item-response
Type:
Show Source
object
-
ActionDate: string
(date)
Title:
Date
Action date of a requisition activity item. -
actions: array
Job Requisition Actions List
Title:
Job Requisition Actions List
The 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:
true
Maximum Length:30
Default action of the requisition activity item. -
DefaultActionName: string
Read Only:
true
Maximum Length:255
Name of the default action for the requisition activity item. -
HiringManager: string
Title:
Hiring Manager
Read Only:true
Maximum Length:240
Name of the hiring manager of the requisition for the activity item. -
HiringManagerId: integer
(int64)
Read Only:
true
Person identifier of the hiring manager associated with the activity item. -
ItemId: integer
(int64)
Read Only:
true
Unique identifier of the requisition activity item. -
ItemName: string
Title:
Activity
Read Only:true
Maximum Length:240
Name of the requisition activity item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupCode: string
Title:
Lookup Code
Read Only:true
Maximum Length:30
Lookup code for requisition activity item. -
LookupType: string
Title:
Lookup Type
Read Only:true
Maximum Length:30
Lookup type for requisition activity item. -
Priority: string
Title:
Priority
Read Only:true
Maximum Length:80
Requisition activity item priority. Can be high or null. -
PriorityCode: string
Read Only:
true
Maximum Length:30
Rule priority code the requisition activity relates to. -
Recruiter: string
Title:
Recruiter
Read Only:true
Maximum Length:240
Name of the recruiter of the requisition for the activity item. -
RecruiterId: integer
(int64)
Read Only:
true
Person identifier of the recruiter associated with the activity item. -
requisitionActionPreviews: array
Job Requisition Action Previews
Title:
Job Requisition Action Previews
The 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:
true
Requisition ID of the requisition associated with the requisition activity item. -
RequisitionNumber: string
Title:
Requisition Number
Read Only:true
Maximum Length:240
Requisition number of the requisition associated with the requisition activity item. -
requisitionPreviews: array
Job Requisition Preview
Title:
Job Requisition Preview
The requisitionPreviews is the child of the recruitingRACItems resource. It provides a preview of the details of a job requisition. -
RequisitionTitle: string
Title:
Requisition
Read Only:true
Maximum Length:240
Requisition title of the requisition associated with the requisition activity item. -
Subject: string
Read Only:
true
Maximum Length:30
Subject associated with the job requisition. -
SubscriberLookupCode: string
Title:
Lookup Code
Read Only:true
Maximum Length:30
Lookup code of the subscriber associated with the activity item. -
SubscriberLookupType: string
Title:
Lookup Type
Read Only:true
Maximum Length:30
Lookup type of the subscriber associated with the activity item. -
SubscriberRuleCode: string
Read Only:
true
Maximum Length:30
Subscriber rule code of the requisition activity item. -
SubscriberTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Subscriber type meaning of the subscriber associated with the activity item.
Nested Schema : Job Requisition Actions List
Type:
array
Title:
Job Requisition Actions List
The 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Job Requisition Action Previews
Type:
array
Title:
Job Requisition Action Previews
The 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:
array
Title:
Job Requisition Preview
The 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:
30
Action code the job requisition activity item relates to. -
ActionName: string
Read Only:
true
Maximum Length:255
Action name the job requisition activity item relates to. -
DefaultFlag: boolean
Maximum Length:
1
Indicates 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:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingRACItems-requisitionList-requisitionActionPreviews-item-response
Type:
Show Source
object
-
AdditionalLocCount: integer
Read Only:
true
Count of the additional locations associated with the requisition. -
AdditionalWorkLocCount: integer
Read Only:
true
Count of the additional work locations associated with the requisition. -
HiringManager: string
Title:
Hiring Manager
Read Only:true
Maximum Length:240
Name of the hiring manager associated with the requisition. -
Job: string
Title:
Job
Read Only:true
Maximum Length:240
Job associated to the requisition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Title:
Location
Read Only:true
Maximum Length:255
Location defined on the requisition. -
NumberOfHires: integer
(int32)
Title:
Hired Count
Read Only:true
Number of hires for the requisition. -
NumberOfJobApplications: integer
Title:
Number of Job Applications
Read Only:true
Number of job applications submitted to the requisition. -
NumberOfOpenings: string
Title:
Number of Openings
Read Only:true
Maximum Length:255
Number of openings for the requisition. -
NumberOfProspects: integer
(int32)
Title:
Number of Prospects
Read Only:true
Number of prospect candidates associated with the requisition. -
Organization: string
Title:
Organization
Read Only:true
Maximum Length:255
Organization associated to the requisition. -
OtherRequisitionTitle: string
Title:
Other Requisition Title
Read Only:true
Maximum Length:240
Other requisition title of the requisition. -
PhaseName: string
Title:
Phase
Read Only:true
Maximum Length:240
Phase of the requisition in the requisition life cycle. -
Position: string
Title:
Position
Read Only:true
Maximum Length:750
Position associated to the requisition. -
Recruiter: string
Title:
Recruiter
Read Only:true
Maximum Length:240
Name of the recruiter associated with the requisition. -
RecruitingType: string
Title:
Recruiting Type
Read Only:true
Maximum Length:255
Recruiting type defined on the requisition. For example, professional or hourly. -
RequisitionId: integer
(int64)
Read Only:
true
Requisition ID of the requisition. -
RequisitionNumber: string
Title:
Requisition Number
Read Only:true
Maximum Length:240
Requisition number of the requisition. -
RequisitionStatus: string
Title:
Requisition Status
Read Only:true
Maximum Length:255
Status of the requisition in the requisition life cycle. -
RequisitionTitle: string
Title:
Requisition Title
Read Only:true
Maximum Length:240
Title of the requisition. -
RequisitionType: string
Title:
Requisition Type
Read Only:true
Maximum Length:255
Requisition type of the requisition, either pipeline or standard. -
StateName: string
Title:
State
Read Only:true
Maximum Length:240
State of the requisition in the requisition life cycle. -
WorkLocation: string
Title:
Work Location
Read Only:true
Maximum Length:255
Work location of the requisition.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingRACItems-requisitionList-requisitionPreviews-item-response
Type:
Show Source
object
-
AdditionalLocCount: string
Read Only:
true
Maximum Length:255
Count of the additional locations associated with the requisition preview. -
AdditionalWorkLocCount: string
Read Only:
true
Maximum Length:255
Count of the additional work locations associated with the requisition preview. -
BusinessJustification: string
Title:
Business Justification
Read Only:true
Maximum Length:255
Business justification for creating the requisition in the requisition preview. -
Comments: string
(byte)
Title:
Comments
Read Only:true
Comments provided for creating the requisition in the requisition preview. -
HiringManager: string
Title:
Hiring Manager
Read Only:true
Maximum Length:240
Name of the hiring manager associated with the requisition in the requisition preview. -
HotJob: string
Title:
Hot Job
Read Only:true
Maximum Length:255
Hot job indicator on the requisition in the requisition preview. -
Job: string
Title:
Job
Read Only:true
Maximum Length:240
Job associated to the requisition in the requisition preview. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Title:
Location
Read Only:true
Maximum Length:255
Location defined on the requisition in the requisition preview. -
NumberOfHires: integer
(int32)
Title:
Hired Count
Read Only:true
Number of hires for the requisition in the requisition preview. -
NumberOfJobApplications: integer
Title:
Number of Job Applications
Read Only:true
Number of job applications submitted to the requisition in the requisition preview. -
NumberOfOpenings: string
Title:
Number of Openings
Read Only:true
Maximum Length:255
Number of openings for the requisition in the requisition preview. -
NumberOfProspects: integer
(int32)
Title:
Number of Prospects
Read Only:true
Number of prospect candidates associated with the requisition in the requisition preview. -
Organization: string
Title:
Organization
Read Only:true
Maximum Length:255
Organization associated to the requisition in the requisition preview. -
OtherRequisitionTitle: string
Title:
Other Requisition Title
Read Only:true
Maximum Length:240
Other requisition title of the requisition in the requisition preview. -
Position: string
Title:
Position
Read Only:true
Maximum Length:750
Position associated to the requisition in the requisition preview. -
Recruiter: string
Title:
Recruiter
Read Only:true
Maximum Length:240
Name of the recruiter associated with the requisition in the requisition preview. -
RecruitingType: string
Title:
Recruiting Type
Read Only:true
Maximum Length:255
Recruiting type defined on the requisition in the requisition preview. For example, professional or hourly. -
RequisitionId: integer
(int64)
Read Only:
true
Requisition ID of the requisition in the requisition preview. -
RequisitionNumber: string
Title:
Requisition Number
Read Only:true
Maximum Length:240
Requisition number of the requisition in the requisition preview. -
RequisitionStatus: string
Title:
Requisition Status
Read Only:true
Maximum Length:255
Status of the requisition in the requisition life cycle in the requisition preview. -
RequisitionTitle: string
Title:
Requisition Title
Read Only:true
Maximum Length:240
Title of the requisition in the requisition preview. -
RequisitionType: string
Title:
Requisition Type
Read Only:true
Maximum Length:255
Requisition type of the requisition in the requisition preview, either pipeline or standard. -
WorkLocation: string
Title:
Work Location
Read Only:true
Maximum Length:255
Work location of the requisition in the requisition preview.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- findByAdvancedSearchQuery
-
Searches for activities based on selected filters.