Create overrides for the calculation card component
post
/hcmRestApi/resources/11.13.18.05/calculationEntries/{DirCardId}/child/CIRComponent/{CIRComponentUniqID}/child/CIRComponentDateRanges
Request
Path Parameters
-
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.
-
Upsert-Mode: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
AssignmentId: integer
Assignment ID of the employee for component date ranges.
-
AssignmentNumber: string
Assignment number of the employee for component date ranges.
-
AttributeCheckSum: string
Check sum of the attribute.
-
BaseClassificationName: string
Maximum Length:
160Base classification name for component date ranges. -
BaseComponentName: string
Maximum Length:
80Base component name of the calculation card component for component date ranges. -
BaseComponentNameFilter: string
Base component filter.
-
BaseDeductionGroupName: string
Maximum Length:
240Base deduction group name of the calculation card component for component date ranges. -
CardEffectiveEndDate: string
(date)
Effective end date of the calculation card for component date ranges.
-
CardEffectiveStartDate: string
(date)
Effective start date of the calculation card for component date ranges.
-
CardLevel: string
Maximum Length:
30Card level for component date ranges. -
CardSequence: integer
(int64)
Card sequence of the calculation card for component date ranges.
-
CIREffectiveDate: string
(date)
Effective start date of the calculation card component for component date ranges.
-
CIRMode: string
Represents the current mode of the card component.
-
ClassificationId: number
Classification ID of the calculation card component for component date ranges.
-
ComponentDiscriminator: string
Maximum Length:
255Discriminator for the calculation card component. -
ComponentSequence: integer
(int64)
Sequence value of the calculation card component for component date ranges.
-
Context1: string
Maximum Length:
150Reference Value 1 for component date ranges. -
Context2: string
Maximum Length:
150Reference Value 2 for component date ranges. -
Context3: string
Maximum Length:
150Reference Value 3 for component date ranges. -
Context4: string
Maximum Length:
150Reference Value 4 for component date ranges. -
Context5: string
Maximum Length:
150Reference Value 5 for component date ranges. -
Context6: string
Maximum Length:
150Reference Value 6 for component date ranges. -
DeductionGroupId: integer
(int64)
Deduction group ID of the calculation card component for component date ranges.
-
DeductionGroupName: string
Maximum Length:
240Deduction group name of the calculation card component for component date ranges. -
DirCardCompDefId: integer
(int64)
Definition ID of the calculation card component for component date ranges.
-
DirCardCompDefName: string
Maximum Length:
80Definition name of the calculation card component for component date ranges. -
DirCardCompDrId: integer
(int64)
Unique identifier for the calculation card component date range.
-
DirCardCompId: integer
(int64)
ID of the calculation card component.
-
DirCardDefinitionBaseName: string
Maximum Length:
80Definition base name of the calculation card for component date ranges. -
DirCardDefinitionId: integer
(int64)
Definition ID of the calculation card for component date ranges.
-
DirCardDefinitionName: string
Maximum Length:
80Definition name of the calculation card for component date ranges. -
DirCardId: integer
(int64)
Unique identifier of the calculation card for component date ranges.
-
DynamicAttributeNames: string
Attribute names of the calculation card component for component date ranges.
-
DynamicData: string
DynamicData is the write oriented attribute. Consumers pass a JSON string where each key identifies the calculation card components override attribute to create or change the value
-
DynamicDataDetails: string
DynamicDataDetails is the read-oriented metadata or value representation. It tells the consumer which dynamic override attributes are available for the calculation card component
-
EffectiveEndDate: string
(date)
Effective end date of calculation card component override.
-
EffectiveStartDate: string
(date)
Effective start date of the calculation card component override.
-
ElementTypeId: integer
(int64)
Element type ID of the calculation card component for component date ranges.
-
GroupBaseComponentName: string
Maximum Length:
80Group base component name of the calculation card component for component date ranges. -
GroupComponentName: string
Maximum Length:
80Group component name of the calculation card component for component date ranges. -
GroupDirCardCompDefId: integer
Group component definition ID of the calculation card component for component date ranges.
-
GUID: string
GUID for component date ranges.
-
IgnoreCompsWithoutOvdOrFlexes: string
Default Value:
NIgnore calculation card components without overrides. -
IgnoreTUContextComps: string
Indicates whether calculation card components with tax unit context are ignored for component date ranges.
-
LegislativeDataGroupId: integer
(int64)
Legislative data group ID of the employee payroll relationship for component date ranges.
-
LegislativeDataGroupName: string
Maximum Length:
240Legislative data group name of the employee payroll relationship for component date ranges. -
LevelCode: string
Maximum Length:
30Level code for component date ranges. -
OverrideFlexAttributeDetails: string
Overrides attribute details of the calculation card component.
-
ParentDirCardCompDefId: integer
Component definition ID of the calculation card components parent component for component date ranges.
-
ParentDirCardCompId: integer
(int64)
Component ID of calculation card components parent component.
-
PayrollRelationshipId: integer
Payroll Relationship ID of the employee.
-
PayrollRelationshipNumber: string
Payroll relationship number of the employee for component date ranges.
-
PayrollStatUnitId: integer
Payroll statutory unit ID for component date ranges.
-
PayrollStatutoryUnitName: string
Name of the payroll statutory unit for component date ranges.
-
RangeEndDate: string
(date)
Range end date for component date ranges.
-
RangeMode: string
RangeMode controls certain date effective behavior for the update or delete of component date ranges.
-
RangeStartDate: string
(date)
Range start date for component date ranges.
-
Role: string
Role of the user.
-
SecBaseClassificationName: string
Maximum Length:
160Secondary base classification name of the calculation card component for component date ranges. -
SecondaryClassificationId: number
Secondary classification ID of the calculation card component for component date ranges.
-
SourceId: integer
(int64)
Payroll relationship ID of the employee for component date ranges.
-
SourceSystemId: string
Source system identifier for component date ranges.
-
SourceSystemOwner: string
Source system owner for component date ranges.
-
SourceType: string
Maximum Length:
30Type of source associated with the calculation card component date range. -
Subpriority: integer
Subpriority of the calculation card component date range.
-
SystemPersonType: string
System person type for component date ranges.
-
TaxReportingUnitName: string
Tax reporting unit name assigned to the calculation card for component date ranges.
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-CIRComponentDateRanges-item-response
Type:
Show Source
object-
AssignmentId: integer
Assignment ID of the employee for component date ranges.
-
AssignmentNumber: string
Assignment number of the employee for component date ranges.
-
AttributeCheckSum: string
Check sum of the attribute.
-
BaseClassificationName: string
Maximum Length:
160Base classification name for component date ranges. -
BaseComponentName: string
Maximum Length:
80Base component name of the calculation card component for component date ranges. -
BaseComponentNameFilter: string
Base component filter.
-
BaseDeductionGroupName: string
Maximum Length:
240Base deduction group name of the calculation card component for component date ranges. -
CardEffectiveEndDate: string
(date)
Effective end date of the calculation card for component date ranges.
-
CardEffectiveStartDate: string
(date)
Effective start date of the calculation card for component date ranges.
-
CardLevel: string
Maximum Length:
30Card level for component date ranges. -
CardSequence: integer
(int64)
Card sequence of the calculation card for component date ranges.
-
CIREffectiveDate: string
(date)
Effective start date of the calculation card component for component date ranges.
-
CIRMode: string
Represents the current mode of the card component.
-
ClassificationId: number
Classification ID of the calculation card component for component date ranges.
-
ComponentDiscriminator: string
Maximum Length:
255Discriminator for the calculation card component. -
ComponentSequence: integer
(int64)
Sequence value of the calculation card component for component date ranges.
-
Context1: string
Maximum Length:
150Reference Value 1 for component date ranges. -
Context2: string
Maximum Length:
150Reference Value 2 for component date ranges. -
Context3: string
Maximum Length:
150Reference Value 3 for component date ranges. -
Context4: string
Maximum Length:
150Reference Value 4 for component date ranges. -
Context5: string
Maximum Length:
150Reference Value 5 for component date ranges. -
Context6: string
Maximum Length:
150Reference Value 6 for component date ranges. -
DeductionGroupId: integer
(int64)
Deduction group ID of the calculation card component for component date ranges.
-
DeductionGroupName: string
Maximum Length:
240Deduction group name of the calculation card component for component date ranges. -
DirCardCompDefId: integer
(int64)
Definition ID of the calculation card component for component date ranges.
-
DirCardCompDefName: string
Maximum Length:
80Definition name of the calculation card component for component date ranges. -
DirCardCompDrId: integer
(int64)
Unique identifier for the calculation card component date range.
-
DirCardCompId: integer
(int64)
ID of the calculation card component.
-
DirCardDefinitionBaseName: string
Maximum Length:
80Definition base name of the calculation card for component date ranges. -
DirCardDefinitionId: integer
(int64)
Definition ID of the calculation card for component date ranges.
-
DirCardDefinitionName: string
Maximum Length:
80Definition name of the calculation card for component date ranges. -
DirCardId: integer
(int64)
Unique identifier of the calculation card for component date ranges.
-
DynamicAttributeNames: string
Attribute names of the calculation card component for component date ranges.
-
DynamicData: string
DynamicData is the write oriented attribute. Consumers pass a JSON string where each key identifies the calculation card components override attribute to create or change the value
-
DynamicDataDetails: string
DynamicDataDetails is the read-oriented metadata or value representation. It tells the consumer which dynamic override attributes are available for the calculation card component
-
EffectiveEndDate: string
(date)
Effective end date of calculation card component override.
-
EffectiveStartDate: string
(date)
Effective start date of the calculation card component override.
-
ElementTypeId: integer
(int64)
Element type ID of the calculation card component for component date ranges.
-
GroupBaseComponentName: string
Maximum Length:
80Group base component name of the calculation card component for component date ranges. -
GroupComponentName: string
Maximum Length:
80Group component name of the calculation card component for component date ranges. -
GroupDirCardCompDefId: integer
Group component definition ID of the calculation card component for component date ranges.
-
GUID: string
GUID for component date ranges.
-
IgnoreCompsWithoutOvdOrFlexes: string
Default Value:
NIgnore calculation card components without overrides. -
IgnoreTUContextComps: string
Indicates whether calculation card components with tax unit context are ignored for component date ranges.
-
LegislativeDataGroupId: integer
(int64)
Legislative data group ID of the employee payroll relationship for component date ranges.
-
LegislativeDataGroupName: string
Maximum Length:
240Legislative data group name of the employee payroll relationship for component date ranges. -
LevelCode: string
Maximum Length:
30Level code for component date ranges. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OverrideFlexAttributeDetails: string
Overrides attribute details of the calculation card component.
-
ParentDirCardCompDefId: integer
Component definition ID of the calculation card components parent component for component date ranges.
-
ParentDirCardCompId: integer
(int64)
Component ID of calculation card components parent component.
-
PayrollRelationshipId: integer
Payroll Relationship ID of the employee.
-
PayrollRelationshipNumber: string
Payroll relationship number of the employee for component date ranges.
-
PayrollStatUnitId: integer
Payroll statutory unit ID for component date ranges.
-
PayrollStatutoryUnitName: string
Name of the payroll statutory unit for component date ranges.
-
RangeEndDate: string
(date)
Range end date for component date ranges.
-
RangeMode: string
RangeMode controls certain date effective behavior for the update or delete of component date ranges.
-
RangeStartDate: string
(date)
Range start date for component date ranges.
-
Role: string
Role of the user.
-
SecBaseClassificationName: string
Maximum Length:
160Secondary base classification name of the calculation card component for component date ranges. -
SecondaryClassificationId: number
Secondary classification ID of the calculation card component for component date ranges.
-
SourceId: integer
(int64)
Payroll relationship ID of the employee for component date ranges.
-
SourceSystemId: string
Source system identifier for component date ranges.
-
SourceSystemOwner: string
Source system owner for component date ranges.
-
SourceType: string
Maximum Length:
30Type of source associated with the calculation card component date range. -
Subpriority: integer
Subpriority of the calculation card component date range.
-
SystemPersonType: string
System person type for component date ranges.
-
TaxReportingUnitName: string
Tax reporting unit name assigned to the calculation card for component date ranges.
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.