Identifier of the job valid grade to be provided when using alternate key finder on jobs valid grades.
get
/hcmRestApi/resources/11.13.18.05/jobs
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
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- AltKey Surrogate identifier for the job.
Finder Variables- EffectiveStartDate; string; Effective start date of the job to be provided when using primary key finder on jobs.
- JobCode; string; Surrogate identifier for the job.
- SetId; integer; Identifier of the job set to be provided when using alternate key finder on jobs.
- PrimaryKey Finds all the jobs that match the specified primary key criteria.
Finder Variables- EffectiveEndDate; string; Effective end date for the job.
- EffectiveStartDate; string; Effective start date of the job to be provided when using primary key finder on jobs.
- JobId; integer; Surrogate identifier for the job.
- findByJobId Finds all the jobs that match the specified job identifier.
Finder Variables- JobId; integer; Surrogate identifier for the job in the primary key finder.
- SysEffectiveDate; object;
- AltKey Surrogate identifier for the job.
-
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:- ActiveStatus; string; Active status of job.
- AnnualWorkingDurationUnits; string; Code of the unit of job's standard annual working duration.
- ApprovalAuthority; integer; Approval authority of the job.
- CreationDate; string; Date and time when the job record was created.
- EffectiveEndDate; string; Effective end date of the job.
- EffectiveStartDate; string; Effective start date of the job.
- FullPartTime; string; Code of the full-time or part time.
- GradeLadderId; integer; Unique identifier for the grade ladder.
- JobCode; string; Code of the job.
- JobFamilyId; integer; Identifier of the job family of a job.
- JobFunctionCode; string; Code of the job function.
- JobId; integer; Unique identifier for the job.
- LastUpdateDate; string; Date and time the job was updated.
- ManagerLevel; string; Level of the manager.
- MedicalCheckupRequired; string; Indicates whether medial checkup is required for the job. The default value is false.
- Name; string; Name of the job.
- RegularTemporary; string; Indicates whether a job is regular or temporary. Valid values are defined in the RegularTemporaryVA list.
- SchedulingGroup; string; Name of the scheduling group of the job.
- SetId; integer; Surrogate identifier for the set to which the job belongs.
- StandardAnnualWorkingDuration; number; Standard annual working duration of the job.
- StandardWorkingFrequency; string; Meaning of the frequency of job's standard working hours.
- StandardWorkingHours; number; Standard working hours of the job.
-
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
-
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:
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 : jobs
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 : jobs-item-response
Type:
Show Source
object
-
ActiveStatus: string
Title:
Status
Maximum Length:30
Default Value:A
Active status of job. -
AnnualWorkingDurationUnits: string
Title:
Annual Working Duration Units
Maximum Length:10
Code of the unit of job's standard annual working duration. -
ApprovalAuthority: integer
(int64)
Title:
Level
Approval authority of the job. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the job record was created. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
Effective end date of the job. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Effective start date of the job. -
FullPartTime: string
Title:
Full Time or Part Time
Maximum Length:30
Code of the full-time or part time. -
GradeLadderId: integer
(int64)
Title:
Grade Ladder
Unique identifier for the grade ladder. -
JobCode: string
Title:
Code
Maximum Length:30
Code of the job. -
JobCustomerFlex: array
JobCustomerFlex
Customer's flexfield for job.
-
JobFamilyId: integer
(int64)
Title:
Job Family
Identifier of the job family of a job. -
JobFunctionCode: string
Title:
Function
Maximum Length:30
Code of the job function. -
JobId: integer
(int64)
Unique identifier for the job.
-
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 the manager. -
MedicalCheckupRequired: string
Title:
Medical Checkup Required
Maximum Length:30
Default Value:N
Indicates whether medial checkup is required for the job. The default value is false. -
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 RegularTemporaryVA list. -
SchedulingGroup: string
Maximum Length:
30
Name of the scheduling group of the job. -
SetId: integer
(int64)
Title:
Job Set
Surrogate identifier for the set to which the job belongs. -
StandardAnnualWorkingDuration: number
Title:
Standard Annual Working Duration
Standard annual working duration of the job. -
StandardWorkingFrequency: string
Title:
Standard Working Hours Frequency
Maximum Length:30
Meaning of the frequency of job's standard working hours. -
StandardWorkingHours: number
Title:
Standard Working Hours
Standard working hours of the job. -
validGrades: array
Jobs Valid Grades
Title:
Jobs Valid Grades
Finds all the jobs valid grades that match the specified job identifier.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Jobs Valid Grades
Type:
array
Title:
Jobs Valid Grades
Finds all the jobs valid grades that match the specified job identifier.
Show Source
Nested Schema : jobs-JobCustomerFlex-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
JobId: integer
(int64)
-
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)
Effective end date of the valid grades.
-
EffectiveStartDate: string
(date)
Effective start date of the valid grades.
-
GradeId: integer
(int64)
Unique identifier of the valid 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
Examples
The following example shows how to retrieve all the jobs 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"
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" : [25] { "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: { ...} { "JobId" : 2322, "JobCode" : "JOBCD2322", "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" : "TEC100.Technician", "ApprovalAuthority" : null, "CreationDate" : "2003-06-25T18:14:28-07:00", "LastUpdateDate" : "2005-10-14T16:32:31-07:00", "links" : [4] 0: { ...} }