REST API for Oracle Supply Chain Management Cloud

Get all child items that were rolled up

get

/fscmRestApi/resources/11.13.18.05/rollupChildItemCosts

Request

Query Parameters

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 a child item by the primary key.
  Finder Variables
  - Display; string; Unique identifier of the display attribute for the child item.
  - ResourceSequenceNumber; number; Unique identifier of the resource sequence number for the child item.
  - RollupHeaderKey; string; Unique identifier of the rollup header key for the child item.
  - RollupHeaderType; string; Unique identifier of the rollup header type for the child item.
  - ScenarioId; integer; Unique identifier of the scenario for the child item.
- getDetails Finds all rolled-up cost details.
  Finder Variables
  - BindParentRollupHeaderKey; string;
  - BindParentRollupScenarioId; integer;
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:
- AbsorptionType; string; Identifies the absorption type of the overhead rate details.
- AbsorptionTypeMeaning; string; Identifies the absorption type of the overhead rate details.
- AllocatedExtendedCost; string; Indicates the allocated rate multiplied by the usage scaled amount or the allocated material cost multiplied by the quantity scaled amount that takes into consideration the costing batch output size and basis type along with the material yield when applicable for sourcing rule level.
- AllocatedMaterialCost; string; Identifies the allocated cost of a material at the sourcing rule node.
- AllocatedOverheadCost; string; Identifies the allocated cost of an overhead at the sourcing rule node.
- AllocatedResourceCost; string; Identifies the allocated cost of a resource at the sourcing rule node.
- Allocation; number; Indicates the allocation of the sourcing rule for the rolled-up cost of the product.
- AssetValUnitId; integer; Indicates the unique identifier of the asset valuation unit
- BasisType; string; Indicates whether the item quantity is fixed (for example, quantity per lot produced) or variable (for example, quantity per item produced).
- BatchQuantity; string; Represents the quantity produced for the work definition. In process manufacturing, this is the batch quantity.
- BatchQuantityUOMCode; string; Represents the unit of measure code of the batch quantity.
- CostAllocationFixed; string; Captures the total of all the allocated unit cost for output at the operation level in process manufacturing.
- CostAllocationPercentage; number; Identifies the cost allocation percentage for an output item for a particular operation plus the cost allocation percentage for an output item for a prior operation for the output at the operation level in process manufacturing.
- CostAllocationSequence; number; Sequence of cost allocation for the output at the operation level in process manufacturing.
- CostOrgLevelCost; string; Identifies the cost of an item that's specified at the cost organization level and shared across plants. This is populated only for items where the valuation unit is at the cost organization level.
- CostUOMCode; string; Indicates the costing unit of measure code.
- CostUOMConversionFactor; number; Indicates the conversion factor for converting from the primary unit of measure to the costing unit of measure.
- CostUnitOfMeasure; string; Indicates the costing unit of measure.
- CostingBatchOutputSize; string; Indicates the costing batch output size for the work definition for which the snapshot is created.
- CostingQuantity; number; Represents the quantity in costing.
- CurrencyCode; string; Indicates the currency code in which the cost is stored.
- CurrencyExtendedPrecision; integer; Indicates the extended precision of the currency.
- CurrencyName; string; Indicates the currency name in which the cost is stored.
- CurrencyPrecision; integer; Indicates the precision of the currency.
- Display; string; Indicates the name of the input item, output item, operation, overhead, resource, and sourcing rule that will appear at their corresponding level.
- DisplaySequence; string; Indicates the sequence of the sourcing rule types.
- EnteredUnitCost; string; Identifies the manually entered unit cost. This can be buy or standard cost of a component, resource rate, or fixed output costs.
- ExtendedCost; string; Indicates the rate multiplied by the usage scaled amount or the material cost multiplied by the quantity scaled amount that takes into consideration the costing batch output size and basis type along with the material yield when applicable for each sourcing rule type.
- ExtractionDate; string; Indicates the date of creation of the sourcing rule.
- InventoryItemId; number; Indicates the unique identifier of the inventory item.
- ItemDescription; string; Indicates the description of the item.
- MaterialCost; string; Indicates the cumulative cost of a material for each sourcing rule type.
- OperationExtendedCost; number; Indicates the rate multiplied by the usage scaled amount or the material cost multiplied by the quantity scaled amount at an operation level.
- OperationReverseYieldFactor; number; Indicates the reverse cumulative yield factor for the operation.
- OperationSequenceNumber; number; Indicates the sequence of the operation in the work definition snapshot.
- OperationType; string; Specifies the type of the operation.
- OperationUnitCost; number; Indicates the rate multiplied by the usage amount or the material cost multiplied by the quantity amount at an operation level.
- OperationYieldFactor; number; Indicates the yield factor for the operation. The default value is 1 (100%). It's used by the cost rollup process for yield calculations.
- OrganizationId; number; Indicates the manufacturing plant where the work definition is created.
- OutputCost; string; Captures the total of all the allocated extended cost for output at the operation level in process manufacturing.
- OutputInventoryItemId; integer; Represents the unique identifier of the output item of an operation.
- OutputItem; string; Indicates item number of the output item.
- OutputSequenceNumber; number; Indicates the sequence of the output items.
- OutputType; string; Type of output produced by the operation.
- OverheadCost; string; Identifies the cumulative cost of an overhead for each sourcing rule type level.
- OverheadRate; string; Indicates the unit rate of the overhead that was applied by the rollup process.
- OverheadRateDetails; string; Indicates the category, item number, work center, and the type of resource associated with the overhead.
- ParentRollupHeaderKey; string; Surrogate parent key identifying the sourcing rule type.
- ParentRollupHeaderType; string; Indicates the type of the parent rollup header key.
- ParentRollupScenarioId; integer; Unique identifier of the scenario for the parent rollup header.
- PlantOrgName; string; Name of the inventory organization where the work definition of the item is set up.
- PostedIndicator; string; Indicates if the rolled up cost of an output item has been posted to the standard costs table for publishing. Not applicable for resource costs, component costs, or operation level costs.
- ProductionLineName; string; Indicates the production line name referenced in the flow manufacturing work definition.
- Quantity; number; Indicates the quantity of the material for the work definition.
- ReferenceType; string; Indicates the reference type of the rolled up cost.
- ResourceCost; string; Identifies the cumulative cost of a resource.
- ResourceSequenceNumber; number; Indicates the resource sequence for the resource under the work definition operation.
- RollupDate; string; Indicates the date when the cost was rolled up.
- RollupHeaderKey; string; Surrogate key identifying the sourcing rule type.
- RollupHeaderType; string; Indicates the type of the rollup header key.
- RollupHeaderTypeMeaning; string; Indicates the meaning of the rollup header key.
- RollupScenarioId; integer; Unique identifier of the scenario for the rollup header.
- RuleRank; number; Indicates the rank of the sourcing rule.
- RuleType; string; Identifies the type of the sourcing rule. Possible values are Buy from, Make at, and Transfer from.
- RunningTotal; string; Captures the running total of extended cost in process manufacturing as inputs are consumed and outputs are yielded.
- ScenarioId; integer; Unique identifier for each cost scenario.
- ScenarioNumber; string; Indicates the number of the cost scenario.
- ScenarioRollupHeaderId; integer; Indicates the surrogate identifier generated for rollup header rows.
- SourceId; number; Indicates the cost rollup derived source identifier of the input material cost or the resource rate linked to the rollup header row.
- SourceInvOrgId; number; Indicates the source organization identifier.
- SourceOrg; string; Indicates the name of the source organization.
- SourceType; string; Indicates the cost rollup derived source table linked to the rollup header.
- SourcingRuleId; number; Indicates the costing identifier for the sourcing rule.
- SourcingRuleName; string; Indicates the sourcing rule name.
- StatusCode; string; Indicates the status of the rollup header. Valid values are NOT_PROCESSED, SUCCESS, CHANGED, or an FND message name.
- Supplier; string; Indicates the supplier name of the transfer sourcing rule.
- SupplierSite; string; Indicates the supplier site of the transfer sourcing rule.
- TransferChargeRuleName; string; Indicates the name for the transfer sourcing rule.
- TransferCostRuleId; number; Indicates the key that uniquely identifies the transfer cost rule for cost rollup.
- UnitCost; string; Indicates the average per output amount calculated as EXTENDED_COST divided by COSTING_BATCH_OUTPUT_SIZE. It's the amount used for rolling up to the next level.
- UnitOfMeasure; string; Represents the unit of measure of the product.
- WorkDefinitionHeaderName; string; Indicates the name assigned to this work definition.
- WorkDefinitionItemId; integer; Identifies the manufacturing work definition identifier from which the work definition snapshot is created.
- WorkDefinitionName; string; Indicates the name of the work definition for which the snapshot is being created.
- WorkDefinitionOperationId; integer; Indicates the manufacturing work definition operation identifier. For CTO snapshot data, this identifier can be shared across different assemblies. Therefore it should only be used to reference the data.
- WorkMethodCode; string; Indicates the work method code of the manufacturing work definition of the product.
- WorkMethodName; string; Indicates the name of the work method.
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

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.

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 : rollupChildItemCosts

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":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "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."
        },
        "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"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/rollupChildItemCosts-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"InventoryManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object rollupChildItemCosts-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/rollupChildItemCosts-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 : rollupChildItemCosts-item-response

Type: object

Show Source

AbsorptionType: string

Read Only: true

Maximum Length: 30

Identifies the absorption type of the overhead rate details.
AbsorptionTypeMeaning: string

Read Only: true

Maximum Length: 80

Identifies the absorption type of the overhead rate details.
AllocatedExtendedCost: string

Read Only: true

Maximum Length: 40

Indicates the allocated rate multiplied by the usage scaled amount or the allocated material cost multiplied by the quantity scaled amount that takes into consideration the costing batch output size and basis type along with the material yield when applicable for sourcing rule level.
AllocatedMaterialCost: string

Read Only: true

Maximum Length: 40

Identifies the allocated cost of a material at the sourcing rule node.
AllocatedOverheadCost: string

Read Only: true

Maximum Length: 40

Identifies the allocated cost of an overhead at the sourcing rule node.
AllocatedResourceCost: string

Read Only: true

Maximum Length: 40

Identifies the allocated cost of a resource at the sourcing rule node.
Allocation: number

Read Only: true

Indicates the allocation of the sourcing rule for the rolled-up cost of the product.
AssetValUnitId: integer (int64)

Read Only: true

Indicates the unique identifier of the asset valuation unit
BasisType: string

Read Only: true

Maximum Length: 30

Indicates whether the item quantity is fixed (for example, quantity per lot produced) or variable (for example, quantity per item produced).
BatchQuantity: string

