Update a substitute component
/fscmRestApi/resources/11.13.18.05/productChangeOrders/{ChangeId}/child/AffectedObject/{AffectedObjectUniqID}/child/AffectedItemStructure/{AffectedItemStructureUniqID}/child/StructureComponent/{StructureComponentUniqID}/child/RedlinedSubstituteComponent/{RedlinedSubstituteComponentUniqID}
Request
-
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.
-
RedlinedSubstituteComponentUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Substitute Components resource and used to uniquely identify an instance of Substitute Components. The client should not generate the hash key value. Instead, the client should query on the Substitute Components collection resource in order to navigate to a specific instance of Substitute Components to get the hash key.
-
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.
-
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.
- application/json
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 Components
The 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.
array
Flexfields for Substitute Components
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:30
Descriptive flexfield context that references the substitute component. -
__FLEX_Context_DisplayValue: string
Title:
Context
Response
- application/json
Default Response
-
Metadata-Context(required):
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(required):
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
-
ACDType: integer
Read Only:
true
Value that indicates if the substitute component is being added, modified, or deleted through a change line. -
ACDTypeValue: string
Read Only:
true
Value that indicates if the substitute component is being added, modified, or deleted through a change line. -
ChangeNotice: string
Title:
Change Notice
Read Only:true
Value that uniquely identifies the change order associated with the substitute component. -
CreationDate: string
(date-time)
Read Only:
true
Date when the substitute component was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the substitute component was most recently updated. -
links: array
Links
Title:
Links
The 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 Components
The 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.
array
Links
array
Flexfields for Substitute Components
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed 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
-
__FLEX_Context: string
Title:
Context
Maximum Length:30
Descriptive flexfield context that references the substitute component. -
__FLEX_Context_DisplayValue: string
Title:
Context
-
links: array
Links
Title:
Links
The 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.
array
Links
- SubstituteComponentDFF
-
Parameters:
- AffectedItemStructureUniqID:
$request.path.AffectedItemStructureUniqID
- AffectedObjectUniqID:
$request.path.AffectedObjectUniqID
- ChangeId:
$request.path.ChangeId
- RedlinedSubstituteComponentUniqID:
$request.path.RedlinedSubstituteComponentUniqID
- StructureComponentUniqID:
$request.path.StructureComponentUniqID
The Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component. - AffectedItemStructureUniqID:
Examples
This example describes how to update a substitute 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/productChangeOrders/ChangeId/child/AffectedObject/ChangeLineId/child/AffectedItemStructure/AffectedItemStructureUniqID/child/StructureComponent/StructureComponentUniqID/child/RedlinedSubstituteComponent/RedlinedSubstituteComponentUniqID"
For example:
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/productChangeOrders/300100184375438/child/AffectedObject/00020000000EACED00057708000110F084E300980000000EACED00057708000110F084E30098/child/AffectedItemStructure/300100184375436/child/StructureComponent/300100184807411/child/RedlinedSubstituteComponent/300100184807415"
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":2 }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "LastUpdateDate": "2020-09-23T22:17:30.270+05:30", "CreationDate": "2020-09-23T21:43:12.001+05:30", "ChangeNotice": null, "SubstituteComponentItemNumber": "P0076", "ACDType": 1, "SequenceId": 300100184807415, "Quantity": 2, "ACDTypeValue": "Added", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100184375438/child/AffectedObject/00020000000EACED00057708000110F084E300980000000EACED00057708000110F084E30098/child/AffectedItemStructure/300100184375436/child/StructureComponent/300100184807411/child/RedlinedSubstituteComponent/300100184807415", "name": "RedlinedSubstituteComponent", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100184375438/child/AffectedObject/00020000000EACED00057708000110F084E300980000000EACED00057708000110F084E30098/child/AffectedItemStructure/300100184375436/child/StructureComponent/300100184807411/child/RedlinedSubstituteComponent/300100184807415", "name": "RedlinedSubstituteComponent", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100184375438/child/AffectedObject/00020000000EACED00057708000110F084E300980000000EACED00057708000110F084E30098/child/AffectedItemStructure/300100184375436/child/StructureComponent/300100184807411", "name": "StructureComponent", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100184375438/child/AffectedObject/00020000000EACED00057708000110F084E300980000000EACED00057708000110F084E30098/child/AffectedItemStructure/300100184375436/child/StructureComponent/300100184807411/child/RedlinedSubstituteComponent/300100184807415/child/SubstituteComponentDFF", "name": "SubstituteComponentDFF", "kind": "collection" } ] }