1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Product Lifecycle Management
  4. itemStructures

Update

patch

/fscmRestApi/resources/11.13.18.05/itemStructures/{BillSequenceId}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Component
Type: array
A constituent item of a structure that includes attributes describing its usage, such as component PWRCRD of a laptop item structure, or component GEAR of an auto transmission item structure.
Show Source
Nested Schema : Item Structure Explosion
Type: array
Title: Item Structure Explosion
A Structure Explosion breaks apart each assembly or sub-assembly into its component parts.
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
A view object that represents attachments associated with an item structure.
Show Source
Nested Schema : StructureDFF
Type: array
A customer-specified field used to capture a characteristic of a structure.
Show Source
Nested Schema : itemStructures-Component-item-patch-request
Type: object
Show Source
  • Title: Automatically Request Material
    Maximum Length: 1
    Default Value: true
    A flag that indicates if a move order is automatically created for a material at work order release.
  • Title: Basis
    Default Value: 1
  • An attribute value that determines if the option class quantity can be overridden by sales order. The valid values include None (can override) or Option Class (cannot override)
  • Identifies the change order to which the pending component has been added.
  • Title: Check ATP
    Default Value: false
    A flag indicating to check available to promise and/or capable to promise information when placing demand.
  • Title: Comments
    Maximum Length: 4000
    An attribute value that represents comments about a component.
  • Title: Formula Name
    Maximum Length: 80
    Indicates the context formula for an ingredient.
  • Title: Completion Type
    Maximum Length: 30
    Indicates how the output item will be reported during work execution.
  • Maximum Length: 255
    Value used by the manufacturer to define the type of completion of products. Values include Automatic, Manual, or None.
  • ComponentDFF
    A customer-specified field used to capture a characteristic of a component.
  • Maximum Length: 255
    Indicates the context formula for an ingredient.
  • Maximum Length: 255
    Indicates the type of material. The values include Ingredient or Product.
  • Title: Contribute to Yield
    Maximum Length: 30
    Indicates whether the ingredient quantity contributes to the yield. Values are Yes and No.
  • Maximum Length: 255
    Value used by the manufacturer to define the contribution to the yield of ingredients. The values include Yes, No, or None.
  • Title: End Date
    The date and time on which a component in a structure ends.
  • An attribute value used by planning to generate the demand in integer quantities. The values include Round Up, Round Down or None.
  • Title: Enforce Integer Requirement
    Default Value: 0
  • Title: Find Number
    Default Value: 1
    An attribute value that holds find number for the component.
  • Title: From End Item Unit Number
    Maximum Length: 30
    The item unit number or serial number from which the component is effective. Valid only for unit or serial effective structures. The value should be a serial number or an unit number depending on the effectivity of the structure.
  • Title: Include on Shipping Documents
    Default Value: false
    A flag value that indicates if a component is displayed on shipping documentation.
  • Title: Instantiability
    Maximum Length: 30
  • A unique identifier indicating whether a component item is instantiable in an item structure.
  • Title: Item Sequence
    A unique number which defines the sequence of components in a structure.
  • Title: Maximum Quantity
    An attribute that value indicates the maximum quantity allowed on an order.
  • Title: Minimum Quantity
    An attribute that value indicates the minimum quantity allowed on an order.
  • Title: Mutually Exclusive
    Default Value: false
    A flag indicating if one or more options under this Option Class can be chosen.
  • Title: Optional
    Default Value: false
    A flag indicating if component is optional for a structure.
  • Title: Planning Percent
    Default Value: 100
    An attribute used by forecast planning that represents the distribution percentage for a component.
  • Maximum Length: 30
  • Maximum Length: 255
    A value which indicates 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.
  • Title: Product Type
    Maximum Length: 30
    Type of product for the formula output.
  • Maximum Length: 255
    Type of product. Values include Primary, Co-Product, or By-Product. There's only one primary product in a formula.
  • Title: Quantity
    Default Value: 1
    An attribute value the represents the quantity of component item used.
  • Title: Quantity Related
    Default Value: false
    An attribute that indicates whether a component is quantity related or not. If enabled, the application validates whether the specified quantity matches the number of reference designators on the component.
  • ReferenceDesignator
    A set of reference designators that mark the location of the component in an item structure.
  • Maximum Length: 255
    The item number of the replacement component.
  • An attribute value that holds the replaced by find number.
  • Title: Required for Revenue
    Default Value: false
    A flag indicating if component is required to recognize revenue before you ship the order.
  • Title: Required to Ship
    Default Value: false
    Flag indicating if component is required to ship
  • An indicator to override the default quantity for the option class when a sales order is entered (the default), for components of BOM Item Type option class. Option class quantities affect the mandatory standard components assigned to the option class.
  • An attribute value that indicates if the component is visible in the sales application. Values include Yes, Hide Self and Hide Self and descendents.
  • Title: Sales Order Basis
    Default Value: 2
  • Title: Start Date
    The date and time on which a component in a structure begins.
  • SubstituteComponent
    A set of items that can be used as substitutes for a component in a structure
  • Title: Suggested Operation Sequence
    An attribute value that holds the suggested operation sequence.
  • An attribute indicating a supply type for components.
  • Title: To End Item Unit Number
    Maximum Length: 30
    The item unit number or serial number up to which the component is effective. Valid only for unit or serial effective structures. The value should be a serial number or an unit number depending on the effectivity of the structure.
  • Title: Use Placeholder
    A flag indicating if this Option Class item data should be loaded into configurator models.
  • WhereUsed
  • Title: Supply Type
  • Title: Yield
    Default Value: 1
    An attribute that for a quantity represents the planned or actual output of a process. Yield includes a loss, an increase, or no change in the planned or actual output quantity.
