Get the details of a job distribution
get
/hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}
Request
Path Parameters
-
jobDistributionDetailsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Recruiting Job Requisition Distribution resource and used to uniquely identify an instance of Recruiting Job Requisition Distribution. The client should not generate the hash key value. Instead, the client should query on the Recruiting Job Requisition Distribution collection resource in order to navigate to a specific instance of Recruiting Job Requisition Distribution to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : jobDistributionDetails-item-response
Type:
Show Source
object
-
ContractType: string
Title:
Lookup Code
Read Only:true
Maximum Length:30
Type of contract signed with the candidate. -
DomesticTravelRequired: string
Title:
Travel Domestically
Read Only:true
Maximum Length:30
Indicates if domestic travel is required for the candidate. -
ExternalContactEmail: string
Title:
Email of External Contact
Read Only:true
Maximum Length:240
External contact email of the candidate. -
ExternalContactName: string
Title:
Name of External Contact
Read Only:true
Maximum Length:240
External contact name of the candidate. -
InternationalTravelRequired: string
Title:
Travel Internationally
Read Only:true
Maximum Length:30
Indicates if international travel is required for the candidate. -
JobFamilyCode: string
Read Only:
true
Maximum Length:240
Code assigned to the job family. -
JobSchedule: string
Title:
Lookup Code
Read Only:true
Maximum Length:30
Schedule of the job. -
JobShift: string
Title:
Lookup Code
Read Only:true
Maximum Length:30
Shift of the job. -
JobType: string
Title:
Visibility
Read Only:true
Maximum Length:30
Type of job. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationDisplayName: string
Title:
Organization
Read Only:true
Maximum Length:240
Display name of the organization. -
PartnerId: string
ID assigned to the partner.
-
PostingEndDate: string
(date-time)
Title:
End Date
Read Only:true
End date of the job posting. -
PostingStartDate: string
(date-time)
Title:
Start Date
Read Only:true
Start date of the job posting. -
PostingStatus: string
Title:
Posting Status
Read Only:true
Maximum Length:30
Status of the job posting. -
PrimaryLocationCountryCode: string
Read Only:
true
Maximum Length:2
Country code of the primary location of the job posting. -
PrimaryLocationLevelTwoCode: string
Read Only:
true
Maximum Length:255
Second level code of the primary location of the job posting. -
PrimaryWorkLocationPostalCode: string
Title:
Postal Code
Read Only:true
Maximum Length:30
Postal code of the primary work location of the job posting. -
requisitionLanguages: array
Requisition Languages
Title:
Requisition Languages
The requisitionLanguages resource is a child of jobDistributionDetails. It includes the details of the languages mentioned in the job description. -
RequisitionNumber: string
Title:
Requisition Number
Read Only:true
Maximum Length:240
Requisition number of the job posting. -
skills: array
Requisition Skills
Title:
Requisition Skills
The skills resource is a child of jobDistributionDetails. It includes the details of skills mentioned in the requisition. -
StudyLevel: string
Title:
Meaning
Read Only:true
Maximum Length:80
Educational qualification of the candidate. -
WorkplaceTypeCode: string
Read Only:
true
Maximum Length:30
Type of workplace of the job requisition.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Requisition Languages
Type:
array
Title:
Requisition Languages
The requisitionLanguages resource is a child of jobDistributionDetails. It includes the details of the languages mentioned in the job description.
Show Source
Nested Schema : Requisition Skills
Type:
array
Title:
Requisition Skills
The skills resource is a child of jobDistributionDetails. It includes the details of skills mentioned in the requisition.
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 : jobDistributionDetails-requisitionLanguages-item-response
Type:
Show Source
object
-
ApplyURL: string
Read Only:
true
The URL for applying in the requisition languages. -
DefaultLanguageFlag: boolean
Read Only:
true
Maximum Length:1
Default language of the requisition. -
EmployerDescriptionStr: string
Read Only:
true
Description of the employer in the requisition languages. -
ExternalDescription: string
Description of the external candidate in the requisition languages.
-
ExternalDescriptionHtml: string
HTML description for the external candidate in the requisition languages.
-
ExternalQualificationsHTML: string
HTML qualifications for the external candidate in the requisition languages.
-
ExternalResponsibilitiesHTML: string
HTML responsibilities for the external candidate in the requisition languages.
-
JobFamily: string
Read Only:
true
Maximum Length:240
Details of the job family in the requisition languages. -
LanguageCode: string
Code assigned to the language in the requisition languages.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
media: array
Requisition Media
Title:
Requisition Media
The media resource is a child of requisitionLanguages. It includes the details of the type of media used in the job distribution. -
OrganizationDescriptionStr: string
Read Only:
true
Description of the organization in the requisition languages. -
OrganizationNameML: string
Title:
Organization
Read Only:true
Maximum Length:240
Display name of the organization in the requisition languages. -
PrimaryLocation: string
Read Only:
true
Primary job location mentioned in the requisition languages. -
PrimaryLocationCountryName: string
Country name of the primary location in the requisition languages.
-
PrimaryLocationLevelThreeName: string
Read Only:
true
Maximum Length:255
Third level name of the primary location in the requisition languages. -
PrimaryLocationLevelTwoName: string
Read Only:
true
Maximum Length:255
Second level name of the primary location in the requisition languages. -
PrimaryWorkLocationCity: string
Title:
Town or City
Read Only:true
Maximum Length:30
City of the primary work location in the requisition languages. -
secondaryLocations: array
Secondary Locations
Title:
Secondary Locations
The secondaryLocations resource includes all the details of the secondary preferred location for the job distribution. -
ShortDescription: string
Short description of the requisition languages.
-
StudyLevelML: string
Read Only:
true
Maximum Length:80
Educational qualification needed in the requisition languages. -
Title: string
Read Only:
true
Maximum Length:240
Title of the requisition languages.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Requisition Media
Type:
array
Title:
Requisition Media
The media resource is a child of requisitionLanguages. It includes the details of the type of media used in the job distribution.
Show Source
Nested Schema : Secondary Locations
Type:
array
Title:
Secondary Locations
The secondaryLocations resource includes all the details of the secondary preferred location for the job distribution.
Show Source
Nested Schema : jobDistributionDetails-requisitionLanguages-media-item-response
Type:
Show Source
object
-
Id: integer
(int64)
Read Only:
true
ID assigned to the media used in requisition languages. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Priority: integer
(int32)
Read Only:
true
Priority assigned to the media used in requisition languages. -
RequisitionMediaLinkId: integer
(int64)
Read Only:
true
Priority assigned to the media used in requisition languages. -
ThumbURL: string
Read Only:
true
Maximum Length:1000
Thumb URL assigned to the media used in requisition languages. -
Title: string
Read Only:
true
Maximum Length:240
Title assigned to the media used in requisition languages. -
Type: string
Title:
Lookup Code
Read Only:true
Maximum Length:30
Type assigned to the media used in requisition languages. -
URL: string
Read Only:
true
Maximum Length:1000
URL of the media used in the job application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jobDistributionDetails-requisitionLanguages-secondaryLocations-item-response
Type:
Show Source
object
-
GeographyNodeId: integer
(int64)
Title:
Primary Location
Read Only:true
Geography node ID of the secondary location. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Read Only:
true
Location of requisitions.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jobDistributionDetails-skills-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SectionName: string
Maximum Length:
255
Name of the section to which a skill belongs. -
Skill: string
Maximum Length:
255
Name of the skill.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- requisitionLanguages
-
Parameters:
- jobDistributionDetailsUniqID:
$request.path.jobDistributionDetailsUniqID
The requisitionLanguages resource is a child of jobDistributionDetails. It includes the details of the languages mentioned in the job description. - jobDistributionDetailsUniqID:
- skills
-
Operation: /hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}/child/skillsParameters:
- jobDistributionDetailsUniqID:
$request.path.jobDistributionDetailsUniqID
The skills resource is a child of jobDistributionDetails. It includes the details of skills mentioned in the requisition. - jobDistributionDetailsUniqID: