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
Maximum Length:
80
Business Unit Name -
CompetencyCode: string
Maximum Length:
80
Competency Name -
DepartmentCode: string
Maximum Length:
80
Department Name -
EndAfterMidnightFlag: boolean
End After Midnight Flag
-
EndDate: string
(date)
End Date
-
EndTime: string
Maximum Length:
255
End Time -
JobProfileCode: string
Maximum Length:
80
Job Profile Code -
JobProfileId: integer
Job Profile ID
-
JobProfileType: string
Maximum Length:
80
Job Profile Type Code -
JobSetCode: string
Maximum Length:
80
Job Set Code -
LocationCode: string
Maximum Length:
80
Location Code -
LocationSetCode: string
Maximum Length:
80
Location Set Code -
SchedUnitId: integer
(int64)
Schedule Unit ID
-
SkillId: integer
(int64)
Skill ID
-
StartAfterMidnightFlag: boolean
Start After Midnight Flag
-
StartDate: string
(date)
Start Date
-
StartTime: string
Maximum Length:
255
Start Time -
WorkloadType: string
Maximum Length:
30
Workload Type Code -
WorkloadUOM: string
Maximum Length:
30
UOM Code -
WorkloadValue: number
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
Maximum Length:
80
Business Unit Name -
CompetencyCode: string
Maximum Length:
80
Competency Name -
DepartmentCode: string
Maximum Length:
80
Department Name -
EndAfterMidnightFlag: boolean
End After Midnight Flag
-
EndDate: string
(date)
End Date
-
EndTime: string
Maximum Length:
255
End Time -
JobProfileCode: string
Maximum Length:
80
Job Profile Code -
JobProfileId: integer
Job Profile ID
-
JobProfileType: string
Maximum Length:
80
Job Profile Type Code -
JobSetCode: string
Maximum Length:
80
Job Set Code -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationCode: string
Maximum Length:
80
Location Code -
LocationSetCode: string
Maximum Length:
80
Location Set Code -
SchedUnitId: integer
(int64)
Schedule Unit ID
-
SkillId: integer
(int64)
Skill ID
-
StartAfterMidnightFlag: boolean
Start After Midnight Flag
-
StartDate: string
(date)
Start Date
-
StartTime: string
Maximum Length:
255
Start Time -
WorkloadPlanCode: string
Maximum Length:
30
Workload Plan Code -
WorkloadPlanId: integer
(int64)
Workload Plan ID
-
WorkloadType: string
Maximum Length:
30
Workload Type Code -
WorkloadUOM: string
Maximum Length:
30
UOM Code -
WorkloadValue: number
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.