Jump to

• Request
• Response

Get overrides of all calculation card components

get

/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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds all the calculation card overrides that match the specified primary key criteria.
    Finder Variables
    • DirCardCompDrId; integer; Calculation card component date range ID used to find the component date range by primary key.
    • EffectiveEndDate; string; Effective end date based on primary key for component date ranges.
    • EffectiveStartDate; string; Effective start date based on primary key for component date ranges.
  • findByEffectiveDatedFinder Finds all calculation card overrides based on the effective dated indicator.
    Finder Variables
    • pCIRMode; string;
    • pEffectiveDate; string;
    • pRole; string;
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • BaseClassificationName; string; Base classification name for component date ranges.
  • BaseComponentName; string; Base component name of the calculation card component for component date ranges.
  • BaseDeductionGroupName; string; Base deduction group name of the calculation card component for component date ranges.
  • CardEffectiveEndDate; string; Effective end date of the calculation card for component date ranges.
  • CardEffectiveStartDate; string; Effective start date of the calculation card for component date ranges.
  • CardLevel; string; Card level for component date ranges.
  • CardSequence; integer; Card sequence of the calculation card for component date ranges.
  • ClassificationId; number; Classification ID of the calculation card component for component date ranges.
  • ComponentDiscriminator; string; Discriminator for the calculation card component.
  • ComponentSequence; integer; Sequence value of the calculation card component for component date ranges.
  • Context1; string; Reference Value 1 for component date ranges.
  • Context2; string; Reference Value 2 for component date ranges.
  • Context3; string; Reference Value 3 for component date ranges.
  • Context4; string; Reference Value 4 for component date ranges.
  • Context5; string; Reference Value 5 for component date ranges.
  • Context6; string; Reference Value 6 for component date ranges.
  • DeductionGroupId; integer; Deduction group ID of the calculation card component for component date ranges.
  • DeductionGroupName; string; Deduction group name of the calculation card component for component date ranges.
  • DirCardCompDefId; integer; Definition ID of the calculation card component for component date ranges.
  • DirCardCompDefName; string; Definition name of the calculation card component for component date ranges.
  • DirCardCompDrId; integer; Unique identifier for the calculation card component date range.
  • DirCardCompId; integer; ID of the calculation card component.
  • DirCardDefinitionBaseName; string; Definition base name of the calculation card for component date ranges.
  • DirCardDefinitionId; integer; Definition ID of the calculation card for component date ranges.
  • DirCardDefinitionName; string; Definition name of the calculation card for component date ranges.
  • DirCardId; integer; Unique identifier of the calculation card for component date ranges.
  • EffectiveEndDate; string; Effective end date of calculation card component override.
  • EffectiveStartDate; string; Effective start date of the calculation card component override.
  • ElementTypeId; integer; Element type ID of the calculation card component for component date ranges.
  • GroupBaseComponentName; string; Group base component name of the calculation card component for component date ranges.
  • GroupComponentName; string; Group 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.
  • LegislativeDataGroupId; integer; Legislative data group ID of the employee payroll relationship for component date ranges.
  • LegislativeDataGroupName; string; Legislative data group name of the employee payroll relationship for component date ranges.
  • LevelCode; string; Level code for component date ranges.
  • ParentDirCardCompDefId; integer; Component definition ID of the calculation card components parent component for component date ranges.
  • ParentDirCardCompId; integer; Component ID of calculation card components parent component.
  • RangeEndDate; string; 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; Range start date for component date ranges.
  • SecBaseClassificationName; string; Secondary 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; Payroll relationship ID of the employee for component date ranges.
  • SourceType; string; Type of source associated with the calculation card component date range.
  • Subpriority; integer; Subpriority of the calculation card component date range.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

Back to Top

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.

Body ()

Root Schema : calculationEntries-CIRComponent-CIRComponentDateRanges

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/calculationEntries-CIRComponent-CIRComponentDateRanges-item-response"
            },
            "x-cardinality":"1"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object calculationEntries-CIRComponent-CIRComponentDateRanges-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/calculationEntries-CIRComponent-CIRComponentDateRanges-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : calculationEntries-CIRComponent-CIRComponentDateRanges-item-response

Type: object

Show Source

• 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: 160

  Base classification name for component date ranges.
• BaseComponentName: string
  Maximum Length: 80

  Base component name of the calculation card component for component date ranges.
• BaseComponentNameFilter: string
  Base component filter.