Nested Schema : ComponentDFF
Type: array
A customer-specified field used to capture a characteristic of a component.
Show Source
Nested Schema : ReferenceDesignator
Type: array
A set of reference designators that mark the location of the component in an item structure.
Show Source
Nested Schema : SubstituteComponent
Type: array
A set of items that can be used as substitutes for a component in a structure
Show Source
Nested Schema : WhereUsed
Type: array
Show Source
Nested Schema : itemStructures-Component-ComponentDFF-item-patch-request
Type: object
Show Source
Nested Schema : itemStructures-Component-ReferenceDesignator-item-patch-request
Type: object
Show Source
Nested Schema : ReferenceDesignatorDFF
Type: array
Descriptive Flexfield extensions for structure reference designators.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : itemStructures-Component-SubstituteComponent-item-patch-request
Type: object
Show Source
Nested Schema : SubstituteComponentDFF
Type: array
Descriptive Flexfield extensions for structure reference designators.
Show Source
Nested Schema : itemStructures-Component-SubstituteComponent-SubstituteComponentDFF-item-patch-request
Type: object
Show Source
Nested Schema : itemStructures-Component-WhereUsed-item-patch-request
Type: object
Show Source
  • Maximum Length: 80
    An attribute value that indicates how the component quantity is consumed in an assembly. The values include item and lot.
  • A unique identifier of the parent structure.
  • Maximum Length: 240
    An attribute value that represents the item description of a component.
  • Maximum Length: 300
    An attribute value that represents the item number of a component.
  • Maximum Length: 4000
    An attribute value that represents the hierarchical Path of a component item to the root item in a structure.
  • A unique identifier for an Component in a structure.
  • An attribute which value indicates the way effectively is controlled within a structure. The values include Date, Unit Number, or Serial Number.
  • The date and time on which a component in a structure ends.
  • Maximum Length: 30
    Starting Item serial number that a component is effective in a structure. Valid only for serial effective structures.
  • Maximum Length: 30
    Starting Item Unit Number or starting Item Serial Number that a component is effective in a structure. Valid only for unit effective structures.
  • Maximum Length: 250
    An attribute that value provides metadata common to all items that share the category.
  • Maximum Length: 240
    An attribute that defines codes used to control the transaction activity of an item. For example, an item in active status can be customer order enabled.
  • Maximum Length: 80
    An attribute that indicates 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.
  • A name of an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting.
  • A unique identifier for parent structure.
  • An attribute for 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.
  • An attribute value which represent the quantity of a component in structure.
  • The date and time on which a component in a structure begins.
  • An attribute which value represents the name of a structure.
  • Maximum Length: 1
    A flag that identifies the root item for the explosion of the structure.
  • Maximum Length: 30
    An attribute value which represents the serial number at the beginning of the end item (or root item) serial number range during which a given record is available.
  • Maximum Length: 30
    An attribute value which represents the Unit number at the beginning of the end item (or root item) unit number range during which a given record is available.
