Update workload plan
patch
/hcmRestApi/resources/11.13.18.05/workloadPlans/{WorkloadPlanId}
Request
Path Parameters
-
WorkloadPlanId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
BusinessUnitName: string
Title:
Business Unit Name
Maximum Length:80
Business Unit Name -
DepartmentName: string
Maximum Length:
80
Name of the schedule department. -
EndAfterMidnightFlag: boolean
Indicates whether the workload plan ends after midnight.
-
EndDate: string
(date)
Title:
End Date
End Date -
EndTime: string
Maximum Length:
80
End Time -
JobCode: string
Maximum Length:
80
Code that uniquely identifies the HCM job used to identify the workload import record. -
JobFamilyCode: string
Maximum Length:
80
Code that uniquely identifies the HCM job family used to identify the workload import record. -
JobProfileType: string
Title:
Job Profile Type
Maximum Length:80
Job Profile Code -
JobSetCode: string
Title:
Job Set Code
Maximum Length:80
Job Set Code -
LocationCode: string
Title:
Location Code
Maximum Length:80
Location Code -
LocationSetCode: string
Title:
Location Set Code
Maximum Length:80
Location Set Code -
OtherQualification: string
Maximum Length:
80
Competency, license or certification, or language value for the selected qualification type for the workload. -
OtherQualificationType: string
Maximum Length:
80
Competency, license or certification, or language used to define the Other Qualification value for workload. -
PositionCode: string
Title:
Position Code
Maximum Length:80
Code that uniquely identifies the HCM position used to identify the workload import record. -
SchedulingGroupCode: string
Maximum Length:
80
Code that uniquely identifies the HCM scheduling group used to identify the workload import record. -
ShiftTypeCode: string
Code for the shift type, such as Regular or On-Call.
-
ShiftTypeExtendedCode: string
Maximum Length:
80
Code used to describe the shift type. -
StartDate: string
(date)
Title:
Start Date
Start Date -
StartTime: string
Maximum Length:
80
Start Time -
WorkloadType: string
Title:
Workload Type
Maximum Length:30
Workload Type -
WorkloadUOM: string
Title:
Workload UOM Code
Maximum Length:30
UOM Code -
WorkloadValue: number
Title:
Workload Value
Workload Value
Response
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 : workloadPlans-item-response
Type:
Show Source
object
-
BusinessUnitName: string
Title:
Business Unit Name
Maximum Length:80
Business Unit Name -
DepartmentName: string
Maximum Length:
80
Name of the schedule department. -
EndAfterMidnightFlag: boolean
Indicates whether the workload plan ends after midnight.
-
EndDate: string
(date)
Title:
End Date
End Date -
EndTime: string
Maximum Length:
80
End Time -
JobCode: string
Maximum Length:
80
Code that uniquely identifies the HCM job used to identify the workload import record. -
JobFamilyCode: string
Maximum Length:
80
Code that uniquely identifies the HCM job family used to identify the workload import record. -
JobProfileType: string
Title:
Job Profile Type
Maximum Length:80
Job Profile Code -
JobSetCode: string
Title:
Job Set Code
Maximum Length:80
Job Set Code -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationCode: string
Title:
Location Code
Maximum Length:80
Location Code -
LocationSetCode: string
Title:
Location Set Code
Maximum Length:80
Location Set Code -
OtherQualification: string
Maximum Length:
80
Competency, license or certification, or language value for the selected qualification type for the workload. -
OtherQualificationType: string
Maximum Length:
80
Competency, license or certification, or language used to define the Other Qualification value for workload. -
PositionCode: string
Title:
Position Code
Maximum Length:80
Code that uniquely identifies the HCM position used to identify the workload import record. -
SchedulingGroupCode: string
Maximum Length:
80
Code that uniquely identifies the HCM scheduling group used to identify the workload import record. -
ShiftTypeCode: string
Code for the shift type, such as Regular or On-Call.
-
ShiftTypeExtendedCode: string
Maximum Length:
80
Code used to describe the shift type. -
StartDate: string
(date)
Title:
Start Date
Start Date -
StartTime: string
Maximum Length:
80
Start Time -
WorkloadPlanCode: string
Title:
Workload Plan Code
Maximum Length:30
Workload Plan Code -
WorkloadPlanId: integer
(int64)
Title:
Workload Plan Identifier
Workload Plan ID -
WorkloadType: string
Title:
Workload Type
Maximum Length:30
Workload Type -
WorkloadUOM: string
Title:
Workload UOM Code
Maximum Length:30
UOM Code -
WorkloadValue: number
Title:
Workload Value
Workload Value
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.