1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Supply Chain Planning
  4. Simulation Sets
  5. Items

Get one item

get

/fscmRestApi/resources/11.13.18.05/simulationSets/{SimulationSetId}/child/Items/{ItemsUniqID}

Request

Path Parameters
  • 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.
  • 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
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : simulationSets-Items-item-response
Type: object
Show Source
  • 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.
  • 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.
  • Value that indicates whether common supplies are used in case the project inventory isn't sufficient during the demand and supply netting process. Valid values are: 1 or 2. If 1, then common supplies are used. If 2, then not.
  • Percent of unit cost that represents the internal cost to stock one unit for one year.
  • Read Only: true
    Maximum Length: 1
    Number of days required to assemble an item independent of the sales order quantity, such as setup time or tear down time.
  • 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.
  • Read Only: true
    Average time, expressed in days, between intervals.
  • Number of days specified by the user to override the average interarrival time, where the average interarrival time is the average time, expressed in days, between intervals.
  • 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.
  • Read Only: true
    Maximum Length: 4000
    Value that uniquely identifies the model to use when creating an assemble-to-order configuration.
  • 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.
  • Read Only: true
    Maximum Length: 240
    Name of the buyer associated with the item.
  • Read Only: true
    Contains one of the following values: 1 or 0. If 1, then enable available-to-promise functionality in Oracle Global Order Promising Cloud when planning for this item. If 2, don't enable. This attribute doesn't have a default value.
  • 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.
  • Read Only: true
    Maximum Length: 64
    User who created the item.
  • 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.
  • Date after which supplies can be created. This attribute is editable only when the CreateSupply attribute is set to 1.
  • Read Only: true
    Date and time when the user created the item.
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 30
    Value that indicates the currency associated with the item's price and cost.
  • Number of days of cover for the item. Days of Cover is multiplied by the average demand to calculate the safety stock level.
  • 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.
  • 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.
  • Time horizon, expressed in number of days, within which forecast demand is ignored.
  • 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.
  • Maximum Length: 240
    Description of the item.
  • Read Only: true
    Average discount for the item.
  • 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.
  • Time horizon, expressed in number of days, after which inventory is considered excess.
  • Number of days to use to modify the size and timing of each planned order quantity.
  • Number of days required to assemble an item independent of the sales order quantity, such as setup time or tear down time.
  • Multiplier to use, in units for each day, for each fixed lot quantity or each repetitive rate.
  • Quantity to use to modify the size of each planned order quantity or each repetitive daily rate.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates how the forecast is exploded and consumed. This attribute isn't currently used.
  • 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.
  • Maximum Length: 4000
    Meaning associated with the ForecastErrorType Code attribute.
  • 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.
  • Maximum Length: 4000
    Meaning associated with the HardPeggingLevel attribute.
  • 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.
  • Value specified by the user to override the Intermittent Demand, where Intermittent Demand indicates whether the demand 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.
  • Value that uniquely identifies the item.
  • Read Only: true
    Maximum Length: 4000
    Unit of measure associated with an item's cost.
  • Maximum Length: 300
    Name of the item.
  • 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.
  • Read Only: true
    Date and time when the user most recently updated the item.
  • Read Only: true
    Maximum Length: 64
    User most recently updated the item.
  • Multiplier to use, in units for each day, for each fixed lot quantity or each repetitive rate.
  • Number of months or periods in which the constrained supply plan offsets the lead time, after converting the number of months or periods to days. Month buckets are used if the supply planning calendar is Gregorian. Value can be null or greater than or equal to zero. This attribute doesn't have a default value.
  • Number of weeks in which the constrained supply plan offsets the lead time, after converting the number of weeks to days. Value can be null or greater than or equal to zero. This attribute doesn't have a default value.
  • Maximum Length: 120
    Name of lifecycle phase of the item.
  • Links
  • 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.
  • 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.
  • 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.
  • 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.
  • Read Only: true
    Value of the mean absolute deviation for the item.
  • Value that's the user override of the mean absolute deviation, where mean absolute deviation is a statistical formula used to measure the quantity deviation between actual and forecasted demand.
  • 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.
  • Read Only: true
    Value of the mean absolute percentage error for the item.
  • Value that's the user override of the mean absolute percentage error, where mean absolute percentage error is a statistical formula used to measure the percentage deviation between actual and forecasted demand.
  • Maximum order quantity of the item.
  • Minimum order quantity of the item.
  • Read Only: true
    Selling price of an item after applying an average discount to the item's list price.
  • The number of days after the demand date that the demand can be satisfied. This attribute doesn't have a default value.
  • Date when the item is obsolete.
  • Fixed costs that are associated with placing a sales order for the item.
  • 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.
  • Maximum Length: 49
    Abbreviation that identifies the organization associated with the item.
  • Value that uniquely identifies the organization.
  • 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.
  • Maximum Length: 10
    Abbreviation that identifies the planner responsible for the item.
  • Read Only: true
    Maximum Length: 4000
    Description of the planner responsible for the item.
  • 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.
  • 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.
  • 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.
  • Time horizon, in number of days, in which supply orders aren't scheduled to be due.
  • 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.
  • Number of days required to make an item available in inventory once the supply is complete.
  • Number of days which must be added to purchasing or manufacturing lead time to place an order.
  • Number of days required to procure or manufacture an item.
  • 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.
  • Time horizon, in number of days, in which orders are automatically released as work orders or purchase requisitions.
  • 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.
  • 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.
  • 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.
  • Maximum Length: 4000
    Meaning associated with the SafetyStockCode attribute.
  • Read Only: true
    Desired level of safety stock of an item.
  • Numeric value provided by the user to override the standard safety stock quantity of an item.
  • Selling price of the item.
  • 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.
  • Average amount of material you expect to lose when manufacturing or storing the item.
  • Standard cost of an item.
  • 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.
  • Read Only: true
    Volume of one item.
  • Read Only: true
    Weight of one item.
  • Read Only: true
    Maximum Length: 4000
    Planning unit of measure of the item.
  • Time to produce one unit of an assembly.
  • Read Only: true
    Maximum Length: 4000
    Unit of measure to use for the item volume.
  • Read Only: true
    Maximum Length: 4000
    Unit of measure to use for the item weight.
Back to Top

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/simulationSets/SimulationSetId/child/Items/ItemsUniqID"

For example, the following command gets one item:

curl -u username:password "https://servername/fscmRestApi/resources/version/simulationSets/300100082877057/child/Items?q=ItemName='75100006'"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"items": [
	{
		"ItemName": "75100006",
		"Organization": "M1",
		"Planner": null,
		"Buyer": null,
		"Description": "Colour Catridge Carrier",
		"PlanningMethodCode": 3,
		"PlanningMethod": "MRP planning",
		"MakeOrBuy": "Make",
		"LastUpdateDate": "2015-12-09T15:42:51.069+00:00",
		"LastUpdatedBy": "USER01",
		"ABCClass": null,
		"AcceptableEarlyDays": null,
		"ForecastControl": "Consume and Derive Forecast",
		"ATPComponents": "2",
		"CalculateATPIndicator": 2,
		"DiscountPercentage": null,
		"AverageInterarrivalTime": null,
		"AverageInterarrivalTimeOvrride": null,
		"BaseModel": null,
		"ItemStructureType": "Standard",
		"AnnualCarryingCostPercentage": null,
		"ConsiderInClearToBuild": null,
		"CreateSupply": 1,
		"CreatedBy": "USER01",
		"CreationDate": "2015-12-09T15:38:58.510+00:00",
		"CriticalComponent": null,
		"CumulativeManufacturingLT": 4,
		"DemandTimeFenceDays": null,
		"DemandTimeFenceCode": null,
		"DemandTimeFenceType": null,
		"ExcessHorizon": null,
		"FixedLeadTime": 0,
		"FixedLotMultiplier": null,
		"FixedOrderQuantity": null,
		"ForecastErrorType": null,
		"ForecastErrorTypeStr": null,
		"ProcessingLeadTime": 1,
		"IntermittentDemand": null,
		"IntermittentDemandOverride": null,
		"InventoryItemId": 11190,
		"SellingPrice": 10,
		"MADOverride": null,
		"MAPEOverride": null,
		"MaximumOrderQuantity": null,
		"MinimumOrderQuantity": null,
		"ObsolescenceDate": null,
		"OrganizationId": 10001,
		"PlanningTimeFenceDays": 1,
		"PlanningTimeFenceCode": 4,
		"PlanningTimeFenceType": "User-defined time fence",
		"PostprocessingLeadTime": 0,
		"PreprocessingLeadTime": null,
		"ReleaseTimeFenceDays": null,
		"ReleaseTimeFenceCode": null,
		"ReleaseTimeFenceType": null,
		"Rounding": 1,
		"DaysOfCoverDemandPeriod": null,
		"SafetyStockCode": 3,
		"SafetyStockPlanningMethod": "Not planned",
		"DaysOfCover": null,
		"SafetyStockQuantity": null,
		"SafetyStockQuantityOverride": null,
		"ServiceLevelPercentage": null,
		"ShrinkageRate": null,
		"StandardCost": null,
		"UnitVolume": null,
		"UnitWeight": null,
		"UOM": "Each",
		"VariableLeadTime": 0.00347222222222222,
		"VolumeUOMName": null,
		"WeightUOMName": null,
		"SupplyType": "Assembly pull",
		"BackToBackEnabled": 2,
		"AutocreatedConfiguration": 2,
		"LifeCyclePhase": "Design",
		"FixedDaysOfSupply": null,
		"Currency": null,
		"ItemCostUOM": null,
		"OrderModifierToStartQuantity": null,
		"PlannerDescription": null,
		"EnforcePurchasingLeadTime": 1,
		"PickComponents": null,
		"OrderCost": null,
		"HardPeggingLevel": "4",
		"HardPeggingLevelStr": "None",
		"AllowUseOfCommonSupplies": null,
		"LeadTimeLotSize": 1,
		"NetSellingPrice": 10,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100082877057/child/Items/00050000000EACED000577080000000000002BB60000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED0005770800000000000027110000000EACED00057708000110F07E299F9B0000000EACED00057708000110F07ED64281",
			"name": "Items",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100082877057/child/Items/00050000000EACED000577080000000000002BB60000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED0005770800000000000027110000000EACED00057708000110F07E299F9B0000000EACED00057708000110F07ED64281",
			"name": "Items",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100082877057",
			"name": "simulationSets",
			"kind": "item"
		}
		]
	}
	],
	"count": 1,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100082877057/child/Items",
		"name": "Items",
		"kind": "collection"
	}
	]
}
Back to Top