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

Get one demand

get

/fscmRestApi/resources/11.13.18.05/simulationSets/{SimulationSetId}/child/PlanningDemands/{TransactionId}

Request

Path Parameters
  • 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=
  • 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-PlanningDemands-item-response
Type: object
Show Source
  • Read Only: true
    Value that indicates whether Oracle Global Order Promising Cloud can automatically split a fulfillment line into two or more lines to optimize promising results. Valid values are 1 or 2. If 1, then Global Order Promising can automatically split a fulfillment line. If 2, then Global Order Promising can't automatically split a fulfillment line.
  • Read Only: true
    Value that indicates whether Oracle Global Order Promising Cloud can consider end item substitution to optimize promising results. Valid values are 1 or 2. If 1, then Global Order Promising considers end item substitution. If 2, then Global Order Promising doesn't consider end item substitution.
  • Title: Arrival Set Name
    Read Only: true
    Maximum Length: 30
    A named set designating the order lines that should arrive together. On the sales order, the arrival set name designates lines that should arrive together at the customer site.
  • Title: Asset
    Read Only: true
    Maximum Length: 80
    Number that identifies the asset associated with a maintenance work order.
  • Title: Bucket Type
    Read Only: true
    Maximum Length: 7
    Time bucket used for forecast demands. Valid values include Day, Month, Period, or Week. A list of accepted values is defined in the lookup types ORA_MSC_TIME_LEVELS_GREGORIAN and ORA_MSC_TIME_LEVELS_MFG.
  • Title: Buyer
    Read Only: true
    Name of the buyer associated with the item.
  • Read Only: true
    Shipped quantity of the sales order.
  • Read Only: true
    Quantity of a component issued to a work order.
  • Title: Configuration Item
    Read Only: true
    Maximum Length: 300
    Name of the configuration item.
  • Read Only: true
    Maximum Length: 64
    User who created the order.
  • Read Only: true
    Date when the user created the order.
  • Title: Customer
    Read Only: true
    Maximum Length: 4000
    Name of the customer associated with the sales order or forecast.
  • Read Only: true
    Maximum Length: 50
    Number that identifies the customer purchase order line corresponding to the sales order.
  • Read Only: true
    Maximum Length: 50
    Customer purchase order number corresponding to the sales order.
  • Read Only: true
    Maximum Length: 50
    Number that identifies the schedule level customer purchase order line location that corresponds to the sales order.
  • Title: Customer Site
    Read Only: true
    Maximum Length: 4000
    Code associated with a specific customer ship-to location.
  • Read Only: true
    Value that identifies the delivery cost per unit.
  • Read Only: true
    Value that identifies the delivery lead time from the promising application.
  • Read Only: true
    Maximum Length: 34
    Classification of demand used to track and consume different types of demand. Review and update the value for this attribute using the Manage Demand Classes task.
  • Title: Demand Class
    Read Only: true
    Maximum Length: 4000
    Code that identifies the demand class associated with the order. A list of accepted values is defined in the MSC_SR_LOOKUP_VALUES_TL table where LOOKUP_TYPE is DEMAND_CLASS.
  • Title: Order Priority
    Read Only: true
    Priority of the demand.
  • Title: Destination Time Zone
    Read Only: true
    Maximum Length: 100
    Time zone associated with the entity that's receiving the order. The destination entity can be a customer or an organization.
  • Read Only: true
    Date when the customer can accept the order to arrive at the earliest.
  • Read Only: true
    Date when the customer can accept the order to be shipped at the earliest.
  • Monetary value associated with the end demand.
  • Read Only: true
    Maximum Length: 50
    Contains one of the following values: Yes or No. If Yes, then the transfer is to an expense destination. If No, then the transfer isn't to an expense destination.
  • Title: Firm Date
    Date when the demand is due. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm.
  • Title: Firm Status
    Value that indicates whether the demand is firmed or not. Valid values are 1 or 2. If 1, then the demand is firm. If 2, then the demand isn't firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
  • Title: Firm Quantity
    Fixed quantity of demand. This attribute value can't be changed by planning and is only populated when the firm status is firm.
  • Read Only: true
    Maximum Length: 4000
    Status that indicates whether the order is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
  • Read Only: true
    Estimated cost to deliver a fulfillment line to a customer. The amount includes item cost and shipping cost.
  • Title: Fulfillment Line
    Read Only: true
    Fulfillment line number associated with a sales order.
  • Read Only: true
    Maximum Length: 300
    Value that uniquely identifies the cross reference of the recommended split fulfillment line created by Oracle Global Order Promising Cloud.
  • Read Only: true
    Value that indicates whether the sales order line is communicated to Oracle Global Order Promising Cloud for pick-to-order items. Valid values are 1 or 2. If 1, then pick-to-order items are communicated to Global Order Promising. If 2, then pick-to-order items aren't communicated to Global Order Promising.
  • Maximum Length: 300
    Name of the item associated with the demand.
  • Read Only: true
    Maximum Length: 240
    Description of the item associated with the demand.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the subclassification of the item on the order. A list of accepted values is defined in the lookup type ORA_MSC_OP_CTO_ITEM_SUB_TYPE.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the type of the item on the order. Valid values are 1, 2 or 3. If 1, then Model Item. If 2, then Option Class. If 3, then Standard Item.
  • Read Only: true
    Date when the demand was most recently updated.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the demand.
  • Read Only: true
    Date when the customer can accept the order to arrive at the latest.
  • Title: Latest Acceptable Date
    Read Only: true
    Date beyond which the demand line must not be promised.
  • Read Only: true
    Date when the customer can accept the order to be shipped at the latest.
  • Title: Line Number
    Read Only: true
    Maximum Length: 100
    Line number associated with the demand.
  • Links
  • Read Only: true
    If splits are allowed, this attribute specifies the minimum percentage required for splitting a fulfillment line.
  • Read Only: true
    If splits are allowed, this attribute specifies the minimum quantity required for splitting a fulfillment line.
  • Read Only: true
    Minimum duration of shelf life remaining when perishable products such as pharmaceuticals or groceries arrive at the customer site, so that there will be enough time for the end consumer to buy and use the products.
  • Title: Old Due Date
    Read Only: true
    Date when the demand quantity was originally due. This attribute value is extracted from the source application.
  • Title: Order Date Type
    Read Only: true
    Maximum Length: 4000
    Value that indicates the date specified by the customer. This attribute applies only to sales orders. Valid values include Ship date or Arrival date. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_DATE_TYPE_CODE.
  • Read Only: true
    Value that indicates the date specified by the customer. This attribute applies only to sales orders. Valid values include: 1 where customer has specified a requested ship date or 2 where customer has specified a requested arrival date. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_DATE_TYPE_CODE.
  • Read Only: true
    Value that indicates the difference between the revenue from the fulfillment line and the cost of promising the fulfillment line based on the current promising result.
  • Title: Order Number
    Read Only: true
    Maximum Length: 4000
    Order number associated with the sales order.
  • Title: Order Quantity
    Read Only: true
    Quantity associated with the demand.
  • Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
  • Title: Order Type
    Maximum Length: 4000
    Value that indicates the type of order such as sales order or forecast. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
  • Maximum Length: 49
    Name of the organization associated with the order.
  • Title: Organization Time Zone
    Read Only: true
    Maximum Length: 100
    Time zone of the organization associated with the demand.
  • Read Only: true
    Maximum Length: 100
    Abbreviation that identifies the base currency of the organization.
  • Title: Original Item
    Read Only: true
    Maximum Length: 4000
    Name of the item for which the order was originally scheduled.
  • Title: Original Order Quantity
    Read Only: true
    Quantity associated with the order. This value is extracted from the source application.
  • Read Only: true
    Maximum Length: 400
    For an order with assemble-to-order elements, this attribute indicates the immediate parent of an assemble-to-order component.
  • Title: Parent Model
    Read Only: true
    Maximum Length: 4000
    Model at a higher level in a hierarchy that's used to drive the forecast of a child model, option class, or option.
  • Title: Planned Arrival Date
    Read Only: true
    Date when the item will arrive. The attribute value is calculated using the suggested ship date, carrier calendar, in-transit lead time, and the receiving calendar.
  • Read Only: true
    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.
  • Planning Attributes
    Title: Planning Attributes
    The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply.
  • Maximum Length: 4000
    Value that identifies the project group.
  • Maximum Length: 4000
    Value that identifies the project.
  • Title: Promised Arrival Date
    Read Only: true
    Date when a customer has been promised the delivery of the order.
  • Title: Promised Ship Date
    Read Only: true
    Date when a customer has been promised the shipping of the order.
  • Read Only: true
    Maximum Length: 50
    Name of the promising application that promises supply for the demand.
  • Title: Requested Arrival Date
    Read Only: true
    Date when the material must arrive at the customer site.
  • Title: Requested Ship Date
    Read Only: true
    Date when the material must be shipped out to the customer.
  • Read Only: true
    Maximum Length: 400
    For an order having assemble-to-order elements, this attribute indicates the top-most model.
  • Read Only: true
    Maximum Length: 50
    Contact details of the sales representative.
  • Title: Scheduled Arrival Date
    Read Only: true
    Date when the demand has been scheduled to arrive at a customer site.
  • Title: Scheduled Ship Date
    Read Only: true
    Date when the demand has been scheduled to be shipped.
  • Title: Schedule Name
    Read Only: true
    Maximum Length: 4000
    Name of the supply or demand schedule associated with an order.
  • Read Only: true
    Selling price of an item on the order line.
  • Title: Shipment Set Name
    Read Only: true
    Maximum Length: 50
    On the sales order, the ship set name designates lines that should ship together.
  • Read Only: true
    Maximum Length: 30
    Value that indicates the shipping method associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
  • Title: Shipping Method
    Read Only: true
    Maximum Length: 4000
    Value that indicates the shipping method used to ship the order, or is a concatenation of carrier name, method of transportation, and service level associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
  • Read Only: true
    Maximum Length: 1200
    Value that indicates the shipping preference for the order.
  • Title: Ship To
    Read Only: true
    Maximum Length: 4000
    Abbreviation that identifies the specific ship-to location.
  • Title: Source Order
    Read Only: true
    Maximum Length: 50
    Value that identifies the order number in the source application against which fulfillment line has been created.
  • Title: Source Order Line
    Read Only: true
    Maximum Length: 50
    Value that identifies the order line number in the source application against which fulfillment line has been created.
  • Title: Source Organization
    Read Only: true
    Maximum Length: 4000
    Name of the organization that will source the order.
  • Title: Source Time Zone
    Read Only: true
    Maximum Length: 100
    Time zone associated with the entity that's sourcing the order. The sourcing entity can be a supplier or an organization.
  • Title: Suggested Dock Date
    Read Only: true
    Date when the demand is recommended to be completed.
  • Title: Suggested Ship Date
    Read Only: true
    Date when the order is recommended to be shipped.
  • Title: Supplier
    Read Only: true
    Maximum Length: 4000
    Name of the source supplier.
  • Title: Supplier Site
    Read Only: true
    Maximum Length: 4000
    Abbreviation that indicates the specific supplier ship-from location.
  • Read Only: true
    For drop ship sales orders, the source application for which the supplier site is defined.
  • Maximum Length: 4000
    Value that identifies task.
  • Value that uniquely identifies the demand. This value is internally generated by the application.
  • Read Only: true
    Maximum Length: 4000
    Name of the unit of measure that's associated with the order quantity.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure associated with the order quantity.
  • Title: Using Assembly
    Read Only: true
    Maximum Length: 4000
    For component demands, this field refers to the assembly item that uses this item as a component.
  • Title: Zone
    Read Only: true
    Maximum Length: 4000
    Region or zone where the demand quantity is being shipped.
Nested Schema : Planning Attributes
Type: array
Title: Planning Attributes
The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply.
Show Source
Nested Schema : simulationSets-PlanningDemands-PlanningAttributes-item-response
Type: object
Show Source
Links
PlanningAttributes
Parameters:
  • SimulationSetId: $request.path.SimulationSetId
  • TransactionId: $request.path.TransactionId
The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply.
Back to Top

Examples

This example describes how to get one demand.

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/PlanningDemands/TransactionId"

For example, the following command gets one demand:

curl -u username:password "https://servername/fscmRestApi/resources/version/simulationSets/300100548130525/child/PlanningDemands/2493901"

Example Response Body

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

{
	"CreatedBy": "SCP_PC_USER",
	"CreationDate": "2021-03-04T09:04:03.446+00:00",
	"FirmDate": "2030-01-31",
	"FirmQuantity": 0,
	"LastUpdateDate": "2021-03-04T09:21:27.033+00:00",
	"LastUpdatedBy": "SCP_PC_USER",
	"TransactionId": 2493901,
	"ArrivalSetName": null,
	"BucketType": null,
	"Buyer": null,
	"CustomerSite": "CINtomer Location 1",
	"DemandClass": null,
	"DemandPriority": null,
	"ItemDescription": "Tail Gear Box Assy",
	"ScheduleName": null,
	"Item": "AI-T-001",
	"Organization": "EX8:M1",
	"OrderTypeText": "Sales order",
	"FirmPlannedType": 1,
	"FirmStatus": "Firm",
	"SuggestedDueDate": "2030-01-31",
	"OrderNumber": "SO_T-0033",
	"Planner": "Jones",
	"Customer": "Computer Service and Rentals EX8",
	"SuggestedShipDate": null,
	"LatestAcceptableDate": null,
	"OldDueDate": null,
	"OrderDateTypeCode": 1,
	"OrderDateType": "Ship date",
	"OrderType": 1030,
	"OriginalItem": "AI-T-001",
	"OriginalOrderQuantity": 25,
	"PlannedArrivalDate": null,
	"PromisedArrivalDate": "2030-01-31",
	"PromisedShipDate": "2030-01-31",
	"OrderQuantity": -25,
	"RequestedArrivalDate": null,
	"RequestedShipDate": "2030-01-31",
	"ScheduledArrivalDate": "2030-01-31",
	"ScheduledShipDate": "2030-01-31",
	"SellingPrice": 10,
	"ShipMethod": null,
	"ShippingMethod": null,
	"ShipmentSetName": null,
	"ShipTo": "CINtomer Location 1",
	"SourceOrganization": null,
	"Supplier": null,
	"SupplierSite": null,
	"UOMCode": "Ea8",
	"UOM": "Each_qtyEX8",
	"UsingAssembly": null,
	"Zone": null,
	"SourceOrderLine": "1",
	"SourceOrder": "SO_T-0033",
	"LineNumber": "1",
	"FulfillmentLine": null,
	"DemandClassCode": null,
	"OrgCurrencyCode": "Us8",
	"CustomerPONumber": null,
	"ExpenseDestinationTransfer": "No",
	"ParentModel": null,
	"OrganizationTimeZone": null,
	"PlannerDescription": "Jones",
	"SourceTimeZone": null,
	"DestinationTimeZone": null,
	"ProjectValue": null,
	"TaskValue": null,
	"ProjectGroupValue": null,
	"ComponentQuantityIssued": null,
	"ConfigurationItem": null,
	"AssetNumber": null,
	"AllowSplits": 2,
	"AllowSubstitution": 2,
	"CompletedQuantity": null,
	"CustomerPOLineNumber": null,
	"CustomerPOScheduleNumber": null,
	"DeliveryCost": null,
	"DeliveryLeadTime": null,
	"EarliestAcceptableArrivalDate": "2030-01-31",
	"EarliestAcceptableShipDate": "2030-01-31",
	"FulfillmentCost": null,
	"GOPReferenceId": null,
	"IncludedItemsIndicator": null,
	"ItemSubTypeCode": null,
	"ItemTypeCode": null,
	"LatestAcceptableArrivalDate": "2030-01-31",
	"LatestAcceptableShipDate": "2030-01-31",
	"MinimumPercentageForSplit": null,
	"MinimumQuantityForSplit": null,
	"MinimumRemainingShelfLife": null,
	"OrderMargin": null,
	"ParentFulfillmentLine": null,
	"PromisingSystem": null,
	"RootFulfillmentLine": null,
	"SalesRepresentativeContact": null,
	"ShippingPreference": null,
	"SupplierSiteSourceSystem": null,
	"EndDemandValue": 250.0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100548130525/child/PlanningDemands/2493901",
		"name": "PlanningDemands",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000027372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100548130525/child/PlanningDemands/2493901",
		"name": "PlanningDemands",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100548130525",
		"name": "simulationSets",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100548130525/child/PlanningDemands/2493901/child/PlanningAttributes",
		"name": "PlanningAttributes",
		"kind": "collection"
	}
	]
}
Back to Top