Update a calculation card association
patch
/hcmRestApi/resources/11.13.18.05/calculationEntries/{DirCardId}/child/CIRComponent/{CIRComponentUniqID}/child/CIRComponentAssociation/{CIRComponentAssociationUniqID}
Request
Path Parameters
-
CIRComponentAssociationUniqID(required): string
This is the hash key of the attributes which make up the composite key--- DirRepCardId, EffectiveStartDate and EffectiveEndDate ---for the Calculation Card Component Associations resource and used to uniquely identify an instance of Calculation Card Component Associations. The client should not generate the hash key value. Instead, the client should query on the Calculation Card Component Associations collection resource with a filter on the primary key values in order to navigate to a specific instance of Calculation Card Component Associations.
For example: CIRComponentAssociation?q=DirRepCardId=<value1>;EffectiveStartDate=<value2>;EffectiveEndDate=<value3> -
CIRComponentUniqID(required): string
This is the hash key of the attributes which make up the composite key--- EffectiveStartDate, EffectiveEndDate and DirCardCompId ---for the Calculation Card Component resource and used to uniquely identify an instance of Calculation Card Component. The client should not generate the hash key value. Instead, the client should query on the Calculation Card Component collection resource with a filter on the primary key values in order to navigate to a specific instance of Calculation Card Component.
For example: CIRComponent?q=EffectiveStartDate=<value1>;EffectiveEndDate=<value2>;DirCardCompId=<value3> -
DirCardId(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
-
Effective-Of: string
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: string
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: string
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-
CIRComponentAssociationDetails: array
Calculation Card Component Association Details
Title:
Calculation Card Component Association DetailsThe CIRComponentAssociationDetails resource returns details of the calculation card association. -
DirCardCompId: integer
(int64)
Title:
Component Base NameUnique identifier for the calculation card component. -
EffectiveEndDate: string
(date)
Effective end date of the calculation card association.
-
EffectiveStartDate: string
(date)
Effective start date of the calculation card association.
-
GUID: string
GUID for the component association.
-
LegisCode: string
Legislation code for component association.
-
ObjectVersionNumber: integer
(int32)
Current object version number for the calculation card component association.
-
PayrollStatUnitId: integer
Payroll statutory unit ID.
-
SourceSystemId: string
Source system identifier for component association.
-
SourceSystemOwner: string
Source system owner for component association.
-
TaxGroupName: string
Maximum Length:
255Tax group name of the calculation card association. -
TaxUnitId: integer
(int64)
Title:
Tax Reporting UnitTax unit ID of the calculation card association. -
TruBatchId: string
Maximum Length:
80Tax reporting unit batch ID.
Nested Schema : Calculation Card Component Association Details
Type:
arrayTitle:
Calculation Card Component Association DetailsThe CIRComponentAssociationDetails resource returns details of the calculation card association.
Show Source
Nested Schema : schema
Type:
Show Source
object-
AssignmentNumber: string
Maximum Length:
255Assignment number of the calculation card association. -
DirCardCompId: integer
(int64)
Title:
Component Base NameUnique identifier of the calculation card for component association details. -
EffectiveEndDate: string
(date)
Effective end date of the calculation card association details.
-
EffectiveStartDate: string
(date)
Effective start date of the calculation card association details.
-
GUID: string
GUID for component association details.
-
LegisCode: string
Legislation code for component association details.
-
ObjectVersionNumber: integer
(int32)
Current object version number for the calculation card component association details.
-
RelationshipGroupId: integer
(int64)
Title:
Employment Terms NumberRelationship group ID. -
SourceSystemId: string
Source system identifier for component association details.
-
SourceSystemOwner: string
Source system owner for component association details.
-
TierIndicator: string
Maximum Length:
255Tier Indicator for the calculation card association details. -
WorkAtHome: string
Maximum Length:
255Work at home status of the employee assignment.
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 : calculationEntries-CIRComponent-CIRComponentAssociation-item-response
Type:
Show Source
object-
AssociableTru: string
Read Only:
trueMaximum Length:30Associated tax reporting units for component association. -
BaseComponentName: string
Read Only:
trueMaximum Length:80Base component name of the calculation card association. -
BaseDisplayName: string
Read Only:
trueMaximum Length:80Base display name of the calculation card association. -
CIRComponentAssociationDetails: array
Calculation Card Component Association Details
Title:
Calculation Card Component Association DetailsThe CIRComponentAssociationDetails resource returns details of the calculation card association. -
ComponentName: string
Read Only:
trueMaximum Length:80Component name of calculation card association. -
CreatedBy: string
Read Only:
trueMaximum Length:64Name of the person who created the calculation card component association. -
CreationDate: string
(date-time)
Read Only:
trueCreation date of the calculation card component association. -
DirCardCompDefId: integer
(int64)
Read Only:
trueDefinition ID of the calculation card component for component association. -
DirCardCompId: integer
(int64)
Title:
Component Base NameUnique identifier for the calculation card component. -
DirCardDefinitionId: integer
(int64)
Read Only:
trueDefinition ID of the calculation card for component association. -
DirCardId: integer
(int64)
Title:
Calculation Card NameUnique identifier for the calculation card for component association. -
DirRepCardId: integer
(int64)
Unique identifier for the reporting card.
-
DisplayName: string
Read Only:
trueMaximum Length:80Display name of the calculation card association. -
EffectiveEndDate: string
(date)
Effective end date of the calculation card association.
-
EffectiveStartDate: string
(date)
Effective start date of the calculation card association.
-
GUID: string
GUID for the component association.
-
LastUpdateDate: string
(date-time)
Read Only:
trueLast updated date of the calculation card component association. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Name of the person who last updated the calculation card component association. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Last update login of the calculation card component association. -
LegisCode: string
Legislation code for component association.
-
LegislationDiscriminator: string
Read Only:
trueLegislation discriminator for the component association. -
LegislativeDataGroupId: integer
(int64)
Read Only:
trueLegislation data group ID. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Current object version number for the calculation card component association.
-
PayrollStatUnitId: integer
Payroll statutory unit ID.
-
SourceSystemId: string
Source system identifier for component association.
-
SourceSystemOwner: string
Source system owner for component association.
-
TaxGroupName: string
Maximum Length:
255Tax group name of the calculation card association. -
TaxUnitId: integer
(int64)
Title:
Tax Reporting UnitTax unit ID of the calculation card association. -
TruBatchId: string
Maximum Length:
80Tax reporting unit batch ID.
Nested Schema : Calculation Card Component Association Details
Type:
arrayTitle:
Calculation Card Component Association DetailsThe CIRComponentAssociationDetails resource returns details of the calculation card association.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : calculationEntries-CIRComponent-CIRComponentAssociation-CIRComponentAssociationDetails-item-response
Type:
Show Source
object-
AssignmentNumber: string
Maximum Length:
255Assignment number of the calculation card association. -
AssociableTru: string
Read Only:
trueMaximum Length:30Associated tax reporting units for component association details. -
BaseComponentName: string
Read Only:
trueMaximum Length:80Base component name of the calculation card association for component association details. -
BaseDisplayName: string
Read Only:
trueMaximum Length:80Base display name of the calculation card association for component association details. -
ComponentName: string
Read Only:
trueMaximum Length:80Component name of the calculation card association. -
CreatedBy: string
Read Only:
trueMaximum Length:64Name of the person who created the calculation card component association details. -
CreationDate: string
(date-time)
Read Only:
trueCreation date of the calculation card component association details. -
DirCardCompDefId: integer
(int64)
Read Only:
trueDefinition ID of the calculation card component for component association details. -
DirCardCompId: integer
(int64)
Title:
Component Base NameUnique identifier of the calculation card for component association details. -
DirCardDefinitionId: integer
(int64)
Read Only:
trueDefinition ID of the calculation card for component association details. -
DirCardId: integer
(int64)
Read Only:
trueCalculation card identifier. -
DirRepCardId: integer
(int64)
Unique identifier for the reporting card for component association details.
-
DirRepCardUsageId: integer
(int64)
Unique identifier for the reporting card usage.
-
DisplayName: string
Read Only:
trueMaximum Length:80Display name of the calculation card association for component association details. -
EffectiveEndDate: string
(date)
Effective end date of the calculation card association details.
-
EffectiveStartDate: string
(date)
Effective start date of the calculation card association details.
-
GUID: string
GUID for component association details.
-
LastUpdateDate: string
(date-time)
Read Only:
trueLast updated date of the calculation card component association details. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Name of the person who last updated the calculation card component association details. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Last update login of the calculation card component association details. -
LegisCode: string
Legislation code for component association details.
-
LegislationDiscriminator: string
Read Only:
trueLegislation discriminator for component association details. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Current object version number for the calculation card component association details.
-
PayrollRelationshipId: integer
(int64)
Read Only:
truePayroll relationship ID of the employee for component association details. -
RelationshipGroupId: integer
(int64)
Title:
Employment Terms NumberRelationship group ID. -
SourceSystemId: string
Source system identifier for component association details.
-
SourceSystemOwner: string
Source system owner for component association details.
-
TierIndicator: string
Maximum Length:
255Tier Indicator for the calculation card association details. -
WorkAtHome: string
Maximum Length:
255Work at home status of the employee assignment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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
- CIRComponentAssociationDetails
-
Parameters:
- CIRComponentAssociationUniqID:
$request.path.CIRComponentAssociationUniqID - CIRComponentUniqID:
$request.path.CIRComponentUniqID - DirCardId:
$request.path.DirCardId
The CIRComponentAssociationDetails resource returns details of the calculation card association. - CIRComponentAssociationUniqID: