Update one component
patch
/fscmRestApi/resources/11.13.18.05/productChangeOrders/{ChangeId}/child/AffectedObject/{AffectedObjectUniqID}/child/AffectedItemStructure/{AffectedItemStructureUniqID}/child/StructureComponent/{StructureComponentUniqID}
Request
Path Parameters
-
AffectedItemStructureUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Affected Item Structures resource and used to uniquely identify an instance of Affected Item Structures. The client should not generate the hash key value. Instead, the client should query on the Affected Item Structures collection resource in order to navigate to a specific instance of Affected Item Structures to get the hash key.
-
AffectedObjectUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Affected Objects resource and used to uniquely identify an instance of Affected Objects. The client should not generate the hash key value. Instead, the client should query on the Affected Objects collection resource in order to navigate to a specific instance of Affected Objects to get the hash key.
-
ChangeId(required): integer
Value that uniquely identifies the change.
-
StructureComponentUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Structure Components resource and used to uniquely identify an instance of Structure Components. The client should not generate the hash key value. Instead, the client should query on the Structure Components collection resource in order to navigate to a specific instance of Structure Components to get the hash key.
Header Parameters
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
ACDTypeCode: integer
Title:
Change ActionDefault Value:1Value that indicates whether the component is being added, changed, or deleted through a change line. -
AlternateBOMDesignator: string
Maximum Length:
255Value that identifies the alternate bill of material (BOM) designator of the item. -
BillSequenceId: integer
Value that uniquely identifies the structure associated with the item.
-
ChangeId: integer
Value that uniquely identifies the change order associated with the component.
-
ChangeLineId: integer
Default Value:
-1Value that uniquely identifies the change line associated with the component. -
ChangeNotice: string
Maximum Length:
255Number that identifies the change order associated with the item. -
ComponentItemId: string
Maximum Length:
240Value that uniquely identifies the item associated with the component. -
ComponentQuantity: number
Title:
QuantityDefault Value:1Quantity of the component that is used to build the structure. -
ComponentRemarks: string
Title:
CommentsMaximum Length:4000Comments entered by the user for the component. -
ComponentYieldFactor: number
Title:
YieldDefault Value:1Planned or actual output of a process, relevant to the quantity. The yield includes a loss, an increase, or no change in the planned or actual output quantity. -
DisableDate: string
(date-time)
Title:
Effective End DateDate when the component was disabled. -
EffectivityDate: string
(date-time)
Title:
Effective Start DateDate when the component became effective to be used in the structure. -
ImplementationDate: string
(date-time)
Title:
Effective DateDate when the component was implemented. -
ItemNum: number
Title:
Item SequenceNumber that identifies the item associated with the component. -
ItemNumber: string
Number that identifies the item corresponding to the component.
-
OldComponentSequenceId: integer
Value that uniquely identifies the component that was originally present in the structure.
-
OrganizationCode: string
Maximum Length:
255Abbreviation that identifies the organization of the item. -
OrganizationId: string
Maximum Length:
240Value that uniquely identifies the organization of the component. -
OriginalSystemReference: string
Maximum Length:
50Value that identifies the record from the original application. -
PrimaryUomCode: string
Title:
Component UOMMaximum Length:30Value that indicates the unit of measure of the component as used in a bill of materials. -
QuantityRelatedFlag: boolean
Title:
Quantity RelatedDefault Value:trueValue 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. -
RedlinedReferenceDesignator: array
Reference Designators
Title:
Reference DesignatorsThe Reference Designators resource manages the details of a reference designator. -
RedlinedSubstituteComponent: array
Substitute Components
Title:
Substitute ComponentsThe Substitute Components resource manages the details of a substitute component.
Nested Schema : Reference Designators
Type:
arrayTitle:
Reference DesignatorsThe Reference Designators resource manages the details of a reference designator.
Show Source
Nested Schema : Substitute Components
Type:
arrayTitle:
Substitute ComponentsThe Substitute Components resource manages the details of a substitute component.
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItemStructure-StructureComponent-RedlinedReferenceDesignator-item-patch-request
Type:
Show Source
object-
Description: string
Description for the reference designator.
-
ReferenceDesignator: string
Name of the reference designator.
-
ReferenceDesignatorDFF: array
Flexfields for Reference Designators
Title:
Flexfields for Reference DesignatorsThe Flexfields for Reference Designators resource gets the descriptive flexfields associated with the reference designator. -
ReferenceDesignatorSequenceId: integer
Value that uniquely identifies the reference designator. This attribute is read-only and is not required for an update operation.
Nested Schema : Flexfields for Reference Designators
Type:
arrayTitle:
Flexfields for Reference DesignatorsThe Flexfields for Reference Designators resource gets the descriptive flexfields associated with the reference designator.
Show Source
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
ContextMaximum Length:30Descriptive flexfield context that references the structure. -
__FLEX_Context_DisplayValue: string
Title:
ContextContext
Nested Schema : schema
Type:
Show Source
object-
Quantity: number
Quantity of the substitute component that is used to build the structure.
-
SubstituteComponentDFF: array
Flexfields for Substitute Components
Title:
Flexfields for Substitute ComponentsThe Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component. -
SubstituteComponentId: integer
Value that uniquely identifies the item of the substitute component.
Nested Schema : Flexfields for Substitute Components
Type:
arrayTitle:
Flexfields for Substitute ComponentsThe Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component.
Show Source
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
ContextMaximum Length:30Descriptive flexfield context that references the substitute component. -
__FLEX_Context_DisplayValue: string
Title:
ContextContext
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : productChangeOrders-AffectedObject-AffectedItemStructure-StructureComponent-item-response
Type:
Show Source
object-
ACDTypeCode: integer
Title:
Change ActionDefault Value:1Value that indicates whether the component is being added, changed, or deleted through a change line. -
AlternateBOMDesignator: string
Maximum Length:
255Value that identifies the alternate bill of material (BOM) designator of the item. -
BillSequenceId: integer
Value that uniquely identifies the structure associated with the item.
-
ChangeId: integer
Value that uniquely identifies the change order associated with the component.
-
ChangeLineId: integer
Default Value:
-1Value that uniquely identifies the change line associated with the component. -
ChangeNotice: string
Maximum Length:
255Number that identifies the change order associated with the item. -
ComponentItemClass: string
Read Only:
trueMaximum Length:255Class of the component item. This attribute is read-only and is not required for an update operation. -
ComponentItemId: string
Maximum Length:
240Value that uniquely identifies the item associated with the component. -
ComponentQuantity: number
Title:
QuantityDefault Value:1Quantity of the component that is used to build the structure. -
ComponentRemarks: string
Title:
CommentsMaximum Length:4000Comments entered by the user for the component. -
ComponentSequenceId: integer
Value that uniquely identifies the component that is currently in the structure.
-
ComponentYieldFactor: number
Title:
YieldDefault Value:1Planned or actual output of a process, relevant to the quantity. The yield includes a loss, an increase, or no change in the planned or actual output quantity. -
CreationDate: string
(date-time)
Read Only:
trueDate when the application created the component. -
DisableDate: string
(date-time)
Title:
Effective End DateDate when the component was disabled. -
EffectivityDate: string
(date-time)
Title:
Effective Start DateDate when the component became effective to be used in the structure. -
ImplementationDate: string
(date-time)
Title:
Effective DateDate when the component was implemented. -
ItemNum: number
Title:
Item SequenceNumber that identifies the item associated with the component. -
ItemNumber: string
Number that identifies the item corresponding to the component.
-
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the application most recently updated the component. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
trueNumber that identifies the version of the object of the component. -
OldComponentSequenceId: integer
Value that uniquely identifies the component that was originally present in the structure.
-
OrganizationCode: string
Maximum Length:
255Abbreviation that identifies the organization of the item. -
OrganizationId: string
Maximum Length:
240Value that uniquely identifies the organization of the component. -
OriginalSystemReference: string
Maximum Length:
50Value that identifies the record from the original application. -
PrimaryUomCode: string
Title:
Component UOMMaximum Length:30Value that indicates the unit of measure of the component as used in a bill of materials. -
QuantityRelatedFlag: boolean
Title:
Quantity RelatedDefault Value:trueValue 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. -
RedlinedReferenceDesignator: array
Reference Designators
Title:
Reference DesignatorsThe Reference Designators resource manages the details of a reference designator. -
RedlinedSubstituteComponent: array
Substitute Components
Title:
Substitute ComponentsThe Substitute Components resource manages the details of a substitute component.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Reference Designators
Type:
arrayTitle:
Reference DesignatorsThe Reference Designators resource manages the details of a reference designator.
Show Source
Nested Schema : Substitute Components
Type:
arrayTitle:
Substitute ComponentsThe Substitute Components resource manages the details of a substitute component.
Show Source
Nested Schema : link
Type:
Show Source
object-
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.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : productChangeOrders-AffectedObject-AffectedItemStructure-StructureComponent-RedlinedReferenceDesignator-item-response
Type:
Show Source
object-
ACDType: integer
Read Only:
trueValue that indicates if the reference designator is being added, modified, or deleted through a change line. -
ACDTypeValue: string
Read Only:
trueValue that indicates if the reference designator is being added, modified, or deleted through a change line. -
ChangeLineId: integer
(int64)
Read Only:
trueDefault Value:-1Value that uniquely identifies the change line corresponding to the reference designator. -
ChangeNotice: string
Read Only:
trueValue that uniquely identifies the change order associated with the reference designator. -
CreationDateTime: string
(date-time)
Read Only:
trueDate and time when the reference designator was created. -
Description: string
Description for the reference designator.
-
LastUpdateDateTime: string
(date-time)
Read Only:
trueDate and time when the reference designator was most recently updated. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ReferenceDesignator: string
Name of the reference designator.
-
ReferenceDesignatorDFF: array
Flexfields for Reference Designators
Title:
Flexfields for Reference DesignatorsThe Flexfields for Reference Designators resource gets the descriptive flexfields associated with the reference designator. -
ReferenceDesignatorSequenceId: integer
Value that uniquely identifies the reference designator. This attribute is read-only and is not required for an update operation.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Reference Designators
Type:
arrayTitle:
Flexfields for Reference DesignatorsThe Flexfields for Reference Designators resource gets the descriptive flexfields associated with the reference designator.
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItemStructure-StructureComponent-RedlinedReferenceDesignator-ReferenceDesignatorDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
ContextMaximum Length:30Descriptive flexfield context that references the structure. -
__FLEX_Context_DisplayValue: string
Title:
ContextContext -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
RefDesigSequenceId: integer
(int64)
Value that uniquely identifies the reference designator. This attribute is read-only and is not required for an update operation.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItemStructure-StructureComponent-RedlinedSubstituteComponent-item-response
Type:
Show Source
object-
ACDType: integer
Read Only:
trueValue that indicates if the substitute component is being added, modified, or deleted through a change line. -
ACDTypeValue: string
Read Only:
trueValue that indicates if the substitute component is being added, modified, or deleted through a change line. -
ChangeNotice: string
Title:
Change NoticeRead Only:trueValue that uniquely identifies the change order associated with the substitute component. -
CreationDate: string
(date-time)
Read Only:
trueDate when the substitute component was created. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the substitute component was most recently updated. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Quantity: number
Quantity of the substitute component that is used to build the structure.
-
SequenceId: integer
Value that uniquely identifies the substitute component in a structure. This attribute is read-only and is not required for an update operation.
-
SubstituteComponentDFF: array
Flexfields for Substitute Components
Title:
Flexfields for Substitute ComponentsThe Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component. -
SubstituteComponentId: integer
Value that uniquely identifies the item of the substitute component.
-
SubstituteComponentItemNumber: string
Number that identifies the item of the substitute component.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Substitute Components
Type:
arrayTitle:
Flexfields for Substitute ComponentsThe Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component.
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItemStructure-StructureComponent-RedlinedSubstituteComponent-SubstituteComponentDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
ContextMaximum Length:30Descriptive flexfield context that references the substitute component. -
__FLEX_Context_DisplayValue: string
Title:
ContextContext -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SubCompSequenceId: integer
(int64)
Value that uniquely identifies the substitute component in a structure. This attribute is read-only and is not required for an update operation.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- RedlinedReferenceDesignator
-
Parameters:
- AffectedItemStructureUniqID:
$request.path.AffectedItemStructureUniqID - AffectedObjectUniqID:
$request.path.AffectedObjectUniqID - ChangeId:
$request.path.ChangeId - StructureComponentUniqID:
$request.path.StructureComponentUniqID
The Reference Designators resource manages the details of a reference designator. - AffectedItemStructureUniqID:
- RedlinedSubstituteComponent
-
Parameters:
- AffectedItemStructureUniqID:
$request.path.AffectedItemStructureUniqID - AffectedObjectUniqID:
$request.path.AffectedObjectUniqID - ChangeId:
$request.path.ChangeId - StructureComponentUniqID:
$request.path.StructureComponentUniqID
The Substitute Components resource manages the details of a substitute component. - AffectedItemStructureUniqID: