Get one expanded component item
get
/fscmRestApi/resources/11.13.18.05/itemStructures/{BillSequenceId}/child/Expansion/{ComponentSequencePath}
Request
Path Parameters
-
BillSequenceId(required): integer
Value that uniquely identifies the structure. This attribute is read-only, which can be modified only if the resource is already modified.
-
ComponentSequencePath(required): string
Value that identifies the hierarchical path or linage of a component item to the root item in a structure using the component sequence IDs.
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
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : itemStructures-Expansion-item-response
Type:
Show Source
object
-
ATPCode: string
Read Only:
true
Value that indicates to check the following information when placing a demand: available to promise and capable to promise. -
ATPComponentFlag: boolean
Title:
Available to Promise
Maximum Length:1
Value that indicates to include, in available to promise checking, additional components in the bill of material for ATO and PTO items. -
ATPComponentsCode: string
Read Only:
true
Value that indicates to check additional components in the bill of material of assemble-to-order and pick-to-order items when running the available to promise checks. -
ATPFlag: boolean
Title:
Available to Promise
Maximum Length:1
Value that indicates to check available to promise and or capable to promise information when placing demand. -
AutoRequestMaterialFlag: boolean
Title:
Automatically Request Material
Maximum Length:1
Contains one of the following values: true or false. If true, then a move order is automatically created for a material in a work order release. If false, then a move order is not automatically created. The default value is true. -
BasisType: number
Title:
Basis
Value that indicates that the option class quantity can be overridden by a sales order. Valid values include None, can override, or Option Class, can't override. -
BasisValue: string
Value that identifes that the option class quantity can be overridden by a sales order. Valid values include None or Option Class.
-
CheckATPFlag: boolean
Title:
Check ATP
Contains one of the following values: true or false. If true, then check the following when placing the demand: available to promise and capable to promise. If false, then do not check. The default value is true. -
Comments: string
Title:
Comments
Maximum Length:240
Comments about a component. -
CommonComponentSequenceId: number
Value that uniquely identifies a component in a structure.
-
ComponentItemId: string
Maximum Length:
240
Value that uniquely identifies the item associated with the component. -
ComponentItemNumber: string
Maximum Length:
40
Number that identifies the item of a component. -
ComponentPath: string
Maximum Length:
4000
Value that identifies the hierarchical path of a component item to the root item in a structure. -
ComponentSequenceId: number
Value that uniquely identifies a component in a structure.
-
ComponentSequencePath: string
Title:
Path
Maximum Length:32767
Value that identifies the hierarchical path or linage of a component item to the root item in a structure using the component sequence IDs. -
ComponentStructureItemTypeValue: string
Value that identifies whether the component sub-assembly is date effective or is model or unit effetive.
-
ComponentUOMCodeValue: string
Maximum Length:
255
Value that identifies the component's own unit of measurement as used in a bill of materials. This may be different from the item's own unit of measurement. An example would be Wooden Panels used in the construction of a piece of furniure e.g. a Table. The wooden panel's unit of measurement may be "Box" , but it may have a unit of measurement "Each" when used as component of a table. -
CustomerOrderEnabledFlag: boolean
Title:
Customer Orders Enabled
Maximum Length:1
Value that indicates that an item is currently customer orderable. -
CustomerOrderFlag: boolean
Title:
Customer Ordered
Maximum Length:1
Value that indicates that an item can be ordered by external customers. -
EndDateTime: string
(date)
Title:
End Date
Date and time when a component in a structure ends. -
EnforceIntegerRequirementsValue: string
Value that is used by Oracle Supply Planning to generate the demand in integer quantities. Valid values include Round Up, Round Down, or None.
-
EnforceIntRequirements: number
Title:
Enforce Integer Requirement
Value that is used by Oracle Supply Planning to generate the demand in integer quantities. Valid values include Round Up, Round Down, or None. -
ExpandModelFlag: boolean
Read Only:
true
Value that identifies how model subassemblies are handled. If the the value is true, then the model subassemblies will be exploded. -
ExpandOption: integer
Read Only:
true
Value that identifies the expansion operation. The value include, 1 (All), 2 (Current), or 3 (Current and Future). The default option is 2 (Current). -
ExpansionDateTime: string
(date-time)
Read Only:
true
Value that identifies the structure expansion operation for date effective structures. -
ExpansionType: integer
Read Only:
true
Value that identifies the expansion type. The value include, 1 Optional, 2 Included, or 3 Both. The default value is 3 Both. -
ExtendedQuantity: number
Value that identifies the calculated total quantity of the component used in the whole explosion.
-
FindNumber: integer
Title:
Find Number
Read Only:true
An attribute value that holds find number for the component. -
FromNumber: string
Title:
From End Item Unit Number
Maximum Length:30
Number that identifies the item unit or serial from which the component is effective. It is valid only for unit or serial effective structures. Whether the value is unit or serial number depends on when the component is effective. -
FromSerialNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the item serial from which the component is effective in a structure. It's valid only for serial effective structures. -
FromUnitNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the item unit from which the component is effective. It is valid only for unit effective structures. -
ImplementationDate: string
(date)
Title:
Effective Date
Date and time when the component was implemented in production. It displays NULL for pending components. You can use this value to differentiate between pending and production components. -
ImplementationOnlyFlag: boolean
Read Only:
true
Value that identifies how unimplemented components are handled. If the the value is true, then the unimplemented components will be left out of the explosion process. -
IncludeOnShipDocsFlag: boolean
Title:
Include on Shipping Documents
Contains one of the following values: true or false. If true, then the component is displayed on shipping documentation. If false, then the component is not displayed. The default value is true. -
InstantiabilityCode: string
Maximum Length:
30
Abbreviation that identifies whether a component item is instantiable in an item structure. -
InstantiabilityValue: string
Value that indicates that a component item is instantiable in an item structure.
-
InternalOrderEnabledFlag: boolean
Title:
Transfer Orders Enabled
Maximum Length:1
Value indicating that an item can be ordered on an internal requisition. -
InternalOrderFlag: boolean
Title:
Internally Transferable
Maximum Length:1
Value indicating that an Item can be ordered internally. -
InverseQuantity: number
Value that identifies the inverse of an exact or specified quantity defined for a structure component.
-
ItemClassName: string
Name in metadata that is common to all items that share the category.
-
ItemSequenceNumber: number
Title:
Item Sequence
Number that idenfitifies the sequence of components in a structure. -
ItemStatus: string
Maximum Length:
30
Value that identifies the codes used to control the transaction activity of an item. For example, an item in active status can be customer-order enabled. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumQuantity: number
Title:
Maximum Quantity
Value that identifies the maximum order quantity. -
MinimumQuantity: number
Title:
Minimum Quantity
Value that identifies the minimum order quantity. -
MutuallyExclusiveFlag: boolean
Title:
Mutually Exclusive
Contains one of the following values: true or false. If true, then one or more options under this option class can be selected. If false, then you cannot select any options. The default value is true. -
OptionalFlag: boolean
Title:
Optional
Contains one of the following values: true or false. If true, then the component is optional for a structure. If false, then the component is not optional. The default value is true. -
OrganizationCode: string
Abbreviation that identifies the name of an organizing unit in the internal or external organization structure of your enterprise. Organization structure provides the framework for performing legal reporting, financial control, and management reporting. This attribute is read-only, which can be modified for the create operation.
-
OrganizationId: string
Maximum Length:
240
Value that uniquely identifies the organization. -
ParentBillSequenceId: integer
(int64)
Value that uniquely identifies the parent structure.
-
ParentCommonBillSequenceId: integer
(int64)
Value that uniquely identifies the parent bill structure.
-
ParentComponentSequencePath: string
Maximum Length:
32767
Value that identifies the hierarchical path or linage of a parent component item to the root item in a structure using the component sequence IDs. -
ParentEffectivityControl: number
Abbreviation that identifies the way effectively is controlled within the parent of the structure.
-
ParentEffectivityControlValue: string
Value that identifies the way effectivety is controlled within the parent of the structure. The values include Date, Unit Number, or Serial Number.
-
ParentItemId: string
Maximum Length:
240
Value that uniquely identifies the parent of an identifier for a part, material, product, or service that is unique as compared with other items, by the nature of its attributes. -
ParentItemNumber: string
Number that uniquely identifies the parent identifier for a part, material, product, or service.
-
ParentStructureDescription: string
Title:
Description
Maximum Length:240
Value that identifies the description of a parent structure. -
ParentStructureItemTypeValue: string
Value that indicates whether the structure is date effective or is model or unit effetive.
-
ParentStructureName: string
Maximum Length:
255
Value that identifies the name of a parent structure. -
PickComponentFlag: boolean
Title:
Pick Components
Value indicating that an item has a structure l with options, classes, or included items picked from finished goods inventory. -
PlanLevel: number
Value which indicates the depth of the node, row, in the exploded tree. For example, a value of 0 denotes that it is the root node.
-
PlanningPercentage: number
Title:
Planning Percent
Value that identifies the distribution percentage for a component. It is used by forecast planning. -
PrimaryUomCode: string
Maximum Length:
3
Value that identifies the primary unit of measure for the item quantities. -
PrimaryUOMValue: string
Maximum Length:
255
Value that identifies the unit of measure of a component in a bill of materials. This may be different from the unit of measure of the item. For example, wooden panels used in the making of a table. The unit of measure of the wooden panel can be Box; however, when used as the component of a table, the unit of measurement can be Each. -
Quantity: number
Title:
Quantity
Value that identifies quantity of a component in a structure. -
QuantityRelatedFlag: boolean
Title:
Quantity Related
Value that indicates that a component is quantity related. If enabled, the application validates whether the specified quantity matches the number of reference designators on the component. -
ReplenishToOrderFlag: boolean
Title:
Assemble to Order
Maximum Length:1
Value that indicates the generally built for sales order demand; a final assembly work order is created based on sales order details. -
RequiredForRevenueFlag: boolean
Title:
Required for Revenue
Contains one of the following values: true or false. If true, then the component is required to recognize revenue before you ship the order. If false, then the component is not required. The default value is true. -
RequiredToShipFlag: boolean
Title:
Required to Ship
Contains one of the following values: true or false. If true, then the component is required to be shipped. If false, then the component is not required. The default value is true. -
SalesOrderBasisValue: string
Value that indicates to override the default quantity for the option class when a sales order is entered for components belonging to BOM Item Type option class. The option class quantities affect the mandatory standard components.
-
SalesOrderTransactionFlag: boolean
Maximum Length:
1
Value that identifies a reference to the source transaction definition that identifies the type of transactions within each application where a budgetary control transaction is originated. -
ShippableItemFlag: boolean
Title:
Shippable
Maximum Length:1
Value that indicates to ship an item to a customer. -
ShowInSales: number
Value that indicates that the component is visible in the sales application. Valid values include Yes, Hide Self, and Hide Self and Descendants.
-
ShowInSalesValue: string
Value that indicates that the component is visible in the sales application. Valid values include Yes, Hide Self, and Hide Self and Descendants.
-
SoBasis: number
Title:
Sales Order Basis
Value that identifes the basis to override the default quantity for the option class when a sales order is entered, the default, for components of the BOM Item Type option class. The option class quantities affect the mandatory standard components assigned to the option class. -
StartDateTime: string
(date)
Title:
Start Date
Date and time when a component in a structure begins. -
SuggestedOperationSequence: integer
Title:
Suggested Operation Sequence
Read Only:true
An attribute value that holds the suggested operation sequence. -
SupplyType: string
Value that identifies the type of supply for components.
-
ToNumber: string
Title:
To End Item Unit Number
Maximum Length:30
Number that identifies the item unit or serial up to which the component is effective. It is valid only for unit or serial effective structures. Whether the value is unit or serial number depends on when the component is effective. -
TopBillSequenceId: string
Maximum Length:
256
Value that uniquely identifies the bill sequence of the root item of the structure. -
TopItemId: string
Maximum Length:
256
Value that uniquely identifies the root item for the explosion of the structure. -
TopItemNumber: string
Value that identifies the root item for the explosion of the structure.
-
UsePlaceholderFlag: boolean
An attribute that determines whether option class item data should be loaded into configurator models or not.
-
UserItemTypeValue: string
Maximum Length:
255
Value that uniquely identifes a grouping of all items of a particular category that share the same set of item attributes, used as a high-level grouping for processes. For example, each account generator item type , such as FA account generator, contains a group of processes for determining how an accounting flexfield code combination is created. -
WipSupplyType: number
Title:
Supply Type
Value that identifies the type of supply for components. -
Yield: number
Title:
Yield
Value that identifies the planned or actual output of a process. Values include loss, increase, or no change in the planned or actual output quantity.
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.