• BaseDeductionGroupName: string
  Maximum Length: 240

  Base 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: 30

  Card 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: 255

  Discriminator for the calculation card component.
• ComponentSequence: integer (int64)
  Sequence value of the calculation card component for component date ranges.
• Context1: string
  Maximum Length: 150

  Reference Value 1 for component date ranges.
• Context2: string
  Maximum Length: 150

  Reference Value 2 for component date ranges.
• Context3: string
  Maximum Length: 150

  Reference Value 3 for component date ranges.
• Context4: string
  Maximum Length: 150

  Reference Value 4 for component date ranges.
• Context5: string
  Maximum Length: 150

  Reference Value 5 for component date ranges.
• Context6: string
  Maximum Length: 150

  Reference 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: 240

  Deduction 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: 80

  Definition 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: 80

  Definition 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: 80

  Definition 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: 80

  Group base component name of the calculation card component for component date ranges.
• GroupComponentName: string
  Maximum Length: 80

  Group 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: N

  Ignore 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: 240

  Legislative data group name of the employee payroll relationship for component date ranges.
• LevelCode: string
  Maximum Length: 30

  Level code for component date ranges.
• links: array Links
  Title: Links

  The 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: 160

  Secondary 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: 30

  Type 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.

{
    "type":"object",
    "properties":{
        "AssignmentId":{
            "type":"integer",
            "description":"Assignment ID of the employee for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadForeignIntegration":"Assignment;AssignmentId;PER_ALL_ASSIGNMENTS_M;ASSIGNMENT_ID",
                "ForeignVOAttributeName":"AssignmentId",
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.registrations.publicView.PayrollAssignmentPVO\",\"findByAssignmentNumber\",\"AssignmentNumber:pAssignmentNumber\",\"findByAssignmentId\",\"AssignmentId:pAssignmentId\");",
                "DLoadSpreadsheetHideAttribute":"true"
            }
        },
        "AssignmentNumber":{
            "type":"string",
            "description":"Assignment number of the employee for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PAY_VIEW_PAYROLL_RELATIONSHIP_DATA__PAY_REL_GROUPS_DN__PayrollAssignmentPEO",
                "DLoadLOVReturnAttributes":"AssignmentNumber",
                "DLoadLOVDisplayAttributes":"[AssignmentNumber]",
                "DLoadCIRAttributeTableAndColumn":"PAY_REL_GROUPS_DN.ASSIGNMENT_NUMBER",
                "DLoadCIRAttributeWhereClause":"PAY_REL_GROUPS_DN.GROUP_TYPE = 'A';PAY_REL_GROUPS_DN.PAYROLL_RELATIONSHIP_ID = PAY_CIR_CARD_COMPONENTS_DR_VL.SOURCE_ID",
                "HcmComparable":"True",
                "DLoadLOVViewDefName":"oracle.apps.hcm.payrolls.registrations.publicView.PayrollAssignmentPVO",
                "DLoadCIRDependentAttributeWhereClause":"PayrollRelationshipNumber:PAY_REL_GROUPS_DN.PAYROLL_RELATIONSHIP_ID = PAY_PAY_RELATIONSHIPS_DN.PAYROLL_RELATIONSHIP_ID",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PAY_VIEW_PAYROLL_RELATIONSHIP_DATA__PAY_REL_GROUPS_DN__PayrollAssignmentPEO"
            }
        },
        "AttributeCheckSum":{
            "type":"string",
            "description":"Check sum of the attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "BaseClassificationName":{
            "maxLength":160,
            "type":"string",
            "description":"Base classification name for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "BaseComponentName":{
            "maxLength":80,
            "type":"string",
            "description":"Base component name of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "BaseComponentNameFilter":{
            "type":"string",
            "description":"Base component filter.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "BaseDeductionGroupName":{
            "maxLength":240,
            "type":"string",
            "description":"Base deduction group name of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "CIREffectiveDate":{
            "type":"string",
            "description":"Effective start date of the calculation card component for component date ranges.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "DLoadHidden":"true"
            }
        },
        "CIRMode":{
            "type":"string",
            "description":"Represents the current mode of the card component.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "CardEffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of the calculation card for component date ranges.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "CardEffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the calculation card for component date ranges.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "CardLevel":{
            "maxLength":30,
            "type":"string",
            "description":"Card level for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "CardSequence":{
            "type":"integer",
            "description":"Card sequence of the calculation card for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClassificationId":{
            "type":"number",
            "description":"Classification ID of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "ComponentDiscriminator":{
            "maxLength":255,
            "type":"string",
            "description":"Discriminator for the calculation card component.",
            "nullable":true,
            "x-hints":{
                "DLoadCIRRestVoName":"oracle.apps.hcm.payrolls.cir.service.common.bo.view.DIRCardComponentExtendedBO",
                "DLoadCIRElementClassificationRestVoName":"oracle.apps.hcm.payrolls.cir.service.common.helper.view.CIRComponentElementClassificationVO",
                "DLoadHidden":"true",
                "dependencies":[
                    "CIREffectiveDate",
                    "Context1",
                    "Context2",
                    "Context3",
                    "Context4",
                    "Context5",
                    "Context6",
                    "DirCardCompDefId"
                ]
            },
            "x-queryable":true
        },
        "ComponentSequence":{
            "type":"integer",
            "description":"Sequence value of the calculation card component for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "Context1":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 1 for component date ranges.",
            "nullable":true,
            "x-queryable":true
        },
        "Context2":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 2 for component date ranges.",
            "nullable":true,
            "x-queryable":true
        },
        "Context3":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 3 for component date ranges.",
            "nullable":true,
            "x-queryable":true
        },
        "Context4":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 4 for component date ranges.",
            "nullable":true,
            "x-queryable":true
        },
        "Context5":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 5 for component date ranges.",
            "nullable":true,
            "x-queryable":true
        },
        "Context6":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 6 for component date ranges.",
            "nullable":true,
            "x-queryable":true
        },
        "DeductionGroupId":{
            "type":"integer",
            "description":"Deduction group ID of the calculation card component for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DLoadCIRRestVoName":"oracle.apps.hcm.payrolls.cir.service.common.helper.view.CIRComponentDeductionGroupVO",
                "precision":18,
                "DLoadHidden":"true",
                "dependencies":[
                    "DirCardDefinitionBaseName",
                    "DirCardDefinitionId"
                ]
            },
            "x-queryable":true
        },
        "DeductionGroupName":{
            "maxLength":240,
            "type":"string",
            "description":"Deduction group name of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "DirCardCompDefId":{
            "type":"integer",
            "description":"Definition ID of the calculation card component for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DLoadCIRRestVoName":"oracle.apps.hcm.payrolls.cir.service.common.helper.view.CIRComponentDefVO",
                "precision":18,
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.view.DIRCardCompDefVO\",\"DirCardCompDefName:ComponentName;LegislativeDataGroupId;DirCardDefinitionId\",\"DirCardCompDefId\");",
                "dependencies":[
                    "BaseComponentNameFilter",
                    "DeductionGroupId",
                    "IgnoreTUContextComps",
                    "Role"
                ]
            },
            "x-queryable":true
        },
        "DirCardCompDefName":{
            "maxLength":80,
            "type":"string",
            "description":"Definition name of the calculation card component for component date ranges.",
            "nullable":true,
            "x-queryable":true
        },
        "DirCardCompDrId":{
            "type":"integer",
            "description":"Unique identifier for the calculation card component date range.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.ComponentDirCardCompDrIdHelper\");",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DirCardCompId":{
            "type":"integer",
            "description":"ID of the calculation card component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.ComponentDirCardCompIdHelper\");"
            },
            "x-queryable":true
        },
        "DirCardDefinitionBaseName":{
            "maxLength":80,
            "type":"string",
            "description":"Definition base name of the calculation card for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "DirCardDefinitionId":{
            "type":"integer",
            "description":"Definition ID of the calculation card for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.view.DIRCardDefinitionVO\",\"DirCardDefinitionName:DisplayName;LegislativeDataGroupId:LegislativeDataGroupId\",\"DirCardDefinitionId:DirCardDefinitionId\");"
            },
            "x-queryable":true
        },
        "DirCardDefinitionName":{
            "maxLength":80,
            "type":"string",
            "description":"Definition name of the calculation card for component date ranges.",
            "nullable":true,
            "x-queryable":true
        },
        "DirCardId":{
            "type":"integer",
            "description":"Unique identifier of the calculation card for component date ranges.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DynamicAttributeNames":{
            "type":"string",
            "description":"Attribute names of the calculation card component for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true",
                "HcmComparable":"True"
            }
        },
        "DynamicData":{
            "type":"string",
            "description":"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",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "DynamicDataDetails":{
            "type":"string",
            "description":"DynamicDataDetails is the read-oriented metadata or value representation. It tells the consumer which dynamic override attributes are available for the calculation card component",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of calculation card component override.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the calculation card component override.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ElementTypeId":{
            "type":"integer",
            "description":"Element type ID of the calculation card component for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "GUID":{
            "type":"string",
            "description":"GUID for component date ranges.",
            "nullable":true,
            "x-queryable":false
        },
        "GroupBaseComponentName":{
            "maxLength":80,
            "type":"string",
            "description":"Group base component name of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "GroupComponentName":{
            "maxLength":80,
            "type":"string",
            "description":"Group component name of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "GroupDirCardCompDefId":{
            "type":"integer",
            "description":"Group component definition ID of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "IgnoreCompsWithoutOvdOrFlexes":{
            "type":"string",
            "description":"Ignore calculation card components without overrides.",
            "nullable":true,
            "default":"N",
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "IgnoreTUContextComps":{
            "type":"string",
            "description":"Indicates whether calculation card components with tax unit context are ignored for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Legislative data group ID of the employee payroll relationship for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true",
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.view.LegislativeDataGroupVO\",\"LegislativeDataGroupName:Name\",\"LegislativeDataGroupId:LegislativeDataGroupId\");"
            },
            "x-queryable":true
        },
        "LegislativeDataGroupName":{
            "maxLength":240,
            "type":"string",
            "description":"Legislative data group name of the employee payroll relationship for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PER_CHOOSE_LEGISLATIVE_DATA_GROUP_DATA__PER_LEGISLATIVE_DATA_GROUPS__LegislativeDataGroupPEO",
                "DLoadLOVReturnAttributes":"Name",
                "DLoadLOVDisplayAttributes":"[Name]",
                "DLoadLOVViewDefName":"oracle.apps.hcm.legislativeDataGroups.publicView.LegislativeDataGroupPVO",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PER_CHOOSE_LEGISLATIVE_DATA_GROUP_DATA__PER_LEGISLATIVE_DATA_GROUPS__LegislativeDataGroupPEO"
            },
            "x-queryable":true
        },
        "LevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Level code for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "OverrideFlexAttributeDetails":{
            "type":"string",
            "description":"Overrides attribute details of the calculation card component.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "ParentDirCardCompDefId":{
            "type":"integer",
            "description":"Component definition ID of the calculation card components parent component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "ParentDirCardCompId":{
            "type":"integer",
            "description":"Component ID of calculation card components parent component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "PayrollRelationshipId":{
            "type":"integer",
            "description":"Payroll Relationship ID of the employee.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "PayrollRelationshipNumber":{
            "type":"string",
            "description":"Payroll relationship number of the employee for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PAY_VIEW_PAYROLL_RELATIONSHIP_DATA__PAY_PAY_RELATIONSHIPS_DN__PayrollRelationshipPEO",
                "DLoadLOVReturnAttributes":"PayrollRelationshipNumber",
                "DLoadLOVDisplayAttributes":"[PayrollRelationshipNumber]",
                "DLoadCIRAttributeTableAndColumn":"PAY_PAY_RELATIONSHIPS_DN.PAYROLL_RELATIONSHIP_NUMBER",
                "DLoadCIRAttributeWhereClause":"PAY_PAY_RELATIONSHIPS_DN.PAYROLL_RELATIONSHIP_ID = PAY_CIR_CARD_COMPONENTS_DR_VL.SOURCE_ID",
                "HcmComparable":"True",
                "DLoadLOVViewDefName":"oracle.apps.hcm.payrolls.registrations.publicView.PayrollRelationshipPVO",
                "DLoadCIRDependentAttributeWhereClause":"AssignmentNumber:PAY_REL_GROUPS_DN.PAYROLL_RELATIONSHIP_ID = PAY_PAY_RELATIONSHIPS_DN.PAYROLL_RELATIONSHIP_ID",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PAY_VIEW_PAYROLL_RELATIONSHIP_DATA__PAY_PAY_RELATIONSHIPS_DN__PayrollRelationshipPEO"
            }
        },
        "PayrollStatUnitId":{
            "type":"integer",
            "description":"Payroll statutory unit ID for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "PayrollStatutoryUnitName":{
            "type":"string",
            "description":"Name of the payroll statutory unit for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PAY_CHOOSE_PAYROLL_STATUTORY_UNIT_DATA__HR_ALL_ORGANIZATION_UNITS_F__QRSLT",
                "DLoadLOVReturnAttributes":"Name",
                "DLoadLOVDisplayAttributes":"[Name]",
                "DLoadCIRAttributeTableAndColumn":"XLE_ENTITY_PROFILES.NAME",
                "DLoadCIRAttributeWhereClause":"XLE_ENTITY_PROFILES.LEGAL_ENTITY_ID=HR_ALL_ORGANIZATION_UNITS_F_VL.LEGAL_ENTITY_ID AND HR_ALL_ORGANIZATION_UNITS_F_VL.ORGANIZATION_ID=HR_ORG_UNIT_CLASSIFICATIONS_F.ORGANIZATION_ID AND HR_ORG_UNIT_CLASSIFICATIONS_F.CLASSIFICATION_CODE='HCM_PSU' AND HR_ORG_UNIT_CLASSIFICATIONS_F.STATUS='A' AND HR_ALL_ORGANIZATION_UNITS_F_VL.ORGANIZATION_ID=PAY_CIR_CARDS_VL.SOURCE_ID AND PAY_CIR_CARDS_VL.SOURCE_TYPE='PSU'",
                "DLoadCIRAttributeTables":"HR_ALL_ORGANIZATION_UNITS_F_VL;HR_ORG_UNIT_CLASSIFICATIONS_F",
                "DLoadLOVViewDefName":"oracle.apps.hcm.common.pay.publicView.parameters.PayrollStatutoryUnitPVO",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PAY_CHOOSE_PAYROLL_STATUTORY_UNIT_DATA__HR_ALL_ORGANIZATION_UNITS_F__QRSLT"
            }
        },
        "RangeEndDate":{
            "type":"string",
            "description":"Range end date for component date ranges.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "RangeMode":{
            "type":"string",
            "description":"RangeMode controls certain date effective behavior for the update or delete of component date ranges.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "RangeStartDate":{
            "type":"string",
            "description":"Range start date for component date ranges.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "Role":{
            "type":"string",
            "description":"Role of the user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "SecBaseClassificationName":{
            "maxLength":160,
            "type":"string",
            "description":"Secondary base classification name of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "SecondaryClassificationId":{
            "type":"number",
            "description":"Secondary classification ID of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "SourceId":{
            "type":"integer",
            "description":"Payroll relationship ID of the employee for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true",
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.CardSourceIdHelper\");"
            },
            "x-queryable":true
        },
        "SourceSystemId":{
            "type":"string",
            "description":"Source system identifier for component date ranges.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystemOwner":{
            "type":"string",
            "description":"Source system owner for component date ranges.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of source associated with the calculation card component date range.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "Subpriority":{
            "type":"integer",
            "description":"Subpriority of the calculation card component date range.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "SystemPersonType":{
            "type":"string",
            "description":"System person type for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "TaxReportingUnitName":{
            "type":"string",
            "description":"Tax reporting unit name assigned to the calculation card for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PAY_CHOOSE_TAX_REPORTING_UNIT_DATA__HR_ALL_ORGANIZATION_UNITS_F__QRSLT",
                "DLoadLOVReturnAttributes":"TruName",
                "DLoadLOVDisplayAttributes":"[TruName]",
                "DLoadCIRAttributeTableAndColumn":"XLE_ETB_PROFILES.NAME",
                "DLoadCIRAttributeWhereClause":"XLE_ETB_PROFILES.ESTABLISHMENT_ID = HR_ALL_ORGANIZATION_UNITS_F_VL.ESTABLISHMENT_ID AND HR_ALL_ORGANIZATION_UNITS_F_VL.ORGANIZATION_ID = HR_ORG_UNIT_CLASSIFICATIONS_F.ORGANIZATION_ID AND HR_ORG_UNIT_CLASSIFICATIONS_F.CLASSIFICATION_CODE = 'HCM_TRU' AND HR_ORG_UNIT_CLASSIFICATIONS_F.STATUS = 'A' AND HR_ALL_ORGANIZATION_UNITS_F_VL.ORGANIZATION_ID=PAY_CIR_CARDS_VL.SOURCE_ID AND PAY_CIR_CARDS_VL.SOURCE_TYPE='TRU'",
                "DLoadCIRAttributeTables":"HR_ALL_ORGANIZATION_UNITS_F_VL;HR_ORG_UNIT_CLASSIFICATIONS_F",
                "DLoadLOVViewDefName":"oracle.apps.hcm.common.pay.publicView.parameters.TaxReportingUnitPVO",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PAY_CHOOSE_TAX_REPORTING_UNIT_DATA__HR_ALL_ORGANIZATION_UNITS_F__QRSLT"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top