Nested Schema : itemStructures-Expansion-item-patch-request
Type: object
Show Source
  • Absolute yield of a component. The value equals quantity times yield.
  • Title: Available to Promise
    Maximum Length: 1
    A flag that indicates whether to include, in available to promise checking, additional components in the bill of material for ATO and PTO items.
  • Title: Available to Promise
    Maximum Length: 1
    A flag indicating to check available to promise and/or capable to promise information when placing demand.
  • Title: Automatically Request Material
    Maximum Length: 1
    A flag that indicates if a move order is automatically created for a material at work order release.
  • Title: Basis
  • An attribute value that determines if the option class quantity can be overridden by sales order. The valid values include None (can override) or Option Class (cannot override)
  • Title: Check ATP
    A flag indicating to check available to promise and/or capable to promise information when placing demand.
  • Title: Comments
    Maximum Length: 240
    An attribute value that represents comments about a component.
  • A unique identifier for an component in a structure.
  • Maximum Length: 80
    Indicates the context formula for an ingredient.
  • Maximum Length: 30
    Indicates how the output item will be reported during work execution.
  • Maximum Length: 240
    A unique value that identifies the item of a component.
  • Maximum Length: 40
    An attribute value that represents the item number of a component.
  • Maximum Length: 4000
    An attribute value that represents the hierarchical Path of a component item to the root item in a structure.
  • A unique identifier for an Component in a structure.
  • Title: Path
    Maximum Length: 32767
    An attribute value that represents the hierarchical Path or linage of a component item to the root item in a structure using the component sequence IDs.
  • An attribute which indicates the component sub-assembly is Date effective or "Model or Unit" effetive.
  • Maximum Length: 30
    Indicates the type of material for the formula.
  • Maximum Length: 255
    A value which indicates 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.
  • Maximum Length: 30
    Indicates whether the ingredient quantity contributes to the yield. Values are Yes and No.
  • Title: Customer Orders Enabled
    Maximum Length: 1
    A flag indicating whether an item is currently customer orderable.
  • Title: Customer Ordered
    Maximum Length: 1
    A flag attribute Indicating whether to allow an item to be ordered by external customers.
  • Title: End Date
    The date and time on which a component in a structure ends.
  • Starting Item Unit Number or starting Item Serial Number that a component is effective in a structure. Valid only for unit/serial effective structures.
  • Title: Enforce Integer Requirement
  • A calculated total quantity of the component used in the whole explosion.
  • Title: From End Item Unit Number
    Maximum Length: 30
    The item unit number or serial number from which the component is effective. Valid only for unit or serial effective structures. The value should be a serial number or an unit number depending on the effectivity of the structure.
  • Title: Effective Date
    A date on which the item revision is schedule to be implemented.
  • Title: Include on Shipping Documents
    A flag value that indicates if a component is displayed on shipping documentation.
  • Maximum Length: 30
  • A unique identifier indicating whether a component item is instantiable in an item structure.
  • Title: Transfer Orders Enabled
    Maximum Length: 1
    A flag indicating whether to allow an item to be ordered on an internal requisition.
  • Title: Internally Transferable
    Maximum Length: 1
    Attribute indicating whether an Item can be ordered internally.
  • An attribute value which represents the inverse of an exact or specified quantity defined for a structure component.
  • An attribute value that provides metadata common to all items that share the category.
  • Title: Item Sequence
    A unique number which defines the sequence of components in a structure.
  • Maximum Length: 30
    An attribute that defines codes used to control the transaction activity of an item. For example, an item in active status can be customer order enabled.
  • Title: Maximum Quantity
    An attribute that value indicates the maximum quantity allowed on an order.
  • Title: Minimum Quantity
    An attribute that value indicates the minimum quantity allowed on an order.
  • Title: Mutually Exclusive
    A flag indicating if one or more options under this Option Class can be chosen.
  • Title: Optional
    A flag indicating if component is optional for a structure.
  • The parent name of an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting.
  • Maximum Length: 240
    The unique identifier of an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting.
  • A unique identifier for parent structure.
  • A unique identifier for parent structure.
  • Maximum Length: 32767
    An attribute value that represents the hierarchical Path or linage of a parent component item to the root item in a structure using the component sequence IDs.
  • An attribute which value indicates the way effectively is controlled within the parent of the structure. The values include Date, Unit Number, or Serial Number.
  • Maximum Length: 240
    A unique value for 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.
  • An attribute for 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.
  • Title: Description
    Maximum Length: 240
    An attribute which value represents the description of a parent structure.
  • An attribute which indicates the structure is Date effective or "Model or Unit" effetive.
  • Maximum Length: 255
    An attribute which value represents the name of a parent structure.
  • Indicates the percentage of each ingredient or component relative to the total weight or volume of a specific batch of the formula.
  • Indicates the usable percentage of a formula after processing, accounting for waste.
  • Title: Pick Components
    A flag indicating whether an item has a structure l with options, classes, or included items picked from finished goods inventory.
  • An attribute which indicates the depth of the node (row) in the exploded tree. For example, a value 0 denotes that it is the root node.
  • Title: Planning Percent
    An attribute used by forecast planning that represents the distribution percentage for a component.
  • Maximum Length: 3
  • Maximum Length: 255
  • Maximum Length: 30
    Type of product for the formula output.
  • Title: Quantity
    An attribute value the represents the quantity of component item used.
  • Title: Quantity Related
    An attribute that Identifiers to indicates if this component has quantity related reference designators.
  • Title: Assemble to Order
    Maximum Length: 1
    A flag indicating is generally built for sales order demand; a final assembly work order is created based on sales order details.
  • Title: Required for Revenue
    A flag indicating if component is required to recognize revenue before you ship the order.
  • Title: Required to Ship
    A flag indicating if component is required to ship the order.
  • An indicator to override the default quantity for the option class when a sales order is entered (the default), for components of BOM Item Type option class. Option class quantities affect the mandatory standard components assigned to the option class.
  • Maximum Length: 1
    A flag that is a reference to the source transaction definition that identifies the type of transactions within each application where a budgetary control transaction is originated.
  • Title: Shippable
    Maximum Length: 1
    A flag indicating whether to ship an item to a customer.
  • An attribute value that indicates if the component is visible in the sales application. Values include Yes, Hide Self and Hide Self and descendents.
  • Title: Sales Order Basis
  • Title: Start Date
    The date and time on which a component in a structure begins.
  • An attribute indicating a supply type for components.
  • Title: To End Item Unit Number
    Maximum Length: 30
    The item unit number or serial number up to which the component is effective. Valid only for unit or serial effective structures. The value should be a serial number or an unit number depending on the effectivity of the structure.
  • Maximum Length: 256
    A unique identifier for the bill sequence of the root item of the structure.
  • Maximum Length: 256
    A unique identifier for the root item for the explosion of the structure.
  • An attribute value that is the identifier for the root item for the explosion of the structure.
  • An attribute that determines whether option class item data should be loaded into configurator models or not.
  • Maximum Length: 255
    A unique value that indicates 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.
  • Title: Supply Type
  • Title: Yield
    An attribute that for a quantity represents the planned or actual output of a process. Yield includes a loss, an increase, or no change in the planned or actual output quantity.
Nested Schema : itemStructures-StructureAttachments-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : itemStructures-item-response
Type: object
Show Source
  • Title: Name
    Maximum Length: 80
  • Read Only: true
    A unique identifier for structure. This value is only updatable for the updated operation, otherwise read only.
  • Read Only: true
    Read Only: This attribute provides the Change Order Notice to which the service operation added all the Structure component changes. This could happen when a Needs Approval Rule fires.
  • Value that uniquely identifies the common bill of materials.
  • Title: Item
    Read Only: true
    Maximum Length: 300
    Read Only: An attribute which value is the item number for a common structure.
  • Read Only: true
    Maximum Length: 18
    Read Only: An attribute which value is the name for the organziation for a common structure.
  • Component
    A constituent item of a structure that includes attributes describing its usage, such as component PWRCRD of a laptop item structure, or component GEAR of an auto transmission item structure.
  • Read Only: true
    Maximum Length: 64
    Who column: An attribute which indicates the user that created the structure.
  • Read Only: true
    Who column: An attribute that indicates the date and time of the creation of the structure.
  • Title: Description
    Maximum Length: 240
    The description for structure.
  • Title: Effectivity Control
  • An attribute which value indicates the way effectivity is controlled within a structure. The values include Date, Unit Number, or Serial Number.
  • Item Structure Explosion
    Title: Item Structure Explosion
    A Structure Explosion breaks apart each assembly or sub-assembly into its component parts.
  • Maximum Length: 240
  • An attribute that is an identifier for a part, material, product or service that is unique as compared with other items by the nature of its attributes. This value is only updatable for the create operation, otherwise read only.
  • Read Only: true
    Who column: An attribute which indicates the date and time of the last update of the structure.
  • Read Only: true
    Maximum Length: 64
    Who column: An attribute which indicates the user that last updated the structure.
  • Read Only: true
    Maximum Length: 32
    Who column: An attribute which indicates the user that logged in last for the structure.
  • Links
  • A name of an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting. This value is only updatable for the create operation, otherwise read only.
  • Maximum Length: 240
  • Maximum Length: 50
    The authoring system that is responsible for managing the record. If empty, the record is typically managed by the user interactively, in the standard user interface.
  • Read Only: true
    This is the request id generated at import. Its use case is to verify import, the items will be published based on RequestID.
  • Title: Item
    Read Only: true
    Maximum Length: 300
    Read Only: An attribute that represents the spoke system item number from which the structure is created.
  • Read Only: true
    Maximum Length: 18
    Read Only: An attribute indicating the source organization code from which the structure is created.
  • Attachments
    Title: Attachments
    A view object that represents attachments associated with an item structure.
  • StructureDFF
    A customer-specified field used to capture a characteristic of a structure.
  • An attribute which value represents the name of a structure. This value is only updatable for the create operation, otherwise read only.
Nested Schema : Component
Type: array
A constituent item of a structure that includes attributes describing its usage, such as component PWRCRD of a laptop item structure, or component GEAR of an auto transmission item structure.
Show Source
Nested Schema : Item Structure Explosion
Type: array
Title: Item Structure Explosion
A Structure Explosion breaks apart each assembly or sub-assembly into its component parts.
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
A view object that represents attachments associated with an item structure.
Show Source
Nested Schema : StructureDFF
Type: array
A customer-specified field used to capture a characteristic of a structure.
Show Source
Nested Schema : itemStructures-Component-item-response
Type: object
Show Source
  • Title: Absolute Yield
    Read Only: true
    Absolute yield of a component. The value equals quantity times yield.
  • Title: Change Action
    Read Only: true
    Default Value: 1
    Identifies whether the component is being added, modified, or deleted in a change line.
  • Read Only: true
    Maximum Length: 255
    Read Only: This attribute specifies whether the substitute component is being added, modified, or deleted through a change line
  • Title: Automatically Request Material
    Maximum Length: 1
    Default Value: true
    A flag that indicates if a move order is automatically created for a material at work order release.
  • Title: Basis
    Default Value: 1
  • An attribute value that determines if the option class quantity can be overridden by sales order. The valid values include None (can override) or Option Class (cannot override)
  • Identifies the change order to which the pending component has been added.
  • Read Only: true
    Default Value: -1
    Read Only: This attribute provides the revised line the pending component is added to.
  • Read Only: true
    Maximum Length: 255
    Read Only: This attribute provides the Change Order Notice to which the pending component is added.
  • Title: Check ATP
    Default Value: false
    A flag indicating to check available to promise and/or capable to promise information when placing demand.
  • Title: Comments
    Maximum Length: 4000
    An attribute value that represents comments about a component.
  • Title: Formula Name
    Maximum Length: 80
    Indicates the context formula for an ingredient.
  • Title: Completion Type
    Maximum Length: 30
    Indicates how the output item will be reported during work execution.
  • Maximum Length: 255
    Value used by the manufacturer to define the type of completion of products. Values include Automatic, Manual, or None.
  • ComponentDFF
    A customer-specified field used to capture a characteristic of a component.
  • Read Only: true
    Maximum Length: 255
    The component item's item class. This attribute is read only.
  • Maximum Length: 240
  • An attribute that represents the item number of a component. This attribute is only updatable for a create operation, otherwise is read only.
  • Maximum Length: 255
    Indicates the context formula for an ingredient.
  • A unique identifier for an component in a structure. This attribute is read only and is not required for an update operation.
  • Title: Material Type
    Maximum Length: 30
    Default Value: INPUT
    Indicates the type of material for the formula.
  • Maximum Length: 255
    Indicates the type of material. The values include Ingredient or Product.
  • Title: Contribute to Yield
    Maximum Length: 30
    Indicates whether the ingredient quantity contributes to the yield. Values are Yes and No.
  • Maximum Length: 255
    Value used by the manufacturer to define the contribution to the yield of ingredients. The values include Yes, No, or None.
  • Read Only: true
    Maximum Length: 64
    Who column: An attribute which indicates the user that created the structure
  • Read Only: true
    Who column: An attribute that indicates the date and time of the creation of the component.
  • Title: End Date
    The date and time on which a component in a structure ends.
  • An attribute value used by planning to generate the demand in integer quantities. The values include Round Up, Round Down or None.
  • Title: Enforce Integer Requirement
    Default Value: 0
  • Title: Find Number
    Default Value: 1
    An attribute value that holds find number for the component.
  • Title: From End Item Unit Number
    Maximum Length: 30
    The item unit number or serial number from which the component is effective. Valid only for unit or serial effective structures. The value should be a serial number or an unit number depending on the effectivity of the structure.
  • Title: Effective Date
    Read Only: true
    Read Only: This attributes provides the timestamp when the component was implemented as production row. This attribute can be used to differentiate among pending and production components. For pending components this will be null.
  • Title: Include on Shipping Documents
    Default Value: false
    A flag value that indicates if a component is displayed on shipping documentation.
  • Title: Instantiability
    Maximum Length: 30
  • A unique identifier indicating whether a component item is instantiable in an item structure.
  • Title: Item Sequence
    A unique number which defines the sequence of components in a structure.
  • Read Only: true
    Who column: An attribute which indicates the date and time of the last update of the component.
  • Read Only: true
    Maximum Length: 64
    Who column: An attribute which indicates the user that last updated the structure.
  • Read Only: true
    Maximum Length: 32
    Who column: An attribute which indicates the user that logged in last for the structure.
  • Links
  • Title: Maximum Quantity
    An attribute that value indicates the maximum quantity allowed on an order.
  • Title: Minimum Quantity
    An attribute that value indicates the minimum quantity allowed on an order.
  • Title: Mutually Exclusive
    Default Value: false
    A flag indicating if one or more options under this Option Class can be chosen.
  • Read Only: true
    Reference to the production row when the component is modified in a change line.
  • Title: Optional
    Default Value: false
    A flag indicating if component is optional for a structure.
  • Maximum Length: 240
  • Title: Planning Percent
    Default Value: 100
    An attribute used by forecast planning that represents the distribution percentage for a component.
  • Maximum Length: 30
  • Maximum Length: 255
    A value which indicates 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.
  • Read Only: true
    Maximum Length: 255
  • Title: Product Type
    Maximum Length: 30
    Type of product for the formula output.
  • Maximum Length: 255
    Type of product. Values include Primary, Co-Product, or By-Product. There's only one primary product in a formula.
  • Title: Quantity
    Default Value: 1
    An attribute value the represents the quantity of component item used.
  • Title: Quantity Related
    Default Value: false
    An attribute that indicates whether a component is quantity related or not. If enabled, the application validates whether the specified quantity matches the number of reference designators on the component.
  • ReferenceDesignator
    A set of reference designators that mark the location of the component in an item structure.
  • Maximum Length: 255
    The item number of the replacement component.
  • An attribute value that holds the replaced by find number.
  • Read Only: true
    Maximum Length: 255
    The item number of the component that is being replaced.
  • Title: Required for Revenue
    Default Value: false
    A flag indicating if component is required to recognize revenue before you ship the order.
  • Title: Required to Ship
    Default Value: false
    Flag indicating if component is required to ship
  • An indicator to override the default quantity for the option class when a sales order is entered (the default), for components of BOM Item Type option class. Option class quantities affect the mandatory standard components assigned to the option class.
  • An attribute value that indicates if the component is visible in the sales application. Values include Yes, Hide Self and Hide Self and descendents.
  • Title: Sales Order Basis
    Default Value: 2
  • Title: Start Date
    The date and time on which a component in a structure begins.
  • SubstituteComponent
    A set of items that can be used as substitutes for a component in a structure
  • Title: Suggested Operation Sequence
    An attribute value that holds the suggested operation sequence.
  • An attribute indicating a supply type for components.
  • Title: To End Item Unit Number
    Maximum Length: 30
    The item unit number or serial number up to which the component is effective. Valid only for unit or serial effective structures. The value should be a serial number or an unit number depending on the effectivity of the structure.
  • Title: Use Placeholder
    A flag indicating if this Option Class item data should be loaded into configurator models.
  • WhereUsed
  • Title: Supply Type
  • Title: Yield
    Default Value: 1
    An attribute that for a quantity represents the planned or actual output of a process. Yield includes a loss, an increase, or no change in the planned or actual output quantity.