Read Only: true

Represents the quantity produced for the work definition. In process manufacturing, this is the batch quantity.
BatchQuantityUOMCode: string

Read Only: true

Represents the unit of measure code of the batch quantity.
CostAllocationFixed: string

Read Only: true

Maximum Length: 40

Captures the total of all the allocated unit cost for output at the operation level in process manufacturing.
CostAllocationPercentage: number

Read Only: true

Identifies the cost allocation percentage for an output item for a particular operation plus the cost allocation percentage for an output item for a prior operation for the output at the operation level in process manufacturing.
CostAllocationSequence: number

Read Only: true

Sequence of cost allocation for the output at the operation level in process manufacturing.
CostingBatchOutputSize: string

Read Only: true

Indicates the costing batch output size for the work definition for which the snapshot is created.
CostingQuantity: number

Read Only: true

Represents the quantity in costing.
CostOrgLevelCost: string

Read Only: true

Identifies the cost of an item that's specified at the cost organization level and shared across plants. This is populated only for items where the valuation unit is at the cost organization level.
CostUnitOfMeasure: string

Read Only: true

Maximum Length: 100

Indicates the costing unit of measure.
CostUOMCode: string

Read Only: true

Maximum Length: 12

Indicates the costing unit of measure code.
CostUOMConversionFactor: number

