Get all consolidated workload results
get
/hcmRestApi/resources/11.13.18.05/workloads
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 the consolidated workload by primary key.
Finder Variables- WorkloadId; integer; Unique primary key identifier of the consolidated workload.
- PrimaryKey Finds the consolidated workload by 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:- AdvSearchMethod; string; Method for the advanced search.
- CompetencyId; integer; Unique identifier for the competency.
- CompetencyName; string; Name of the competency.
- ContentType; string; Type for the provided workload content.
- EndTime; string; End time for the consolidated workload record.
- EndTimeOffset; integer; End Time Offset in Minutes
- JobProfileId; integer; Unique identifier for the job profile.
- JobProfileName; string; Name of the job profile.
- JobProfileType; string; Type for the job profile.
- JobProfileTypeCode; string; Unique identifier for the job profile code.
- JobProfileTypeMeaning; string; Meaning for the job profile type code.
- LastUpdated; string; Date when the workload was most recently updated.
- ReferenceDate; string; Date of the consolidated workload requirement.
- SchedSkillCode; string; Code for the scheduling skill.
- ScheduleSkillId; integer; Unique identifier for the schedule skill.
- ScheduleUnitId; integer; Unique identifier for he schedule unit.
- SchedulingGroupCode; string; Code identifying the scheduling group.
- ShiftTypeCode; string; Code for the shift type, such as Regular or On-Call
- ShiftTypeId; integer; Unique identifier for the shift type.
- ShiftTypeMeaning; string; Meaning for the shift type code.
- StartTime; string; Start time for the consolidated workload record.
- StartTimeOffset; integer; Start Time Offset in Minutes
- WorkloadHours; number; Workload hours, calculated from the original unit of measure and the workload value into hours.
- WorkloadId; integer; Unique identifier for the workload
- WorkloadTypeCode; string; Code for the workload type, such as Baseline, Actual, or Adjusted.
- WorkloadTypeMeaning; string; Meaning for the workload type.
- WorkloadUOMCode; string; Code for the workload unit of measure, such as Hours or Resources.
- WorkloadUOMMeaning; string; Meaning for the workload unit of measure.
- WorkloadValue; integer; Workload value, such as 7 or 3, for the workload requirement.
-
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 : workloads
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 : workloads-item-response
Type:
Show Source
object
-
AdvSearchMethod: string
Read Only:
true
Maximum Length:255
Method for the advanced search. -
CompetencyId: integer
(int64)
Read Only:
true
Unique identifier for the competency. -
CompetencyName: string
Title:
Competency Name
Read Only:true
Maximum Length:700
Name of the competency. -
ContentType: string
Read Only:
true
Maximum Length:500
Type for the provided workload content. -
EndTime: string
(time)
Title:
End Time
Read Only:true
End time for the consolidated workload record. -
EndTimeOffset: integer
(int32)
Title:
End Time Offset in Minutes
Read Only:true
End Time Offset in Minutes -
JobProfileId: integer
(int64)
Read Only:
true
Unique identifier for the job profile. -
JobProfileName: string
Title:
Job Profile Type Code
Read Only:true
Maximum Length:240
Name of the job profile. -
JobProfileType: string
Read Only:
true
Maximum Length:30
Type for the job profile. -
JobProfileTypeCode: string
Read Only:
true
Maximum Length:17
Unique identifier for the job profile code. -
JobProfileTypeMeaning: string
Read Only:
true
Maximum Length:80
Meaning for the job profile type code. -
LastUpdated: string
(date)
Read Only:
true
Date when the workload was most recently updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReferenceDate: string
(date)
Title:
Date
Read Only:true
Date of the consolidated workload requirement. -
SchedSkillCode: string
Read Only:
true
Maximum Length:255
Code for the scheduling skill. -
ScheduleSkillId: integer
(int64)
Title:
Schedule Skill Identifier
Read Only:true
Unique identifier for the schedule skill. -
ScheduleUnitId: integer
(int64)
Title:
Schedule Unit Identifier
Read Only:true
Unique identifier for he schedule unit. -
SchedulingGroupCode: string
Read Only:
true
Maximum Length:30
Code identifying the scheduling group. -
ShiftTypeCode: string
Read Only:
true
Maximum Length:7
Code for the shift type, such as Regular or On-Call -
ShiftTypeId: integer
(int64)
Read Only:
true
Unique identifier for the shift type. -
ShiftTypeMeaning: string
Read Only:
true
Maximum Length:7
Meaning for the shift type code. -
StartTime: string
(time)
Title:
Start Time
Read Only:true
Start time for the consolidated workload record. -
StartTimeOffset: integer
(int32)
Title:
Start Time Offset in Minutes
Read Only:true
Start Time Offset in Minutes -
WorkloadHours: number
Read Only:
true
Workload hours, calculated from the original unit of measure and the workload value into hours. -
WorkloadId: integer
(int64)
Title:
Workload Identifier
Read Only:true
Unique identifier for the workload -
WorkloadTypeCode: string
Title:
Workload Type Code
Read Only:true
Maximum Length:30
Code for the workload type, such as Baseline, Actual, or Adjusted. -
WorkloadTypeMeaning: string
Title:
Consolidated Workload Type Code
Read Only:true
Maximum Length:80
Meaning for the workload type. -
WorkloadUOMCode: string
Title:
UOM Code
Read Only:true
Maximum Length:30
Code for the workload unit of measure, such as Hours or Resources. -
WorkloadUOMMeaning: string
Title:
Consolidated Workload Unit of Measure Code
Read Only:true
Maximum Length:80
Meaning for the workload unit of measure. -
WorkloadValue: integer
(int32)
Title:
Consolidated Workload Value
Read Only:true
Workload value, such as 7 or 3, for the workload requirement.
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.
Links
- findByAdvancedSearchQuery
-
Finds the workload consolidation results matching the specified criteria such as department or location.