Nested Schema : ComponentDFF
Type: array
A customer-specified field used to capture a characteristic of a component.
Show Source
Nested Schema : ReferenceDesignator
Type: array
A set of reference designators that mark the location of the component in an item structure.
Show Source
Nested Schema : SubstituteComponent
Type: array
A set of items that can be used as substitutes for a component in a structure
Show Source
Nested Schema : WhereUsed
Type: array
Show Source
Nested Schema : itemStructures-Component-ComponentDFF-item-response
Type: object
Show Source
Nested Schema : itemStructures-Component-ReferenceDesignator-item-response
Type: object
Show Source
Nested Schema : ReferenceDesignatorDFF
Type: array
Descriptive Flexfield extensions for structure reference designators.
Show Source
Nested Schema : itemStructures-Component-ReferenceDesignator-ReferenceDesignatorDFF-item-response
Type: object
Show Source
Nested Schema : itemStructures-Component-SubstituteComponent-item-response
Type: object
Show Source
Nested Schema : SubstituteComponentDFF
Type: array
Descriptive Flexfield extensions for structure reference designators.
Show Source
Nested Schema : itemStructures-Component-SubstituteComponent-SubstituteComponentDFF-item-response
Type: object
Show Source
Nested Schema : itemStructures-Component-WhereUsed-item-response
Type: object
Show Source
  • Maximum Length: 80
    An attribute value that indicates how the component quantity is consumed in an assembly. The values include item and lot.
  • A unique identifier of the parent structure.
  • Maximum Length: 240
    An attribute value that represents the item description of a component.
  • Maximum Length: 300
    An attribute value that represents the item number of a component.
  • Maximum Length: 4000
    An attribute value that represents the hierarchical Path of a component item to the root item in a structure.
  • A unique identifier for an Component in a structure.
  • An attribute which value indicates the way effectively is controlled within a structure. The values include Date, Unit Number, or Serial Number.
  • The date and time on which a component in a structure ends.
  • Maximum Length: 30
    Starting Item serial number that a component is effective in a structure. Valid only for serial effective structures.
  • Maximum Length: 30
    Starting Item Unit Number or starting Item Serial Number that a component is effective in a structure. Valid only for unit effective structures.
  • Maximum Length: 250
    An attribute that value provides metadata common to all items that share the category.
  • Maximum Length: 240
    An attribute that defines codes used to control the transaction activity of an item. For example, an item in active status can be customer order enabled.
  • Maximum Length: 80
    An attribute that indicates 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.
  • Links
  • A name of an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting.
  • A unique identifier for parent structure.
  • An attribute for 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.
  • An attribute value which represent the quantity of a component in structure.
  • The date and time on which a component in a structure begins.
  • An attribute which value represents the name of a structure.
  • Maximum Length: 1
    A flag that identifies the root item for the explosion of the structure.
  • Maximum Length: 30
    An attribute value which represents the serial number at the beginning of the end item (or root item) serial number range during which a given record is available.
  • Maximum Length: 30
    An attribute value which represents the Unit number at the beginning of the end item (or root item) unit number range during which a given record is available.