Read Only: true

Indicates the conversion factor for converting from the primary unit of measure to the costing unit of measure.
CurrencyCode: string

Read Only: true

Maximum Length: 60

Indicates the currency code in which the cost is stored.
CurrencyExtendedPrecision: integer (int32)

Read Only: true

Indicates the extended precision of the currency.
CurrencyName: string

Read Only: true

Maximum Length: 80

Indicates the currency name in which the cost is stored.
CurrencyPrecision: integer (int32)

Read Only: true

Indicates the precision of the currency.
Display: string

Read Only: true

Maximum Length: 1000

Indicates the name of the input item, output item, operation, overhead, resource, and sourcing rule that will appear at their corresponding level.
DisplaySequence: string

Read Only: true

Maximum Length: 2

Indicates the sequence of the sourcing rule types.
EnteredUnitCost: string

Read Only: true

Maximum Length: 40

Identifies the manually entered unit cost. This can be buy or standard cost of a component, resource rate, or fixed output costs.
ExtendedCost: string

Read Only: true

Maximum Length: 40

Indicates the rate multiplied by the usage scaled amount or the material cost multiplied by the quantity scaled amount that takes into consideration the costing batch output size and basis type along with the material yield when applicable for each sourcing rule type.
ExtractionDate: string (date)

Read Only: true

Indicates the date of creation of the sourcing rule.
InventoryItemId: number

Read Only: true

Indicates the unique identifier of the inventory item.
ItemDescription: string

Read Only: true

Maximum Length: 240

Indicates the description of the item.
links: array Links

Title: Links

The link relations associated with the resource instance.
MaterialCost: string

Read Only: true

Maximum Length: 40

Indicates the cumulative cost of a material for each sourcing rule type.
OperationExtendedCost: number

Read Only: true

Indicates the rate multiplied by the usage scaled amount or the material cost multiplied by the quantity scaled amount at an operation level.
OperationReverseYieldFactor: number

Read Only: true

Indicates the reverse cumulative yield factor for the operation.
OperationSequenceNumber: number

Read Only: true

Indicates the sequence of the operation in the work definition snapshot.
OperationType: string

Read Only: true

Maximum Length: 30

Specifies the type of the operation.
OperationUnitCost: number

Read Only: true

Indicates the rate multiplied by the usage amount or the material cost multiplied by the quantity amount at an operation level.
OperationYieldFactor: number

Read Only: true

Indicates the yield factor for the operation. The default value is 1 (100%). It's used by the cost rollup process for yield calculations.
OrganizationId: number

Read Only: true

Indicates the manufacturing plant where the work definition is created.
OutputCost: string

Read Only: true

Maximum Length: 40

Captures the total of all the allocated extended cost for output at the operation level in process manufacturing.
OutputInventoryItemId: integer (int64)

Read Only: true

Represents the unique identifier of the output item of an operation.
OutputItem: string

Read Only: true

Maximum Length: 300

Indicates item number of the output item.
OutputSequenceNumber: number

Read Only: true

Indicates the sequence of the output items.
OutputType: string

Read Only: true

Type of output produced by the operation.
OverheadCost: string

Read Only: true

Maximum Length: 40

Identifies the cumulative cost of an overhead for each sourcing rule type level.
OverheadRate: string

Read Only: true

Maximum Length: 40

Indicates the unit rate of the overhead that was applied by the rollup process.
OverheadRateDetails: string

Read Only: true

Maximum Length: 750

Indicates the category, item number, work center, and the type of resource associated with the overhead.
ParentRollupHeaderKey: string

Read Only: true

