Update a cost allocation.
patch
/hcmRestApi/resources/11.13.18.05/costings/{ObjectKey}
Request
Path Parameters
-
ObjectKey(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
genericCosting: array
Cost Allocations
Title:
Cost Allocations
The costAllocations resource provides details, such as effective start date, effective date, costing level identifier, legislative data group of costing levels. -
ObjectKey: string
Unique attribute used to create the service for calling all costing REST resources.
Nested Schema : Cost Allocations
Type:
array
Title:
Cost Allocations
The costAllocations resource provides details, such as effective start date, effective date, costing level identifier, legislative data group of costing levels.
Show Source
Nested Schema : costings-genericCosting-item-patch-request
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.
-
CreatorId: integer
(int64)
Unique identifier for the person who created the cost allocation record.
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Effective start date of the cost allocation record. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Effective end date of the cost allocation record. -
GUID: string
Global user identifier 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.
-
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. -
SourceSystemId: string
Source system identifier for the cost allocation record.
-
SourceSystemOwner: string
Source system owner 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 : schema
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
-
GUID: string
Global user identifier of the cost allocation account record.
-
IdFlexNum: integer
(int64)
Flexfield number identifier for the cost allocation account record.
-
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-patch-request" } }
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-patch-request
Type:
Show Source
object
-
_PAY_COST_StructureInstanceNumber: integer
(int64)
Default Value:
4001
-
CostAllocAccountId: integer
(int64)
-
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
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 : costings-item-response
Type:
Show Source
object
-
genericCosting: array
Cost Allocations
Title:
Cost Allocations
The costAllocations resource provides details, such as effective start date, effective date, costing level identifier, legislative data group of costing levels. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectKey: string
Unique attribute used to create the service for calling all costing REST resources.
Nested Schema : Cost Allocations
Type:
array
Title:
Cost Allocations
The costAllocations resource provides details, such as effective start date, effective date, costing level identifier, legislative data group of costing levels.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : costings-genericCosting-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.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Details of the person who created the cost allocation record. -
CreationDate: string
(date-time)
Read Only:
true
Creation date of the cost allocation record. -
CreatorId: integer
(int64)
Unique identifier for the person who created the cost allocation record.
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Effective start date of the cost allocation record. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Effective end date of the cost allocation record. -
GUID: string
Global user identifier of the cost allocation record.
-
HistoryComments: string
Maximum Length:
80
Comment set on the last update of the cost allocation record. -
LastUpdateDate: string
(date-time)
Read Only:
true
Last updated date of the cost allocation record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Person who last updated the cost allocation record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Last updated login 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. -
SourceSystemId: string
Source system identifier for the cost allocation record.
-
SourceSystemOwner: string
Source system owner 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 : costings-genericCosting-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
- genericCosting
-
Parameters:
- ObjectKey:
$request.path.ObjectKey
The costAllocations resource provides details, such as effective start date, effective date, costing level identifier, legislative data group of costing levels. - ObjectKey: