REST API for Oracle Fusion Cloud HCM

Get a cost allocation.

get

/hcmRestApi/resources/11.13.18.05/assignmentCosting/{assignmentCostingUniqID}

Request

Path Parameters

assignmentCostingUniqID(required): string

This is the hash key of the attributes which make up the composite key--- CostAllocationId, EffectiveEndDate and EffectiveStartDate ---for the Cost Allocations for Payroll Assignment resource and used to uniquely identify an instance of Cost Allocations for Payroll Assignment. The client should not generate the hash key value. Instead, the client should query on the Cost Allocations for Payroll Assignment collection resource with a filter on the primary key values in order to navigate to a specific instance of Cost Allocations for Payroll Assignment.

For example: assignmentCosting?q=CostAllocationId=<value1>;EffectiveEndDate=<value2>;EffectiveStartDate=<value3>

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>
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
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
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

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 : assignmentCosting-item-response

Type: object

Show Source

AssignmentNumber: string

Title: Assignment Number

Maximum Length: 30

Assignment number of the cost allocation record.
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)

Read Only: true

Cost allocation identifier for 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.
LegislativeDataGroupName: string

Title: Name

Maximum Length: 240

Legislative data group name of the cost allocation record.
links: array Links

Title: Links

The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"Effective start date of the cost allocation record.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CostAllocationId":{
            "type":"integer",
            "description":"Cost allocation identifier for the cost allocation record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LegislativeDataGroupName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Legislative data group name of the cost allocation record.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":30,
            "type":"string",
            "description":"Assignment number of the cost allocation record.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CostAllocationAccounts":{
            "title":"Cost Allocation Accounts",
            "type":"array",
            "description":"The CostAllocationAccounts resource provides details of individual costing segments of the respective costing levels of the given cost allocations.",
            "items":{
                "$ref":"#/components/schemas/assignmentCosting-CostAllocationAccounts-item-response"
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Effective end date of the cost allocation record.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        }
    }
}

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

Array of: object assignmentCosting-CostAllocationAccounts-item-response

{
    "title":"Cost Allocation Accounts",
    "type":"array",
    "description":"The CostAllocationAccounts resource provides details of individual costing segments of the respective costing levels of the given cost allocations.",
    "items":{
        "$ref":"#/components/schemas/assignmentCosting-CostAllocationAccounts-item-response"
    }
}

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 : assignmentCosting-CostAllocationAccounts-item-response

Type: object

Show Source

CostAllocAccountId: integer (int64)

Read Only: true

Cost allocation account identifier for the cost allocation account record.
links: array Links

Title: Links

The link relations associated with the resource instance.
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.

{
    "type":"object",
    "properties":{
        "Segment4":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 4 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment3":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 3 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment6":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 6 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment5":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 5 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment8":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 8 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment7":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 7 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment9":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 9 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment19":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 19 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment18":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 18 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment17":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 17 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment16":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 16 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Proportion":{
            "title":"Percentage",
            "type":"number",
            "description":"Proportion of the cost allocation account record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":22,
                "scale":10
            },
            "x-queryable":true
        },
        "Segment11":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 11 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment10":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 10 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Segment30":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 30 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment15":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 15 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment14":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 14 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment13":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 13 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment12":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 12 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CostAllocAccountId":{
            "type":"integer",
            "description":"Cost allocation account identifier for the cost allocation account record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "Segment29":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 29 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment28":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 28 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment27":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 27 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment2":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 2 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment1":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 1 of the cost allocation account key flexfield.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment22":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 22 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment21":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 21 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment20":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 20 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment26":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 26 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment25":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 25 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment24":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 24 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Segment23":{
            "maxLength":60,
            "type":"string",
            "description":"Segment 23 of the cost allocation account key flexfield record.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        }
    }
}

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."
        }
    }
}

Links

CostAllocationAccounts

Operation: /hcmRestApi/resources/11.13.18.05/assignmentCosting/{assignmentCostingUniqID}/child/CostAllocationAccounts

Parameters:

assignmentCostingUniqID: $request.path.assignmentCostingUniqID

The CostAllocationAccounts resource provides details of individual costing segments of the respective costing levels of the given cost allocations.