Maximum Length: 120

Surrogate parent key identifying the sourcing rule type.
ParentRollupHeaderType: string

Read Only: true

Maximum Length: 30

Indicates the type of the parent rollup header key.
ParentRollupScenarioId: integer (int64)

Read Only: true

Unique identifier of the scenario for the parent rollup header.
PlantOrgName: string

Read Only: true

Name of the inventory organization where the work definition of the item is set up.
PostedIndicator: string

Read Only: true

Maximum Length: 1

Indicates if the rolled up cost of an output item has been posted to the standard costs table for publishing. Not applicable for resource costs, component costs, or operation level costs.
ProductionLineName: string

Read Only: true

Maximum Length: 255

Indicates the production line name referenced in the flow manufacturing work definition.
Quantity: number

Read Only: true

Indicates the quantity of the material for the work definition.
ReferenceType: string

Read Only: true

Indicates the reference type of the rolled up cost.
ResourceCost: string

Read Only: true

Maximum Length: 40

Identifies the cumulative cost of a resource.
ResourceSequenceNumber: number

Read Only: true

Indicates the resource sequence for the resource under the work definition operation.
RollupDate: string (date)

Read Only: true

Indicates the date when the cost was rolled up.
RollupHeaderKey: string

Read Only: true

Maximum Length: 480

Surrogate key identifying the sourcing rule type.
RollupHeaderType: string

Read Only: true

Maximum Length: 30

Indicates the type of the rollup header key.
RollupHeaderTypeMeaning: string

Read Only: true

Maximum Length: 255

Indicates the meaning of the rollup header key.
RollupScenarioId: integer (int64)

Read Only: true

Unique identifier of the scenario for the rollup header.
RuleRank: number

Read Only: true

Indicates the rank of the sourcing rule.
RuleType: string

Read Only: true

Maximum Length: 80

Identifies the type of the sourcing rule. Possible values are Buy from, Make at, and Transfer from.
RunningTotal: string

Read Only: true

Maximum Length: 40

Captures the running total of extended cost in process manufacturing as inputs are consumed and outputs are yielded.
ScenarioId: integer

Read Only: true

Unique identifier for each cost scenario.
ScenarioNumber: string

Read Only: true

Maximum Length: 255

Indicates the number of the cost scenario.
ScenarioRollupHeaderId: integer (int64)

Read Only: true

Indicates the surrogate identifier generated for rollup header rows.
SourceId: number

Read Only: true

Indicates the cost rollup derived source identifier of the input material cost or the resource rate linked to the rollup header row.
SourceInvOrgId: number

Read Only: true

Indicates the source organization identifier.
SourceOrg: string

Read Only: true

Maximum Length: 260

Indicates the name of the source organization.
SourceType: string

Read Only: true

Maximum Length: 120

Indicates the cost rollup derived source table linked to the rollup header.
SourcingRuleCount: integer

Read Only: true

Indicates the sequence of the sourcing rule types.
SourcingRuleId: number

Read Only: true

Indicates the costing identifier for the sourcing rule.
SourcingRuleName: string

Read Only: true

Maximum Length: 80

Indicates the sourcing rule name.
StatusCode: string

Read Only: true

Maximum Length: 30

Indicates the status of the rollup header. Valid values are NOT_PROCESSED, SUCCESS, CHANGED, or an FND message name.
Supplier: string

Read Only: true

Maximum Length: 360

Indicates the supplier name of the transfer sourcing rule.
SupplierSite: string

Read Only: true

Maximum Length: 50

Indicates the supplier site of the transfer sourcing rule.
TransferChargeRuleName: string

Read Only: true

Maximum Length: 200

Indicates the name for the transfer sourcing rule.
TransferCostRuleId: number

Read Only: true

Indicates the key that uniquely identifies the transfer cost rule for cost rollup.
UnitCost: string

Read Only: true

Maximum Length: 40

