Update
/fscmRestApi/resources/11.13.18.05/itemStructures/{BillSequenceId}/child/Component/{ComponentSequenceId}
Request
-
BillSequenceId(required): integer
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=
-
ComponentSequenceId(required): number
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=
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
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.
- application/json
object-
AutoRequestMaterialFlag: boolean
Title:
Automatically Request MaterialMaximum Length:1Default Value:trueA flag that indicates if a move order is automatically created for a material at work order release. -
BasisType: integer
Title:
BasisDefault Value:1 -
BasisValue: string
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)
-
ChangeId: integer
Identifies the change order to which the pending component has been added.
-
CheckATPFlag: boolean
Title:
Check ATPDefault Value:falseA flag indicating to check available to promise and/or capable to promise information when placing demand. -
Comments: string
Title:
CommentsMaximum Length:4000An attribute value that represents comments about a component. -
CompAlternateBomDesignator: string
Title:
Formula NameMaximum Length:80Indicates the context formula for an ingredient. -
CompletionType: string
Title:
Completion TypeMaximum Length:30Indicates how the output item will be reported during work execution. -
CompletionTypeValue: string
Maximum Length:
255Value used by the manufacturer to define the type of completion of products. Values include Automatic, Manual, or None. -
ComponentDFF: array
ComponentDFF
A customer-specified field used to capture a characteristic of a component.
-
ComponentItemStructureName: string
Maximum Length:
255Indicates the context formula for an ingredient. -
ComponentTypeValue: string
Maximum Length:
255Indicates the type of material. The values include Ingredient or Product. -
ContributeToYield: string
Title:
Contribute to YieldMaximum Length:30Indicates whether the ingredient quantity contributes to the yield. Values are Yes and No. -
ContributeToYieldValue: string
Maximum Length:
255Value used by the manufacturer to define the contribution to the yield of ingredients. The values include Yes, No, or None. -
EndDateTime: string
(date-time)
Title:
End DateThe date and time on which a component in a structure ends. -
EnforceIntegerRequirementsValue: string
An attribute value used by planning to generate the demand in integer quantities. The values include Round Up, Round Down or None.
-
EnforceIntRequirements: number
Title:
Enforce Integer RequirementDefault Value:0 -
FindNumber: integer
Title:
Find NumberDefault Value:1An attribute value that holds find number for the component. -
FromNumber: string
Title:
From End Item Unit NumberMaximum Length:30The 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. -
IncludeOnShipDocsFlag: boolean
Title:
Include on Shipping DocumentsDefault Value:falseA flag value that indicates if a component is displayed on shipping documentation. -
InstantiabilityCode: string
Title:
InstantiabilityMaximum Length:30 -
InstantiabilityValue: string
A unique identifier indicating whether a component item is instantiable in an item structure.
-
ItemSequenceNumber: number
Title:
Item SequenceA unique number which defines the sequence of components in a structure. -
MaximumQuantity: number
Title:
Maximum QuantityAn attribute that value indicates the maximum quantity allowed on an order. -
MinimumQuantity: number
Title:
Minimum QuantityAn attribute that value indicates the minimum quantity allowed on an order. -
MutuallyExclusiveFlag: boolean
Title:
Mutually ExclusiveDefault Value:falseA flag indicating if one or more options under this Option Class can be chosen. -
OptionalFlag: boolean
Title:
OptionalDefault Value:falseA flag indicating if component is optional for a structure. -
PlanningPercent: number
Title:
Planning PercentDefault Value:100An attribute used by forecast planning that represents the distribution percentage for a component. -
PrimaryUOMCode: string
Maximum Length:
30 -
PrimaryUOMCodeValue: string
Maximum Length:
255A 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. -
ProductType: string
Title:
Product TypeMaximum Length:30Type of product for the formula output. -
ProductTypeValue: string
Maximum Length:
255Type of product. Values include Primary, Co-Product, or By-Product. There's only one primary product in a formula. -
Quantity: number
Title:
QuantityDefault Value:1An attribute value the represents the quantity of component item used. -
QuantityRelatedFlag: boolean
Title:
Quantity RelatedDefault Value:falseAn 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: array
ReferenceDesignator
A set of reference designators that mark the location of the component in an item structure.
-
ReplacedBy: string
Maximum Length:
255The item number of the replacement component. -
ReplacedByFindNumber: integer
An attribute value that holds the replaced by find number.
-
RequiredForRevenueFlag: boolean
Title:
Required for RevenueDefault Value:falseA flag indicating if component is required to recognize revenue before you ship the order. -
RequiredToShipFlag: boolean
Title:
Required to ShipDefault Value:falseFlag indicating if component is required to ship -
SalesOrderBasisValue: string
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.
-
ShowInSales: number
-
ShowInSalesValue: string
An attribute value that indicates if the component is visible in the sales application. Values include Yes, Hide Self and Hide Self and descendents.
-
SoBasis: number
Title:
Sales Order BasisDefault Value:2 -
StartDateTime: string
(date-time)
Title:
Start DateThe date and time on which a component in a structure begins. -
SubstituteComponent: array
SubstituteComponent
A set of items that can be used as substitutes for a component in a structure
-
SuggestedOperationSequence: integer
Title:
Suggested Operation SequenceAn attribute value that holds the suggested operation sequence. -
SupplyType: string
An attribute indicating a supply type for components.
-
ToNumber: string
Title:
To End Item Unit NumberMaximum Length:30The 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. -
UsePlaceholderFlag: boolean
Title:
Use PlaceholderA flag indicating if this Option Class item data should be loaded into configurator models. -
WhereUsed: array
WhereUsed
-
WipSupplyType: integer
Title:
Supply Type -
Yield: number
Title:
YieldDefault Value:1An 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.
arrayarrayarrayobject-
__FLEX_Context: string
Title:
ContextMaximum Length:30Context -
__FLEX_Context_DisplayValue: string
Title:
ContextContext
object-
ACDType: integer
Default Value:
1Read Only: This attribute specifies the acdType code which defines whether the reference designator is being added, modified or deleted through a change line -
ChangeLineId: integer
(int64)
Default Value:
-1Read Only: This attribute provides the revised line the reference designator is added/modified -
ChangeNotice: string
Maximum Length:
10Read Only: This attribute provides the Change Order Notice to which the reference designator is added/modified -
Description: string
Title:
DescriptionMaximum Length:240An attribute value that describes the reference designator code -
ReferenceDesignator: string
Title:
Reference DesignatorMaximum Length:15An attribute that represents the code of a reference designator -
ReferenceDesignatorDFF: array
ReferenceDesignatorDFF
Descriptive Flexfield extensions for structure reference designators.
arrayobject-
__FLEX_Context: string
Title:
ContextMaximum Length:30Context -
__FLEX_Context_DisplayValue: string
Title:
ContextContext
object-
ACDType: integer
Title:
Change ActionDefault Value:1Read Only: This attribute specifies the acdType code which defines whether the reference designator is being added, modified or deleted through a change line -
ACDTypeValue: string
Maximum Length:
255Read Only: This attribute specifies whether the reference designator is being added, modified or deleted through a change line -
ChangeNotice: string
Title:
Change NoticeMaximum Length:10Read Only: This attribute provides the Change Order Notice to which the substitute component is added/modified -
EnforceIntegerRequirementsValue: string
Maximum Length:
255Generates the demand with quantity specified in integers. Used in supply chain planning. The values include Round Up, Round Down or None. -
PrimaryUOMValue: string
Maximum Length:
255Read Only: Primary unit of measure specified for the substitute component. -
Priority: integer
Priority specified for the substitute component.
-
Quantity: number
Title:
QuantityAn attribute value the represents the quantity of substitute component item used. -
SubstituteComponentDFF: array
SubstituteComponentDFF
Descriptive Flexfield extensions for structure reference designators.
-
SubstituteComponentId: integer
arrayobject-
__FLEX_Context: string
Title:
ContextMaximum Length:30Context -
__FLEX_Context_DisplayValue: string
Title:
ContextContext
object-
BasisValue: string
Maximum Length:
80An attribute value that indicates how the component quantity is consumed in an assembly. The values include item and lot. -
ComponentBillSequenceId: integer
(int64)
A unique identifier of the parent structure.
-
ComponentItemDescription: string
Maximum Length:
240An attribute value that represents the item description of a component. -
ComponentItemNumber: string
Maximum Length:
300An attribute value that represents the item number of a component. -
ComponentPath: string
Maximum Length:
4000An attribute value that represents the hierarchical Path of a component item to the root item in a structure. -
ComponentSequenceId: integer
(int64)
A unique identifier for an Component in a structure.
-
EffectivityControlValue: string
An attribute which value indicates the way effectively is controlled within a structure. The values include Date, Unit Number, or Serial Number.
-
EndDateTime: string
(date-time)
The date and time on which a component in a structure ends.
-
FromSerialNumber: string
Maximum Length:
30Starting Item serial number that a component is effective in a structure. Valid only for serial effective structures. -
FromUnitNumber: string
Maximum Length:
30Starting Item Unit Number or starting Item Serial Number that a component is effective in a structure. Valid only for unit effective structures. -
ItemClassName: string
Maximum Length:
250An attribute that value provides metadata common to all items that share the category. -
ItemStatusValue: string
Maximum Length:
240An 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. -
ItemTypeValue: string
Maximum Length:
80An 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. -
OrganizationCode: string
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.
-
ParentBillSequenceId: integer
(int64)
A unique identifier for parent structure.
-
ParentItemNumber: string
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.
-
Quantity: number
An attribute value which represent the quantity of a component in structure.
-
StartDateTime: string
(date-time)
The date and time on which a component in a structure begins.
-
StructureName: string
An attribute which value represents the name of a structure.
-
TopItemFlag: boolean
Maximum Length:
1A flag that identifies the root item for the explosion of the structure. -
ToSerialNumber: string
Maximum Length:
30An 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. -
ToUnitNumber: string
Maximum Length:
30An 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.
Response
- application/json
Default Response
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
object-
AbsoluteYield: number
Title:
Absolute YieldRead Only:trueAbsolute yield of a component. The value equals quantity times yield. -
AcdType: integer
Title:
Change ActionRead Only:trueDefault Value:1Identifies whether the component is being added, modified, or deleted in a change line. -
ACDTypeValue: string
Read Only:
trueMaximum Length:255Read Only: This attribute specifies whether the substitute component is being added, modified, or deleted through a change line -
AutoRequestMaterialFlag: boolean
Title:
Automatically Request MaterialMaximum Length:1Default Value:trueA flag that indicates if a move order is automatically created for a material at work order release. -
BasisType: integer
Title:
BasisDefault Value:1 -
BasisValue: string
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)
-
BillSequenceId: integer
-
ChangeId: integer
Identifies the change order to which the pending component has been added.
-
ChangeLineId: integer
Read Only:
trueDefault Value:-1Read Only: This attribute provides the revised line the pending component is added to. -
ChangeNotice: string
Read Only:
trueMaximum Length:255Read Only: This attribute provides the Change Order Notice to which the pending component is added. -
CheckATPFlag: boolean
Title:
Check ATPDefault Value:falseA flag indicating to check available to promise and/or capable to promise information when placing demand. -
Comments: string
Title:
CommentsMaximum Length:4000An attribute value that represents comments about a component. -
CompAlternateBomDesignator: string
Title:
Formula NameMaximum Length:80Indicates the context formula for an ingredient. -
CompletionType: string
Title:
Completion TypeMaximum Length:30Indicates how the output item will be reported during work execution. -
CompletionTypeValue: string
Maximum Length:
255Value used by the manufacturer to define the type of completion of products. Values include Automatic, Manual, or None. -
ComponentDFF: array
ComponentDFF
A customer-specified field used to capture a characteristic of a component.
-
ComponentItemClass: string
Read Only:
trueMaximum Length:255The component item's item class. This attribute is read only. -
ComponentItemId: string
Maximum Length:
240 -
ComponentItemNumber: string
An attribute that represents the item number of a component. This attribute is only updatable for a create operation, otherwise is read only.
-
ComponentItemStructureName: string
Maximum Length:
255Indicates the context formula for an ingredient. -
ComponentSequenceId: integer
A unique identifier for an component in a structure. This attribute is read only and is not required for an update operation.
-
ComponentType: string
Title:
Material TypeMaximum Length:30Default Value:INPUTIndicates the type of material for the formula. -
ComponentTypeValue: string
Maximum Length:
255Indicates the type of material. The values include Ingredient or Product. -
ContributeToYield: string
Title:
Contribute to YieldMaximum Length:30Indicates whether the ingredient quantity contributes to the yield. Values are Yes and No. -
ContributeToYieldValue: string
Maximum Length:
255Value used by the manufacturer to define the contribution to the yield of ingredients. The values include Yes, No, or None. -
CreatedBy: string
Read Only:
trueMaximum Length:64Who column: An attribute which indicates the user that created the structure -
CreationDateTime: string
(date-time)
Read Only:
trueWho column: An attribute that indicates the date and time of the creation of the component. -
EndDateTime: string
(date-time)
Title:
End DateThe date and time on which a component in a structure ends. -
EnforceIntegerRequirementsValue: string
An attribute value used by planning to generate the demand in integer quantities. The values include Round Up, Round Down or None.
-
EnforceIntRequirements: number
Title:
Enforce Integer RequirementDefault Value:0 -
FindNumber: integer
Title:
Find NumberDefault Value:1An attribute value that holds find number for the component. -
FromNumber: string
Title:
From End Item Unit NumberMaximum Length:30The 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. -
ImplementationDateTime: string
(date-time)
Title:
Effective DateRead Only:trueRead 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. -
IncludeOnShipDocsFlag: boolean
Title:
Include on Shipping DocumentsDefault Value:falseA flag value that indicates if a component is displayed on shipping documentation. -
InstantiabilityCode: string
Title:
InstantiabilityMaximum Length:30 -
InstantiabilityValue: string
A unique identifier indicating whether a component item is instantiable in an item structure.
-
ItemSequenceNumber: number
Title:
Item SequenceA unique number which defines the sequence of components in a structure. -
LastUpdateDateTime: string
(date-time)
Read Only:
trueWho column: An attribute which indicates the date and time of the last update of the component. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Who column: An attribute which indicates the user that last updated the structure. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Who column: An attribute which indicates the user that logged in last for the structure. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaximumQuantity: number
Title:
Maximum QuantityAn attribute that value indicates the maximum quantity allowed on an order. -
MinimumQuantity: number
Title:
Minimum QuantityAn attribute that value indicates the minimum quantity allowed on an order. -
MutuallyExclusiveFlag: boolean
Title:
Mutually ExclusiveDefault Value:falseA flag indicating if one or more options under this Option Class can be chosen. -
OldComponentSequenceId: integer
Read Only:
trueReference to the production row when the component is modified in a change line. -
OptionalFlag: boolean
Title:
OptionalDefault Value:falseA flag indicating if component is optional for a structure. -
OrganizationId: string
Maximum Length:
240 -
PlanningPercent: number
Title:
Planning PercentDefault Value:100An attribute used by forecast planning that represents the distribution percentage for a component. -
PrimaryUOMCode: string
Maximum Length:
30 -
PrimaryUOMCodeValue: string
Maximum Length:
255A 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. -
PrimaryUOMValue: string
Read Only:
trueMaximum Length:255 -
ProductType: string
Title:
Product TypeMaximum Length:30Type of product for the formula output. -
ProductTypeValue: string
Maximum Length:
255Type of product. Values include Primary, Co-Product, or By-Product. There's only one primary product in a formula. -
Quantity: number
Title:
QuantityDefault Value:1An attribute value the represents the quantity of component item used. -
QuantityRelatedFlag: boolean
Title:
Quantity RelatedDefault Value:falseAn 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: array
ReferenceDesignator
A set of reference designators that mark the location of the component in an item structure.
-
ReplacedBy: string
Maximum Length:
255The item number of the replacement component. -
ReplacedByFindNumber: integer
An attribute value that holds the replaced by find number.
-
Replaces: string
Read Only:
trueMaximum Length:255The item number of the component that is being replaced. -
RequiredForRevenueFlag: boolean
Title:
Required for RevenueDefault Value:falseA flag indicating if component is required to recognize revenue before you ship the order. -
RequiredToShipFlag: boolean
Title:
Required to ShipDefault Value:falseFlag indicating if component is required to ship -
SalesOrderBasisValue: string
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.
-
ShowInSales: number
-
ShowInSalesValue: string
An attribute value that indicates if the component is visible in the sales application. Values include Yes, Hide Self and Hide Self and descendents.
-
SoBasis: number
Title:
Sales Order BasisDefault Value:2 -
StartDateTime: string
(date-time)
Title:
Start DateThe date and time on which a component in a structure begins. -
SubstituteComponent: array
SubstituteComponent
A set of items that can be used as substitutes for a component in a structure
-
SuggestedOperationSequence: integer
Title:
Suggested Operation SequenceAn attribute value that holds the suggested operation sequence. -
SupplyType: string
An attribute indicating a supply type for components.
-
ToNumber: string
Title:
To End Item Unit NumberMaximum Length:30The 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. -
UsePlaceholderFlag: boolean
Title:
Use PlaceholderA flag indicating if this Option Class item data should be loaded into configurator models. -
WhereUsed: array
WhereUsed
-
WipSupplyType: integer
Title:
Supply Type -
Yield: number
Title:
YieldDefault Value:1An 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.
arrayarrayLinksarrayarrayobject-
__FLEX_Context: string
Title:
ContextMaximum Length:30Context -
__FLEX_Context_DisplayValue: string
Title:
ContextContext -
ComponentSequenceId: integer
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksobject-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object-
ACDType: integer
Default Value:
1Read Only: This attribute specifies the acdType code which defines whether the reference designator is being added, modified or deleted through a change line -
ACDTypeValue: string
Read Only:
trueMaximum Length:255Read Only: This attribute specifies whether the reference designator is being added, modified or deleted through a change line -
ChangeLineId: integer
(int64)
Default Value:
-1Read Only: This attribute provides the revised line the reference designator is added/modified -
ChangeNotice: string
Maximum Length:
10Read Only: This attribute provides the Change Order Notice to which the reference designator is added/modified -
CreationDateTime: string
(date-time)
Read Only:
trueWho column: An attribute that indicates the date and time of the creation of the reference designator -
Description: string
Title:
DescriptionMaximum Length:240An attribute value that describes the reference designator code -
LastUpdateDateTime: string
(date-time)
Read Only:
trueWho column: An attribute which indicates the date and time of the last update of the reference designator -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ReferenceDesignator: string
Title:
Reference DesignatorMaximum Length:15An attribute that represents the code of a reference designator -
ReferenceDesignatorDFF: array
ReferenceDesignatorDFF
Descriptive Flexfield extensions for structure reference designators.
-
ReferenceDesignatorSequenceId: integer
(int64)
An unique identifier for the reference designator in a structure.
arrayLinksarrayobject-
__FLEX_Context: string
Title:
ContextMaximum Length:30Context -
__FLEX_Context_DisplayValue: string
Title:
ContextContext -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
RefDesigSequenceId: integer
(int64)
arrayLinksobject-
ACDType: integer
Title:
Change ActionDefault Value:1Read Only: This attribute specifies the acdType code which defines whether the reference designator is being added, modified or deleted through a change line -
ACDTypeValue: string
Maximum Length:
255Read Only: This attribute specifies whether the reference designator is being added, modified or deleted through a change line -
ChangeNotice: string
Title:
Change NoticeMaximum Length:10Read Only: This attribute provides the Change Order Notice to which the substitute component is added/modified -
CreationDateTime: string
(date-time)
Read Only:
trueWho column: An attribute that indicates the date and time of the creation of the substitute component -
EnforceIntegerRequirementsValue: string
Maximum Length:
255Generates the demand with quantity specified in integers. Used in supply chain planning. The values include Round Up, Round Down or None. -
LastUpdateDateTime: string
(date-time)
Read Only:
trueWho column: An attribute which indicates the date and time of the last update of the substitute component -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PrimaryUOMValue: string
Maximum Length:
255Read Only: Primary unit of measure specified for the substitute component. -
Priority: integer
Priority specified for the substitute component.
-
Quantity: number
Title:
QuantityAn attribute value the represents the quantity of substitute component item used. -
SubstituteComponentDFF: array
SubstituteComponentDFF
Descriptive Flexfield extensions for structure reference designators.
-
SubstituteComponentId: integer
-
SubstituteComponentItemNumber: string
Maximum Length:
255An attribute that represents the item number of a substitute component. -
SubstituteComponentSequenceId: integer
(int64)
An unique identifier for the substitute component in a structure.
arrayLinksarrayobject-
__FLEX_Context: string
Title:
ContextMaximum Length:30Context -
__FLEX_Context_DisplayValue: string
Title:
ContextContext -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SubCompSequenceId: integer
(int64)
arrayLinksobject-
BasisValue: string
Maximum Length:
80An attribute value that indicates how the component quantity is consumed in an assembly. The values include item and lot. -
ComponentBillSequenceId: integer
(int64)
A unique identifier of the parent structure.
-
ComponentItemDescription: string
Maximum Length:
240An attribute value that represents the item description of a component. -
ComponentItemNumber: string
Maximum Length:
300An attribute value that represents the item number of a component. -
ComponentPath: string
Maximum Length:
4000An attribute value that represents the hierarchical Path of a component item to the root item in a structure. -
ComponentSequenceId: integer
(int64)
A unique identifier for an Component in a structure.
-
EffectivityControlValue: string
An attribute which value indicates the way effectively is controlled within a structure. The values include Date, Unit Number, or Serial Number.
-
EndDateTime: string
(date-time)
The date and time on which a component in a structure ends.
-
FromSerialNumber: string
Maximum Length:
30Starting Item serial number that a component is effective in a structure. Valid only for serial effective structures. -
FromUnitNumber: string
Maximum Length:
30Starting Item Unit Number or starting Item Serial Number that a component is effective in a structure. Valid only for unit effective structures. -
ItemClassName: string
Maximum Length:
250An attribute that value provides metadata common to all items that share the category. -
ItemStatusValue: string
Maximum Length:
240An 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. -
ItemTypeValue: string
Maximum Length:
80An 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: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrganizationCode: string
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.
-
ParentBillSequenceId: integer
(int64)
A unique identifier for parent structure.
-
ParentItemNumber: string
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.
-
Quantity: number
An attribute value which represent the quantity of a component in structure.
-
StartDateTime: string
(date-time)
The date and time on which a component in a structure begins.
-
StructureName: string
An attribute which value represents the name of a structure.
-
TopItemFlag: boolean
Maximum Length:
1A flag that identifies the root item for the explosion of the structure. -
ToSerialNumber: string
Maximum Length:
30An 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. -
ToUnitNumber: string
Maximum Length:
30An 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.
arrayLinks- ComponentDFF
-
Parameters:
- BillSequenceId:
$request.path.BillSequenceId - ComponentSequenceId:
$request.path.ComponentSequenceId
- BillSequenceId:
- ReferenceDesignator
-
Parameters:
- BillSequenceId:
$request.path.BillSequenceId - ComponentSequenceId:
$request.path.ComponentSequenceId
A set of reference designators that mark the location of the component in an item structure. - BillSequenceId:
- SubstituteComponent
-
Parameters:
- BillSequenceId:
$request.path.BillSequenceId - ComponentSequenceId:
$request.path.ComponentSequenceId
A set of items that can be used as substitutes for a component in a structure - BillSequenceId:
- WhereUsed
-
Parameters:
- BillSequenceId:
$request.path.BillSequenceId - ComponentSequenceId:
$request.path.ComponentSequenceId
A list of item structures in which a given item is used as a component, such as item Tire is used in item structures Car and Truck, or item Button is used in item structures Keyboard and Keypad. - BillSequenceId:
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",
...
}