Get all sources
get
/hcmRestApi/resources/11.13.18.05/recruitingUISourceTrackings
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 sources by a unique identifier.
Finder Variables- SourceTrackingId; integer; Source tracking ID and unique identifier used to find sources.
- findBySourceInfo Finds all sources by source info.
Finder Variables- CandidateNumber; string; Candidate number and source info used to find sources.
- Context; string; Context; string; and source info used to find sources.
- ContextId; integer; Context; string; identifier and source info used to find sources.
- PersonId; integer; Person ID and source info used to find sources.
- PrimaryKey Finds all sources by a unique identifier.
-
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:- AgencyName; string; Agency name.
- AgentFirstName; string; Agent first name.
- AgentLastName; string; Agent last name.
- AssetName; string; Asset name.
- CampaignCode; string; Campaign code.
- CampaignName; string; Campaign name.
- CampaignPostId; integer; Campaign post identifier.
- CandidateNumber; string; Candidate number.
- Context; string; Context.
- ContextId; integer; Context identifier.
- CustomSourceName; string; Custom source name.
- DimensionId; integer; Dimension identifier.
- EventId; integer; Event identifier.
- EventName; string; Event name.
- FromEventId; integer; From event identifier.
- FromPoolId; integer; From pool identifier.
- FromRequisitionId; integer; From requisition identifier.
- IsExtensibleSource; string; Extensible source indicator.
- IsRecordEditable; string; Editable record indicator.
- OrigSourceMedium; string; Original source medium.
- OrigSourceName; string; Original source name.
- PersonId; integer; Person identifier
- PoolId; integer; Pool identifier.
- PoolMemberId; integer; Pool member identifier.
- PoolName; string; Pool name.
- ProspectId; integer; Prospect identifier.
- RecruiterId; integer; Recruiter identifier.
- RecruiterName; string; Recruiter name.
- ReferrerId; integer; Referrer identifier.
- ReferrerName; string; Referrer name.
- RequisitionId; integer; Requisition identifier.
- RequisitionTitle; string; Requisition title.
- SharerId; integer; Sharer identifier.
- SharerName; string; Sharer name.
- SiteCode; string; Site code.
- SiteName; string; Site name.
- SiteNumber; string; Site number.
- SourceDisplayName; string; Source display name.
- SourceLevel; string; Source level.
- SourceMedium; string; Source medium.
- SourceMediumDisplayValue; string; Source medium display value.
- SourceMediumURLValue; string; Source medium URL value.
- SourceName; string; Source name.
- SourceTrackingId; integer; Source tracking identifier.
- SourceURLValue; string; Source URL value.
- SubmissionId; integer; Submission identifier.
-
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 : recruitingUISourceTrackings
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 : recruitingUISourceTrackings-item-response
Type:
Show Source
object
-
AgencyName: string
Title:
Agency Name
Maximum Length:255
Agency name. -
AgentFirstName: string
Maximum Length:
300
Agent first name. -
AgentLastName: string
Title:
Agent
Maximum Length:255
Agent last name. -
AssetName: string
Title:
Post
Maximum Length:255
Asset name. -
CampaignCode: string
Title:
Campaign
Maximum Length:255
Campaign code. -
CampaignName: string
Title:
Campaign
Maximum Length:255
Campaign name. -
CampaignPostId: integer
Title:
Post
Campaign post identifier. -
CandidateNumber: string
Candidate number.
-
Context: string
Maximum Length:
255
Context. -
ContextId: integer
Read Only:
true
Context identifier. -
CustomSourceName: string
Title:
Add or Create a Source
Maximum Length:255
Custom source name. -
DimensionId: integer
Dimension identifier.
-
EventId: integer
Event identifier.
-
EventName: string
Title:
Event
Maximum Length:255
Event name. -
FromEventId: integer
Title:
Event
From event identifier. -
FromPoolId: integer
Title:
Candidate Pool
From pool identifier. -
FromRequisitionId: integer
Title:
Job Requisition
From requisition identifier. -
IsExtensibleSource: string
Maximum Length:
255
Extensible source indicator. -
IsRecordEditable: string
Maximum Length:
255
Editable record indicator. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrigSourceMedium: string
Maximum Length:
255
Original source medium. -
OrigSourceName: string
Maximum Length:
255
Original source name. -
PersonId: integer
Person identifier
-
PoolId: integer
Pool identifier.
-
PoolMemberId: integer
Pool member identifier.
-
PoolName: string
Title:
Candidate Pool
Maximum Length:255
Pool name. -
ProspectId: integer
Prospect identifier.
-
RecruiterId: integer
Title:
Added By
Recruiter identifier. -
RecruiterName: string
Title:
Created By
Maximum Length:255
Recruiter name. -
ReferrerId: integer
Referrer identifier.
-
ReferrerName: string
Title:
Referred By
Maximum Length:255
Referrer name. -
RequisitionId: integer
Requisition identifier.
-
RequisitionTitle: string
Title:
Job Requisition
Maximum Length:255
Requisition title. - SharerId: integer
- SharerName: string
-
SiteCode: string
Title:
Career Site
Maximum Length:255
Site code. -
SiteName: string
Title:
Career Site
Maximum Length:255
Site name. -
SiteNumber: string
Title:
Career Site
Maximum Length:255
Site number. -
SourceDisplayName: string
Title:
Source
Maximum Length:255
Source display name. -
SourceLevel: string
Read Only:
true
Maximum Length:255
Source level. -
SourceMedium: string
Title:
Source Medium
Maximum Length:255
Source medium. -
SourceMediumDisplayValue: string
Title:
Source Medium
Read Only:true
Maximum Length:255
Source medium display value. -
SourceMediumURLValue: string
Maximum Length:
255
Source medium URL value. -
SourceName: string
Title:
Source
Maximum Length:255
Source name. -
SourceTrackingId: integer
Source tracking identifier.
-
SourceURLValue: string
Maximum Length:
255
Source URL value. -
SubmissionId: integer
Submission identifier.
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.