Create one substitute component
post
/fscmRestApi/resources/11.13.18.05/productChangeOrders/{ChangeId}/child/AffectedObject/{AffectedObjectUniqID}/child/AffectedItemStructure/{AffectedItemStructureUniqID}/child/StructureComponent/{StructureComponentUniqID}/child/RedlinedSubstituteComponent
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:
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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(required): integer
Value that uniquely identifies the item of the substitute component.
-
SubstituteComponentItemNumber: string
Number that identifies the item of the substitute component.
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 : productChangeOrders-AffectedObject-AffectedItemStructure-StructureComponent-RedlinedSubstituteComponent-SubstituteComponentDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:30
Descriptive flexfield context that references the substitute component. -
__FLEX_Context_DisplayValue: string
Title:
Context
-
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.
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-RedlinedSubstituteComponent-item-response
Type:
Show Source
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : link
Type:
Show Source
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.
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-RedlinedSubstituteComponent-SubstituteComponentDFF-item-response
Type:
Show Source
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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: