Update one bill of resource
patch
/fscmRestApi/resources/11.13.18.05/simulationSets/{SimulationSetId}/child/BillOfResources/{BorId}
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AlternateResources: array
Alternate Resources
Title:
Alternate Resources
The Alternate Resources resource manages the collected alternate resources in the bill of resources that are used as input for the planning engine. -
AssemblyDescription: string
Maximum Length:
240
Description of the assembly item. -
AssemblyItemId: integer
(int64)
Value that uniquely identifies the assembly item.
-
AssemblyItemLevel: string
Maximum Length:
8
Data load level of the item being produced. Valid values are Item and Category. -
AssemblyItemName: string
Maximum Length:
300
Name of the assembly item. -
AssemblyQuantity: number
Default Value:
0
Quantity of the item being produced. -
AssemblyUOM: string
Maximum Length:
4000
Planning unit of measure of the assembly item. -
BasisType: integer
Default Value:
1
Value that indicates whether the component item or resource usage quantity in an assembly item's bill of resources is fixed or variable. Contains one of the following values: 1 or 2. If 1, then usage quantity is variable. If 2, then usage quantity is fixed. The default value is 1. -
BorId(required): integer
(int64)
Value that uniquely identifies the bill of resources.
-
CatalogId: integer
(int64)
Value that uniquely identifies the catalog.
-
CatalogName: string
Maximum Length:
30
Category set or name of the catalog to which an item belongs. If Assembly Item Level is set to Category, then this value is required. -
CategoryId: integer
(int64)
Value that uniquely identifies the category.
-
CategoryName: string
Maximum Length:
250
Name of the category to which an item belongs. If Assembly Item Level is set to Category, then this value is required. -
CategoryUOM: string
Maximum Length:
3
Planning unit of measure of the category. -
ComponentDescription: string
Maximum Length:
240
Description of the component item. -
ComponentItemId: integer
(int64)
Value that uniquely identifies the component item.
-
ComponentItemName: string
Maximum Length:
300
Name of the component item. -
ComponentUOM: string
Maximum Length:
4000
Planning unit of measure of the component item. -
ComponentUsageQuantity: number
Title:
Usage Quantity
Default Value:0
Quantity of the item being consumed. -
ConsumptionType: string
Maximum Length:
72
Type of consumption. This attribute indicates whether an item or resource is being consumed. Valid values are Item and Resource. -
EffectiveEndDate: string
(date)
Date when the component item or resource is no longer available.
-
EffectiveStartDate: string
(date)
Date when the component item or resource is available.
-
FindNumber: integer
Number that uniquely identifies a component when the same component occurs multiple times at the same level in a bill of material.
-
LeadTimeOffsetInDays: number
Default Value:
0
Value that indicates the number of days for which the planning engine offsets the consumption of a component or resource. -
OptionDependentDetails: array
Option Dependent Resource Details
Title:
Option Dependent Resource Details
In the bill of resources, the Option Dependent Resource Details resource manages the details for resources used in operations that are dependent on the choice of one or multiple optional components. The details are used as input for the planning engine. -
Organization: string
Maximum Length:
4000
Abbreviation that identifies the organization associated with the item. -
OrganizationId(required): integer
(int64)
Value that uniquely identifies the organization.
-
ResourceCode: string
Maximum Length:
40
Abbreviation that identifies the resource. -
ResourceId: integer
(int64)
Value that uniquely identifies the resource.
-
ResourceUOM: string
Maximum Length:
4000
Unit of measure associated with the resource. -
ResourceUsageQuantity: number
Default Value:
0
Quantity of the resource being consumed. -
SourceOrganization: string
Maximum Length:
4000
Name of the organization where the component or resource is defined. -
SourceOrganizationId: integer
(int64)
Value that uniquely identifies the source organization.
-
SubstituteComponents: array
Substitute Components
Title:
Substitute Components
The Substitute Components resource manages the collected substitute component, in the bill of resources, which is used as input for the planning engine. -
WorkCenterCode: string
Maximum Length:
120
Abbreviation that identifies the work center. -
WorkCenterId: integer
(int64)
Value that uniquely identifies the work center.
Nested Schema : Alternate Resources
Type:
array
Title:
Alternate Resources
The Alternate Resources resource manages the collected alternate resources in the bill of resources that are used as input for the planning engine.
Show Source
Nested Schema : Option Dependent Resource Details
Type:
array
Title:
Option Dependent Resource Details
In the bill of resources, the Option Dependent Resource Details resource manages the details for resources used in operations that are dependent on the choice of one or multiple optional components. The details are used as input for the planning engine.
Show Source
Nested Schema : Substitute Components
Type:
array
Title:
Substitute Components
The Substitute Components resource manages the collected substitute component, in the bill of resources, which is used as input for the planning engine.
Show Source
Nested 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.
Nested Schema : simulationSets-BillOfResources-OptionDependentDetails-item-patch-request
Type:
Show Source
object
Nested Schema : simulationSets-BillOfResources-SubstituteComponents-item-patch-request
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(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.
Root Schema : simulationSets-BillOfResources-item-response
Type:
Show Source
object
-
AlternateResources: array
Alternate Resources
Title:
Alternate Resources
The Alternate Resources resource manages the collected alternate resources in the bill of resources that are used as input for the planning engine. -
AssemblyDescription: string
Maximum Length:
240
Description of the assembly item. -
AssemblyItemId: integer
(int64)
Value that uniquely identifies the assembly item.
-
AssemblyItemLevel: string
Maximum Length:
8
Data load level of the item being produced. Valid values are Item and Category. -
AssemblyItemName: string
Maximum Length:
300
Name of the assembly item. -
AssemblyQuantity: number
Default Value:
0
Quantity of the item being produced. -
AssemblyUOM: string
Maximum Length:
4000
Planning unit of measure of the assembly item. -
BasisType: integer
Default Value:
1
Value that indicates whether the component item or resource usage quantity in an assembly item's bill of resources is fixed or variable. Contains one of the following values: 1 or 2. If 1, then usage quantity is variable. If 2, then usage quantity is fixed. The default value is 1. -
BorId: integer
(int64)
Value that uniquely identifies the bill of resources.
-
CatalogId: integer
(int64)
Value that uniquely identifies the catalog.
-
CatalogName: string
Maximum Length:
30
Category set or name of the catalog to which an item belongs. If Assembly Item Level is set to Category, then this value is required. -
CategoryId: integer
(int64)
Value that uniquely identifies the category.
-
CategoryName: string
Maximum Length:
250
Name of the category to which an item belongs. If Assembly Item Level is set to Category, then this value is required. -
CategoryUOM: string
Maximum Length:
3
Planning unit of measure of the category. -
ComponentDescription: string
Maximum Length:
240
Description of the component item. -
ComponentItemId: integer
(int64)
Value that uniquely identifies the component item.
-
ComponentItemName: string
Maximum Length:
300
Name of the component item. -
ComponentUOM: string
Maximum Length:
4000
Planning unit of measure of the component item. -
ComponentUsageQuantity: number
Title:
Usage Quantity
Default Value:0
Quantity of the item being consumed. -
ConsumptionType: string
Maximum Length:
72
Type of consumption. This attribute indicates whether an item or resource is being consumed. Valid values are Item and Resource. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the bill of resources. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the bill of resources. -
EffectiveEndDate: string
(date)
Date when the component item or resource is no longer available.
-
EffectiveStartDate: string
(date)
Date when the component item or resource is available.
-
FindNumber: integer
Number that uniquely identifies a component when the same component occurs multiple times at the same level in a bill of material.
-
LastUpdateDate: string
(date-time)
Read Only:
true
User who most recently updated the bill of resources. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Date and time when the user most recently updated the bill of resources. -
LeadTimeOffsetInDays: number
Default Value:
0
Value that indicates the number of days for which the planning engine offsets the consumption of a component or resource. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OptionDependent: integer
(int32)
Read Only:
true
Value that indicates whether the resource in an assembly item's bill of resources is used in operations that are dependent on the choice of one or multiple optional components. Contains one of the following values: 1 or 2. If 1, then the resource is option dependent. If 2, then the resource isn't option dependent. This attribute doesn't have a default value. -
OptionDependentDetails: array
Option Dependent Resource Details
Title:
Option Dependent Resource Details
In the bill of resources, the Option Dependent Resource Details resource manages the details for resources used in operations that are dependent on the choice of one or multiple optional components. The details are used as input for the planning engine. -
Organization: string
Maximum Length:
4000
Abbreviation that identifies the organization associated with the item. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
ResourceCode: string
Maximum Length:
40
Abbreviation that identifies the resource. -
ResourceId: integer
(int64)
Value that uniquely identifies the resource.
-
ResourceUOM: string
Maximum Length:
4000
Unit of measure associated with the resource. -
ResourceUsageQuantity: number
Default Value:
0
Quantity of the resource being consumed. -
SourceOrganization: string
Maximum Length:
4000
Name of the organization where the component or resource is defined. -
SourceOrganizationId: integer
(int64)
Value that uniquely identifies the source organization.
-
SubstituteComponents: array
Substitute Components
Title:
Substitute Components
The Substitute Components resource manages the collected substitute component, in the bill of resources, which is used as input for the planning engine. -
WorkCenterCode: string
Maximum Length:
120
Abbreviation that identifies the work center. -
WorkCenterId: integer
(int64)
Value that uniquely identifies the work center.
Nested Schema : Alternate Resources
Type:
array
Title:
Alternate Resources
The Alternate Resources resource manages the collected alternate resources in the bill of resources that are used as input for the planning engine.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Option Dependent Resource Details
Type:
array
Title:
Option Dependent Resource Details
In the bill of resources, the Option Dependent Resource Details resource manages the details for resources used in operations that are dependent on the choice of one or multiple optional components. The details are used as input for the planning engine.
Show Source
Nested Schema : Substitute Components
Type:
array
Title:
Substitute Components
The Substitute Components resource manages the collected substitute component, in the bill of resources, which is used as input for the planning engine.
Show Source
Nested 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.
Nested Schema : simulationSets-BillOfResources-OptionDependentDetails-item-response
Type:
Show Source
object
-
AssemblyItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the assembly item. -
AssemblyItemName: string
Read Only:
true
Maximum Length:255
Name of the assembly item. -
BorId: integer
Read Only:
true
Value that uniquely identifies the bill of resources. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OperationSequenceNumber: number
Read Only:
true
Number that indicates the order for operations that are dependent on the choice of one or multiple optional components in the bill of resources. -
OptionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the optional component for the option dependent resource in the bill of resources. -
OptionMemberId: integer
(int64)
Read Only:
true
Value that uniquely identifies the end option item or class in the optional component lineage in the bill of resources. -
OptionMemberLineageNames: string
Read Only:
true
Maximum Length:4000
Ordered list of names for the parent option items or classes of an optional component in the bill of resources. -
OptionMemberName: string
Read Only:
true
Maximum Length:4000
Name of the end option item or class in the optional component lineage in the bill of resources. -
OptionMemberType: string
Read Only:
true
Maximum Length:4000
Value that indicates whether the optional component in the bill of resources is an item or class. Contains one of the following values: 0 or 1. If 0, then the component is an option item. If 1, then the component is an option class. This attribute doesn't have a default value. -
OptionMemberUsageQuantity: number
Read Only:
true
Value that indicates the quantity of the optional component being consumed in the bill of resources. -
Organization: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the organization associated with the item. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the organization. -
ResourceCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the resource. -
ResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the resource. -
ResourceUsageQuantity: number
Read Only:
true
Quantity of the resource being consumed.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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
Links
- AlternateResources
-
Parameters:
- BorId:
$request.path.BorId
- SimulationSetId:
$request.path.SimulationSetId
The Alternate Resources resource manages the collected alternate resources in the bill of resources that are used as input for the planning engine. - BorId:
- OptionDependentDetails
-
Parameters:
- BorId:
$request.path.BorId
- SimulationSetId:
$request.path.SimulationSetId
In the bill of resources, the Option Dependent Resource Details resource manages the details for resources used in operations that are dependent on the choice of one or multiple optional components. The details are used as input for the planning engine. - BorId:
- SubstituteComponents
-
Parameters:
- BorId:
$request.path.BorId
- SimulationSetId:
$request.path.SimulationSetId
The Substitute Components resource manages the collected substitute component, in the bill of resources, which is used as input for the planning engine. - BorId:
Examples
This example describes how to update one bill of resource to manage the bill of resources within a simulation set used as input for Oracle Fusion Supply Chain Planning.
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/simulationSets/SimulationSetId/child/BillOfResources/BorId"
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/simulationSets/300100555169265/child/BillOfResources/242157"
Example Request Body
The following example includes the contents of the request body in JSON format.
"{ "ComponentUsageQuantity": 1.5, "EffectiveStartDate"": "2020-07-23", "EffectiveEndDate"": "2022-07-23" }"
Example Response Body
The following example includes the contents of the response body in JSON format:
"{ "BorId": 242157, "OrganizationId": 10001, "Organization": "M1", "AssemblyItemId": 18114, "AssemblyItemName": "RC-TAB-AIR-3000", "AssemblyDescription": "Tab Air ", "AssemblyQuantity": 1, "AssemblyUOM": "EA", "AssemblyItemLevel": "Item", "CatalogId": -23453, "CatalogName": null, "CategoryId": -23453, "CategoryName": null, "CategoryUOM": null, "ConsumptionType": "Item", "ComponentItemId": 18086, "ComponentItemName": "RC-COMP-104", "ComponentDescription": "Memory 64g", "ComponentUsageQuantity": 1.5, "ComponentUOM": "EA", "WorkCenterId": null, "WorkCenterCode": null, "ResourceId": -23453, "ResourceCode": null, "ResourceUsageQuantity": 0, "ResourceUOM": null, "EffectiveStartDate": "2020-07-23", "EffectiveEndDate": "2022-07-23", "CreatedBy": "sop_fixed_dt", "CreationDate": "2021-09-08T15:43:07.929+00:00", "LastUpdateDate": "2021-09-16T12:43:43+00:00", "LastUpdatedBy": "APS_ALL", "SourceOrganizationId": 10001, "SourceOrganization": "M1", "LeadTimeOffsetInDays": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100555169265/child/BillOfResources/242157", "name": "BillOfResources", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100555169265/child/BillOfResources/242157", "name": "BillOfResources", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100555169265", "name": "simulationSets", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100555169265/child/BillOfResources/242157/child/AlternateResources", "name": "AlternateResources", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100555169265/child/BillOfResources/242157/child/SubstituteComponents", "name": "SubstituteComponents", "kind": "collection" } ] }"