Update an assignment work measure
patch
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/workMeasures/{workMeasuresUniqID}
Request
Path Parameters
-
PeriodOfServiceId(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=
-
assignmentsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AssignmentId, EffectiveStartDate, EffectiveEndDate, EffectiveSequence and EffectiveLatestChange ---for the Assignments resource and used to uniquely identify an instance of Assignments. The client should not generate the hash key value. Instead, the client should query on the Assignments collection resource with a filter on the primary key values in order to navigate to a specific instance of Assignments.
For example: assignments?q=AssignmentId=<value1>;EffectiveStartDate=<value2>;EffectiveEndDate=<value3>;EffectiveSequence=<value4>;EffectiveLatestChange=<value5> -
workMeasuresUniqID(required): string
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=
-
workersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Workers resource and used to uniquely identify an instance of Workers. The client should not generate the hash key value. Instead, the client should query on the Workers collection resource in order to navigate to a specific instance of Workers to get the hash key.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActionCode: string
Title:
Action Code
Action being performed on the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV. -
CalculateWorkmeasureFlag: boolean
Title:
Calculate FTE and Headcount Automatically
Maximum Length:30
Indicates whether the full time equivalency (FTE) should be calculated automatically. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
End date of the date-effective changes to the record. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Start date of the date-effective changes to the record. -
ReasonCode: string
Title:
Reason Code
Reason for the change.Valid values are defined in the actionReasonsLOV. -
Value: number
Title:
Value
Value of the work measure.
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 : workers-workRelationships-assignments-workMeasures-item-response
Type:
Show Source
object
-
ActionCode: string
Title:
Action Code
Action being performed on the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV. -
AssignWorkMeasureId: integer
(int64)
Title:
Assignment Work Measure ID
Read Only:true
Surrogate identifier for the assignment work measure. -
CalculateWorkmeasureFlag: boolean
Title:
Calculate FTE and Headcount Automatically
Maximum Length:30
Indicates whether the full time equivalency (FTE) should be calculated automatically. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the work measure. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the work measure was created. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
End date of the date-effective changes to the record. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Start date of the date-effective changes to the record. -
LastUpdateDate: string
(date-time)
Title:
Last Changed Date
Read Only:true
Date and time when the work measure was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the work measure. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReasonCode: string
Title:
Reason Code
Reason for the change.Valid values are defined in the actionReasonsLOV. -
Unit: string
Title:
Unit
Maximum Length:30
Unit of measure. Valid values are defined in the commonLookupsLOV. -
UnitMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of the person's unit code. -
Value: number
Title:
Value
Value of the work measure.
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
- actionReasonsLOV
-
Parameters:
- finder:
findByActionId%3BActionId%3D{ActionId}
The following properties are defined on the LOV link relation:- Source Attribute: ReasonCode; Target Attribute: ActionReasonCode
- Display Attribute: ActionReason
- finder:
- actionsLOV
-
Operation: /hcmRestApi/resources/11.13.18.05/actionsLOVThe following properties are defined on the LOV link relation:
- Source Attribute: ActionCode; Target Attribute: ActionCode
- Display Attribute: ActionName
- unitsLOV
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupType%3DBUDGET_MEASUREMENT_TYPE%2CLegislationCode%3D{LegislationCode}%2CLookupCode%3D{Unit}
The following properties are defined on the LOV link relation:- Source Attribute: Unit; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: