Get all cost allocations.
get
/hcmRestApi/resources/11.13.18.05/positionCostingInEmploymentProcesses
Request
Query Parameters
-
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 cost allocations by its primary key.
Finder Variables- CostAllocationId; integer; Search term criteria to find cost allocation based on the cost allocation identifier.
- EffectiveEndDate; string; Search term criteria to find the cost allocations based on the effective end date.
- EffectiveStartDate; string; Search term criteria to find cost allocations based on the effective start date.
- findByCostAllocationId Finds cost allocations by cost allocation identifier.
Finder Variables- CostAllocationId; integer; Search term criteria to find cost allocation based on the cost allocation identifier.
- SysEffectiveDate; object;
- findByLegislativeDataGroupIdSourceId Finds a cost allocation by source and legislative data group identifier.
Finder Variables- LegislativeDataGroupId; integer; Search term criteria to find cost allocation for the given legislative data group in find by legislative data group and source identifier.
- SourceId; integer; Search term criteria to find cost allocation for the given source identifier.
- SysEffectiveDate; object;
- PrimaryKey Finds cost allocations by its primary key.
-
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:- CostAllocationId; integer; Cost allocation identifier for the cost allocation record.
- CostAllocationRecordId; integer; Cost allocation record identifier for the cost allocation record.
- EffectiveEndDate; string; Effective end date of the cost allocation record.
- EffectiveStartDate; string; Effective start date of the cost allocation record.
- HistoryComments; string; Comment set on the last update of the cost allocation record.
- LegislativeDataGroupId; integer; Legislative data group identifier for the cost allocation record.
- ObjectVersionNumber; integer; Current object version number for the cost allocation record.
- PayrollRelationshipId; integer; Payroll relationship identifier for the cost allocation record.
- SourceId; integer; Source identifier for the cost allocation record.
- SourceType; string; Source type for the cost allocation record.
- SysEffectiveDate; string; System effective date for the cost allocation record.
-
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:
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.
There's no request body for this operation.
Back to TopResponse
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 : positionCostingInEmploymentProcesses
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : positionCostingInEmploymentProcesses-item-response
Type:
Show Source
object
-
costAllocationAccounts: array
Cost Allocation Accounts
Title:
Cost Allocation Accounts
The CostAllocationAccounts resource provides details of individual costing segments of the respective costing levels of the given cost allocations. -
CostAllocationId: integer
(int64)
Cost allocation identifier for the cost allocation record.
-
CostAllocationRecordId: integer
(int64)
Cost allocation record identifier for the cost allocation record.
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Effective end date of the cost allocation record. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Effective start date of the cost allocation record. -
HistoryComments: string
Maximum Length:
80
Comment set on the last update of the cost allocation record. -
LegislativeDataGroupId: integer
(int64)
Legislative data group identifier for the cost allocation record.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Current object version number for the cost allocation record.
-
PayrollRelationshipId: integer
(int64)
Payroll relationship identifier for the cost allocation record.
-
SourceId: integer
(int64)
Title:
Element Cost Allocations
Source identifier for the cost allocation record. -
SourceType: string
Maximum Length:
30
Source type for the cost allocation record. -
SysEffectiveDate: string
(date)
System effective date for the cost allocation record.
Nested Schema : Cost Allocation Accounts
Type:
array
Title:
Cost Allocation Accounts
The CostAllocationAccounts resource provides details of individual costing segments of the respective costing levels of the given cost allocations.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : positionCostingInEmploymentProcesses-costAllocationAccounts-item-response
Type:
Show Source
object
-
CostAllocAccountId: integer
(int64)
Cost allocation account identifier for the cost allocation account record.
-
CostAllocationKeyflexId: integer
(int64)
Cost allocation key flexfield identifier for the cost allocation account record.
-
CostAllocationRecordId: integer
(int64)
Cost allocation record identifier for the cost allocation account record.
-
CostPartialKff: array
CostPartialKff
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Name of the person that created the cost allocation record. -
CreationDate: string
(date-time)
Read Only:
true
Creation date of the cost allocation account record. -
GUID: string
Global user identifier of the cost allocation account record.
-
IdFlexNum: integer
(int64)
Flexfield number identifier for the cost allocation account record.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Last update date for the cost allocation account record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Details of the person who last updated the cost allocation account record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Last update login for the cost allocation account record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Current object version number of the cost allocation account record.
-
Proportion: number
Title:
Percentage
Proportion of the cost allocation account record. -
Segment1: string
Maximum Length:
60
Segment 1 of the cost allocation account key flexfield. -
Segment10: string
Maximum Length:
60
Segment 10 of the cost allocation account key flexfield record. -
Segment11: string
Maximum Length:
60
Segment 11 of the cost allocation account key flexfield record. -
Segment12: string
Maximum Length:
60
Segment 12 of the cost allocation account key flexfield record. -
Segment13: string
Maximum Length:
60
Segment 13 of the cost allocation account key flexfield record. -
Segment14: string
Maximum Length:
60
Segment 14 of the cost allocation account key flexfield record. -
Segment15: string
Maximum Length:
60
Segment 15 of the cost allocation account key flexfield record. -
Segment16: string
Maximum Length:
60
Segment 16 of the cost allocation account key flexfield record. -
Segment17: string
Maximum Length:
60
Segment 17 of the cost allocation account key flexfield record. -
Segment18: string
Maximum Length:
60
Segment 18 of the cost allocation account key flexfield record. -
Segment19: string
Maximum Length:
60
Segment 19 of the cost allocation account key flexfield record. -
Segment2: string
Maximum Length:
60
Segment 2 of the cost allocation account key flexfield record. -
Segment20: string
Maximum Length:
60
Segment 20 of the cost allocation account key flexfield record. -
Segment21: string
Maximum Length:
60
Segment 21 of the cost allocation account key flexfield record. -
Segment22: string
Maximum Length:
60
Segment 22 of the cost allocation account key flexfield record. -
Segment23: string
Maximum Length:
60
Segment 23 of the cost allocation account key flexfield record. -
Segment24: string
Maximum Length:
60
Segment 24 of the cost allocation account key flexfield record. -
Segment25: string
Maximum Length:
60
Segment 25 of the cost allocation account key flexfield record. -
Segment26: string
Maximum Length:
60
Segment 26 of the cost allocation account key flexfield record. -
Segment27: string
Maximum Length:
60
Segment 27 of the cost allocation account key flexfield record. -
Segment28: string
Maximum Length:
60
Segment 28 of the cost allocation account key flexfield record. -
Segment29: string
Maximum Length:
60
Segment 29 of the cost allocation account key flexfield record. -
Segment3: string
Maximum Length:
60
Segment 3 of the cost allocation account key flexfield record. -
Segment30: string
Maximum Length:
60
Segment 30 of the cost allocation account key flexfield record. -
Segment4: string
Maximum Length:
60
Segment 4 of the cost allocation account key flexfield record. -
Segment5: string
Maximum Length:
60
Segment 5 of the cost allocation account key flexfield record. -
Segment6: string
Maximum Length:
60
Segment 6 of the cost allocation account key flexfield record. -
Segment7: string
Maximum Length:
60
Segment 7 of the cost allocation account key flexfield record. -
Segment8: string
Maximum Length:
60
Segment 8 of the cost allocation account key flexfield record. -
Segment9: string
Maximum Length:
60
Segment 9 of the cost allocation account key flexfield record. -
SourceSubType: string
Maximum Length:
30
Source subtype of the cost allocation account record. -
SourceSystemId: string
Source system identifier of the cost allocation account record.
-
SourceSystemOwner: string
System owner identifier of the cost allocation account record.
-
SubTypeSequence: integer
(int64)
Subtype sequence of the cost allocation account record.
Nested Schema : CostPartialKff
Type:
Show Source
array
-
Array of:
object Discriminator: _PAY_COST_StructureInstanceNumber
Discriminator:
{ "propertyName":"_PAY_COST_StructureInstanceNumber", "mapping":{ "4001":"#/components/schemas/oracle_apps_hcm_payrolls_costs_flex_partial_view_CostPartialKffCRFL__5FPAYROLL__5FCOST__5FFLEX__5FINSVO-item-response" } }
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Discriminator: _PAY_COST_StructureInstanceNumber
Type:
object
Discriminator: _PAY_COST_StructureInstanceNumber
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_payrolls_costs_flex_partial_view_CostPartialKffCRFL__5FPAYROLL__5FCOST__5FFLEX__5FINSVO-item-response
Type:
Show Source
object
-
_PAY_COST_StructureInstanceNumber: integer
(int64)
Default Value:
4001
-
CostAllocAccountId: integer
(int64)
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
payrollAccount: string
Title:
Payroll_Account
Maximum Length:60
-
payrollCompany: string
Title:
Payroll_Company
Maximum Length:60
-
payrollDepartment: string
Title:
Payroll_Department
Maximum Length:60
-
payrollProduct: string
Title:
Payroll_Product
Maximum Length:60
-
payrollSubAccount: string
Title:
Payroll_Sub-Account
Maximum Length:60
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
- futureRecordExists
-
Operation: /hcmRestApi/resources/11.13.18.05/positionCostingInEmploymentProcesses/action/futureRecordExistsFinds future costing records for the specified legislative data group and position.
- pastRecordExists
-
Operation: /hcmRestApi/resources/11.13.18.05/positionCostingInEmploymentProcesses/action/pastRecordExistsFinds past costing records for the specified legislative data group and position.