Update one alternate resource in the bill of resources
patch
/fscmRestApi/resources/11.13.18.05/simulationSets/{SimulationSetId}/child/BillOfResources/{BorId}/child/AlternateResources/{AlternateResourceId}
Request
Path Parameters
-
AlternateResourceId(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=
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AlternateResourceCode: string
Maximum Length:
40
Abbreviation that identifies the alternate resource. -
AlternateResourceId: integer
(int64)
Value that uniquely identifies the alternate resource.
-
AlternateResourcePriority: number
Value that indicates the priority associated with the resource to use as the alternate resource.
-
AlternateResourceQuantity: number
Default Value:
0
Value that indicates the quantity of the alternate resource being consumed. -
CreatedBy: string
Maximum Length:
64
User who created the alternate resources in the bill of resources. -
CreationDate: string
(date-time)
Date and time when the user created the alternate resources in the bill of resources.
-
LastUpdateDate: string
(date-time)
Date and time when the user most recently updated the alternate resources in the bill of resources.
-
LastUpdatedBy: string
Maximum Length:
64
User who most recently updated the alternate resources in the bill of resources.
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-AlternateResources-item-response
Type:
Show Source
object
-
AlternateResourceCode: string
Maximum Length:
40
Abbreviation that identifies the alternate resource. -
AlternateResourceId: integer
(int64)
Value that uniquely identifies the alternate resource.
-
AlternateResourcePriority: number
Value that indicates the priority associated with the resource to use as the alternate resource.
-
AlternateResourceQuantity: number
Default Value:
0
Value that indicates the quantity of the alternate resource being consumed. -
AlternateResourceUOM: string
Read Only:
true
Maximum Length:4000
Unit of measure associated with the alternate resource. -
AlternateWorkCenterCode: string
Read Only:
true
Maximum Length:120
Abbreviation that identifies the work center to which the alternate resource belongs to in the bill of resources. -
AlternateWorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center to which the alternate resource belongs to in the bill of resources. -
CreatedBy: string
Maximum Length:
64
User who created the alternate resources in the bill of resources. -
CreationDate: string
(date-time)
Date and time when the user created the alternate resources in the bill of resources.
-
LastUpdateDate: string
(date-time)
Date and time when the user most recently updated the alternate resources in the bill of resources.
-
LastUpdatedBy: string
Maximum Length:
64
User who most recently updated the alternate resources in the bill of resources. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.