Get a job
get
/hcmRestApi/resources/11.13.18.05/jobs/{jobsUniqID}
Request
Path Parameters
-
jobsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Jobs resource and used to uniquely identify an instance of Jobs. The client should not generate the hash key value. Instead, the client should query on the Jobs collection resource in order to navigate to a specific instance of Jobs 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
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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(required):
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(required):
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 : jobs-item-response
Type:
Show Source
object
-
ActiveStatus: string
Title:
Status
Maximum Length:30
Default Value:A
Indicates whether a job is active or not. Valid values are defined in the list ActiveStatusLOV. -
AnnualWorkingDurationUnits: string
Title:
Annual Working Duration Units
Maximum Length:10
The unit of measure in hours, days, weeks, or months for the standard annual working duration. -
ApprovalAuthority: integer
(int64)
Title:
Level
Number that identifies levels across jobs which are used for approvals if the job list builder is used. -
CreationDate: string
(date-time)
Read Only:
true
Date and time the job was created. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
Date at the end of the date range within which the job is effective. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Date at the beginning of the date range within which the job is effective. -
FullPartTime: string
Title:
Full Time or Part Time
Maximum Length:30
Indicates whether a job is full-time or part-time. Valid values are defined in the list FullPartTimeLOV. -
GradeLadderId: integer
(int64)
Title:
Grade Ladder
Identifier for the grade ladder. -
JobCode: string
Title:
Code
Maximum Length:30
Short form for a job. Used for identification purposes. -
JobCustomerFlex: array
Job Customer Flexfields
Title:
Job Customer Flexfields
The JobCustomerFlex resource is a child of the jobs resource. It includes all job flexfields as of the specified date. By default, the current date is retained. -
JobFamilyId: integer
(int64)
Title:
Job Family
Unique key for a group of jobs having different but related functions, qualifications, and titles. -
JobFunctionCode: string
Title:
Function
Maximum Length:30
Code that best categorizes the job by function, such as administrative, legal, or management. Valid values are defined in the list JobFunctionLookup. -
JobId: integer
(int64)
Primary key generated by the application.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time the job was updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManagerLevel: string
Title:
Management Level
Maximum Length:30
Level of management associated with the employee. Valid values are defined in the list ManagerLevelLookup. -
MedicalCheckupRequired: string
Title:
Medical Checkup Required
Maximum Length:30
Default Value:N
Indicates whether a job requires a one-time medical checkup when the worker is hired. Valid values are defined in the list MedicalCheckupRequiredLOV. -
Name: string
Title:
Name
Maximum Length:240
Name of the job. -
RegularTemporary: string
Title:
Regular or Temporary
Maximum Length:30
Indicates whether a job is regular or temporary. Valid values are defined in the list RegularTemporaryLOV. -
SchedulingGroup: string
Maximum Length:
30
Scheduling Groups are specific functions by which customers would want to group jobs by so that they can be used in Workforce Scheduling. -
SetId: integer
(int64)
Title:
Job Set
Set of reference data shared across business units and other entities. Also known as Reference Data Sets, they are used to filter reference data in transactional UIs. -
StandardAnnualWorkingDuration: number
Title:
Standard Annual Working Duration
The standard annual working duration for the job. -
StandardWorkingFrequency: string
Title:
Standard Working Hours Frequency
Maximum Length:30
Frequency for the standard working hours. -
StandardWorkingHours: number
Title:
Standard Working Hours
Number of standard working hours. -
validGrades: array
Valid Grades
Title:
Valid Grades
The validGrades resource is a child of the jobs resource. It includes all valid grades for the job, as of the specified date.
Nested Schema : Job Customer Flexfields
Type:
array
Title:
Job Customer Flexfields
The JobCustomerFlex resource is a child of the jobs resource. It includes all job flexfields as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Valid Grades
Type:
array
Title:
Valid Grades
The validGrades resource is a child of the jobs resource. It includes all valid grades for the job, as of the specified date.
Show Source
Nested Schema : jobs-JobCustomerFlex-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Flexfield for job. Valid values are defined in the list LVVO___FLEX_Context. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Flexfield for job. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Flexfield for job. -
JobId: integer
(int64)
Flexfield for job.
-
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 : jobs-validGrades-item-response
Type:
Show Source
object
-
EffectiveEndDate: string
(date)
Date at the end of the date range within which the grade is effective.
-
EffectiveStartDate: string
(date)
Date at the beginning of the date range within which the grade is effective.
-
GradeId: integer
(int64)
Identifier for the grade.
-
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
Links
- JobCustomerFlex
-
Parameters:
- jobsUniqID:
$request.path.jobsUniqID
The JobCustomerFlex resource is a child of the jobs resource. It includes all job flexfields as of the specified date. By default, the current date is retained. - jobsUniqID:
- validGrades
-
Parameters:
- jobsUniqID:
$request.path.jobsUniqID
The validGrades resource is a child of the jobs resource. It includes all valid grades for the job, as of the specified date. - jobsUniqID:
Examples
The following example shows how to retrieve a job using the job ID, by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/jobs?q=JobId=2318"
Example of Response Header
The following shows an example of the response header.
Status: HTTP/1.1 200 OK Content-Type : application/json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items" : [1] { "JobId" : 2318, "JobCode" : "JOBCD2318", "JobFamilyId" : null, "ActiveStatus" : "A", "FullPartTime" : null, "JobFunctionCode" : null, "ManagerLevel" : null, "MedicalCheckupRequired" : null, "RegularTemporary" : null, "SetId" : 202, "EffectiveStartDate" : "1990-01-01", "EffectiveEndDate" : "4712-12-31", "Name" : "MCH100.Mechanic", "ApprovalAuthority" : null, "CreationDate" : "2003-06-25T18:09:00-07:00", "LastUpdateDate" : "2005-10-14T16:27:24-07:00", "links" : [4] 0: { ...} }