Nested Schema : itemStructures-Expansion-item-response
Type: object
Show Source
  • Absolute yield of a component. The value equals quantity times yield.
  • Read Only: true
    An attribute to check the following information when placing a demand: available to promise and capable to promise.
  • Title: Available to Promise
    Maximum Length: 1
    A flag that indicates whether to include, in available to promise checking, additional components in the bill of material for ATO and PTO items.
  • Read Only: true
    An attribute indicating whether 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.
  • Title: Available to Promise
    Maximum Length: 1
    A flag indicating to check available to promise and/or capable to promise information when placing demand.
  • Title: Automatically Request Material
    Maximum Length: 1
    A flag that indicates if a move order is automatically created for a material at work order release.
  • Title: Basis
  • An attribute value that determines if the option class quantity can be overridden by sales order. The valid values include None (can override) or Option Class (cannot override)
  • Title: Check ATP
    A flag indicating to check available to promise and/or capable to promise information when placing demand.
  • Title: Comments
    Maximum Length: 240
    An attribute value that represents comments about a component.
  • A unique identifier for an component in a structure.
  • Maximum Length: 80
    Indicates the context formula for an ingredient.
  • Maximum Length: 30
    Indicates how the output item will be reported during work execution.
  • Read Only: true
    Maximum Length: 255
    Value used by the manufacturer to define the type of completion of products. Values include Automatic, Manual, or None.
  • Maximum Length: 240
    A unique value that identifies the item of a component.
  • Maximum Length: 40
    An attribute value that represents the item number of a component.
  • Maximum Length: 4000
    An attribute value that represents the hierarchical Path of a component item to the root item in a structure.
  • A unique identifier for an Component in a structure.
  • Title: Path
    Maximum Length: 32767
    An attribute value that represents the hierarchical Path or linage of a component item to the root item in a structure using the component sequence IDs.
  • An attribute which indicates the component sub-assembly is Date effective or "Model or Unit" effetive.
  • Maximum Length: 30
    Indicates the type of material for the formula.
  • Read Only: true
    Maximum Length: 255
    Indicates the type of material. The values include Ingredient or Product.
  • Maximum Length: 255
    A value which indicates 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.
  • Maximum Length: 30
    Indicates whether the ingredient quantity contributes to the yield. Values are Yes and No.
  • Read Only: true
    Maximum Length: 255
    Value used by the manufacturer to define the contribution to the yield of ingredients. The values include Yes, No, or None.
  • Title: Customer Orders Enabled
    Maximum Length: 1
    A flag indicating whether an item is currently customer orderable.
  • Title: Customer Ordered
    Maximum Length: 1
    A flag attribute Indicating whether to allow an item to be ordered by external customers.
  • Title: End Date
    The date and time on which a component in a structure ends.
  • Starting Item Unit Number or starting Item Serial Number that a component is effective in a structure. Valid only for unit/serial effective structures.
  • Title: Enforce Integer Requirement
  • Read Only: true
  • Read Only: true
  • Read Only: true
  • Read Only: true
  • A calculated total quantity of the component used in the whole explosion.
  • Title: Find Number
    Read Only: true
    An attribute value that holds find number for the component.
  • Title: From End Item Unit Number
    Maximum Length: 30
    The item unit number or serial number from which the component is effective. Valid only for unit or serial effective structures. The value should be a serial number or an unit number depending on the effectivity of the structure.
  • Read Only: true
    Maximum Length: 30
  • Read Only: true
    Maximum Length: 30
  • Title: Effective Date
    A date on which the item revision is schedule to be implemented.
  • Read Only: true
  • Title: Include on Shipping Documents
    A flag value that indicates if a component is displayed on shipping documentation.
  • Maximum Length: 30
  • A unique identifier indicating whether a component item is instantiable in an item structure.
  • Title: Transfer Orders Enabled
    Maximum Length: 1
    A flag indicating whether to allow an item to be ordered on an internal requisition.
  • Title: Internally Transferable
    Maximum Length: 1
    Attribute indicating whether an Item can be ordered internally.
  • An attribute value which represents the inverse of an exact or specified quantity defined for a structure component.
  • An attribute value that provides metadata common to all items that share the category.
  • Title: Item Sequence
    A unique number which defines the sequence of components in a structure.
  • Maximum Length: 30
    An attribute that defines codes used to control the transaction activity of an item. For example, an item in active status can be customer order enabled.
  • Links
  • Title: Maximum Quantity
    An attribute that value indicates the maximum quantity allowed on an order.
  • Title: Minimum Quantity
    An attribute that value indicates the minimum quantity allowed on an order.
  • Title: Mutually Exclusive
    A flag indicating if one or more options under this Option Class can be chosen.
  • Title: Optional
    A flag indicating if component is optional for a structure.
  • The parent name of an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting.
  • Maximum Length: 240
    The unique identifier of an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting.
  • A unique identifier for parent structure.
  • A unique identifier for parent structure.
  • Maximum Length: 32767
    An attribute value that represents the hierarchical Path or linage of a parent component item to the root item in a structure using the component sequence IDs.
  • An attribute which value indicates the way effectively is controlled within the parent of the structure. The values include Date, Unit Number, or Serial Number.
  • Maximum Length: 240
    A unique value for 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.
  • An attribute for 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.
  • Title: Description
    Maximum Length: 240
    An attribute which value represents the description of a parent structure.
  • An attribute which indicates the structure is Date effective or "Model or Unit" effetive.
  • Maximum Length: 255
    An attribute which value represents the name of a parent structure.
  • Indicates the percentage of each ingredient or component relative to the total weight or volume of a specific batch of the formula.
  • Indicates the usable percentage of a formula after processing, accounting for waste.
  • Title: Pick Components
    A flag indicating whether an item has a structure l with options, classes, or included items picked from finished goods inventory.
  • An attribute which indicates the depth of the node (row) in the exploded tree. For example, a value 0 denotes that it is the root node.
  • Title: Planning Percent
    An attribute used by forecast planning that represents the distribution percentage for a component.
  • Maximum Length: 3
  • Maximum Length: 255
  • Maximum Length: 30
    Type of product for the formula output.
  • Read Only: true
    Maximum Length: 255
    Type of product. Values include Primary, Co-Product, or By-Product. There's only one primary product in a formula.
  • Title: Quantity
    An attribute value the represents the quantity of component item used.
  • Title: Quantity Related
    An attribute that Identifiers to indicates if this component has quantity related reference designators.
  • Title: Assemble to Order
    Maximum Length: 1
    A flag indicating is generally built for sales order demand; a final assembly work order is created based on sales order details.
  • Title: Required for Revenue
    A flag indicating if component is required to recognize revenue before you ship the order.
  • Title: Required to Ship
    A flag indicating if component is required to ship the order.
  • An indicator to override the default quantity for the option class when a sales order is entered (the default), for components of BOM Item Type option class. Option class quantities affect the mandatory standard components assigned to the option class.
  • Maximum Length: 1
    A flag that is a reference to the source transaction definition that identifies the type of transactions within each application where a budgetary control transaction is originated.
  • Title: Shippable
    Maximum Length: 1
    A flag indicating whether to ship an item to a customer.
  • An attribute value that indicates if the component is visible in the sales application. Values include Yes, Hide Self and Hide Self and descendents.
  • Title: Sales Order Basis
  • Title: Start Date
    The date and time on which a component in a structure begins.
  • Title: Suggested Operation Sequence
    Read Only: true
    An attribute value that holds the suggested operation sequence.
  • An attribute indicating a supply type for components.
  • Title: To End Item Unit Number
    Maximum Length: 30
    The item unit number or serial number up to which the component is effective. Valid only for unit or serial effective structures. The value should be a serial number or an unit number depending on the effectivity of the structure.
  • Maximum Length: 256
    A unique identifier for the bill sequence of the root item of the structure.
  • Maximum Length: 256
    A unique identifier for the root item for the explosion of the structure.
  • An attribute value that is the identifier for the root item for the explosion of the structure.
  • An attribute that determines whether option class item data should be loaded into configurator models or not.
  • Maximum Length: 255
    A unique value that indicates 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.
  • Title: Supply Type
  • Title: Yield
    An attribute that for a quantity represents the planned or actual output of a process. Yield includes a loss, an increase, or no change in the planned or actual output quantity.
