Update

patch

/fscmRestApi/resources/11.13.18.05/itemStructures/{BillSequenceId}/child/Component/{ComponentSequenceId}

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=
  • 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
  • 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.
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-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.
Back to Top

Examples

This example describes how to update a component.

Example 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/child/Component/ComponentSequenceId"

For example, the following command updates a component where the component sequence identifier is 300100152494350:

curl -u username:password "https://servername/fscmRestApi/resources/version/itemStructures/300100159234307/child/Component/300100159297408"

Example 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.

{
"Quantity": 125,
"Comments": "TEST"
}

Example Response Body

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

{
    "ComponentSequenceId": 300100159297408,
    "OrganizationId": "204",
    "ComponentItemNumber": "JUN26_PIM001_BOM1",
    "ComponentItemId": "300100159234167",
    "ChangeNotice": "JUN26_CCO001",
    "ChangeLineId": 300100159295698,
    "ItemSequenceNumber": 10,
    "Quantity": 125,
    "Yield": 1,
    "Comments": "TEST",
    "StartDateTime": "2018-06-27T05:39:33+00:00",
    "EndDateTime": null,
    "ImplementationDateTime": null,
    "FromNumber": null,
    "ToNumber": null,
    "PlanningPercent": 100,
    "BasisType": 1,
    "BasisValue": "Variable",
    "EnforceIntRequirements": 0,
    "EnforceIntegerRequirementsValue": "None",
    "WipSupplyType": 1,
    "SupplyType": "Push",
    "AutoRequestMaterialFlag": true,
    "MinimumQuantity": null,
    "MaximumQuantity": null,
    "OptionalFlag": false,
    "MutuallyExclusiveFlag": false,
    "CheckATPFlag": false,
    "SoBasis": 2,
    "SalesOrderBasisValue": "None",
    "InstantiabilityCode": null,
    "InstantiabilityValue": null,
    "ShowInSales": null,
    "ShowInSalesValue": null,
    "RequiredToShipFlag": false,
    "RequiredForRevenueFlag": false,
    "IncludeOnShipDocsFlag": false,
    "CreationDateTime": "2018-06-27T05:26:25.272+00:00",
    "LastUpdateDateTime": "2018-06-28T05:23:41.126+00:00",
    "BillSequenceId": 300100159234307,
    "PrimaryUOMValue": "Each",
    "PrimaryUOMCode": "Ea",
    "PrimaryUOMCodeValue": "Each",
    "ACDTypeValue": "Updated",
...
}
Back to Top