Create substitute components in the bill of resources
post
/fscmRestApi/resources/11.13.18.05/simulationSets/{SimulationSetId}/child/BillOfResources/{BorId}/child/SubstituteComponents
Request
Path Parameters
-
BorId(required): integer(int64)
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=
-
SimulationSetId(required): integer(int64)
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=
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
-
CreatedBy: string
Maximum Length:
64
User who created the substitute components in the bill of resources. -
CreationDate: string
(date-time)
Date and time when the user created the substitute components in the bill of resources.
-
LastUpdateDate: string
(date-time)
Date and time when the user most recently updated the substitute components in the bill of resources.
-
LastUpdatedBy: string
Maximum Length:
64
User who most recently updated the substitute components in the bill of resources. -
SubstituteComponentItemId: integer
(int64)
Value that uniquely identifies the component item to use as the substitute component in the bill of resources.
-
SubstituteComponentItemName: string
Maximum Length:
300
Name of the component item to use as the substitute component in the bill of resources. -
SubstituteComponentItemPriority: number
Value that indicates the priority associated with the component item to use as the substitute component in the bill of resources.
-
SubstituteComponentItemQuantity: number
Default Value:
0
Value that indicates the quantity of the substitute component being consumed.
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 : simulationSets-BillOfResources-SubstituteComponents-item-response
Type:
Show Source
object
-
CreatedBy: string
Maximum Length:
64
User who created the substitute components in the bill of resources. -
CreationDate: string
(date-time)
Date and time when the user created the substitute components in the bill of resources.
-
LastUpdateDate: string
(date-time)
Date and time when the user most recently updated the substitute components in the bill of resources.
-
LastUpdatedBy: string
Maximum Length:
64
User who most recently updated the substitute components in the bill of resources. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SubstituteComponentItemId: integer
(int64)
Value that uniquely identifies the component item to use as the substitute component in the bill of resources.
-
SubstituteComponentItemName: string
Maximum Length:
300
Name of the component item to use as the substitute component in the bill of resources. -
SubstituteComponentItemPriority: number
Value that indicates the priority associated with the component item to use as the substitute component in the bill of resources.
-
SubstituteComponentItemQuantity: number
Default Value:
0
Value that indicates the quantity of the substitute component being consumed. -
SubstituteComponentItemUOM: string
Read Only:
true
Maximum Length:4000
Unit of measure associated with the substitute component.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Examples
The following examples describe how to create substitute components in the bill of resources.
Example 1 cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username: password -X POST -H "Content-Type: application/json" -d 'request payload' "https://servername/fscmRestApi/resources/version/simulationSets/SimulationSetId/child/BillOfResources/BorId/child/SubstituteComponents"
For
example:
curl -u username: password -X POST -H "Content-Type: application/json" -d 'request payload' "https://servername/fscmRestApi/resources/11.13.18.05/simulationSets/300100081236009/child/BillOfResources/91079/child/SubstituteComponents"
Example 1 Request Body
The following example includes the contents of the request body in JSON format:
{ "SubstituteComponentItemId": 19489, "SubstituteComponentItemName": "LH-eBook4G-PCBSubAssy-Memory 4GB-335", "SubstituteComponentItemPriority": 1, "SubstituteComponentItemQuantity": 1 }
Example 1 Response Body
The following example includes the contents of the response body in JSON
format:
{ "SubstituteComponentItemId": 19489, "SubstituteComponentItemName": "LH-eBook4G-PCBSubAssy-Memory 4GB-335", "SubstituteComponentItemPriority": 1, "SubstituteComponentItemQuantity": 1, "SubstituteComponentItemUOM": "EA", "CreatedBy": "APS_ALL", "CreationDate": "2021-10-20T14:15:33+00:00", "LastUpdatedBy": "APS_ALL", "LastUpdateDate": "2021-10-20T14:15:33.064+00:00", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/91078/child/SubstituteComponents/19489", "name": "SubstituteComponents", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/91078/child/SubstituteComponents/19489", "name": "SubstituteComponents", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/91078", "name": "BillOfResources", "kind": "item" } ] }
Example 2 cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username: password -X POST -H "Content-Type: application/json" -d 'request payload' "https://servername/fscmRestApi/resources/version"
For example:
curl -u username: password -X POST -H "Content-Type: application/json" -d 'request payload' "https://servername/fscmRestApi/resources/11.13.18.05"
Example 2 Request Body
The following example includes the contents of the request body in JSON
format:
{ "parts": [ { "id": "1", "path": "/simulationSets/300100081236009/child/BillOfResources/91079/child/SubstituteComponents", "operation": "create", "payload": { "SubstituteComponentItemId": 19489, "SubstituteComponentItemName": "LH-eBook4G-PCBSubAssy-Memory 4GB-335", "SubstituteComponentItemPriority": 1, "SubstituteComponentItemQuantity": 1 } }, { "id": "2", "path": "/simulationSets/300100081236009/child/BillOfResources/91079/child/SubstituteComponents", "operation": "create", "payload": { "SubstituteComponentItemId": 733152, "SubstituteComponentItemName": "LH-eBook5G-PCBSubAssy-Memory 32GB-338", "SubstituteComponentItemPriority": 1, "SubstituteComponentItemQuantity": 1 } } ] }
Example 2 Response Body
Here's an example of the response body in JSON format:
{ "parts": [ { "id": "1", "path": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/91079/child/SubstituteComponents", "operation": "create", "payload": { "SubstituteComponentItemId": 19489, "SubstituteComponentItemName": "LH-eBook4G-PCBSubAssy-Memory 4GB-335", "SubstituteComponentItemPriority": 1, "SubstituteComponentItemQuantity": 1, "SubstituteComponentItemUOM": "EA", "CreatedBy": "APS_ALL", "CreationDate": "2021-10-21T10:22:01+00:00", "LastUpdatedBy": "APS_ALL", "LastUpdateDate": "2021-10-21T10:22:01.247+00:00", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/91079/child/SubstituteComponents/19489", "name": "SubstituteComponents", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/91079/child/SubstituteComponents/19489", "name": "SubstituteComponents", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/91079", "name": "BillOfResources", "kind": "item" } ] } }, { "id": "2", "path": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/91079/child/SubstituteComponents", "operation": "create", "payload": { "SubstituteComponentItemId": 733152, "SubstituteComponentItemName": "LH-eBook5G-PCBSubAssy-Memory 32GB-338", "SubstituteComponentItemPriority": 1, "SubstituteComponentItemQuantity": 1, "SubstituteComponentItemUOM": "EA", "CreatedBy": "APS_ALL", "CreationDate": "2021-10-21T10:22:01.230+00:00", "LastUpdatedBy": "APS_ALL", "LastUpdateDate": "2021-10-21T10:22:01.377+00:00", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/91079/child/SubstituteComponents/733152", "name": "SubstituteComponents", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/91079/child/SubstituteComponents/733152", "name": "SubstituteComponents", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/91079", "name": "BillOfResources", "kind": "item" } ] } } ] }