1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Product Lifecycle Management
  4. Item Structures
  5. Components

Update a component

patch

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

Request

Path Parameters
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
    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.
  • Title: Basis
    Default Value: 1
    Value that indicates if the option class quantity can be overridden by sales order. Valid values include None (can override) or Option Class (cannot override).
  • Value that determines if the option class quantity can be overridden by the sales order. Valid values include None or Option Class.
  • Title: Check ATP
    Default Value: false
    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.
  • Title: Comments
    Maximum Length: 240
    Comments about a component.
  • Flexfields for Components
    Title: Flexfields for Components
    The Flexfields for Components resource gets the descriptive flexfields associated with the component.
  • Title: End Date
    Date and time when a component in a structure ends.
  • Value that is used by planning to generate the demand in integer quantities. Values include Round Up, Round Down, or None.
  • Title: Enforce Integer Requirement
    Default Value: 0
    Value that is used by Oracle Supply Planning Cloud to generate the demand in integer quantities. Valid values include Round Up, Round Down, or None.
  • Title: Find Number
    Default Value: 1
    Number used to locate a specific instance of an item in a structure.
  • Title: From End Item Unit Number
    Maximum Length: 30
    Number that indicates 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.
  • Title: Include on Shipping Documents
    Default Value: false
    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.
  • Title: Instantiability
    Maximum Length: 30
    Abbreviation that identifies the whether a component item is instantiable in an item structure.
  • Value that indicates whether a component item is instantiable in an item structure.
  • Title: Item Sequence
    Number that defines the sequence of components in a structure.
  • Title: Maximum Quantity
    Value that indicates the maximum order quantity.
  • Title: Minimum Quantity
    Value that indicates the minimum order quantity.
  • Title: Mutually Exclusive
    Default Value: false
    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.
  • Title: Optional
    Default Value: false
    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.
  • Title: Planning Percent
    Default Value: 100
    Distribution percentage for a component. It is used by forecast planning.
  • Maximum Length: 30
    Primary unit of measure for the item quantities.
  • Maximum Length: 255
    Value that indicates 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.
  • Title: Quantity
    Default Value: 1
    Quantity of component item that is used.
  • Title: Quantity Related
    Default Value: false
    Value 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.
  • Reference Designators
    Title: Reference Designators
    The Reference Designators resource manages the details of a reference designator.
  • Maximum Length: 255
    Item number of the replacement component.
  • New find number value of the replacement component.
  • Title: Required for Revenue
    Default Value: false
    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.
  • Title: Required to Ship
    Default Value: false
    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.
  • 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.
  • Value that indicates if the component is visible in the sales application. Valid values include Yes, Hide Self, and Hide Self and Descendants.
  • Value that indicates if the component is visible in the sales application. Values include Yes, Hide Self, and Hide Self and Descendants.
  • Title: Sales Order Basis
    Default Value: 2
    Value that indicates 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.
  • Title: Start Date
    Date and time when a component in a structure begins.
  • Substitute Components
    Title: Substitute Components
    The Substitute Components resource manages the details of a substitute component.
  • Title: Suggested Operation Sequence
    Sequence number suggested by a design engineer for a specific component operation in a manufacturing work definition. Example values are 10, 20, 30, and so on.
  • Type of supply for components.
  • 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.
  • Title: Use Placeholder
    A flag indicating if this Option Class item data should be loaded into configurator models.
  • Where Used for Item Structures
    Title: Where Used for Item Structures
    The Where Used for Item Structures resource gets the items in which this structure is used.
  • Title: Supply Type
    Type of supply for components.
  • Title: Yield
    Default Value: 1
    Value that indicates the planned or actual output of a process. Values include loss, increase, or no change in the planned or actual output quantity.
Nested Schema : Flexfields for Components
Type: array
Title: Flexfields for Components
The Flexfields for Components resource gets the descriptive flexfields associated with the component.
Show Source
Nested Schema : Reference Designators
Type: array
Title: Reference Designators
The Reference Designators resource manages the details of a reference designator.
Show Source
Nested Schema : Substitute Components
Type: array
Title: Substitute Components
The Substitute Components resource manages the details of a substitute component.
Show Source
Nested Schema : Where Used for Item Structures
Type: array
Title: Where Used for Item Structures
The Where Used for Item Structures resource gets the items in which this structure is used.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : itemStructures-Component-ReferenceDesignator-item-patch-request
Type: object
Show Source
Nested Schema : Flexfields for Reference Designators
Type: array
Title: Flexfields for Reference Designators
The Flexfields for Reference Designators resource gets the descriptive flexfields associated with the reference designator.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : itemStructures-Component-SubstituteComponent-item-patch-request
Type: object
Show Source
Nested Schema : Flexfields for Substitute Components
Type: array
Title: Flexfields for Substitute Components
The Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component.
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
    Value that indicates how the component quantity is consumed in an assembly. Values include item and lot.
  • Value that uniquely identifies the parent structure.
  • Maximum Length: 240
    Description of the item of a component.
  • Maximum Length: 300
    Number that indicates the item of a component.
  • Maximum Length: 4000
    Value that represents the hierarchical path of a component item to the root item in a structure.
  • Value that uniquely identifies the component in a structure.
  • Value that indicates the method used to control effectivity in a structure. Values include Date, Unit Number, or Serial Number.
  • Date and time when a component in a structure ends.
  • Maximum Length: 30
    Number that indicates the item serial from which the component is effective in a structure. It is valid only for serial effective structures.
  • Maximum Length: 30
    Number that indicates the item unit or serial from which the component is effective. It is valid only for unit effective structures.
  • Maximum Length: 250
    Name in metadata that is common to all items that share the category.
  • Maximum Length: 240
    Value 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
    Value that indicates grouping of all items of a particular category that share the same set of item attributes, used as a high-level grouping for processes.
  • 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.
  • Value that uniquely identifies the parent structure.
  • Number that uniquely identifies the parent identifier for a part, material, product, or service.
  • Quantity of a component in a structure.
  • Date and time when a component in a structure begins.
  • Name of the structure. This attribute is read-only, which can be modified for the create operation.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the item is the top item where this component is used. If false, then the item is not the top item where this component is used. The default value is false.
  • Maximum Length: 30
    Number that identifies the item serial up to which the component is effective in a structure.
  • Maximum Length: 30
    Number that identifies the item unit up to which the component is effective.
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
  • Read Only: true
    Maximum Length: 255
    Value that indicates if the substitute component is being added, modified, or deleted through a change line.
  • Title: Automatically Request Material
    Maximum Length: 1
    Default Value: true
    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.
  • Title: Basis
    Default Value: 1
    Value that indicates if the option class quantity can be overridden by sales order. Valid values include None (can override) or Option Class (cannot override).
  • Value that determines if the option class quantity can be overridden by the sales order. Valid values include None or Option Class.
  • Value that uniquely identifies the structure.
  • Read Only: true
    Default Value: -1
    Value that uniquely identifies the revised change line to which pending component is added.
  • Read Only: true
    Maximum Length: 255
    Change order notice to which the pending component is added.
  • Title: Check ATP
    Default Value: false
    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.
  • Title: Comments
    Maximum Length: 240
    Comments about a component.
  • Flexfields for Components
    Title: Flexfields for Components
    The Flexfields for Components resource gets the descriptive flexfields associated with the component.
  • Read Only: true
    Maximum Length: 255
    Class of the component item. This attribute is read-only and is not required for an update operation.
  • Maximum Length: 240
    Value that uniquely identifies the item associated with the component.
  • Number that indicates the item of a component. This attribute is read-only, which can be modified for the create operation.
  • Value that uniquely identifies the component in a structure. This attribute is read-only and is not required for an update operation.
  • Read Only: true
    Maximum Length: 64
    User who created the component.
  • Read Only: true
    Date and time when the structure was created.
  • Title: End Date
    Date and time when a component in a structure ends.
  • Value that is used by planning to generate the demand in integer quantities. Values include Round Up, Round Down, or None.
  • Title: Enforce Integer Requirement
    Default Value: 0
    Value that is used by Oracle Supply Planning Cloud to generate the demand in integer quantities. Valid values include Round Up, Round Down, or None.
  • Title: Find Number
    Default Value: 1
    Number used to locate a specific instance of an item in a structure.
  • Title: From End Item Unit Number
    Maximum Length: 30
    Number that indicates 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.
  • Title: Effective Date
    Read Only: true
    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.
  • Title: Include on Shipping Documents
    Default Value: false
    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.
  • Title: Instantiability
    Maximum Length: 30
    Abbreviation that identifies the whether a component item is instantiable in an item structure.
  • Value that indicates whether a component item is instantiable in an item structure.
  • Title: Item Sequence
    Number that defines the sequence of components in a structure.
  • Read Only: true
    Date and time when the structure was most recently updated.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the component.
  • Read Only: true
    Maximum Length: 32
    Login of the user who most recently updated the component.
  • Links
  • Title: Maximum Quantity
    Value that indicates the maximum order quantity.
  • Title: Minimum Quantity
    Value that indicates the minimum order quantity.
  • Title: Mutually Exclusive
    Default Value: false
    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.
  • Title: Optional
    Default Value: false
    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.
  • Maximum Length: 240
    Value that uniquely identifies the organization.
  • Title: Planning Percent
    Default Value: 100
    Distribution percentage for a component. It is used by forecast planning.
  • Maximum Length: 30
    Primary unit of measure for the item quantities.
  • Maximum Length: 255
    Value that indicates 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.
  • Read Only: true
    Maximum Length: 255
    Value in the primary unit of measure for the item quantities.
  • Title: Quantity
    Default Value: 1
    Quantity of component item that is used.
  • Title: Quantity Related
    Default Value: false
    Value 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.
  • Reference Designators
    Title: Reference Designators
    The Reference Designators resource manages the details of a reference designator.
  • Maximum Length: 255
    Item number of the replacement component.
  • New find number value of the replacement component.
  • Read Only: true
    Maximum Length: 255
    Item number of the component that's being replaced.
  • Title: Required for Revenue
    Default Value: false
    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.
  • Title: Required to Ship
    Default Value: false
    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.
  • 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.
  • Value that indicates if the component is visible in the sales application. Valid values include Yes, Hide Self, and Hide Self and Descendants.
  • Value that indicates if the component is visible in the sales application. Values include Yes, Hide Self, and Hide Self and Descendants.
  • Title: Sales Order Basis
    Default Value: 2
    Value that indicates 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.
  • Title: Start Date
    Date and time when a component in a structure begins.
  • Substitute Components
    Title: Substitute Components
    The Substitute Components resource manages the details of a substitute component.
  • Title: Suggested Operation Sequence
    Sequence number suggested by a design engineer for a specific component operation in a manufacturing work definition. Example values are 10, 20, 30, and so on.
  • Type of supply for components.
  • 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.
  • Title: Use Placeholder
    A flag indicating if this Option Class item data should be loaded into configurator models.
  • Where Used for Item Structures
    Title: Where Used for Item Structures
    The Where Used for Item Structures resource gets the items in which this structure is used.
  • Title: Supply Type
    Type of supply for components.
  • Title: Yield
    Default Value: 1
    Value that indicates the planned or actual output of a process. Values include loss, increase, or no change in the planned or actual output quantity.