Indicates the average per output amount calculated as EXTENDED_COST divided by COSTING_BATCH_OUTPUT_SIZE. It's the amount used for rolling up to the next level.
UnitOfMeasure: string

Read Only: true

Maximum Length: 25

Represents the unit of measure of the product.
WorkDefinitionHeaderName: string

Read Only: true

Maximum Length: 120

Indicates the name assigned to this work definition.
WorkDefinitionItemId: integer (int64)

Read Only: true

Identifies the manufacturing work definition identifier from which the work definition snapshot is created.
WorkDefinitionName: string

Read Only: true

Indicates the name of the work definition for which the snapshot is being created.
WorkDefinitionOperationId: integer (int64)

Read Only: true

Indicates the manufacturing work definition operation identifier. For CTO snapshot data, this identifier can be shared across different assemblies. Therefore it should only be used to reference the data.
WorkMethodCode: string

Read Only: true

Maximum Length: 30

Indicates the work method code of the manufacturing work definition of the product.
WorkMethodName: string

Read Only: true

Indicates the name of the work method.

{
    "type":"object",
    "properties":{
        "ParentRollupScenarioId":{
            "type":"integer",
            "description":"Unique identifier of the scenario for the parent rollup header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OperationReverseYieldFactor":{
            "type":"number",
            "description":"Indicates the reverse cumulative yield factor for the operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkMethodName":{
            "type":"string",
            "description":"Indicates the name of the work method.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupDate":{
            "type":"string",
            "description":"Indicates the date when the cost was rolled up.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceType":{
            "maxLength":"120",
            "type":"string",
            "description":"Indicates the cost rollup derived source table linked to the rollup header.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OutputItem":{
            "maxLength":"300",
            "type":"string",
            "description":"Indicates item number of the output item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransferCostRuleId":{
            "type":"number",
            "description":"Indicates the key that uniquely identifies the transfer cost rule for cost rollup.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the status of the rollup header. Valid values are NOT_PROCESSED, SUCCESS, CHANGED, or an FND message name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceType":{
            "type":"string",
            "description":"Indicates the reference type of the rolled up cost.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupHeaderTypeMeaning":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the meaning of the rollup header key.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OutputSequenceNumber":{
            "type":"number",
            "description":"Indicates the sequence of the output items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"60",
            "type":"string",
            "description":"Indicates the currency code in which the cost is stored.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OutputInventoryItemId":{
            "type":"integer",
            "description":"Represents the unique identifier of the output item of an operation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RollupScenarioId":{
            "type":"integer",
            "description":"Unique identifier of the scenario for the rollup header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CostingQuantity":{
            "type":"number",
            "description":"Represents the quantity in costing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkDefinitionOperationId":{
            "type":"integer",
            "description":"Indicates the manufacturing work definition operation identifier. For CTO snapshot data, this identifier can be shared across different assemblies. Therefore it should only be used to reference the data.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentRollupHeaderType":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of the parent rollup header key.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaterialCost":{
            "maxLength":"40",
            "type":"string",
            "description":"Indicates the cumulative cost of a material for each sourcing rule type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllocatedOverheadCost":{
            "maxLength":"40",
            "type":"string",
            "description":"Identifies the allocated cost of an overhead at the sourcing rule node.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OutputType":{
            "type":"string",
            "description":"Type of output produced by the operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrg":{
            "maxLength":"260",
            "type":"string",
            "description":"Indicates the name of the source organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllocatedMaterialCost":{
            "maxLength":"40",
            "type":"string",
            "description":"Identifies the allocated cost of a material at the sourcing rule node.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourcingRuleId":{
            "type":"number",
            "description":"Indicates the costing identifier for the sourcing rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":"25",
            "type":"string",
            "description":"Represents the unit of measure of the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceSequenceNumber":{
            "type":"number",
            "description":"Indicates the resource sequence for the resource under the work definition operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"number",
            "description":"Indicates the unique identifier of the inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RunningTotal":{
            "maxLength":"40",
            "type":"string",
            "description":"Captures the running total of extended cost in process manufacturing as inputs are consumed and outputs are yielded.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleType":{
            "maxLength":"80",
            "type":"string",
            "description":"Identifies the type of the sourcing rule. Possible values are Buy from, Make at, and Transfer from.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationExtendedCost":{
            "type":"number",
            "description":"Indicates the rate multiplied by the usage scaled amount or the material cost multiplied by the quantity scaled amount at an operation level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the number of the cost scenario.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleRank":{
            "type":"number",
            "description":"Indicates the rank of the sourcing rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostUOMConversionFactor":{
            "type":"number",
            "description":"Indicates the conversion factor for converting from the primary unit of measure to the costing unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AbsorptionTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Identifies the absorption type of the overhead rate details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransferChargeRuleName":{
            "maxLength":"200",
            "type":"string",
            "description":"Indicates the name for the transfer sourcing rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OverheadRateDetails":{
            "maxLength":"750",
            "type":"string",
            "description":"Indicates the category, item number, work center, and the type of resource associated with the overhead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "maxLength":"50",
            "type":"string",
            "description":"Indicates the supplier site of the transfer sourcing rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExtractionDate":{
            "type":"string",
            "description":"Indicates the date of creation of the sourcing rule.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "type":"number",
            "description":"Indicates the sequence of the operation in the work definition snapshot.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllocatedExtendedCost":{
            "maxLength":"40",
            "type":"string",
            "description":"Indicates the allocated rate multiplied by the usage scaled amount or the allocated material cost multiplied by the quantity scaled amount that takes into consideration the costing batch output size and basis type along with the material yield when applicable for sourcing rule level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationType":{
            "maxLength":"30",
            "type":"string",
            "description":"Specifies the type of the operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnteredUnitCost":{
            "maxLength":"40",
            "type":"string",
            "description":"Identifies the manually entered unit cost. This can be buy or standard cost of a component, resource rate, or fixed output costs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceInvOrgId":{
            "type":"number",
            "description":"Indicates the source organization identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentRollupHeaderKey":{
            "maxLength":"120",
            "type":"string",
            "description":"Surrogate parent key identifying the sourcing rule type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceCost":{
            "maxLength":"40",
            "type":"string",
            "description":"Identifies the cumulative cost of a resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExtendedCost":{
            "maxLength":"40",
            "type":"string",
            "description":"Indicates the rate multiplied by the usage scaled amount or the material cost multiplied by the quantity scaled amount that takes into consideration the costing batch output size and basis type along with the material yield when applicable for each sourcing rule type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyExtendedPrecision":{
            "type":"integer",
            "description":"Indicates the extended precision of the currency.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "CostOrgLevelCost":{
            "type":"string",
            "description":"Identifies the cost of an item that's specified at the cost organization level and shared across plants. This is populated only for items where the valuation unit is at the cost organization level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "maxLength":"2",
            "type":"string",
            "description":"Indicates the sequence of the sourcing rule types.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDefinitionName":{
            "type":"string",
            "description":"Indicates the name of the work definition for which the snapshot is being created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceId":{
            "type":"number",
            "description":"Indicates the cost rollup derived source identifier of the input material cost or the resource rate linked to the rollup header row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"number",
            "description":"Indicates the manufacturing plant where the work definition is created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostAllocationPercentage":{
            "type":"number",
            "description":"Identifies the cost allocation percentage for an output item for a particular operation plus the cost allocation percentage for an output item for a prior operation for the output at the operation level in process manufacturing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostAllocationFixed":{
            "maxLength":"40",
            "type":"string",
            "description":"Captures the total of all the allocated unit cost for output at the operation level in process manufacturing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Indicates the description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioRollupHeaderId":{
            "type":"integer",
            "description":"Indicates the surrogate identifier generated for rollup header rows.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CostingBatchOutputSize":{
            "type":"string",
            "description":"Indicates the costing batch output size for the work definition for which the snapshot is created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OutputCost":{
            "maxLength":"40",
            "type":"string",
            "description":"Captures the total of all the allocated extended cost for output at the operation level in process manufacturing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDefinitionHeaderName":{
            "maxLength":"120",
            "type":"string",
            "description":"Indicates the name assigned to this work definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Allocation":{
            "type":"number",
            "description":"Indicates the allocation of the sourcing rule for the rolled-up cost of the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostAllocationSequence":{
            "type":"number",
            "description":"Sequence of cost allocation for the output at the operation level in process manufacturing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Supplier":{
            "maxLength":"360",
            "type":"string",
            "description":"Indicates the supplier name of the transfer sourcing rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupHeaderType":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of the rollup header key.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostUnitOfMeasure":{
            "maxLength":"100",
            "type":"string",
            "description":"Indicates the costing unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AbsorptionType":{
            "maxLength":"30",
            "type":"string",
            "description":"Identifies the absorption type of the overhead rate details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioId":{
            "type":"integer",
            "description":"Unique identifier for each cost scenario.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDefinitionItemId":{
            "type":"integer",
            "description":"Identifies the manufacturing work definition identifier from which the work definition snapshot is created.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CostUOMCode":{
            "maxLength":"12",
            "type":"string",
            "description":"Indicates the costing unit of measure code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetValUnitId":{
            "type":"integer",
            "description":"Indicates the unique identifier of the asset valuation unit",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OverheadCost":{
            "maxLength":"40",
            "type":"string",
            "description":"Identifies the cumulative cost of an overhead for each sourcing rule type level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllocatedResourceCost":{
            "maxLength":"40",
            "type":"string",
            "description":"Identifies the allocated cost of a resource at the sourcing rule node.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Indicates the quantity of the material for the work definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkMethodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the work method code of the manufacturing work definition of the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchQuantity":{
            "type":"string",
            "description":"Represents the quantity produced for the work definition. In process manufacturing, this is the batch quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourcingRuleName":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the sourcing rule name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlantOrgName":{
            "type":"string",
            "description":"Name of the inventory organization where the work definition of the item is set up.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductionLineName":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the production line name referenced in the flow manufacturing work definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyName":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the currency name in which the cost is stored.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationYieldFactor":{
            "type":"number",
            "description":"Indicates the yield factor for the operation. The default value is 1 (100%). It's used by the cost rollup process for yield calculations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourcingRuleCount":{
            "type":"integer",
            "description":"Indicates the sequence of the sourcing rule types.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UnitCost":{
            "maxLength":"40",
            "type":"string",
            "description":"Indicates the average per output amount calculated as EXTENDED_COST divided by COSTING_BATCH_OUTPUT_SIZE. It's the amount used for rolling up to the next level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchQuantityUOMCode":{
            "type":"string",
            "description":"Represents the unit of measure code of the batch quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostedIndicator":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the rolled up cost of an output item has been posted to the standard costs table for publishing. Not applicable for resource costs, component costs, or operation level costs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BasisType":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the item quantity is fixed (for example, quantity per lot produced) or variable (for example, quantity per item produced).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupHeaderKey":{
            "maxLength":"480",
            "type":"string",
            "description":"Surrogate key identifying the sourcing rule type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OverheadRate":{
            "maxLength":"40",
            "type":"string",
            "description":"Indicates the unit rate of the overhead that was applied by the rollup process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationUnitCost":{
            "type":"number",
            "description":"Indicates the rate multiplied by the usage amount or the material cost multiplied by the quantity amount at an operation level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Display":{
            "maxLength":"1000",
            "type":"string",
            "description":"Indicates the name of the input item, output item, operation, overhead, resource, and sourcing rule that will appear at their corresponding level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyPrecision":{
            "type":"integer",
            "description":"Indicates the precision of the currency.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"1"
            },
            "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."
        }
    }
}