Nested Schema : itemStructures-StructureAttachments-item-response
Type: object
Show Source
Nested Schema : itemStructures-StructureDFF-item-response
Type: object
Show Source
Links
Component
Parameters:
  • BillSequenceId: $request.path.BillSequenceId
A constituent item of a structure that includes attributes describing its usage, such as component PWRCRD of a laptop item structure, or component GEAR of an auto transmission item structure.
Expansion
Parameters:
  • BillSequenceId: $request.path.BillSequenceId
A Structure Explosion breaks apart each assembly or sub-assembly into its component parts.
StructureAttachments
Parameters:
  • BillSequenceId: $request.path.BillSequenceId
A view object that represents attachments associated with an item structure.
StructureDFF
Parameters:
  • BillSequenceId: $request.path.BillSequenceId
A customer-specified field used to capture a characteristic of a structure.
Back to Top

Examples

Example 1

This example describes how to update an item structure.

Example 1 cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/itemStructures/BillSequenceId"

Example 1 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates. 

{
"Description": "update"
}

Example 1 Response Body

The following example includes the contents of the response body in JSON format:

{
    "BillSequenceId": 300100159234307,
    "ChangeNotice": null,
    "OrganizationId": "204",
    "OrganizationCode": "V1",
    "ItemId": "300100159234165",
    "ItemNumber": "JUN26_PIM001",
    "AlternateBOMDesignator": "EBOM_KM",
    "StructureName": "EBOM_KM",
    "Description": "update",
    "EffectivityControl": 1,
    "EffectivityControlValue": "Date",
    "CommonItemNumber": "JUN26_PIM001",
    "CommonOrganizationCode": "V1",
    "SourceItemNumber": "JUN26_PIM001",
    "SourceOrganizationCode": "V1",
    "CreationDateTime": "2018-06-26T08:37:44.741+00:00",
    "LastUpdateDateTime": "2018-06-26T08:37:53.307+00:00",
    "OriginalSystemReference": null,
...
}

Example 2

This example describes how to update the UsePlaceHolder mark for an Option Class Item in a structure.

Example 2 cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/itemStructures/BillSequenceId"
For example:
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/itemStructures/300100574512929/child/Component/300100574512937"

Example 2 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates. 

{ "UsePlaceholderFlag": "true"}

Example 2 Response Body

The following example includes the contents of the response body in JSON format:
{

   "ComponentSequenceId": 300100576149824,

   "OrganizationId": "204",

   "ComponentItemNumber": "CPU Option Class",

   "ComponentItemId": "300100067746408",

   "ChangeNotice": null,

   "ChangeLineId": -1,

   "ItemSequenceNumber": 240,

   "Quantity": 1,

   "Yield": 1,

   "Comments": null,

   "StartDateTime": "2023-01-19T17:17:21+00:00",

   "EndDateTime": null,

   "ImplementationDateTime": "2023-01-19T17:17:21+00:00",

   "FromNumber": null,

   "ToNumber": null,

   "PlanningPercent": 100,

   "BasisType": 1,

   "BasisValue": "Variable",

   "EnforceIntRequirements": 0,

   "EnforceIntegerRequirementsValue": "None",

   "WipSupplyType": null,

   "SupplyType": null,

   "AutoRequestMaterialFlag": true,

   "MinimumQuantity": 1,

   "MaximumQuantity": 2,

   "OptionalFlag": false,

   "MutuallyExclusiveFlag": true,

   "CheckATPFlag": false,

   "SoBasis": 2,

   "SalesOrderBasisValue": "None",

   "InstantiabilityCode": null,

   "InstantiabilityValue": null,

   "ShowInSales": 1,

   "ShowInSalesValue": "Yes",

   "RequiredToShipFlag": false,

   "RequiredForRevenueFlag": false,

   "IncludeOnShipDocsFlag": false,

   "CreationDateTime": "2023-01-19T17:17:24.971+00:00",

   "LastUpdateDateTime": "2023-01-19T20:24:02.253+00:00",

   "BillSequenceId": 300100576149816,

   "PrimaryUOMValue": "Each",

   "PrimaryUOMCode": "Ea",

   "PrimaryUOMCodeValue": "Each",

   "ACDTypeValue": "Added",

   "CreatedBy": "PLM_AUTO",

   "LastUpdateLogin": "F1F9A5AA8BAC50E1E053B06515AC1848",

   "LastUpdatedBy": "PLM_AUTO",

   "ComponentItemClass": "Root Item Class",

   "QuantityRelatedFlag": false,

   "Replaces": null,

   "ReplacedBy": null,

   "UsePlaceholderFlag": true

}
Back to Top