Nested Schema : Flexfields for Components
Type: array
Title: Flexfields for Components
The Flexfields for Components resource gets the descriptive flexfields associated with the component.
Show Source
Nested Schema : Reference Designators
Type: array
Title: Reference Designators
The Reference Designators resource manages the details of a reference designator.
Show Source
Nested Schema : Substitute Components
Type: array
Title: Substitute Components
The Substitute Components resource manages the details of a substitute component.
Show Source
Nested Schema : Where Used for Item Structures
Type: array
Title: Where Used for Item Structures
The Where Used for Item Structures resource gets the items in which this structure is used.
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 : Flexfields for Reference Designators
Type: array
Title: Flexfields for Reference Designators
The Flexfields for Reference Designators resource gets the descriptive flexfields associated with the reference designator.
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 : Flexfields for Substitute Components
Type: array
Title: Flexfields for Substitute Components
The Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component.
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
    Value that indicates how the component quantity is consumed in an assembly. Values include item and lot.
  • Value that uniquely identifies the parent structure.
  • Maximum Length: 240
    Description of the item of a component.
  • Maximum Length: 300
    Number that indicates the item of a component.
  • Maximum Length: 4000
    Value that represents the hierarchical path of a component item to the root item in a structure.
  • Value that uniquely identifies the component in a structure.
  • Value that indicates the method used to control effectivity in a structure. Values include Date, Unit Number, or Serial Number.
  • Date and time when a component in a structure ends.
  • Maximum Length: 30
    Number that indicates the item serial from which the component is effective in a structure. It is valid only for serial effective structures.
  • Maximum Length: 30
    Number that indicates the item unit or serial from which the component is effective. It is valid only for unit effective structures.
  • Maximum Length: 250
    Name in metadata that is common to all items that share the category.
  • Maximum Length: 240
    Value 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
    Value that indicates grouping of all items of a particular category that share the same set of item attributes, used as a high-level grouping for processes.
  • Links
  • 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.
  • Value that uniquely identifies the parent structure.
  • Number that uniquely identifies the parent identifier for a part, material, product, or service.
  • Quantity of a component in a structure.
  • Date and time when a component in a structure begins.
  • Name of the structure. This attribute is read-only, which can be modified for the create operation.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the item is the top item where this component is used. If false, then the item is not the top item where this component is used. The default value is false.
  • Maximum Length: 30
    Number that identifies the item serial up to which the component is effective in a structure.
  • Maximum Length: 30
    Number that identifies the item unit up to which the component is effective.
Links
ComponentDFF
Parameters:
  • BillSequenceId: $request.path.BillSequenceId
  • ComponentSequenceId: $request.path.ComponentSequenceId
The Flexfields for Components resource gets the descriptive flexfields associated with the component.
ReferenceDesignator
Parameters:
  • BillSequenceId: $request.path.BillSequenceId
  • ComponentSequenceId: $request.path.ComponentSequenceId
The Reference Designators resource manages the details of a reference designator.
SubstituteComponent
Parameters:
  • BillSequenceId: $request.path.BillSequenceId
  • ComponentSequenceId: $request.path.ComponentSequenceId
The Substitute Components resource manages the details of a substitute component.
WhereUsed
Parameters:
  • BillSequenceId: $request.path.BillSequenceId
  • ComponentSequenceId: $request.path.ComponentSequenceId
The Where Used for Item Structures resource gets the items in which this structure is used.
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