Get one item
get
/fscmRestApi/resources/11.13.18.05/planInputs/{PlanInputId}/child/Items/{ItemsUniqID}
Request
Path Parameters
-
ItemsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Items resource and used to uniquely identify an instance of Items. The client should not generate the hash key value. Instead, the client should query on the Items collection resource in order to navigate to a specific instance of Items to get the hash key.
-
PlanInputId(required): integer
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=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : planInputs-Items-item-response
Type:
Show Source
object
-
ABCClass: string
Read Only:
true
Maximum Length:40
Code assigned to the item for classification purposes. Items are divided into categories called ABC classes, such as A, B, and C, according to a criterion such as revenue generation, turnover, or value. -
AcceptableEarlyDays: integer
Read Only:
true
Number of days before which the planning process won't reschedule the sales order. For example, if the due date on the original sales order is June 10, and if the Acceptable Early Days is 3, and if the new due date is less than or equal to June 13 then the planning process won't suggest rescheduling. -
AnnualCarryingCostPercentage: number
Read Only:
true
Percent of unit cost that represents the internal cost to stock one unit for one year. -
ATPComponents: string
Read Only:
true
Maximum Length:1
Value that indicates whether to enable available-to-promise functionality in Oracle Fusion Cloud Global Order Promising when planning for this item. Valid values are 1 and 2. If 1, then available-to-promise functionality is enabled. If 2, then available-to-promise functionality isn't enabled. -
AutocreatedConfiguration: integer
(int32)
Read Only:
true
Value that indicates whether the item is a configured item or not. Valid values are: 1 or 2. If 1, then item is a configured item. If 2, then not. -
AverageInterarrivalTime: number
Read Only:
true
Average time, expressed in days, between intervals. -
BackToBackEnabled: integer
Read Only:
true
Value that indicates whether the item is enabled for back-to-back ordering or not. Valid values are: 1 or 2. If 1, then item is enabled for back-to-back ordering. If 2, then not. -
BaseModel: string
Read Only:
true
Maximum Length:4000
Value that uniquely identifies the model to use when creating an assemble-to-order configuration. -
BuildInWIPOption: integer
Read Only:
true
Contains one of the following values: 1 or 2. If 1, then work orders can be created. If No, then work orders can't be created. -
Buyer: string
Read Only:
true
Maximum Length:240
Name of the buyer associated with the item. -
CalculateATPIndicator: integer
Read Only:
true
Value that indicates whether to enable available-to-promise functionality in Oracle Fusion Cloud Global Order Promising when planning for this item. Valid values are 1 and 2. If 1, then available-to-promise functionality is enabled. If 2, then available-to-promise functionality isn't enabled. -
ConsiderInClearToBuild: string
Read Only:
true
Maximum Length:1
Value that indicates whether to include this component item when calculating clear-to-build for an assembly item. Valid values are 1 or 2. If 1, then this component item is included. If 2, then it's not. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the item. -
CreateSupply: integer
Read Only:
true
Value that indicates whether planning creates planned orders for this item. Valid values are 1 or 2. If 1, then planned orders are created. If 2, then planned orders aren't created. -
CreateSupplyAfter: string
(date)
Read Only:
true
Date after which supplies can be created. This attribute is editable only when the CreateSupply attribute is set to 1. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the supplier item. -
CriticalComponent: integer
Read Only:
true
Value that indicates whether the item is a critical component or not. Valid values are 1 or 2. If 1, then the item is a critical component. If 2, then the item isn't a critical component. -
CumulativeManufacturingLT: number
Read Only:
true
Number of days required to manufacture the item, including the adjusted, cumulative, and total lead time for the component that requires the longest time to assemble. -
Currency: string
Read Only:
true
Maximum Length:30
Value that indicates the currency associated with the item's price and cost. -
DaysOfCover: number
Read Only:
true
Number of days of cover for the item. Days of Cover is multiplied by the average demand to calculate the safety stock level. -
DaysOfCoverDemandPeriod: integer
Read Only:
true
Period of time, specified as a number of days, used to determine the average gross demand when using the Days of Cover method to calculate safety stock. -
DemandTimeFenceCode: integer
Read Only:
true
Abbreviation that identifies the point in time inside which the planning process ignores forecast demand and considers only sales order demand when calculating gross requirements. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES. -
DemandTimeFenceDays: integer
Read Only:
true
Time horizon, expressed in number of days, within which forecast demand is ignored. -
DemandTimeFenceType: string
Read Only:
true
Maximum Length:4000
Value that identifies the point in time inside which the planning process ignores forecast demand and considers only sales order demand when calculating gross requirements. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES. -
Description: string
Read Only:
true
Maximum Length:240
Description of the item. -
DiscountPercentage: number
Read Only:
true
Average discount for the item. -
EnforcePurchasingLeadTime: integer
(int32)
Read Only:
true
Value that indicates whether purchasing lead times are imposed as a hard constraint during constraint-based planning. Valid values are: 1 or 2. If 1, then purchasing lead times are enforced. If 2, then not. -
ExcessHorizon: number
Read Only:
true
Time horizon, expressed in number of days, after which inventory is considered excess. -
FixedDaysOfSupply: number
Read Only:
true
Number of days to use to modify the size and timing of each planned order quantity. -
FixedLeadTime: number
Read Only:
true
Number of days required to assemble an item independent of the sales order quantity, such as setup time or tear down time. -
FixedLotMultiplier: number
Read Only:
true
Multiplier to use, in units for each day, for each fixed lot quantity or each repetitive rate. -
FixedOrderQuantity: number
Read Only:
true
Quantity to use to modify the size of each planned order quantity or each repetitive daily rate. -
ForecastControl: string
Read Only:
true
Maximum Length:4000
Value that indicates how the forecast is exploded and consumed. This attribute isn't currently used. -
ForecastErrorType: string
Read Only:
true
Maximum Length:30
Value that indicates how the quality of a forecast is measured. A list of accepted values is defined in the lookup type MSC_FORECAST_ERROR_TYPES. -
ForecastErrorTypeStr: string
Read Only:
true
Maximum Length:4000
Meaning associated with the ForecastErrorType Code attribute. -
HardPeggingLevel: string
Read Only:
true
Maximum Length:25
Value that identifies the type of pegging considered by the planning engine during the supply and demand netting process. A list of accepted values is defined in the lookup type ORA_MSC_HARD_PEGGING_LEVEL. -
HardPeggingLevelStr: string
Read Only:
true
Maximum Length:4000
Meaning associated with the HardPeggingLevel attribute. -
IntermittentDemand: number
Read Only:
true
Value that indicates whether the demand for the item has an irregular frequency or not. Valid values are: 1 or 2. If 1, then demand for the item has an irregular frequency . If 2, then not. -
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item. -
ItemCostUOM: string
Read Only:
true
Maximum Length:4000
Unit of measure associated with an item's cost. -
ItemName: string
Read Only:
true
Maximum Length:255
Name of the item. -
ItemStructureType: string
Read Only:
true
Maximum Length:4000
Value that indicates the type of bill of material. A list of accepted values is defined in the lookup type ORA_MSC_BOM_ITEM_TYPE. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the item. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User most recently updated the item. -
LeadTimeLotSize: number
Read Only:
true
Multiplier to use, in units for each day, for each fixed lot quantity or each repetitive rate. -
LifeCyclePhase: string
Read Only:
true
Maximum Length:120
Name of lifecycle phase of the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotControl: string
Read Only:
true
Maximum Length:4000
Meaning associated with the LotControlCode attribute. A list of accepted values is defined in the lookup type ORA_MSC_LOT_CONTROL_CODE. -
LotControlCode: integer
Read Only:
true
Value that identifies whether the item is lot controlled. Valid values are 1 and 2. If 1, then lot control isn't established for the item. If 2, then lot control is used to track inventory balances by the lot number. A list of accepted values is defined in the lookup type ORA_MSC_LOT_CONTROL_CODE. -
LotExpirationControl: string
Read Only:
true
Maximum Length:4000
Meaning associated with the LotsExpiration attribute. A list of accepted values is defined in the lookup type ORA_MSC_LOT_EXPIRATION_CONTROL. -
LotsExpiration: integer
(int64)
Read Only:
true
Value that identifies how lot expiration dates are calculated. Valid values are 1 and 2. If 1, then lots don't expire. If 2, then lot expiration is based on the number of shelf life days for the item. A list of accepted values is defined in the lookup type ORA_MSC_LOT_EXPIRATION_CONTROL. -
MakeOrBuy: string
Read Only:
true
Maximum Length:4000
Value that indicates whether the item is manufactured or purchased. Valid values are Make or Buy. If Make, then the item is manufactured. If Buy, then the item is purchased. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY. -
MaximumOrderQuantity: number
Read Only:
true
Maximum order quantity of the item. -
MinimumOrderQuantity: number
Read Only:
true
Minimum order quantity of the item. -
NetSellingPrice: number
Selling price of an item after applying an average discount to the item's list price.
-
ObsolescenceDate: string
(date)
Read Only:
true
Date when the item is obsolete. -
OrderCost: number
Read Only:
true
Fixed costs that are associated with placing a sales order for the item. -
OrderModifierToStartQuantity: integer
Read Only:
true
Value that indicates whether order modifiers are applied to start quantity or not. Valid values are: 1 or 2. If 1, then order modifiers are applied to start quantity. If 2, then not. -
Organization: string
Read Only:
true
Maximum Length:49
Abbreviation that identifies the organization associated with the item. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the organization. -
PickComponents: integer
Read Only:
true
Value that indicates whether the item can be picked from finished goods inventory. Valid values are: 1 or 2. If 1, then the item can be picked from finished goods inventory. If 2, then not. -
Planner: string
Read Only:
true
Maximum Length:10
Abbreviation that identifies the planner responsible for the item. -
PlannerDescription: string
Read Only:
true
Maximum Length:4000
Description of the planner responsible for the item. -
PlanningMethod: string
Read Only:
true
Maximum Length:4000
Value that indicates the type of planning used for the item. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_CODE. -
PlanningMethodCode: integer
Read Only:
true
Abbreviation that indicates the type of planning used for the item. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_CODE. -
PlanningTimeFenceCode: integer
Read Only:
true
Abbreviation that identifies the point in time inside which the planning process won't schedule a supply order to be due. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES. -
PlanningTimeFenceDays: integer
Read Only:
true
Time horizon, in number of days, in which supply orders aren't scheduled to be due. -
PlanningTimeFenceType: string
Read Only:
true
Maximum Length:4000
Value that identifies the point in time inside which the planning process won't schedule a supply order to be due. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES. -
PostprocessingLeadTime: number
Read Only:
true
Number of days required to make an item available in inventory once the supply is complete. -
PreprocessingLeadTime: number
Read Only:
true
Number of days which must be added to purchasing or manufacturing lead time to place an order. -
ProcessingLeadTime: number
Read Only:
true
Number of days required to procure or manufacture an item. -
ReleaseTimeFenceCode: integer
Read Only:
true
Abbreviation that identifies the point in time inside which planned orders with certain criteria are automatically released as work orders or purchase orders. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES. -
ReleaseTimeFenceDays: integer
Read Only:
true
Time horizon, in number of days, in which orders are automatically released as work orders or purchase requisitions. -
ReleaseTimeFenceType: string
Read Only:
true
Maximum Length:4000
Value that identifies the point in time inside which planned orders with certain criteria are automatically released as work orders or purchase orders. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES. -
Rounding: integer
Read Only:
true
Value that indicates whether planned order quantity is rounded to a whole number or not. Valid values are: 1 or 2. If 1, then planned order quantity is rounded. If 2, then not. -
SafetyStockCode: integer
Read Only:
true
Value that identifies the method that planning uses to calculate safety stock levels for the item. A list of accepted values is defined in the lookup type ORA_MSC_SS_PLANNING_METHD. -
SafetyStockPlanningMethod: string
Read Only:
true
Maximum Length:4000
Meaning associated with the SafetyStockCode attribute. -
SafetyStockQuantity: number
Read Only:
true
Desired level of safety stock of an item. -
SellingPrice: number
Read Only:
true
Selling price of the item. -
ServiceLevelPercentage: number
Read Only:
true
Desired level of customer service, expressed as a percentage, in satisfying product demand. This represents the probability that an order can be filled from available inventory. -
ShrinkageRate: number
Read Only:
true
Average amount of material you expect to lose when manufacturing or storing the item. -
StandardCost: number
Read Only:
true
Standard cost of an item. -
SupplyType: string
Read Only:
true
Maximum Length:4000
Value that indicates the supply type for components. A list of accepted values is defined in the lookup type ORA_MSC_WIP_SUP_TYPE. -
UnitVolume: number
Read Only:
true
Volume of one item. -
UnitWeight: number
Read Only:
true
Weight of one item. -
UOM: string
Read Only:
true
Maximum Length:4000
Planning unit of measure of the item. -
VariableLeadTime: number
Read Only:
true
Time to produce one unit of an assembly. -
VolumeUOMName: string
Read Only:
true
Maximum Length:4000
Unit of measure to use for the item volume. -
WeightUOMName: string
Read Only:
true
Maximum Length:4000
Unit of measure to use for the item weight.
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
This example describes how to get one item.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/planInputs/PlanInputId/child/Items/ItemsUniqID"
For example, the following command gets one item using the query parameter:
curl -u username:password "https://servername/fscmRestApi/resources/version/planInputs/-1/child/Items?q=ItemName LIKE 'KB-EX5-300CB-ALLOY';Organization='EX5:M2'"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "ItemName": "KB-EX5-300CB-ALLOY", "Organization": "EX5:M2", "Planner": "Clare", "Buyer": null, "Description": "Alloy Steel", "PlanningMethodCode": 3, "PlanningMethod": "MRP planning", "MakeOrBuy": "Buy", "LastUpdateDate": "2018-03-13T06:19:10.609+00:00", "LastUpdatedBy": "USER01", "ABCClass": null, "AcceptableEarlyDays": null, "ForecastControl": "Consume then explode", "ATPComponents": "1", "CalculateATPIndicator": 2, "DiscountPercentage": 0, "AverageInterarrivalTime": null, "BaseModel": null, "ItemStructureType": "Standard", "AnnualCarryingCostPercentage": null, "ConsiderInClearToBuild": null, "CreateSupply": null, "CreatedBy": "USER01", "CreationDate": "2017-07-24T14:02:12.527+00:00", "CriticalComponent": null, "CumulativeManufacturingLT": null, "DemandTimeFenceDays": 2, "DemandTimeFenceCode": 4, "DemandTimeFenceType": "User-defined time fence", "ExcessHorizon": null, "FixedLeadTime": null, "FixedLotMultiplier": null, "FixedOrderQuantity": null, "ForecastErrorType": null, "ForecastErrorTypeStr": null, "ProcessingLeadTime": 25, "IntermittentDemand": null, "InventoryItemId": 767175, "SellingPrice": 20, "MaximumOrderQuantity": null, "MinimumOrderQuantity": null, "ObsolescenceDate": null, "OrganizationId": 23634, "PlanningTimeFenceDays": 3, "PlanningTimeFenceCode": 4, "PlanningTimeFenceType": "User-defined time fence", "PostprocessingLeadTime": null, "PreprocessingLeadTime": 2, "ReleaseTimeFenceDays": 15, "ReleaseTimeFenceCode": 4, "ReleaseTimeFenceType": "User-defined time fence", "Rounding": 2, "DaysOfCoverDemandPeriod": 0, "SafetyStockCode": 1, "SafetyStockPlanningMethod": "Safety stock quantity", "DaysOfCover": 0, "SafetyStockQuantity": null, "ServiceLevelPercentage": null, "ShrinkageRate": null, "StandardCost": null, "UnitVolume": null, "UnitWeight": null, "UOM": "Kilogram", "VariableLeadTime": null, "VolumeUOMName": null, "WeightUOMName": null, "SupplyType": "Push", "BackToBackEnabled": 2, "AutocreatedConfiguration": 2, "LifeCyclePhase": null, "FixedDaysOfSupply": null, "Currency": null, "ItemCostUOM": null, "OrderModifierToStartQuantity": null, "PlannerDescription": "Clare Jones", "EnforcePurchasingLeadTime": 1, "PickComponents": 1, "OrderCost": null, "HardPeggingLevel": null, "HardPeggingLevelStr": null, "LeadTimeLotSize": null, "NetSellingPrice": 20, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/planInputs/-1/child/Items/00050000000EACED0005770800000000000BB4C70000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED000577080000000000005C520000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708FFFFFFFFFFFFFFFF", "name": "Items", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/planInputs/-1/child/Items/00050000000EACED0005770800000000000BB4C70000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED000577080000000000005C520000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708FFFFFFFFFFFFFFFF", "name": "Items", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/planInputs/-1", "name": "planInputs", "kind": "item" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/planInputs/-1/child/Items", "name": "Items", "kind": "collection" } ] }